Drag[en]gine Game Engine  1.0
deLocomotion Class Reference

Actor locmotion handling. More...

#include <deLocomotion.h>

Inheritance diagram for deLocomotion:
deResource deObject

Public Member Functions

Management
deAnimatorInstanceGetAnimatorInstance () const
 Animator instance to control or NULL if not used. More...
 
void SetAnimatorInstance (deAnimatorInstance *animatorInstance)
 Set animator instance to control or NULL if not used. More...
 
deColliderGetCollider () const
 Collider to control or NULL if not used. More...
 
void SetCollider (deCollider *collider)
 Set collider to control or NULL if not used. More...
 
Units
int GetUnitCount () const
 Number of units. More...
 
deLocomotionUnitGetUnitAt (int index) const
 Unit at index. More...
 
int IndexOfUnit (deLocomotionUnit *unit) const
 Index of unit or -1 if not present in the locomotion. More...
 
void AddUnit (deLocomotionUnit *unit)
 Add unit. More...
 
void RemoveUnit (deLocomotionUnit *unit)
 Remove unit. More...
 
void RemoveAllUnits ()
 Removes all units. More...
 
void NotifyUnitChanged (int index)
 Notify peers about changes to a unit. More...
 
System Peers
deBaseAILocomotionGetPeerAI () const
 AI system peer or NULL if not set. More...
 
void SetPeerAI (deBaseAILocomotion *peer)
 Set AI system peer or NULL if not set. More...
 
- Public Member Functions inherited from deResource
deResourceManagerGetResourceManager () const
 Resource manager or NULL if resource is leaking. More...
 
deEngineGetEngine () const
 Game engine object from resource manager. More...
 
deResourceGetLLManagerPrev () const
 Previous resource in the resource manager linked list. More...
 
void SetLLManagerPrev (deResource *resource)
 Set next resource in the resource manager linked list. More...
 
deResourceGetLLManagerNext () const
 Next resource in the resource manager linked list. More...
 
void SetLLManagerNext (deResource *resource)
 Set next resource in the resource manager linked list. More...
 
void MarkLeaking ()
 Marks the resource leaking. More...
 
 deResource (deResourceManager *resourceManager)
 Create resource. More...
 
- Public Member Functions inherited from deObject
int GetRefCount () const
 Reference count. More...
 
void AddReference ()
 Add reference increasing reference count by 1. More...
 
void FreeReference ()
 Decrease reference count by one and delete object if count reaches 0. More...
 
 deObject ()
 Create object with reference count of 1. More...
 

Constructors and Destructors

 deLocomotion (deLocomotionManager *manager)
 Create new locomotion object. More...
 
virtual ~deLocomotion ()
 Clean up the locomotion object. More...
 

Additional Inherited Members

- Protected Member Functions inherited from deResource
virtual ~deResource ()
 Clean up resource. More...
 
- Protected Member Functions inherited from deObject
virtual ~deObject ()
 Clean up object. More...
 

Detailed Description

Actor locmotion handling.

Drive actor locomotion using a definition system. Allows to construct various kinds of locomotion calculated by the AI Module.

Author
Pl├╝ss Roland
Version
1.0
Date
2015

Constructor & Destructor Documentation

◆ deLocomotion()

deLocomotion::deLocomotion ( deLocomotionManager manager)

Create new locomotion object.

Exceptions
deeInvalidParammanager is NULL.

◆ ~deLocomotion()

virtual deLocomotion::~deLocomotion ( )
protectedvirtual

Clean up the locomotion object.

Note
Subclasses should set their destructor protected too to avoid users accidently deleting a reference counted object through the object pointer. Only FreeReference() is allowed to delete the object.

Member Function Documentation

◆ AddUnit()

void deLocomotion::AddUnit ( deLocomotionUnit unit)

Add unit.

Exceptions
deeInvalidParamunit is NULL.

Referenced by GetCollider().

◆ GetAnimatorInstance()

deAnimatorInstance* deLocomotion::GetAnimatorInstance ( ) const
inline

Animator instance to control or NULL if not used.

References SetAnimatorInstance().

◆ GetCollider()

deCollider* deLocomotion::GetCollider ( ) const
inline

Collider to control or NULL if not used.

References AddUnit(), GetUnitAt(), GetUnitCount(), IndexOfUnit(), NotifyUnitChanged(), RemoveAllUnits(), RemoveUnit(), and SetCollider().

◆ GetPeerAI()

deBaseAILocomotion* deLocomotion::GetPeerAI ( ) const
inline

AI system peer or NULL if not set.

References SetPeerAI().

◆ GetUnitAt()

deLocomotionUnit* deLocomotion::GetUnitAt ( int  index) const

Unit at index.

Exceptions
deeInvalidParamindex is less than 0 or greater than GetUnitCount()-1.

Referenced by GetCollider().

◆ GetUnitCount()

int deLocomotion::GetUnitCount ( ) const

Number of units.

Referenced by GetCollider().

◆ IndexOfUnit()

int deLocomotion::IndexOfUnit ( deLocomotionUnit unit) const

Index of unit or -1 if not present in the locomotion.

Referenced by GetCollider().

◆ NotifyUnitChanged()

void deLocomotion::NotifyUnitChanged ( int  index)

Notify peers about changes to a unit.

Exceptions
deeInvalidParamindex is less than 0 or greater than GetUnitCount()-1.

Referenced by GetCollider().

◆ RemoveAllUnits()

void deLocomotion::RemoveAllUnits ( )

Removes all units.

Referenced by GetCollider().

◆ RemoveUnit()

void deLocomotion::RemoveUnit ( deLocomotionUnit unit)

Remove unit.

Exceptions
deeInvalidParamunit is NULL.
deeInvalidParamunit is not present in the locmotion.

Referenced by GetCollider().

◆ SetAnimatorInstance()

void deLocomotion::SetAnimatorInstance ( deAnimatorInstance animatorInstance)

Set animator instance to control or NULL if not used.

Referenced by GetAnimatorInstance().

◆ SetCollider()

void deLocomotion::SetCollider ( deCollider collider)

Set collider to control or NULL if not used.

Referenced by GetCollider().

◆ SetPeerAI()

void deLocomotion::SetPeerAI ( deBaseAILocomotion peer)

Set AI system peer or NULL if not set.

Referenced by GetPeerAI().


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