Cafu Engine
cf::GameSys::ComponentMoverT Class Reference

This component controls the movement of one or more entities and implements the related effects. More...

#include "CompMover.hpp"

Inheritance diagram for cf::GameSys::ComponentMoverT:

Classes

class  VarDestActivatedT
 A variable of type int that describes the mover's behavior when it is activated at the "dest" position. More...
 
class  VarOtherEntitiesT
 A variable of type int that describes the mover's behavior regarding other entities. More...
 
class  VarTrajFuncT
 A variable of type int that describes the base function that is used to compute the mover's trajectory. More...
 

Public Member Functions

 ComponentMoverT ()
 The constructor. More...
 
 ComponentMoverT (const ComponentMoverT &Comp)
 The copy constructor. More...
 
ComponentMoverTClone () const override
 The virtual copy constructor. More...
 
const char * GetName () const override
 Returns the name of this component. More...
 
unsigned int GetEditorColor () const override
 Returns a color that the Map Editor can use to render the representation of this component's entity. More...
 
BoundingBox3fT GetEditorBB () const override
 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...
 
const cf::TypeSys::TypeInfoTGetType () const override
 
- Public Member Functions inherited from cf::GameSys::ComponentBaseT
 ComponentBaseT ()
 The constructor. More...
 
 ComponentBaseT (const ComponentBaseT &Comp)
 The copy constructor. More...
 
virtual ~ComponentBaseT ()
 The virtual destructor. More...
 
EntityTGetEntity () const
 Returns the parent entity that contains this component, or NULL if this component is currently not a part of any entity. More...
 
TypeSys::VarManTGetMemberVars ()
 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 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...
 
- Public Member Functions inherited from RefCountedT
unsigned int GetRefCount () const
 

Static Public Member Functions

static void * CreateInstance (const cf::TypeSys::CreateParamsT &Params)
 
- Static Public Member Functions inherited from cf::GameSys::ComponentBaseT
static void * CreateInstance (const cf::TypeSys::CreateParamsT &Params)
 

Static Public Attributes

static const cf::TypeSys::TypeInfoT TypeInfo
 
- Static Public Attributes inherited from cf::GameSys::ComponentBaseT
static const cf::TypeSys::TypeInfoT TypeInfo
 

Static Protected Member Functions

static int HandleMove (lua_State *LuaState)
 
static int toString (lua_State *LuaState)
 
- Static Protected Member Functions inherited from cf::GameSys::ComponentBaseT
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)
 

Static Protected Attributes

static const luaL_Reg MethodsList []
 The list of Lua methods for this class. More...
 
static const char * DocClass
 
static const cf::TypeSys::MethsDocT DocMethods []
 
static const cf::TypeSys::VarsDocT DocVars []
 
- Static Protected Attributes inherited from cf::GameSys::ComponentBaseT
static const luaL_Reg MethodsList []
 The list of Lua methods for this class. More...
 
static const char * DocClass
 
static const cf::TypeSys::MethsDocT DocMethods []
 
static const cf::TypeSys::MethsDocT DocCallbacks []
 

Additional Inherited Members

- Protected Member Functions inherited from RefCountedT
 RefCountedT (const RefCountedT &)
 
RefCountedToperator= (const RefCountedT &)
 

Detailed Description

This component controls the movement of one or more entities and implements the related effects.

The component can handle a single entity, e.g. a moving platform or a lift, or several entities that act together as a team, e.g. the wings of a door.

This component works in concert with a Script component, which must be present in the same entity. The Mover component queries the Script component for the desired spatial transformation of each team member, and notifies it whenever the movement is blocked by another entity (e.g. a player). It also implements the appropriate effects on other entities, e.g. their being pushed by moving parts, or their riding on top of them.

Constructor & Destructor Documentation

ComponentMoverT::ComponentMoverT ( )

The constructor.

ComponentMoverT::ComponentMoverT ( const ComponentMoverT Comp)

The copy constructor.

Parameters
CompThe component to create a copy of.

Member Function Documentation

ComponentMoverT * ComponentMoverT::Clone ( ) const
overridevirtual

The virtual copy constructor.

Callers can use this method to create a copy of this component without knowing its concrete type. Overrides in derived classes use a covariant return type to facilitate use when the concrete type is known. The newly cloned component is initially not a part of any entity, even if the source component was.

Reimplemented from cf::GameSys::ComponentBaseT.

BoundingBox3fT cf::GameSys::ComponentMoverT::GetEditorBB ( ) const
inlineoverridevirtual

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.

The Map Editor may use the bounding-box of an entity's first component as returned by this method to render the visual representation of the entity.

Note that the returned bounding-box is often smaller than the bounding-box returned by GetCullingBB(), e.g. for light sources (whose radius and thus their indirect effects on other objects it may not cover), for trees (whose trunk it usually covers, but maybe not their crown), or for models (that, when animated, may break the limits of the static bounding-box).

On the other hand, the returned bounding-box may also be larger than the bounding-box returned by GetCullingBB(), e.g. for models that are not initialized. Such models would be "invisible" in the 2D and 3D views of the Map Editor if we didn't return "dummy" bounding-boxes for them so that users can see and work with them.

The returned bounding-box is in local entity space and is always initialized (IsInited() == true).

Reimplemented from cf::GameSys::ComponentBaseT.

unsigned int cf::GameSys::ComponentMoverT::GetEditorColor ( ) const
inlineoverridevirtual

Returns a color that the Map Editor can use to render the representation of this component's entity.

The Map Editor may use the color of an entity's first component as returned by this method to render the visual representation of the entity.

Reimplemented from cf::GameSys::ComponentBaseT.

const char* cf::GameSys::ComponentMoverT::GetName ( ) const
inlineoverridevirtual

Returns the name of this component.

Reimplemented from cf::GameSys::ComponentBaseT.

Member Data Documentation

const char * ComponentMoverT::DocClass
staticprotected
Initial value:
=
"This component controls the movement of one or more entities and implements the related effects.\n"
"\n"
"The component can handle a single entity, e.g. a moving platform or a lift, or several entities\n"
"that act together as a team, e.g. the wings of a door.\n"
"\n"
"This component works in concert with a Script component, which must be present in the same entity.\n"
"The Mover component queries the Script component for the desired spatial transformation of each\n"
"team member, and notifies it whenever the movement is blocked by another entity (e.g. a player).\n"
"It also implements the appropriate effects on other entities, e.g. their being pushed by moving\n"
"parts, or their riding on top of them."
const cf::TypeSys::MethsDocT ComponentMoverT::DocMethods
staticprotected
Initial value:
=
{
META_HandleMove,
META_toString,
{ NULL, NULL, NULL, NULL }
}
const cf::TypeSys::VarsDocT ComponentMoverT::DocVars
staticprotected
Initial value:
=
{
{ "moveDuration", "The time in seconds that it takes to move each part from one endpoint to the other." },
{ "destActivated", "Describes the mover's behavior when it is activated at the \"dest\" position." },
{ "destTimeout", "The timeout in seconds after which the parts move back to their \"home\" position. A negative value to disables the timeout." },
{ "otherEntities", "Describes the mover's behavior regarding other entities." },
{ "trajFunc", "Describes the base function that is used to compute the mover's trajectory." },
{ "trajExp", "The exponent that is applied to `trajFunc`." },
{ NULL, NULL }
}
const luaL_Reg ComponentMoverT::MethodsList
staticprotected
Initial value:
=
{
{ "HandleMove", HandleMove },
{ "__tostring", toString },
{ NULL, NULL }
}

The list of Lua methods for this class.


The documentation for this class was generated from the following files: