T3DSceneComponent Class Reference

#include <T3DSceneComponent.h>

Inheritance diagram for T3DSceneComponent:

Inheritance graph
[legend]
List of all members.

Public Member Functions

 T3DSceneComponent ()
StringTableEntry getSceneGroup () const
void setSceneGroup (const char *sceneGroup)
StringTableEntry getParentTransformName () const
void setParentTransformName (const char *name)
U32 getObjectType () const
void setObjectType (U32 objectTypeMask)
void setUseOwnerObjectType (bool val)
bool useOwnerObjectType () const
bool isDirtyObjectBox () const
void setDirtyObjectBox (bool val)
bool isDirtyWorldBox () const
void setDirtyWorldBox (bool val)
bool isObjectBoxLocked () const
void setObjectBoxLocked (bool val)
bool isWorldBoxLocked () const
void setWorldBoxLocked (bool val)
bool doRenderObjectBounds () const
void setRenderObjectBounds (bool val)
bool doRenderWorldBounds () const
void setRenderWorldBounds (bool val)
bool doRenderSubBounds () const
void setRenderSubBounds (bool val)
bool isVisible () const
void setVisible (bool val)
float getVisibilityLevel () const
void setVisibilityLevel (float val)
Point3F getPosition () const
 Returns the position of the object.
void setPosition (const Point3F &pos)
 Sets the position of the object.
QuatF getRotation () const
void setRotation (const QuatF &rotation)
Point3F getScale () const
 Returns the scale of the object.
void setScale (const Point3F &scale)
 Sets the scale for the object.
Transform3DgetTransform3D ()
void setTransform (const MatrixF &mat)
 Sets the Object -> World transform.
Box3F getObjectBox ()
Box3F getWorldBox ()
T3DSceneClientgetSceneClientList () const
void Render ()
void AddSceneClient (T3DSceneClient *sceneClient)
void RemoveClientObject (T3DSceneClient *sceneClient)
void OnTransformDirty ()

Protected Types

 None = 0
 Visible = 1 << 0
 DirtyObjectBox = 1 << 1
 DirtyWorldBox = 1 << 2
 LockObjectBox = 1 << 3
 LockWorldBox = 1 << 4
 UseOwnerObjectType = 1 << 5
 RenderDebug = 1 << 6
 RenderObjectBounds = 1 << 7
 RenderWorldBounds = 1 << 8
 RenderSubBounds = 1 << 9
 LastFlag = 1 << 9
enum  SceneFlags {
  None = 0,
  Visible = 1 << 0,
  DirtyObjectBox = 1 << 1,
  DirtyWorldBox = 1 << 2,
  LockObjectBox = 1 << 3,
  LockWorldBox = 1 << 4,
  UseOwnerObjectType = 1 << 5,
  RenderDebug = 1 << 6,
  RenderObjectBounds = 1 << 7,
  RenderWorldBounds = 1 << 8,
  RenderSubBounds = 1 << 9,
  LastFlag = 1 << 9
}

Protected Member Functions

bool onComponentRegister (SimComponent *owner)
 onComponentRegister is called on each component by it's owner.
void onComponentUnRegister ()
 onUnregister is called when the owner is unregistering.
void registerInterfaces (SimComponent *owner)
 registerInterfaces is called on each component as it's owner is registering it's interfaces.
void _ComputeObjectBox ()
void _UpdateWorldBox ()
void setTransform3D (Transform3D *transform)
bool _TestFlag (U32 test) const
void _SetFlag (U32 test, bool value)

Protected Attributes

Transform3D_transform
T3DSceneClient_sceneClientList
ValueWrapperInterface< Box3F > * _objectBox
U32 _flags
float _visibilityLevel
U32 _objectType
StringTableEntry _sceneGroup
StringTableEntry _parentTransformName

Private Types

typedef SceneObject Parent

Member Typedef Documentation

Reimplemented from SceneObject.


Member Enumeration Documentation

Enumerator:
None 
Visible 
DirtyObjectBox 
DirtyWorldBox 
LockObjectBox 
LockWorldBox 
UseOwnerObjectType 
RenderDebug 
RenderObjectBounds 
RenderWorldBounds 
RenderSubBounds 
LastFlag 


Constructor & Destructor Documentation

T3DSceneComponent::T3DSceneComponent (  )  [inline]


Member Function Documentation

