An actor is an entity with an orientation. More...

#include <LSEActor.h>

Inheritance diagram for lse::CActor:

Public Member Functions
virtual LSUINT32 LSE_CALL	EntityType () const
virtual LSVOID LSE_CALL	SetEntityParent (CEntity *_peParent)
LSE_INLINE LSUINT32 LSE_CALL	ActorId () const
LSE_INLINE const CMatrix4x4 &LSE_CALL	LocalTrans () const
LSE_INLINE const CMatrix4x4 &LSE_CALL	WorldTrans () const
LSE_INLINE const COrientation &LSE_CALL	Orientation () const
LSE_INLINE COrientation &LSE_CALL	Orientation ()
LSVOID LSE_CALL	Propagate () const
LSE_INLINE LSBOOL LSE_CALL	IsWorldDirty () const
Protected Member Functions
virtual LSVOID LSE_CALL	UndirtyLocal () const
virtual LSVOID LSE_CALL	LocalWillChange () const
virtual LSVOID LSE_CALL	LocalDidChange () const
LSVOID LSE_CALL	UndirtyWorld () const
virtual LSVOID LSE_CALL	WorldWillChange () const
virtual LSVOID LSE_CALL	WorldDidChange () const
LSVOID LSE_CALL	DirtyChildrenWorldTrans () const
Protected Attributes
CMatrix4x4	m_mLocalTrans
CMatrix4x4	m_mWorldTrans
COrientation	m_oOrientation
LSBOOL	m_bWorldDirty
LSBOOL	m_bInheritsTrans
LSUINT32	m_ui32ActorId
Static Protected Attributes
static LSUINT32	m_ui32ActorIdCounter
static LSUINT32	m_ui32ActorCounter
static CCriticalSection	m_csCrit

Detailed Description

An actor is an entity with an orientation.

Class CActor Description: An actor is an entity with an orientation. It is the basis for all objects that can exist within the physical game world. Most things inherit from this rather than from CEntity.

Member Function Documentation

LSE_INLINE LSUINT32 LSE_CALL lse::CActor::ActorId ( ) const

Gets the actor's unique ID.

Returns:: Returns the unique ID for this actor.

LSVOID LSE_CALL lse::CActor::DirtyChildrenWorldTrans ( ) const [protected]

Causes all childrens' world dirty flag to be set to true. Should be called any time our local rotation changes.

virtual LSUINT32 LSE_CALL lse::CActor::EntityType ( ) const [virtual]

Get the entity type.

Returns:: Returns the type mask for this entity.

Reimplemented from lse::CEntity.

Reimplemented in lse::CCamera, lse::CMeshInstance, and lse::CModelInstance.

LSE_INLINE LSBOOL LSE_CALL lse::CActor::IsWorldDirty ( ) const

Is the world transform dirty?

Returns:: Returns true if the world transform is in need of updating.

virtual LSVOID LSE_CALL lse::CActor::LocalDidChange ( ) const [protected, virtual]

Inform child classes that the local transform has changed.

LSE_INLINE const CMatrix4x4 &LSE_CALL lse::CActor::LocalTrans ( ) const

Gets the local transform for this actor.

Returns:: Returns the local transform for this actor.

virtual LSVOID LSE_CALL lse::CActor::LocalWillChange ( ) const [protected, virtual]

Inform child classes that the local transform is about to change.

LSE_INLINE const COrientation &LSE_CALL lse::CActor::Orientation ( ) const

Gets the orientation of the object for read-only.

Returns:: Returns the orientation of this object.

LSE_INLINE COrientation &LSE_CALL lse::CActor::Orientation ( )

Gets the orientation of the object.

Returns:: Returns the orientation of this object.

LSVOID LSE_CALL lse::CActor::Propagate ( ) const

Dirty the children of this actor if necessary.

virtual LSVOID LSE_CALL lse::CActor::SetEntityParent ( CEntity * _peParent ) [virtual]

Set our parent.

Parameters:

_peParent A pointer to our new parent.

Reimplemented from lse::CEntity.

virtual LSVOID LSE_CALL lse::CActor::UndirtyLocal ( ) const [protected, virtual]

Undirty the local transform.

LSVOID LSE_CALL lse::CActor::UndirtyWorld ( ) const [protected]

Undirty the world transform.

virtual LSVOID LSE_CALL lse::CActor::WorldDidChange ( ) const [protected, virtual]

Inform child classes that the world transform has changed.

Reimplemented in lse::CMeshInstance, and lse::CModelInstance.

LSE_INLINE const CMatrix4x4 &LSE_CALL lse::CActor::WorldTrans ( ) const

Gets the world transform for this actor.

Returns:: Returns the world transform for this actor.

virtual LSVOID LSE_CALL lse::CActor::WorldWillChange ( ) const [protected, virtual]

Inform child classes that the world transform is about to change.

Member Data Documentation

LSBOOL lse::CActor::m_bInheritsTrans [protected]

If true, this actor inherits its transform from its parent. This is almost always the case. If false, this actor's local transform is its world transform.

LSBOOL lse::CActor::m_bWorldDirty [mutable, protected]

If true, the world transform is out-of-date.

CCriticalSection lse::CActor::m_csCrit [static, protected]

Critical section to guard the ID counters.

CMatrix4x4 lse::CActor::m_mLocalTrans [mutable, protected]

The local transform of this actor.

CMatrix4x4 lse::CActor::m_mWorldTrans [mutable, protected]

The world transform of this actor.

COrientation lse::CActor::m_oOrientation [protected]

The local orientation of this actor.

LSUINT32 lse::CActor::m_ui32ActorCounter [static, protected]

Actor count. When this reaches 0, the ID counter can be set back to 0.