osg::BasicActorBase Class Reference

#include <OSGBasicActorBase.h>

Inheritance diagram for osg::BasicActorBase:

List of all members.

Public Types
Types
typedef NewActionTypes::ResultE	ResultE
typedef NewActionTypes::PriorityType	PriorityType
typedef NewActionTypes::PriorityTypeTraits	PriorityTypeTraits
typedef NewActionTypes::Functor	Functor
typedef NewActionTypes::FunctorArgumentType	FunctorArgumentType
Public Member Functions
Destructor
virtual	~BasicActorBase (void)
Start/Stop
virtual ResultE	start (void)=0
virtual ResultE	stop (void)=0
Enter/Leave Callback
virtual ResultE	enterNode (FunctorArgumentType &funcArg)=0
virtual ResultE	leaveNode (FunctorArgumentType &funcArg)=0
Config
bool	getEnterNodeFlag (void) const
bool	getLeaveNodeFlag (void) const
void	setEnterNodeFlag (bool enter)
void	setLeaveNodeFlag (bool leave)
Action Access
const NewActionBase *	getAction (void) const
NewActionBase *	getAction (void)
UInt32	getActorId (void) const
Children Management
bool	getChildrenListEnabled (void) const
void	setChildrenListEnabled (bool enabled)
NodePtr	getNode (void) const
UInt32	getNumChildren (void) const
NodePtr	getChild (UInt32 childIndex) const
bool	getChildActive (UInt32 childIndex) const
void	setChildActive (UInt32 childIndex, bool active)
PriorityType	getChildPriority (UInt32 childIndex) const
void	setChildPriority (UInt32 childIndex, PriorityType prio)
Extra Children Management
UInt32	getNumExtraChildren (void) const
NodePtr	getExtraChild (UInt32 childIndex) const
bool	getExtraChildActive (UInt32 childIndex) const
void	setExtraChildActive (UInt32 childIndex, bool active)
PriorityType	getExtraChildPriority (UInt32 childIndex) const
void	setExtraChildPriority (UInt32 childIndex, PriorityType prio)
Multi Pass Management
UInt32	getNumPasses (void) const
State Management
virtual ActorBaseState *	createStateClone (void)=0
virtual void	destroyStateClone (ActorBaseState *pStateClone)=0
virtual void	createInitialState (void)=0
virtual void	deleteInitialState (void)=0
void	beginEditState (void)
void	endEditState (void)
const ActorBaseState *	getState (void) const
ActorBaseState *	getState (void)
void	setState (ActorBaseState *pState)
Protected Types
Types
typedef ActorBase	Inherited
typedef Inherited::StateType	StateType
Protected Member Functions
Constructor
	BasicActorBase (void)
Add, Sub and Find Helper
virtual UInt32	addHelper (NewActionBase *pAction)
virtual void	subHelper (NewActionBase *pAction)
virtual UInt32	findHelper (const NewActionBase *pAction)
Event Notification
virtual void	addEvent (NewActionBase *pAction, UInt32 actorId)
virtual void	subEvent (NewActionBase *pAction, UInt32 actorId)
Friends
Friends
class	osg::NewActionBase

---

Detailed Description

Definition at line 56 of file OSGBasicActorBase.h.

---

Member Typedef Documentation

typedef ActorBase osg::BasicActorBase::Inherited [protected]

Definition at line 89 of file OSGBasicActorBase.h.

typedef Inherited::StateType osg::BasicActorBase::StateType [protected]

Reimplemented from osg::ActorBase.

Definition at line 90 of file OSGBasicActorBase.h.

typedef NewActionTypes::ResultE osg::ActorBase::ResultE [inherited]

Definition at line 66 of file OSGActorBase.h.

typedef NewActionTypes::PriorityType osg::ActorBase::PriorityType [inherited]

Definition at line 67 of file OSGActorBase.h.

typedef NewActionTypes::PriorityTypeTraits osg::ActorBase::PriorityTypeTraits [inherited]

Definition at line 68 of file OSGActorBase.h.

typedef NewActionTypes::Functor osg::ActorBase::Functor [inherited]

Definition at line 69 of file OSGActorBase.h.

typedef NewActionTypes::FunctorArgumentType osg::ActorBase::FunctorArgumentType [inherited]