StringTableEntry T3DSceneComponent::getSceneGroup (  )  const [inline]

void T3DSceneComponent::setSceneGroup ( const char *  sceneGroup  ) 

StringTableEntry T3DSceneComponent::getParentTransformName (  )  const [inline]

void T3DSceneComponent::setParentTransformName ( const char *  name  ) 

U32 T3DSceneComponent::getObjectType (  )  const [inline]

void T3DSceneComponent::setObjectType ( U32  objectTypeMask  ) 

void T3DSceneComponent::setUseOwnerObjectType ( bool  val  )  [inline]

bool T3DSceneComponent::useOwnerObjectType (  )  const [inline]

bool T3DSceneComponent::isDirtyObjectBox (  )  const [inline]

void T3DSceneComponent::setDirtyObjectBox ( bool  val  ) 

bool T3DSceneComponent::isDirtyWorldBox (  )  const [inline]

void T3DSceneComponent::setDirtyWorldBox ( bool  val  ) 

bool T3DSceneComponent::isObjectBoxLocked (  )  const [inline]

void T3DSceneComponent::setObjectBoxLocked ( bool  val  ) 

bool T3DSceneComponent::isWorldBoxLocked (  )  const [inline]

void T3DSceneComponent::setWorldBoxLocked ( bool  val  ) 

bool T3DSceneComponent::doRenderObjectBounds (  )  const [inline]

void T3DSceneComponent::setRenderObjectBounds ( bool  val  )  [inline]

bool T3DSceneComponent::doRenderWorldBounds (  )  const [inline]

void T3DSceneComponent::setRenderWorldBounds ( bool  val  )  [inline]

bool T3DSceneComponent::doRenderSubBounds (  )  const [inline]

void T3DSceneComponent::setRenderSubBounds ( bool  val  )  [inline]

bool T3DSceneComponent::isVisible (  )  const [inline]

void T3DSceneComponent::setVisible ( bool  val  )  [inline]

float T3DSceneComponent::getVisibilityLevel (  )  const [inline]

void T3DSceneComponent::setVisibilityLevel ( float  val  )  [inline]

Point3F T3DSceneComponent::getPosition (  )  const [inline, virtual]

Returns the position of the object.

Reimplemented from SceneObject.

void T3DSceneComponent::setPosition ( const Point3F pos  ) 

Sets the position of the object.

Reimplemented from SceneObject.

QuatF T3DSceneComponent::getRotation (  )  const [inline]

void T3DSceneComponent::setRotation ( const QuatF rotation  ) 

Point3F T3DSceneComponent::getScale (  )  const [inline]

Returns the scale of the object.

Reimplemented from SceneObject.

void T3DSceneComponent::setScale ( const Point3F scale  )  [virtual]

Sets the scale for the object.

Parameters:
scale Scaling values

Reimplemented from SceneObject.

Transform3D* T3DSceneComponent::getTransform3D (  )  [inline]

void T3DSceneComponent::setTransform ( const MatrixF mat  )  [virtual]

Sets the Object -> World transform.

Parameters:
mat New transform matrix

Reimplemented from SceneObject.

Box3F T3DSceneComponent::getObjectBox (  ) 

Box3F T3DSceneComponent::getWorldBox (  ) 

T3DSceneClient* T3DSceneComponent::getSceneClientList (  )  const [inline]

void T3DSceneComponent::Render (  ) 

void T3DSceneComponent::AddSceneClient ( T3DSceneClient sceneClient  ) 

void T3DSceneComponent::RemoveClientObject ( T3DSceneClient sceneClient  ) 

void T3DSceneComponent::OnTransformDirty (  )  [inline]

bool T3DSceneComponent::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 T3DSceneComponent::onComponentUnRegister (  )  [protected, virtual]

onUnregister is called when the owner is unregistering.

Your object should do cleanup here, as well as pass a call up the chain to the parent.

Reimplemented from SimComponent.

void T3DSceneComponent::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.

void T3DSceneComponent::_ComputeObjectBox (  )  [protected]

void T3DSceneComponent::_UpdateWorldBox (  )  [protected]

void T3DSceneComponent::setTransform3D ( Transform3D transform  )  [protected]

bool T3DSceneComponent::_TestFlag ( U32  test  )  const [inline, protected]

void T3DSceneComponent::_SetFlag ( U32  test,
bool  value 
) [inline, protected]


Member Data Documentation