T3DSceneClient Class Reference

#include <T3DSceneClient.h>

Inheritance diagram for T3DSceneClient:

Inheritance graph
[legend]
List of all members.

Public Member Functions

 T3DSceneClient ()
T3DSceneClient * getNextSceneClient ()
void setNextSceneClient (T3DSceneClient *client)
T3DSceneComponent * getSceneGroup ()
StringTableEntry getSceneGroupName ()
void setSceneGroupName (const char *name)
StringTableEntry getSceneClientName ()
void setSceneClientName (const char *name)

Protected Member Functions

bool onComponentRegister (SimComponent *owner)
 onComponentRegister is called on each component by it's owner.
void registerInterfaces (SimComponent *owner)
 registerInterfaces is called on each component as it's owner is registering it's interfaces.

Protected Attributes

T3DSceneClient * _nextClient
T3DSceneComponent * _sceneGroup
StringTableEntry _sceneGroupName
StringTableEntry _sceneClientName

Private Types

typedef SimComponent Parent

Member Typedef Documentation

typedef SimComponent T3DSceneClient::Parent [private]

Constructor & Destructor Documentation

T3DSceneClient::T3DSceneClient (  )  [inline]

Member Function Documentation

T3DSceneClient* T3DSceneClient::getNextSceneClient (  )  [inline]

void T3DSceneClient::setNextSceneClient ( T3DSceneClient *  client  )  [inline]

T3DSceneComponent* T3DSceneClient::getSceneGroup (  )  [inline]

StringTableEntry T3DSceneClient::getSceneGroupName (  )  [inline]

void T3DSceneClient::setSceneGroupName ( const char *  name  ) 

StringTableEntry T3DSceneClient::getSceneClientName (  )  [inline]

void T3DSceneClient::setSceneClientName ( const char *  name  )  [inline]

bool T3DSceneClient::onComponentRegister ( SimComponent *  owner  )  [protected, virtual]

onComponentRegister is called on each component by it's owner.

If a component has no owner, onComponentRegister will not be called on it. The purpose of onComponentRegister is to allow a component to check for any external interfaces, or other dependencies which it needs to function. If any component in a component hierarchy returns false from it's onComponentRegister call the entire hierarchy is invalid, and SimObject::onAdd will fail on the top-level component. To put it another way, if a component contains other components, it will be registered successfully with Sim iff each subcomponent returns true from onComponentRegister. If a component does not contain other components, it will not receive an onComponentRegister call.

When onComponentRegister is called on a component, it can be assumed that all *interfaces* are registered, but not that all components are registered. To perform initialization operations, please use onComponentPostRegister.

See also:
onComponentPostRegister
Overloads of this method must pass the call along to their parent, as is shown in the example below.

   /// bool FooComponent::onComponentRegister( SimComponent *owner )
   /// {
   ///    if( !Parent::onComponentRegister( owner ) )
   ///       return false;
   ///    ...
   /// }
   ///

Reimplemented from SimComponent.

void T3DSceneClient::registerInterfaces ( SimComponent *  owner  )  [protected, virtual]

registerInterfaces is called on each component as it's owner is registering it's interfaces.

This is called before onComponentRegister, and should be used to register all interfaces exposed by your component, as well as all callbacks needed by your component.

Reimplemented from SimComponent.

Member Data Documentation

T3DSceneClient* T3DSceneClient::_nextClient [protected]

T3DSceneComponent* T3DSceneClient::_sceneGroup [protected]

StringTableEntry T3DSceneClient::_sceneGroupName [protected]

StringTableEntry T3DSceneClient::_sceneClientName [protected]

© GarageGames.com Home Back to Top
© GarageGames.com Home Back to Top