Definition at line 70 of file OSGActorBase.h.

---

Constructor & Destructor Documentation

BasicActorBase::~BasicActorBase

(

void

)

[virtual]

Definition at line 51 of file OSGBasicActorBase.cpp.

{
}

BasicActorBase::BasicActorBase

(

void

)

[protected]

Default constructor

Definition at line 94 of file OSGBasicActorBase.cpp.

    : Inherited()
{
}

---

Member Function Documentation

BasicActorBase::ResultE BasicActorBase::start

(

void

)

[pure virtual]

Implements osg::ActorBase.

Definition at line 60 of file OSGBasicActorBase.cpp.

References osg::ActorBase::start().

{
    return Inherited::start();
}

BasicActorBase::ResultE BasicActorBase::stop

(

void

)

[pure virtual]

Implements osg::ActorBase.

Definition at line 66 of file OSGBasicActorBase.cpp.

References osg::ActorBase::stop().

{
    return Inherited::stop();
}

BasicActorBase::ResultE BasicActorBase::enterNode

(

FunctorArgumentType &

funcArg

)

[pure virtual]

Implements osg::ActorBase.

Definition at line 76 of file OSGBasicActorBase.cpp.

References osg::NewActionTypes::Continue.

{
    return NewActionTypes::Continue;
}

BasicActorBase::ResultE BasicActorBase::leaveNode

(

FunctorArgumentType &

funcArg

)

[pure virtual]

Implements osg::ActorBase.

Definition at line 82 of file OSGBasicActorBase.cpp.

References osg::NewActionTypes::Continue.

{
    return NewActionTypes::Continue;
}

UInt32 BasicActorBase::addHelper

(

NewActionBase *

pAction

)

[protected, virtual]

Implements osg::ActorBase.

Definition at line 104 of file OSGBasicActorBase.cpp.

References osg::NewActionBase::addBasicActor().

{
    return pAction->addBasicActor(this);
}

void BasicActorBase::subHelper

(

NewActionBase *

pAction

)

[protected, virtual]

Implements osg::ActorBase.

Definition at line 110 of file OSGBasicActorBase.cpp.

References osg::endLog(), osg::NewActionBase::findBasicActor(), osg::NewActionBase::subBasicActor(), and SWARNING.

{
    UInt32 actorIndex = pAction->findBasicActor(this);

    if(actorIndex == TypeTraits<UInt32>::getMax())
    {
        SWARNING << "BasicActorBase::subHelper: Illegal actor index."
                 << endLog;

        return;
    }

    pAction->subBasicActor(actorIndex);
}

UInt32 BasicActorBase::findHelper

(

const NewActionBase *

pAction

)

[protected, virtual]

Implements osg::ActorBase.

Definition at line 126 of file OSGBasicActorBase.cpp.

References osg::NewActionBase::findBasicActor().

{
    return pAction->findBasicActor(this);
}

bool osg::ActorBase::getEnterNodeFlag

(

void

)

const [inline, inherited]

Return if operations upon "entering" a node are enabled.

Definition at line 75 of file OSGActorBase.inl.

References osg::ActorBase::_enterNodeFlag.

Referenced by osg::PriorityAction::addBasicEvent(), osg::DepthFirstStateAction::addBasicEvent(), osg::DepthFirstAction::addBasicEvent(), osg::PriorityAction::addExtendEvent(), osg::DepthFirstStateAction::addExtendEvent(), and osg::DepthFirstAction::addExtendEvent().

{
    return _enterNodeFlag;
}

bool osg::ActorBase::getLeaveNodeFlag

(

void

)

const [inline, inherited]

Return if operations upon "leaving" a node are enabled.

Definition at line 84 of file OSGActorBase.inl.

References osg::ActorBase::_leaveNodeFlag.

Referenced by osg::DepthFirstStateAction::addBasicEvent(), osg::DepthFirstAction::addBasicEvent(), osg::DepthFirstStateAction::addExtendEvent(), and osg::DepthFirstAction::addExtendEvent().

{
    return _leaveNodeFlag;
}

void osg::ActorBase::setEnterNodeFlag

(

bool

enter

)

[inline, inherited]

Set if operations upon entering a node are desired.

Warning:

You must not call this while the actor is attached to an action, it will cause possibly fatal inconsistency.

