This component adds information about the position and orientation of its entity.
More...
|
| ComponentTransformT () |
| The constructor. More...
|
|
| ComponentTransformT (const ComponentTransformT &Comp) |
| The copy constructor. More...
|
|
bool | IsIdentity () const |
| Returns whether the transformation described by this component is the identity ("no") transform. More...
|
|
const Vector3fT & | GetOriginPS () const |
| Returns the origin of the transform (in "parent-space"). More...
|
|
void | SetOriginPS (const Vector3fT &Origin) |
| Sets the origin of the transform (in "parent-space"). More...
|
|
const cf::math::QuaternionfT | GetQuatPS () const |
| Returns the orientation of the transform (in "parent-space"). More...
|
|
void | SetQuatPS (const cf::math::QuaternionfT &Quat) |
| Sets the orientation of the transform (in "parent-space"). More...
|
|
Vector3fT | GetOriginWS () const |
| Returns the origin of the transform (in world-space). More...
|
|
void | SetOriginWS (const Vector3fT &OriginWS) |
| Sets the origin of the transform (in world-space). More...
|
|
const cf::math::QuaternionfT | GetQuatWS () const |
| Returns the orientation of the transform (in world-space). More...
|
|
void | SetQuatWS (const cf::math::QuaternionfT &QuatWS) |
| Sets the orientation of the transform (in world-space). More...
|
|
MatrixT | GetEntityToWorld () const |
| Returns the transformation matrix from local entity-space to world-space. More...
|
|
void | LookAt (const Vector3fT &Pos, unsigned int AxisNr=0, bool NoPitch=false) |
| Sets the orientation of the transform so that it "looks at" the given position. More...
|
|
ComponentTransformT * | Clone () const |
| The virtual copy constructor. More...
|
|
const char * | GetName () const |
| Returns the name of this component. More...
|
|
const cf::TypeSys::TypeInfoT * | GetType () const |
|
| ComponentBaseT () |
| The constructor. More...
|
|
| ComponentBaseT (const ComponentBaseT &Comp) |
| The copy constructor. More...
|
|
virtual | ~ComponentBaseT () |
| The virtual destructor. More...
|
|
EntityT * | GetEntity () const |
| Returns the parent entity that contains this component, or NULL if this component is currently not a part of any entity. More...
|
|
TypeSys::VarManT & | GetMemberVars () |
| Returns the variable manager that keeps generic references to our member variables, providing a simple kind of "reflection" or "type introspection" feature. More...
|
|
template<class T > |
void | SetMember (const char *Name, const T &Value) |
| Sets the member variable with the given name to the given value. More...
|
|
ArrayT< ApproxBaseT * > & | GetInterpolators () |
| Returns the interpolators that have been registered with this component. More...
|
|
bool | InitClientApprox (const char *VarName) |
| Registers the member variable with the given name for interpolation over client frames in order to bridge the larger intervals between server frames. More...
|
|
void | Serialize (cf::Network::OutStreamT &Stream) const |
| Writes the current state of this component into the given stream. More...
|
|
void | Deserialize (cf::Network::InStreamT &Stream, bool IsIniting) |
| Reads the state of this component from the given stream, and updates the component accordingly. More...
|
|
bool | CallLuaMethod (const char *MethodName, int NumExtraArgs, const char *Signature="",...) |
| Calls the given Lua method of this component. More...
|
|
virtual void | UpdateDependencies (EntityT *Entity) |
| This method is called whenever something "external" to this component has changed: More...
|
|
virtual unsigned int | GetEditorColor () const |
| Returns a color that the Map Editor can use to render the representation of this component's entity. More...
|
|
virtual BoundingBox3fT | GetEditorBB () const |
| Returns a bounding-box that the Map Editor can use to render the representation of this component's entity and for related hit tests in the 2D and 3D views after mouse clicks. More...
|
|
virtual BoundingBox3fT | GetCullingBB () const |
| This method returns a bounding-box that encloses the visual representation of this component. More...
|
|
virtual const
cf::ClipSys::ClipModelT * | GetClipModel () |
| This method returns the clip model of this component, if any. More...
|
|
virtual void | PreCache () |
| Initializes any resources that may be needed on the client or server ahead of time. More...
|
|
virtual bool | Render (bool FirstPersonView, float LodDist) const |
| This method implements the graphical output of this component. More...
|
|
virtual void | PostRender (bool FirstPersonView) |
| This method provides an opportunity for another render pass. More...
|
|
virtual void | OnPostLoad (bool OnlyStatic) |
| This method is called after all entities and their components have been loaded. More...
|
|
virtual bool | OnInputEvent (const CaKeyboardEventT &KE) |
| This method handles keyboard input events. More...
|
|
virtual bool | OnInputEvent (const CaMouseEventT &ME, float PosX, float PosY) |
| This method handles mouse input events. More...
|
|
void | OnServerFrame (float t) |
| Advances the component one frame (one "clock-tick") on the server. More...
|
|
void | OnClientFrame (float t) |
| Advances the component one frame (one "clock-tick") on the client. More...
|
|
unsigned int | GetRefCount () const |
|
|
static int | GetOriginWS (lua_State *LuaState) |
|
static int | SetOriginWS (lua_State *LuaState) |
|
static int | GetAngles (lua_State *LuaState) |
|
static int | SetAngles (lua_State *LuaState) |
|
static int | GetAxisX (lua_State *LuaState) |
|
static int | GetAxisY (lua_State *LuaState) |
|
static int | GetAxisZ (lua_State *LuaState) |
|
static int | LookAt (lua_State *LuaState) |
|
static int | toString (lua_State *LuaState) |
|
static int | Get (lua_State *LuaState) |
|
static int | Set (lua_State *LuaState) |
|
static int | GetExtraMessage (lua_State *LuaState) |
|
static int | Interpolate (lua_State *LuaState) |
|
static int | GetEntity (lua_State *LuaState) |
|
static int | InitClientApprox (lua_State *LuaState) |
|
static int | toString (lua_State *LuaState) |
|
This component adds information about the position and orientation of its entity.
Positions and orientations can be measured relative to several distinct spaces:
world-space : The global and "absolute" coordinate space that also exists when nothing else does.
entity-space : The local coordinate system of the entity. It is defined by the entity's transform component relative to the entity's parent-space. The term "model-space" can be used synonymously with "entity-space".
parent-space : The entity-space of an entity's parent. If an entity has no parent entity, this is the same as world-space.
Although transform components can theoretically and technically exist without being attached to an entity, in practice this distinction is not made. Every entity has exactly one built-in transform component, and terms like "the origin of the transform" and "the origin of the entity" are used synonymously.