DtBindableLuaComponentInterface Class Reference

Multiply inherit from this class to add some convenience lua functions. More...

Inheritance diagram for DtBindableLuaComponentInterface:

Public Member Functions
	DtBindableLuaComponentInterface (const DtVrfObject *entity, const DtString &componentName, const DtString &componentType)
	CTOR.
virtual	~DtBindableLuaComponentInterface ()
	DTOR.
virtual void	bindLuaFunctions (lua_State *)=0
	Override to bind lua functions.
virtual void	bindLuaGlobals (lua_State *)=0
	Override to bind lua globals.
virtual void	bind (DtVrfObject *, const DtString &scriptId, lua_State *)
	Starts the binding process.
virtual DtString	bindableName (const DtString &) const
	Returns a name suitable for binding. Replaces spaces and - with _.

Protected Member Functions
virtual bool	shouldBind (lua_State *) const =0

Protected Attributes
const DtVrfObject *	myBoundEntity
lua_State *	myBoundForState
DtString	myType

Detailed Description

Multiply inherit from this class to add some convenience lua functions.

Constructor & Destructor Documentation

DtBindableLuaComponentInterface::DtBindableLuaComponentInterface	(	const DtVrfObject *	entity,
		const DtString &	componentName,
		const DtString &	componentType
	)

CTOR.

The name will be the name to ingnore when saving and the class name to be referenced in scripts

virtual DtBindableLuaComponentInterface::~DtBindableLuaComponentInterface ( )

virtual

DTOR.

Member Function Documentation

virtual void DtBindableLuaComponentInterface::bindLuaFunctions ( lua_State *  )

pure virtual

Override to bind lua functions.

Implemented in DtTranslatablePartActuator, DtSimpleProximitySensor, and DtSwingingPartActuator.

virtual void DtBindableLuaComponentInterface::bindLuaGlobals ( lua_State *  )

pure virtual

Override to bind lua globals.

Implemented in DtTranslatablePartActuator, DtSimpleProximitySensor, and DtSwingingPartActuator.

virtual void DtBindableLuaComponentInterface::bind ( DtVrfObject *  , const DtString &  scriptId, lua_State *    )

virtual

Starts the binding process.

virtual DtString DtBindableLuaComponentInterface::bindableName ( const DtString &  ) const

virtual

Returns a name suitable for binding. Replaces spaces and - with _.

virtual bool DtBindableLuaComponentInterface::shouldBind ( lua_State *  ) const

protectedpure virtual

Implemented in DtBindableLuaComponent< T >, DtBindableLuaComponent< DtSwingingPartActuator >, DtBindableLuaComponent< DtSimpleProximitySensor >, and DtBindableLuaComponent< DtTranslatablePartActuator >.

Member Data Documentation

const DtVrfObject* DtBindableLuaComponentInterface::myBoundEntity

protected

lua_State* DtBindableLuaComponentInterface::myBoundForState

protected

DtString DtBindableLuaComponentInterface::myType

protected

---

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

• /exports/nfedora7-1/nightly/docs/vrforcesDevelopment.vrf4-3-branch/include/vrfmodel/bindableLuaComponent.h