Definition at line 95 of file OSGActorBase.inl.

References osg::ActorBase::_enterNodeFlag.

{
    _enterNodeFlag = enter;
}

void osg::ActorBase::setLeaveNodeFlag

(

bool

leave

)

[inline, inherited]

Set if operations upon leaving a node are desired.

Warning:

You must not call this while the actor is attached to an action, it will cause possibly fatal inconsistency.

Definition at line 106 of file OSGActorBase.inl.

References osg::ActorBase::_leaveNodeFlag.

{
    _leaveNodeFlag = leave;
}

const NewActionBase * osg::ActorBase::getAction

(

void

)

const [inline, inherited]

Definition at line 116 of file OSGActorBase.inl.

References osg::ActorBase::_pAction.

Referenced by osg::ExtendActorBase::addExtraChild(), and osg::ExtendActorBase::setNumPasses().

{
    return _pAction;
}

NewActionBase * osg::ActorBase::getAction

(

void

)

[inline, inherited]

Definition at line 122 of file OSGActorBase.inl.

References osg::ActorBase::_pAction.

{
    return _pAction;
}

UInt32 osg::ActorBase::getActorId

(

void

)

const [inline, inherited]

Definition at line 128 of file OSGActorBase.inl.

References osg::ActorBase::_actorId.

Referenced by osg::NewActionBase::subBasicActor(), and osg::NewActionBase::subExtendActor().

{
    return _actorId;
}

bool osg::ActorBase::getChildrenListEnabled

(

void

)

const [inline, inherited]

Return if the children list is enabled.

Definition at line 141 of file OSGActorBase.inl.

References osg::ActorBase::_pAction, and osg::NewActionBase::getChildrenListEnabled().

{
    return _pAction->getChildrenListEnabled();
}

void osg::ActorBase::setChildrenListEnabled

(

bool

enabled

)

[inline, inherited]

Enable or disable the children list.

Definition at line 150 of file OSGActorBase.inl.

References osg::ActorBase::_pAction, and osg::NewActionBase::setChildrenListEnabled().

{
    _pAction->setChildrenListEnabled(enabled);
}

NodePtr osg::ActorBase::getNode

(

void

)

const [inline, inherited]

Return the traversed node.

Definition at line 159 of file OSGActorBase.inl.

References osg::ActorBase::_pAction, osg::NewActionBase::getChildrenList(), and osg::ChildrenList::getParentNode().

{
    return _pAction->getChildrenList().getParentNode();
}

UInt32 osg::ActorBase::getNumChildren

(

void

)

const [inline, inherited]

Return the number of children of the traversed node.

Definition at line 168 of file OSGActorBase.inl.

References osg::ActorBase::_pAction, osg::NewActionBase::getChildrenList(), and osg::ChildrenList::getSize().

{
    return _pAction->getChildrenList().getSize();
}

NodePtr osg::ActorBase::getChild

(

UInt32

childIndex

)

const [inline, inherited]

Return the childIndex'th child of the traversed node.

Warning:

childIndex is not range checked.

Definition at line 178 of file OSGActorBase.inl.

References osg::ActorBase::_pAction, osg::ChildrenList::getChild(), and osg::NewActionBase::getChildrenList().

{
    return _pAction->getChildrenList().getChild(childIndex);
}

bool osg::ActorBase::getChildActive

(

UInt32

childIndex

)

const [inline, inherited]

Return if the childIndex'th child is active, i.e. whether it will be traversed.

Warning:

childIndex is not range checked.

The children list must have been enabled with setChildrenListEnabled(true);

Definition at line 191 of file OSGActorBase.inl.

References osg::ActorBase::_pAction, osg::ChildrenList::getActive(), and osg::NewActionBase::getChildrenList().

{
    return _pAction->getChildrenList().getActive(childIndex);
}

void osg::ActorBase::setChildActive	(	UInt32	childIndex,
		bool	active
	)			[inline, inherited]

Set if the childIndex'th child will be included in the traversal.

Warning:

childIndex is not range checked.

The children list must have been enabled with setChildrenListEnabled(true);

Definition at line 203 of file OSGActorBase.inl.

References osg::ActorBase::_pAction, osg::NewActionBase::getChildrenList(), and osg::ChildrenList::setActive().

{
    _pAction->getChildrenList().setActive(childIndex, active);
}

