iPcMesh Struct Reference
This is a property class holding the representation of a mesh. More...
#include <propclass/mesh.h>
Public Member Functions | |
virtual void | SetPath (const char *path)=0 |
Set the path to use. | |
virtual bool | SetMesh (const char *factname, const char *filename)=0 |
Set the mesh filename to use. | |
virtual void | SetMesh (iMeshWrapper *mesh, bool do_remove=false)=0 |
Set the mesh to use directly. | |
virtual void | CreateEmptyThing ()=0 |
Create an empty thing mesh (use instead of SetMesh()). | |
virtual iMeshWrapper * | GetMesh () const =0 |
Get the mesh. | |
virtual void | MoveMesh (iSector *sector, const csVector3 &pos)=0 |
Convenience function to move the mesh to some sector and position and also update lighting. | |
virtual void | SetAction (const char *actionName, bool reset=false)=0 |
Convenience function to set an 'action' for the mesh. | |
virtual const char * | GetAction ()=0 |
Return the current action name. | |
virtual void | SetReverseAction (bool reverse=true)=0 |
Convenience function to set an 'action' to be reversed for the mesh. | |
virtual void | Hide ()=0 |
Hide this mesh. | |
virtual void | Show ()=0 |
Show this mesh. | |
virtual bool | IsVisible () const =0 |
Return true if mesh is visible. |
Detailed Description
This is a property class holding the representation of a mesh.This property class supports the following actions (add prefix 'cel.action.' to get the ID of the action and add prefix 'cel.parameter.' to get the ID of the parameter):
- SetMesh: parameters 'name' (string). This sets an already existing mesh for this pcmesh.
- LoadMesh: parameters 'filename' (string) and 'factoryname' (string).
- LoadMeshPath: parameters 'path' (string), 'filename' (string) and 'factoryname' (string).
- MoveMesh: parameters 'sector' (string) and 'position' (vector3).
Definition at line 51 of file mesh.h.
Member Function Documentation
|
Create an empty thing mesh (use instead of SetMesh()). After this use GetMesh() to add polygons to the mesh. |
|
Return the current action name.
|
|
Get the mesh.
|
|
Hide this mesh.
|
|
Return true if mesh is visible.
|
|
Convenience function to move the mesh to some sector and position and also update lighting. If sector specified is 0, sector is not updated. |
|
Convenience function to set an 'action' for the mesh. This only works for 3D sprites. For other mesh objects nothing will happen. |
|
Set the mesh to use directly. It is normally not recommended to use this function directly. iPcRegion will use it for its dummy entities.
|
|
Set the mesh filename to use. Returns false on failure. Note that this filename can refer to a mesh factory file or a library file containing a mesh factory. If 'filename' is not given (i.e. 0) then it is assumed the factory is already loaded in memory. |
|
Set the path to use. If this is not done then the filename in SetMesh() will be used alone. Otherwise this path is used to temporarily set the current VFS dir while loading (which will be restored afterwards) and the filename in SetMesh() is used relative to that. Note that this must be called before SetMesh(). |
|
Convenience function to set an 'action' to be reversed for the mesh. This only works for 3D sprites. For other mesh objects nothing will happen. |
|
Show this mesh.
|
The documentation for this struct was generated from the following file:
- propclass/mesh.h
Generated for CEL: Crystal Entity Layer by doxygen 1.4.4