ActorBase::PriorityType osg::ActorBase::getChildPriority

(

UInt32

childIndex

)

const [inline, inherited]

Return the priority assigned to the childIndex'th child.

Warning:

childIndex is not range checked.

The children list must have been enabled with setChildrenListEnabled(true);

Definition at line 215 of file OSGActorBase.inl.

References osg::ActorBase::_pAction, osg::NewActionBase::getChildrenList(), and osg::ChildrenList::getPriority().

{
    return _pAction->getChildrenList().getPriority(childIndex);
}

void osg::ActorBase::setChildPriority	(	UInt32	childIndex,
		PriorityType	prio
	)			[inline, inherited]

Set the priority of the childIndex'th child.

Warning:

childIndex is not range checked.

The children list must have been enabled with setChildrenListEnabled(true);

Definition at line 227 of file OSGActorBase.inl.

References osg::ActorBase::_pAction, osg::NewActionBase::getChildrenList(), and osg::ChildrenList::setPriority().

{
    _pAction->getChildrenList().setPriority(childIndex, prio);
}

UInt32 osg::ActorBase::getNumExtraChildren

(

void

)

const [inline, inherited]

Return the number of extra children already added.

Definition at line 240 of file OSGActorBase.inl.

References osg::ActorBase::_pAction, osg::NewActionBase::getExtraChildrenList(), and osg::ExtraChildrenList::getSize().

{
    return _pAction->getExtraChildrenList().getSize();
}

NodePtr osg::ActorBase::getExtraChild

(

UInt32

childIndex

)

const [inline, inherited]

Return the childIndex'th extra child.

Warning:

childIndex is not range checked.

Definition at line 250 of file OSGActorBase.inl.

References osg::ActorBase::_pAction, osg::ExtraChildrenList::getChild(), and osg::NewActionBase::getExtraChildrenList().

{
    return _pAction->getExtraChildrenList().getChild(childIndex);
}

bool osg::ActorBase::getExtraChildActive

(

UInt32

childIndex

)

const [inline, inherited]

Return if the childIndex'th extra child is active, i.e. whether it will be traversed.

Warning:

childIndex is not range checked.

Definition at line 261 of file OSGActorBase.inl.

References osg::ActorBase::_pAction, osg::ExtraChildrenList::getActive(), and osg::NewActionBase::getExtraChildrenList().

{
    return _pAction->getExtraChildrenList().getActive(childIndex);
}

void osg::ActorBase::setExtraChildActive	(	UInt32	childIndex,
		bool	active
	)			[inline, inherited]

Set if the childIndex'th extra child will be included in the traversal.

Warning:

childIndex is not range checked.

Definition at line 271 of file OSGActorBase.inl.

References osg::ActorBase::_pAction, osg::NewActionBase::getExtraChildrenList(), and osg::ExtraChildrenList::setActive().

{
    _pAction->getExtraChildrenList().setActive(childIndex, active);
}

ActorBase::PriorityType osg::ActorBase::getExtraChildPriority

(

UInt32

childIndex

)

const [inline, inherited]

Return the priority assigned to the childIndex'th extra child.

Warning:

childIndex is not range checked.

Definition at line 281 of file OSGActorBase.inl.

References osg::ActorBase::_pAction, osg::NewActionBase::getExtraChildrenList(), and osg::ExtraChildrenList::getPriority().

{
    return _pAction->getExtraChildrenList().getPriority(childIndex);
}

void osg::ActorBase::setExtraChildPriority	(	UInt32	childIndex,
		PriorityType	prio
	)			[inline, inherited]

Set the priority of the childIndex'th extra child.

Warning:

childIndex is not range checked.

Definition at line 291 of file OSGActorBase.inl.

References osg::ActorBase::_pAction, osg::NewActionBase::getExtraChildrenList(), and osg::ExtraChildrenList::setPriority().

{
    _pAction->getExtraChildrenList().setPriority(childIndex, prio);
}

UInt32 osg::ActorBase::getNumPasses

(

void

)

const [inline, inherited]

Return the number of passes requested for the current node. The default number of passes is 1.

Definition at line 305 of file OSGActorBase.inl.

References osg::ActorBase::_pAction, and osg::NewActionBase::getNumPasses().

{
    return _pAction->getNumPasses();
}

virtual ActorBaseState* osg::ActorBase::createStateClone

(

void

)

[pure virtual, inherited]

virtual void osg::ActorBase::destroyStateClone

(

ActorBaseState *

pStateClone

)

[pure virtual, inherited]

virtual void osg::ActorBase::createInitialState

(

void

)

[pure virtual, inherited]

Referenced by osg::ActorBase::addEvent().

virtual void osg::ActorBase::deleteInitialState

(

void

)

[pure virtual, inherited]

Referenced by osg::ActorBase::subEvent().

void osg::ActorBase::beginEditState

(

void

)

[inline, inherited]

Notify the action, that state is about to be edited.

Ext: Call this method inside a functor or the enterNode method of an actor before accessing any state variables. If you are worried about top performance you may omit the call as long as you only read state values, but as this is error prone it is not recommended.

Definition at line 326 of file OSGActorBase.inl.

References osg::ActorBase::_actorId, osg::ActorBase::_pAction, and osg::NewActionBase::beginEditStateEvent().

{
    _pAction->beginEditStateEvent(this, _actorId);
}

void osg::ActorBase::endEditState

(

void

)

[inline, inherited]

Notify the action, that state access is complete.

Ext: Call this method after you are done with modifying state. None of the implemented actions perform anything upon this call, hence it is not as critical as the beginEditState call.

Definition at line 341 of file OSGActorBase.inl.

References osg::ActorBase::_actorId, osg::ActorBase::_pAction, and osg::NewActionBase::endEditStateEvent().

{
    _pAction->endEditStateEvent(this, _actorId);
}

const ActorBase::ActorBaseState * osg::ActorBase::getState

(

void

)

const [inline, inherited]

Get a const pointer to the currently used state.

Definition at line 350 of file OSGActorBase.inl.

References osg::ActorBase::_pState.

{
    return _pState;
}

ActorBase::ActorBaseState * osg::ActorBase::getState

(

void

)

[inline, inherited]

Get a pointer to the currently used state.

Definition at line 359 of file OSGActorBase.inl.

References osg::ActorBase::_pState.

{
    return _pState;
}

void osg::ActorBase::setState

(

ActorBaseState *

pState

)

[inline, inherited]

Set the currently used state.

Definition at line 368 of file OSGActorBase.inl.

References osg::ActorBase::_pState.

{
    _pState = pState;
}

void ActorBase::addEvent	(	NewActionBase *	pAction,
		UInt32	actorId
	)			[protected, virtual, inherited]

Notifies the actor, that it was added to an action.

Warning:

When overriding this method, you must call the inherited version.

Definition at line 160 of file OSGActorBase.cpp.

References osg::ActorBase::_actorId, osg::ActorBase::_pAction, osg::ActorBase::createInitialState(), osg::endLog(), and SWARNING.

Referenced by osg::NewActionBase::addBasicActor(), and osg::NewActionBase::addExtendActor().

{
    if((_pAction != NULL) || (_actorId != TypeTraits<UInt32>::getMax()))
    {
        SWARNING << "ActorBase::attachEvent: Actor already attached."
                 << endLog;
    }

    createInitialState();

    _pAction = pAction;
    _actorId = actorId;
}

void ActorBase::subEvent	(	NewActionBase *	pAction,
		UInt32	actorId
	)			[protected, virtual, inherited]

Notifies the actor, that it was removed from an action.

Warning:

When overriding this method, you must call the inherited version.

Definition at line 179 of file OSGActorBase.cpp.

References osg::ActorBase::_actorId, osg::ActorBase::_pAction, osg::ActorBase::deleteInitialState(), osg::endLog(), and SWARNING.

Referenced by osg::NewActionBase::subBasicActor(), and osg::NewActionBase::subExtendActor().

{
    if((_pAction != pAction) || (_actorId != actorId))
    {
        SWARNING << "ActorBase::detachEvent: Inconsistency detected."
                 << endLog;
    }

    deleteInitialState();

    _pAction = NULL;
    _actorId = TypeTraits<UInt32>::getMax();
}

---

Friends And Related Function Documentation

friend class osg::NewActionBase [friend, inherited]

Definition at line 214 of file OSGActorBase.h.

---

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

• OSGBasicActorBase.h
• OSGBasicActorBase.cpp