osg::DepthFirstStateAction Class Reference

#include <OSGDepthFirstStateAction.h>

Inheritance diagram for osg::DepthFirstStateAction:

List of all members.

Statistics
static StatElemDesc< StatIntElem >	statNodesEnter
static StatElemDesc< StatIntElem >	statNodesLeave
const StatCollector *	getStatistics (void) const
StatCollector *	getStatistics (void)
void	setStatistics (StatCollector *pStatistics)
Types
typedef NewActionBase	Inherited
typedef ActorBase::ActorBaseState	ActorBaseState
typedef std::list < ActorBaseState * >	StateStore
typedef StateStore::iterator	StateStoreIt
typedef StateStore::const_iterator	StateStoreConstIt
typedef std::list< StateRefCount >	StateRefCountStore
typedef StateRefCountStore::iterator	StateRefCountStoreIt
typedef StateRefCountStore::const_iterator	StateRefCountStoreConstIt
typedef std::deque < NodeStackEntry >	NodeStack
class	StateRefCount
class	NodeStackEntry
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	~DepthFirstStateAction (void)
Apply
virtual ResultE	apply (NodePtr pRoot)
Generic Actor Management
UInt32	addActor (ActorBase *pActor)
void	subActor (ActorBase *pActor)
UInt32	findActor (ActorBase *pActor) const
UInt32	getNumActors (void) const
Extend Actor Management
UInt32	addExtendActor (ExtendActorBase *pActor)
UInt32	addExtendActor (ExtendActorBase *pActor, UInt32 pos)
void	subExtendActor (UInt32 pos)
UInt32	findExtendActor (ExtendActorBase *pActor) const
UInt32	getNumExtendActors (void) const
Basic Actor Management
UInt32	addBasicActor (BasicActorBase *pActor)
UInt32	addBasicActor (BasicActorBase *pActor, UInt32 pos)
void	subBasicActor (UInt32 pos)
UInt32	findBasicActor (BasicActorBase *pActor) const
UInt32	getNumBasicActors (void) const
Traversal Mask
UInt32	getTravMask (void) const
void	setTravMask (UInt32 travMask)
Static Public Member Functions
Create
static DepthFirstStateAction *	create (void)
Static Public Attributes
Statistics
static StatElemDesc< StatIntElem >	statStateClones
static StatElemDesc< StatIntElem >	statStateRestores
Protected Types
Types
typedef std::vector < ExtendActorBase * >	ExtendActorStore
typedef ExtendActorStore::iterator	ExtendActorStoreIt
typedef ExtendActorStore::const_iterator	ExtendActorStoreConstIt
typedef std::vector < BasicActorBase * >	BasicActorStore
typedef BasicActorStore::iterator	BasicActorStoreIt
typedef BasicActorStore::const_iterator	BasicActorStoreConstIt
Protected Member Functions
Constructors
	DepthFirstStateAction (void)
Events
virtual void	addExtendEvent (ExtendActorBase *pActor, UInt32 actorIndex)
virtual void	subExtendEvent (ExtendActorBase *pActor, UInt32 actorIndex)
virtual void	addBasicEvent (BasicActorBase *pActor, UInt32 actorIndex)
virtual void	subBasicEvent (BasicActorBase *pActor, UInt32 actorIndex)
virtual void	startEvent (void)
virtual void	stopEvent (void)
virtual void	beginEditStateEvent (ActorBase *pActor, UInt32 actorId)
virtual void	endEditStateEvent (ActorBase *pActor, UInt32 actorId)
ChildrenList/ExtraChildrenList Access
bool	getChildrenListEnabled (void) const
void	setChildrenListEnabled (bool enabled)
const ChildrenList &	getChildrenList (void) const
ChildrenList &	getChildrenList (void)
const ExtraChildrenList &	getExtraChildrenList (void) const
ExtraChildrenList &	getExtraChildrenList (void)
MultiPass Setup
UInt32	getNumPasses (void) const
void	setNumPasses (UInt32 numPasses)
Actor Access
ExtendActorStoreConstIt	beginExtend (void) const
ExtendActorStoreIt	beginExtend (void)
ExtendActorStoreConstIt	endExtend (void) const
ExtendActorStoreIt	endExtend (void)
BasicActorStoreConstIt	beginBasic (void) const
BasicActorStoreIt	beginBasic (void)
BasicActorStoreConstIt	endBasic (void) const
BasicActorStoreIt	endBasic (void)
ResultE	startActors (void)
ResultE	stopActors (void)
Private Member Functions
Helper Methods
ResultE	traverseEnter (void)
ResultE	traverseEnterLeave (void)
void	pushChildren (const NodePtr &pNode, ResultE result)
ResultE	enterNode (const NodePtr &pNode, UInt32 pass)
ResultE	leaveNode (const NodePtr &pNode, UInt32 pass)
StateRefCountStoreIt	cloneState (void)
StateRefCountStoreIt	getState (void)
void	setState (StateRefCountStoreIt itStateRefCount)
void	incRefCount (StateRefCountStoreIt itStateRefCount, Int32 inc=1)
void	decRefCount (StateRefCountStoreIt itStateRefCount, Int32 dec=1)
Private Attributes
NodeStack	_nodeStack
StateRefCountStore	_stateRefCountStore
StateStore	_stateStore
StateRefCountStoreIt	_itInitialState
StateRefCountStoreIt	_itActiveState
bool	_stateClonedFlag
ExtendActorStore	_extendEnterActors
ExtendActorStore	_extendLeaveActors
BasicActorStore	_basicEnterActors
BasicActorStore	_basicLeaveActors
Friends
Friends
class	osg::ActorBase
class	osg::ExtendActorBase
class	osg::BasicActorBase
Classes
class	NodeStackEntry
class	StateRefCount

---

Detailed Description

Definition at line 63 of file OSGDepthFirstStateAction.h.

---

Member Typedef Documentation

typedef NewActionBase osg::DepthFirstStateAction::Inherited [private]

Definition at line 136 of file OSGDepthFirstStateAction.h.

typedef ActorBase::ActorBaseState osg::DepthFirstStateAction::ActorBaseState [private]

Definition at line 137 of file OSGDepthFirstStateAction.h.

typedef std::list<ActorBaseState *> osg::DepthFirstStateAction::StateStore [private]

Definition at line 164 of file OSGDepthFirstStateAction.h.

typedef StateStore::iterator osg::DepthFirstStateAction::StateStoreIt [private]

Definition at line 165 of file OSGDepthFirstStateAction.h.

typedef StateStore::const_iterator osg::DepthFirstStateAction::StateStoreConstIt [private]

Definition at line 166 of file OSGDepthFirstStateAction.h.

typedef std::list<StateRefCount> osg::DepthFirstStateAction::StateRefCountStore [private]

Definition at line 196 of file OSGDepthFirstStateAction.h.

typedef StateRefCountStore::iterator osg::DepthFirstStateAction::StateRefCountStoreIt [private]

Definition at line 197 of file OSGDepthFirstStateAction.h.

typedef StateRefCountStore::const_iterator osg::DepthFirstStateAction::StateRefCountStoreConstIt [private]

Definition at line 198 of file OSGDepthFirstStateAction.h.

typedef std::deque<NodeStackEntry> osg::DepthFirstStateAction::NodeStack [private]

Definition at line 223 of file OSGDepthFirstStateAction.h.

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

Definition at line 71 of file OSGNewActionBase.h.

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

Definition at line 72 of file OSGNewActionBase.h.

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

Definition at line 73 of file OSGNewActionBase.h.

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

Definition at line 74 of file OSGNewActionBase.h.

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

Definition at line 75 of file OSGNewActionBase.h.

typedef std::vector<ExtendActorBase *> osg::NewActionBase::ExtendActorStore [protected, inherited]

Definition at line 155 of file OSGNewActionBase.h.

typedef ExtendActorStore::iterator osg::NewActionBase::ExtendActorStoreIt [protected, inherited]

Definition at line 156 of file OSGNewActionBase.h.

typedef ExtendActorStore::const_iterator osg::NewActionBase::ExtendActorStoreConstIt [protected, inherited]

Definition at line 157 of file OSGNewActionBase.h.

typedef std::vector<BasicActorBase *> osg::NewActionBase::BasicActorStore [protected, inherited]

Definition at line 159 of file OSGNewActionBase.h.

typedef BasicActorStore::iterator osg::NewActionBase::BasicActorStoreIt [protected, inherited]

Definition at line 160 of file OSGNewActionBase.h.

typedef BasicActorStore::const_iterator osg::NewActionBase::BasicActorStoreConstIt [protected, inherited]

Definition at line 161 of file OSGNewActionBase.h.

---

Constructor & Destructor Documentation

DepthFirstStateAction::~DepthFirstStateAction

(

void

)

[virtual]

Destructor.

Definition at line 71 of file OSGDepthFirstStateAction.cpp.

{
}

DepthFirstStateAction::DepthFirstStateAction

(

void

)

[protected]

Default constructor.

Definition at line 154 of file OSGDepthFirstStateAction.cpp.

Referenced by create().

    : Inherited          (     ),
      _nodeStack         (     ),
      _stateRefCountStore(     ),
#ifndef OSG_NEWACTION_STATESLOTINTERFACE
      _stateStore        (     ),
#endif
      _itInitialState    (     ),
      _itActiveState     (     ),
      _stateClonedFlag   (false),
      _extendEnterActors (     ),
      _extendLeaveActors (     ),
      _basicEnterActors  (     ),
      _basicLeaveActors  (     )
{
}

---

Member Function Documentation

DepthFirstStateAction * DepthFirstStateAction::create

(

void

)

[static]

Create new instance.

Definition at line 83 of file OSGDepthFirstStateAction.cpp.

References DepthFirstStateAction().

{
    return new DepthFirstStateAction();
}

DepthFirstStateAction::ResultE DepthFirstStateAction::apply

(

NodePtr

pRoot

)

[virtual]

Implements osg::NewActionBase.

Definition at line 93 of file OSGDepthFirstStateAction.cpp.

References _basicLeaveActors, _extendLeaveActors, _itActiveState, _itInitialState, _nodeStack, _stateClonedFlag, _stateRefCountStore, _stateStore, cloneState(), osg::NewActionTypes::Continue, decRefCount(), getState(), incRefCount(), NodeStackEntry, osg::NewActionTypes::Quit, setState(), osg::NewActionBase::startActors(), startEvent(), osg::NewActionBase::stopActors(), stopEvent(), traverseEnter(), and traverseEnterLeave().

{
    ResultE result = NewActionTypes::Continue;

    startEvent();

    result = startActors();

    if(result & NewActionTypes::Quit)
        return result;

    _itInitialState = getState  ();
    _itActiveState  = cloneState();

    // gained refs: active, root
    incRefCount(_itActiveState, 2);

    _nodeStack.push_back(NodeStackEntry(pRoot, _itActiveState, 1));

    if((_extendLeaveActors.empty() == true) &&
       (_basicLeaveActors .empty() == true)    )
    {
        result = traverseEnter();
    }
    else
    {
        result = traverseEnterLeave();
    }

    setState(_itInitialState);

    // lost refs: active, current node
    decRefCount(_itActiveState, 2);

    _itActiveState   = _itInitialState;
    _stateClonedFlag = true;

    _nodeStack         .clear();
#ifndef OSG_NEWACTION_STATESLOTINTERFACE
    _stateStore        .clear();
#endif
    _stateRefCountStore.clear();

    if(result & NewActionTypes::Quit)
        return result;

    result = stopActors();

    stopEvent();

    return result;
}

void DepthFirstStateAction::addExtendEvent	(	ExtendActorBase *	pActor,
		UInt32	actorIndex
	)			[protected, virtual]

Inserts the extend actor into an internal data structure, depending on whether the enter node flag and leave node flag are set. This avoids making the destinction everytime the actors are called.

Implements osg::NewActionBase.

Definition at line 181 of file OSGDepthFirstStateAction.cpp.

References _extendEnterActors, _extendLeaveActors, osg::NewActionBase::beginExtend(), osg::ActorBase::getEnterNodeFlag(), and osg::ActorBase::getLeaveNodeFlag().

{
    ExtendActorStoreIt itActors  = beginExtend();
    ExtendActorStoreIt endActors = beginExtend() + actorIndex;

    ExtendActorStoreIt itEnter   = _extendEnterActors.begin();
    ExtendActorStoreIt itLeave   = _extendLeaveActors.begin();

    for(; itActors != endActors; ++itActors)
    {
        if((*itActors)->getEnterNodeFlag() == true)
            ++itEnter;

        if((*itActors)->getLeaveNodeFlag() == true)
            ++itLeave;
    }

    if(pActor->getEnterNodeFlag() == true)
        _extendEnterActors.insert(itEnter, pActor);

    if(pActor->getLeaveNodeFlag() == true)
        _extendLeaveActors.insert(itLeave, pActor);
}

void DepthFirstStateAction::subExtendEvent	(	ExtendActorBase *	pActor,
		UInt32	actorIndex
	)			[protected, virtual]

Removes the extend actor from the internal data structures.

Implements osg::NewActionBase.

Definition at line 209 of file OSGDepthFirstStateAction.cpp.

References _extendEnterActors, and _extendLeaveActors.

{
    ExtendActorStoreIt itEnter  = _extendEnterActors.begin();
    ExtendActorStoreIt endEnter = _extendEnterActors.end  ();

    ExtendActorStoreIt itLeave  = _extendLeaveActors.begin();
    ExtendActorStoreIt endLeave = _extendLeaveActors.end  ();

    for(; itEnter != endEnter; ++itEnter)
    {
        if(*itEnter == pActor)
        {
            _extendEnterActors.erase(itEnter);

            break;
        }
    }

    for(; itLeave != endLeave; ++itLeave)
    {
        if(*itLeave == pActor)
        {
            _extendLeaveActors.erase(itLeave);

            break;
        }
    }
}

void DepthFirstStateAction::addBasicEvent	(	BasicActorBase *	pActor,
		UInt32	actorIndex
	)			[protected, virtual]

Inserts the basic actor into an internal data structure, depending on whether the enter node flag and leave node flag are set. This avoids making the destinction everytime the actors are called.

Implements osg::NewActionBase.

Definition at line 244 of file OSGDepthFirstStateAction.cpp.

References _basicEnterActors, _basicLeaveActors, osg::NewActionBase::beginBasic(), osg::ActorBase::getEnterNodeFlag(), and osg::ActorBase::getLeaveNodeFlag().

{
    BasicActorStoreIt itActors  = beginBasic();
    BasicActorStoreIt endActors = beginBasic() + actorIndex;

    BasicActorStoreIt itEnter   = _basicEnterActors.begin();
    BasicActorStoreIt itLeave   = _basicLeaveActors.begin();

    for(; itActors != endActors; ++itActors)
    {
        if((*itActors)->getEnterNodeFlag() == true)
            ++itEnter;

        if((*itActors)->getLeaveNodeFlag() == true)
            ++itLeave;
    }

    if(pActor->getEnterNodeFlag() == true)
        _basicEnterActors.insert(itEnter, pActor);

    if(pActor->getLeaveNodeFlag() == true)
        _basicLeaveActors.insert(itLeave, pActor);
}

void DepthFirstStateAction::subBasicEvent	(	BasicActorBase *	pActor,
		UInt32	actorIndex
	)			[protected, virtual]

Removes the extend actor from the internal data structures.

Implements osg::NewActionBase.

Definition at line 272 of file OSGDepthFirstStateAction.cpp.

References _basicEnterActors, and _basicLeaveActors.

{
    BasicActorStoreIt itEnter  = _basicEnterActors.begin();
    BasicActorStoreIt endEnter = _basicEnterActors.end  ();

    BasicActorStoreIt itLeave  = _basicLeaveActors.begin();
    BasicActorStoreIt endLeave = _basicLeaveActors.end  ();

    for(; itEnter != endEnter; ++itEnter)
    {
        if(*itEnter == pActor)
        {
            _basicEnterActors.erase(itEnter);

            break;
        }
    }

    for(; itLeave != endLeave; ++itLeave)
    {
        if(*itLeave == pActor)
        {
            _basicLeaveActors.erase(itLeave);

            break;
        }
    }
}

void DepthFirstStateAction::startEvent

(

void

)

[protected, virtual]

Inserts the extend actor into an internal data structure, depending on whether the enter node flag and leave node flag are set. This avoids making the destinction everytime the actors are called.

Reimplemented from osg::NewActionBase.

Definition at line 302 of file OSGDepthFirstStateAction.cpp.

References osg::StatCollector::getElem(), osg::NewActionBase::getStatistics(), osg::StatElem::reset(), osg::NewActionBase::startEvent(), statStateClones, and statStateRestores.

Referenced by apply().

{
    Inherited::startEvent();

#ifdef OSG_NEWACTION_STATISTICS
    getStatistics()->getElem(statStateClones  )->reset();
    getStatistics()->getElem(statStateRestores)->reset();
#endif /* OSG_NEWACTION_STATISTICS */
}

void DepthFirstStateAction::stopEvent

(

void

)

[protected, virtual]

Inserts the extend actor into an internal data structure, depending on whether the enter node flag and leave node flag are set. This avoids making the destinction everytime the actors are called.

Reimplemented from osg::NewActionBase.

Definition at line 313 of file OSGDepthFirstStateAction.cpp.

References osg::NewActionBase::stopEvent().

Referenced by apply().

{
    Inherited::stopEvent();
}

void DepthFirstStateAction::beginEditStateEvent	(	ActorBase *	pActor,
		UInt32	actorId
	)			[protected, virtual]

Creates a copy of the state of the attached actors and activates the copy.

Implements osg::NewActionBase.

Definition at line 323 of file OSGDepthFirstStateAction.cpp.

References _itActiveState, _nodeStack, _stateClonedFlag, cloneState(), decRefCount(), osg::StatCollector::getElem(), osg::NewActionBase::getStatistics(), incRefCount(), and statStateClones.

{
    if(_stateClonedFlag == false)
    {
#ifdef OSG_NEWACTION_STATISTICS
        getStatistics()->getElem(statStateClones)->inc();
#endif /* OSG_NEWACTION_STATISTICS */

        _stateClonedFlag = true;

        StateRefCountStoreIt itClonedState = cloneState();

        // gained refs: active and current node
        incRefCount(itClonedState, 2);

        // lost refs: active and current node
        decRefCount(_itActiveState, 2);

        _nodeStack.back().setStateRefCount(itClonedState);

        _itActiveState = itClonedState;
    }
}

void DepthFirstStateAction::endEditStateEvent	(	ActorBase *	pActor,
		UInt32	actorId
	)			[protected, virtual]

Does nothing.

Implements osg::NewActionBase.

Definition at line 351 of file OSGDepthFirstStateAction.cpp.

{
}

DepthFirstStateAction::ResultE DepthFirstStateAction::traverseEnter

(

void

)

[private]

Definition at line 361 of file OSGDepthFirstStateAction.cpp.

References _itActiveState, _nodeStack, _stateClonedFlag, osg::NewActionTypes::Continue, decRefCount(), enterNode(), osg::NewActionBase::getChildrenList(), osg::StatCollector::getElem(), osg::NewActionBase::getNumPasses(), osg::NewActionBase::getStatistics(), incRefCount(), NodeStackEntry, pushChildren(), osg::NewActionTypes::Quit, osg::ChildrenList::setParentNode(), setState(), osg::NewActionBase::statNodesEnter, and statStateRestores.

Referenced by apply().

{
    ResultE              result          = NewActionTypes::Continue;
    NodePtr              pNode;
    Int32                nodePass;        // pass over current node
    UInt32               multiPasses;     // requested passes over current node
    StateRefCountStoreIt itStateRefCount; // state for current node

    while((_nodeStack.empty() == false) && !(result & NewActionTypes::Quit))
    {
        pNode           = _nodeStack.back().getNode         ();
        nodePass        = _nodeStack.back().getPassCount    ();
        itStateRefCount = _nodeStack.back().getStateRefCount();

#ifdef OSG_NEWACTION_STATISTICS
        getStatistics()->getElem(statNodesEnter)->inc();
#endif /* OSG_NEWACTION_STATISTICS */

        if(itStateRefCount != _itActiveState)
        {
#ifdef OSG_NEWACTION_STATISTICS
            getStatistics()->getElem(statStateRestores)->inc();
#endif /* OSG_NEWACTION_STATISTICS */

            setState(itStateRefCount);

            // gained refs: active
            incRefCount(itStateRefCount);

            // lost refs: active
            decRefCount(_itActiveState);

            _itActiveState = itStateRefCount;
        }

        _stateClonedFlag = false;

        getChildrenList().setParentNode(pNode);

        result      = enterNode   (pNode, static_cast<UInt32>(nodePass - 1));
        multiPasses = getNumPasses(                                        );

        _nodeStack.pop_back();

        // only initial pass (nodePass == 1) can request multiPasses
        if((nodePass == 1) && (multiPasses > 1))
        {
            for(; multiPasses > 1; --multiPasses)
            {
                // gained refs: additional pass
                incRefCount(_itActiveState);
                
                _nodeStack.push_back(
                    NodeStackEntry(pNode, _itActiveState, multiPasses));
            }
        }
        
        pushChildren(pNode, result);

        // lost refs: current node
        decRefCount(_itActiveState);
    }

    return result;
}

DepthFirstStateAction::ResultE DepthFirstStateAction::traverseEnterLeave

(

void

)

[private]

Definition at line 428 of file OSGDepthFirstStateAction.cpp.

References _itActiveState, _nodeStack, _stateClonedFlag, osg::NewActionTypes::Continue, decRefCount(), enterNode(), osg::NewActionBase::getChildrenList(), osg::StatCollector::getElem(), osg::NewActionBase::getNumPasses(), osg::NewActionBase::getStatistics(), incRefCount(), leaveNode(), NodeStackEntry, pushChildren(), osg::NewActionTypes::Quit, osg::ChildrenList::setParentNode(), setState(), osg::NewActionBase::statNodesEnter, osg::NewActionBase::statNodesLeave, and statStateRestores.

Referenced by apply().

{
    ResultE              result          = NewActionTypes::Continue;
    Int32                nodePass;        // pass over current node
    UInt32               multiPasses;     // requested passes over current node
    NodePtr              pNode;
    StateRefCountStoreIt itStateRefCount;

    while((_nodeStack.empty() == false) && !(result & NewActionTypes::Quit))
    {
        pNode           = _nodeStack.back().getNode         ();
        nodePass        = _nodeStack.back().getPassCount    ();
        itStateRefCount = _nodeStack.back().getStateRefCount();

        if(itStateRefCount != _itActiveState)
        {
#ifdef OSG_NEWACTION_STATISTICS
            getStatistics()->getElem(statStateRestores)->inc();
#endif /* OSG_NEWACTION_STATISTICS */

            setState(itStateRefCount);

            // gained refs: active
            incRefCount(itStateRefCount);

            // lost refs: active
            decRefCount(_itActiveState);

            _itActiveState = itStateRefCount;
        }

        getChildrenList().setParentNode(pNode);

        if(nodePass > 0)
        {
            // positive pass -> enter node
            
#ifdef OSG_NEWACTION_STATISTICS
            getStatistics()->getElem(statNodesEnter)->inc();
#endif /* OSG_NEWACTION_STATISTICS */
            
            _stateClonedFlag = false;

            result      = enterNode   (pNode, static_cast<UInt32>(nodePass - 1));
            multiPasses = getNumPasses(                                        );

            // only initial pass (nodePass == 1) can request multiPass.
            if((nodePass == 1) && (multiPasses > 1))
            {
                // remove current node from stack
                _nodeStack.pop_back();
                
                for(; multiPasses > 1; -- multiPasses)
                {
                    // gained refs: addtional passs
                    incRefCount(_itActiveState);
                    
                    _nodeStack.push_back(
                        NodeStackEntry(pNode, _itActiveState, multiPasses));
                }
                
                // readd current node - with negative pass -> leave
                _nodeStack.push_back(
                    NodeStackEntry(pNode, _itActiveState, -nodePass));
            }
            else
            {
                // change current node passCount to negative -> leave
                _nodeStack.back().setPassCount(-nodePass);
            }
            
            pushChildren(pNode, result);
        }
        else
        {
            // negative pass -> leave node

#ifdef OSG_NEWACTION_STATISTICS
            getStatistics()->getElem(statNodesLeave)->inc();
#endif /* OSG_NEWACTION_STATISTICS */
            
            _stateClonedFlag = true;

            result = leaveNode(pNode, static_cast<UInt32>(-nodePass - 1));

            _nodeStack.pop_back();

            // lost refs: current node
            decRefCount(_itActiveState);
        }
    }

    return result;
}

void DepthFirstStateAction::pushChildren	(	const NodePtr &	pNode,
		ResultE	result
	)			[private]

Definition at line 524 of file OSGDepthFirstStateAction.cpp.

References _itActiveState, _nodeStack, osg::NewActionTypes::Break, osg::ExtraChildrenList::clear(), osg::ExtraChildrenList::getActive(), osg::ChildrenList::getActive(), osg::ExtraChildrenList::getChild(), osg::ChildrenList::getChild(), osg::NewActionBase::getChildrenList(), osg::NewActionBase::getChildrenListEnabled(), osg::NewActionBase::getExtraChildrenList(), osg::ExtraChildrenList::getSize(), osg::ChildrenList::getSize(), osg::NewActionBase::getTravMask(), incRefCount(), NodeStackEntry, osg::NullFC, osg::NewActionTypes::Quit, osg::NewActionBase::setChildrenListEnabled(), osg::NewActionBase::setNumPasses(), and osg::NewActionTypes::Skip.

Referenced by traverseEnter(), and traverseEnterLeave().

{
    if(result & (NewActionTypes::Skip  |
                 NewActionTypes::Break |
                 NewActionTypes::Quit   ))
    {
        setChildrenListEnabled(false);
        setNumPasses          (1    );

        getExtraChildrenList().clear();

        return;
    }

    ChildrenList      &cl  = getChildrenList     ();
    ExtraChildrenList &ecl = getExtraChildrenList();

    if(getChildrenListEnabled() == true)
    {
        for(UInt32 i = 0, size = cl.getSize(); i < size; ++i)
        {
            if(( cl.getActive(i)                                 == true  ) &&
               ( cl.getChild (i)                                 != NullFC) &&
               ((cl.getChild (i)->getTravMask() & getTravMask()) != 0     )   )
            {
                // gained refs: child
                incRefCount(_itActiveState);

                _nodeStack.push_back(
                    NodeStackEntry(cl.getChild(i), _itActiveState, 1));
            }
        }
    }
    else
    {
        MFNodePtr::const_iterator itChildren  = pNode->getMFChildren()->begin();
        MFNodePtr::const_iterator endChildren = pNode->getMFChildren()->end  ();

        for(; itChildren != endChildren; ++itChildren)
        {
            if((  *itChildren                                  != NullFC) &&
               (((*itChildren)->getTravMask() & getTravMask()) != 0     )   )
            {
                // gained refs: child
                incRefCount(_itActiveState);

                _nodeStack.push_back(
                    NodeStackEntry(*itChildren, _itActiveState, 1));
            }
        }
    }

    for(UInt32 i = 0, size = ecl.getSize(); i < size; ++i)
    {
        if(( ecl.getActive(i)                                 == true  ) &&
           ( ecl.getChild (i)                                 != NullFC) &&
           ((ecl.getChild (i)->getTravMask() & getTravMask()) != 0     )   )
        {
            // gained refs: extra child
            incRefCount(_itActiveState);

            _nodeStack.push_back(
                NodeStackEntry(ecl.getChild(i), _itActiveState, 1));
        }
    }

    setChildrenListEnabled(false);
    ecl.clear             (     );
    setNumPasses          (1    );
}

DepthFirstStateAction::ResultE osg::DepthFirstStateAction::enterNode	(	const NodePtr &	pNode,
		UInt32	pass
	)			[inline, private]

Calls the enterNode method of the attached actors.

Definition at line 52 of file OSGDepthFirstStateAction.inl.

References _basicEnterActors, _extendEnterActors, osg::NewActionTypes::Break, osg::NewActionTypes::Continue, osg::NewActionBase::endBasic(), osg::NewActionBase::endExtend(), osg::NewActionTypes::Quit, and osg::NewActionTypes::FunctorArgumentType::setActor().

Referenced by traverseEnter(), and traverseEnterLeave().

{
    FunctorArgumentType funcArg(NULL, pNode, pass);
    ResultE             result    = NewActionTypes::Continue;

    ExtendActorStoreIt  itExtend  = _extendEnterActors.begin();
    ExtendActorStoreIt  endExtend = _extendEnterActors.end  ();

    for(;  (itExtend != endExtend                                    )  &&
          !(result   &  (NewActionTypes::Break | NewActionTypes::Quit));
        ++itExtend                                                         )
    {
        funcArg.setActor(*itExtend);

        result = static_cast<ResultE>(result | (*itExtend)->enterNode(funcArg));
    }

    BasicActorStoreIt   itBasic   = _basicEnterActors.begin();
    BasicActorStoreIt   endBasic  = _basicEnterActors.end  ();

    for(;  (itBasic != endBasic                                     )  &&
          !(result  &  (NewActionTypes::Break | NewActionTypes::Quit));
        ++itBasic                                                        )
    {
        funcArg.setActor(*itBasic);

        result = static_cast<ResultE>(result | (*itBasic)->enterNode(funcArg));
    }

    return result;
}

DepthFirstStateAction::ResultE osg::DepthFirstStateAction::leaveNode	(	const NodePtr &	pNode,
		UInt32	pass
	)			[inline, private]

Calls the leaveNode method of the attached actors.

Definition at line 88 of file OSGDepthFirstStateAction.inl.

References _basicLeaveActors, _extendLeaveActors, osg::NewActionTypes::Break, osg::NewActionTypes::Continue, osg::NewActionBase::endBasic(), osg::NewActionBase::endExtend(), osg::NewActionTypes::Quit, and osg::NewActionTypes::FunctorArgumentType::setActor().

Referenced by traverseEnterLeave().

{
    FunctorArgumentType funcArg(NULL, pNode, pass);
    ResultE             result    = NewActionTypes::Continue;

    ExtendActorStoreIt  itExtend  = _extendLeaveActors.begin();
    ExtendActorStoreIt  endExtend = _extendLeaveActors.end  ();

    for(;  (itExtend != endExtend                                    )  &&
          !(result   &  (NewActionTypes::Break | NewActionTypes::Quit));
        ++itExtend                                                         )
    {
        funcArg.setActor(*itExtend);

        result = static_cast<ResultE>(result | (*itExtend)->leaveNode(funcArg));
    }

    BasicActorStoreIt  itBasic   = _basicLeaveActors.begin();
    BasicActorStoreIt  endBasic  = _basicLeaveActors.end  ();

    for(;  (itBasic != endBasic                                     )  &&
          !(result  &  (NewActionTypes::Break | NewActionTypes::Quit));
        ++itBasic                                                         )
    {
        funcArg.setActor(*itBasic);

        result = static_cast<ResultE>(result | (*itBasic)->leaveNode(funcArg));
    }

    return result;
}

DepthFirstStateAction::StateRefCountStoreIt osg::DepthFirstStateAction::cloneState

(

void

)

[inline, private]

Creates a copy of the state currently used by the attached actors.

Definition at line 367 of file OSGDepthFirstStateAction.inl.

References _stateRefCountStore, _stateStore, osg::NewActionBase::beginBasic(), osg::NewActionBase::beginExtend(), osg::NewActionBase::endBasic(), osg::NewActionBase::endExtend(), and StateRefCount.

Referenced by apply(), and beginEditStateEvent().

{
#ifdef OSG_NEWACTION_STATESLOTINTERFACE

    UInt32               stateSlot;
    StateRefCountStoreIt itStateRefCount = --(_stateRefCountStore.end());

    ExtendActorStoreIt   itExtend        =    beginExtend();
    ExtendActorStoreIt   endItExtend     =    endExtend  ();

    for(; itExtend != endItExtend; ++itExtend)
    {
        stateSlot = (*itExtend)->createStateClone();
    }

    BasicActorStoreIt itBasic    = beginBasic();
    BasicActorStoreIt endItBasic = endBasic  ();

    for(; itBasic != endItBasic; ++itBasic)
    {
        stateSlot = (*itBasic)->createStateClone();
    }

    _stateRefCountStore.push_back(StateRefCount(stateSlot));

    return ++itStateRefCount;

#else  /* OSG_NEWACTION_STATESLOTINTERFACE */

    StateStoreIt         itState         = --(_stateStore        .end  ());
    StateRefCountStoreIt itStateRefCount = --(_stateRefCountStore.end  ());

    ExtendActorStoreIt   itExtend        =    beginExtend();
    ExtendActorStoreIt   endItExtend     =    endExtend  ();

    for(; itExtend != endItExtend; ++itExtend)
    {
        _stateStore.push_back((*itExtend)->createStateClone());
    }

    BasicActorStoreIt itBasic    = beginBasic();
    BasicActorStoreIt endItBasic = endBasic  ();

    for(; itBasic != endItBasic; ++itBasic)
    {
        _stateStore.push_back((*itBasic)->createStateClone());
    }

    _stateRefCountStore.push_back(StateRefCount(++itState));

    return ++itStateRefCount;

#endif /* OSG_NEWACTION_STATESLOTINTERFACE */
}

DepthFirstStateAction::StateRefCountStoreIt osg::DepthFirstStateAction::getState

(

void

)

[inline, private]

Stores the state currently used by the attached actors.

Definition at line 426 of file OSGDepthFirstStateAction.inl.

References _stateRefCountStore, _stateStore, osg::NewActionBase::beginBasic(), osg::NewActionBase::beginExtend(), osg::NewActionBase::endBasic(), osg::NewActionBase::endExtend(), and StateRefCount.

Referenced by apply().

{
#ifdef OSG_NEWACTION_STATESLOTINTERFACE

    UInt32               stateSlot;
    StateRefCountStoreIt itStateRefCount = --(_stateRefCountStore.end  ());

    ExtendActorStoreIt   itExtend        =    beginExtend();
    ExtendActorStoreIt   endItExtend     =    endExtend  ();

    for(; itExtend != endItExtend; ++itExtend)
    {
        stateSlot = (*itExtend)->getSlotMap().size();

        (*itExtend)->getSlotMap().push_back((*itExtend)->getState());
    }

    BasicActorStoreIt itBasic    = beginBasic();
    BasicActorStoreIt endItBasic = endBasic  ();

    for(; itBasic != endItBasic; ++itBasic)
    {
        stateSlot = (*itExtend)->getSlotMap().size();

        (*itExtend)->getSlotMap().push_back((*itExtend)->getState());
    }

    _stateRefCountStore.push_back(StateRefCount(stateSlot));

    return ++itStateRefCount;

#else  /* OSG_NEWACTION_STATESLOTINTERFACE */

    StateStoreIt         itState         = --(_stateStore        .end  ());
    StateRefCountStoreIt itStateRefCount = --(_stateRefCountStore.end  ());

    ExtendActorStoreIt   itExtend        =    beginExtend();
    ExtendActorStoreIt   endItExtend     =    endExtend  ();

    for(; itExtend != endItExtend; ++itExtend)
    {
        _stateStore.push_back((*itExtend)->getState());
    }

    BasicActorStoreIt itBasic    = beginBasic();
    BasicActorStoreIt endItBasic = endBasic  ();

    for(; itBasic != endItBasic; ++itBasic)
    {
        _stateStore.push_back((*itBasic)->getState());
    }

    _stateRefCountStore.push_back(StateRefCount(++itState));

    return ++itStateRefCount;

#endif /* OSG_NEWACTION_STATESLOTINTERFACE */
}

void osg::DepthFirstStateAction::setState

(

StateRefCountStoreIt

itStateRefCount

)

[inline, private]

Sets the state to use for the attached actors.

Definition at line 489 of file OSGDepthFirstStateAction.inl.

References osg::NewActionBase::beginBasic(), osg::NewActionBase::beginExtend(), osg::NewActionBase::endBasic(), and osg::NewActionBase::endExtend().

Referenced by apply(), traverseEnter(), and traverseEnterLeave().

{
#ifdef OSG_NEWACTION_STATESLOTINTERFACE

    UInt32             stateSlot   = itStateRefCount->getStateSlot();

    ExtendActorStoreIt   itExtend        =    beginExtend();
    ExtendActorStoreIt   endItExtend     =    endExtend  ();

    for(; itExtend != endItExtend; ++itExtend, ++itState)
    {
        (*itExtend)->setState((*itExtend)->getSlotMap()[stateSlot]);
    }

    BasicActorStoreIt itBasic    = beginBasic();
    BasicActorStoreIt endItBasic = endBasic  ();

    for(; itBasic != endItBasic; ++itBasic, ++itState)
    {
        (*itBasic)->setState((*itBasic)->getSlotMap()[stateSlot]);
    }

#else  /* OSG_NEWACTION_STATESLOTINTERFACE */

    StateStoreIt       itState     = itStateRefCount->getState();

    ExtendActorStoreIt itExtend    = beginExtend();
    ExtendActorStoreIt endItExtend = endExtend  ();

    for(; itExtend != endItExtend; ++itExtend, ++itState)
    {
        (*itExtend)->setState(*itState);
    }

    BasicActorStoreIt itBasic    = beginBasic();
    BasicActorStoreIt endItBasic = endBasic  ();

    for(; itBasic != endItBasic; ++itBasic, ++itState)
    {
        (*itBasic)->setState(*itState);
    }

#endif /* OSG_NEWACTION_STATESLOTINTERFACE */
}

void osg::DepthFirstStateAction::incRefCount	(	StateRefCountStoreIt	itStateRefCount,
		Int32	inc = 1
	)			[inline, private]

Increment the ref count by inc.

Definition at line 538 of file OSGDepthFirstStateAction.inl.

Referenced by apply(), beginEditStateEvent(), pushChildren(), traverseEnter(), and traverseEnterLeave().

{
    itStateRefCount->incRefCount(inc);
}

void osg::DepthFirstStateAction::decRefCount	(	StateRefCountStoreIt	itStateRefCount,
		Int32	dec = 1
	)			[inline, private]

Decrement the ref count by dec. If it reaches 0 the state is delete.

Definition at line 547 of file OSGDepthFirstStateAction.inl.

References _stateRefCountStore, _stateStore, osg::NewActionBase::beginBasic(), osg::NewActionBase::beginExtend(), osg::NewActionBase::endBasic(), and osg::NewActionBase::endExtend().

Referenced by apply(), beginEditStateEvent(), traverseEnter(), and traverseEnterLeave().

{
#ifdef OSG_NEWACTION_STATESLOTINTERFACE

    itStateRefCount->decRefCount(dec);

    if(itStateRefCount->getRefCount() <= 0)
    {
        UInt32             stateSlot   = itStateRefCount->getStateSlot();

        ExtendActorStoreIt itExtend    = beginExtend();
        ExtendActorStoreIt endItExtend = endExtend  ();

        for(; itExtend != endExtend; ++itExtend)
        {
            delete (*itExtend)->getSlotMap()[stateSlot];

            //(*itExtend)->destroyStateClone(stateSlot);
        }

        BasicActorStoreIt itBasic    = beginBasic();
        BasicActorStoreIt endItBasic = endBasic  ();

        for(; itBasic != endBasic; ++itBasic)
        {
            delete (*itBasic)->getSlotMap()[stateSlot];

            //(*itBasic)->destroyStateClone(stateSlot);
        }

        _stateRefCountStore.erase(itStateRefCount);
    }

#else /* OSG_NEWACTION_STATESLOTINTERFACE */

    itStateRefCount->decRefCount(dec);

    if(itStateRefCount->getRefCount() <= 0)
    {
        StateStoreIt       itState     = itStateRefCount->getState();

        ExtendActorStoreIt itExtend    = beginExtend();
        ExtendActorStoreIt endItExtend = endExtend  ();

        for(; itExtend != endItExtend; ++itExtend)
        {
            delete *itState;

            //(*itExtend)->destroyStateClone(*itState);

            itState = _stateStore.erase(itState);
        }

        BasicActorStoreIt itBasic    = beginBasic();
        BasicActorStoreIt endItBasic = endBasic  ();

        for(; itBasic != endItBasic; ++itBasic)
        {
            delete *itState;

            //(*itBasic)->destroyStateClone(*itState);

            itState = _stateStore.erase(itState);
        }

        _stateRefCountStore.erase(itStateRefCount);
    }

#endif /* OSG_NEWACTION_STATESLOTINTERFACE */
}

const StatCollector* osg::NewActionBase::getStatistics

(

void

)

const [inline, inherited]

Referenced by osg::PriorityAction::beginEditStateEvent(), beginEditStateEvent(), osg::PriorityAction::startEvent(), osg::NewActionBase::startEvent(), startEvent(), osg::PriorityAction::traverseEnter(), traverseEnter(), osg::DepthFirstAction::traverseEnter(), traverseEnterLeave(), and osg::DepthFirstAction::traverseEnterLeave().

StatCollector* osg::NewActionBase::getStatistics

(

void

)

[inline, inherited]

void osg::NewActionBase::setStatistics

(

StatCollector *

pStatistics

)

[inline, inherited]

UInt32 NewActionBase::addActor

(

ActorBase *

pActor

)

[inherited]

Add an actor to this action, it will be appended to the list of extend or basic actors. Returns the index at which the actor was added.

Warning:

Actions assume exclusive ownership of an actor, you can not add an actor to two actions at the same time.

Dev: The ActorBase class has three "visitor pattern" style methods, that will call the appropriate method of the action, e.g. assume pActor is actually derived from ExtendActorBase, then its addHelper method will call the addExtendActor method of the action passed as parameter.

Definition at line 144 of file OSGNewActionBase.cpp.

References osg::ActorBase::addHelper().

{
    return pActor->addHelper(this);
}

void NewActionBase::subActor

(

ActorBase *

pActor

)

[inherited]

Remove an actor from this action. The actor may now be attached to another action.

Dev: See NewActionBase::addActor(ActorBase *pActor) for an explanation of the mechanism used to discover the type of pActor.

Definition at line 159 of file OSGNewActionBase.cpp.

References osg::ActorBase::subHelper().

{
    pActor->subHelper(this);
}

UInt32 NewActionBase::findActor

(

ActorBase *

pActor

)

const [inherited]

Return the index of an actor or TypeTraits<UInt32>::getMax() if the actor can not be found. Note that two actors may have the same index, if one is derived from ExtendActorBase and the other from BasicActorBase.

Dev: See NewActionBase::addActor(ActorBase *pActor) for an explanation of the mechanism used to discover the type of pActor.

I'm not sure if this is a useful thing to have ?? -carsten

Definition at line 177 of file OSGNewActionBase.cpp.

References osg::ActorBase::findHelper().

{
    return pActor->findHelper(this);
}

UInt32 NewActionBase::getNumActors

(

void

)

const [inherited]

Return the total number of actors attached to this action.

Definition at line 186 of file OSGNewActionBase.cpp.

References osg::NewActionBase::_basicActors, and osg::NewActionBase::_extendActors.

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

{
    return _extendActors.size() + _basicActors.size();
}

UInt32 NewActionBase::addExtendActor

(

ExtendActorBase *

pActor

)

[inherited]

Add an extend actor to this action. Returns the index at which the actor was added.

Warning:

Actions assume exclusive ownership of an actor, you can not add an actor to two actions at the same time.

Definition at line 202 of file OSGNewActionBase.cpp.

References osg::NewActionBase::_extendActors.

Referenced by osg::ExtendActorBase::addHelper().

{
    return addExtendActor(pActor, _extendActors.size());
}

UInt32 NewActionBase::addExtendActor	(	ExtendActorBase *	pActor,
		UInt32	pos
	)			[inherited]

Add an extend actor to this action before the index pos. Returns the index at which the actor was added, i.e. this should be pos.

Warning:

Actions assume exclusive ownership of an actor, you can not add an actor to two actions at the same time.

Definition at line 214 of file OSGNewActionBase.cpp.

References osg::NewActionBase::_extendActors, osg::ActorBase::addEvent(), and osg::NewActionBase::getNumActors().

{
    UInt32 actorId = getNumActors();

    pActor       ->addEvent      (this,                        actorId);
    _extendActors. insert        (_extendActors.begin() + pos, pActor );
    this         ->addExtendEvent(pActor,                      pos    );

    return pos;
}

void NewActionBase::subExtendActor

(

UInt32

pos

)

[inherited]

Remove the extend actor at index pos. The actor may now be attached to another action.

Definition at line 230 of file OSGNewActionBase.cpp.

References osg::NewActionBase::_extendActors, osg::ActorBase::getActorId(), and osg::ActorBase::subEvent().

Referenced by osg::ExtendActorBase::subHelper().

{
    ExtendActorStoreIt  itActor = _extendActors.begin() + pos;
    ExtendActorBase    *pActor  = *itActor;

    this  ->subExtendEvent(pActor, pos                 );
    pActor->subEvent      (this,   pActor->getActorId());

    _extendActors.erase(itActor);
}

UInt32 NewActionBase::findExtendActor

(

ExtendActorBase *

pActor

)

const [inherited]

Return the index of the extend actor or TypeTraits<UInt32>::getMax() if the actor is not found. The return value may be used as the pos argument to the addExtendActor and subExtendActor methods.

Definition at line 247 of file OSGNewActionBase.cpp.

References osg::NewActionBase::_extendActors.

Referenced by osg::ExtendActorBase::findHelper(), and osg::ExtendActorBase::subHelper().

{
    ExtendActorStoreConstIt itActors  = _extendActors.begin();
    ExtendActorStoreConstIt endActors = _extendActors.end  ();

    UInt32             pos       = 0;
    bool               found     = false;

    for(; (itActors != endActors) && !found; ++itActors, ++pos)
    {
        if(*itActors == pActor)
        {
            found = true;
            break;
        }
    }

    return (found ? pos : TypeTraits<UInt32>::getMax());
}

UInt32 NewActionBase::getNumExtendActors

(

void

)

const [inherited]

Return the number of extend actors attached to the action.

Definition at line 271 of file OSGNewActionBase.cpp.

References osg::NewActionBase::_extendActors.

{
    return _extendActors.size();
}

UInt32 NewActionBase::addBasicActor

(

BasicActorBase *

pActor

)

[inherited]

Add an basic actor to this action. Returns the index at which the actor was added.

Warning:

Actions assume exclusive ownership of an actor, you can not add an actor to two actions at the same time.

Definition at line 287 of file OSGNewActionBase.cpp.

References osg::NewActionBase::_basicActors.

Referenced by osg::BasicActorBase::addHelper().

{
    return addBasicActor(pActor, _basicActors.size());
}

UInt32 NewActionBase::addBasicActor	(	BasicActorBase *	pActor,
		UInt32	pos
	)			[inherited]

Add an basic actor to this action before the index pos. Returns the index at which the actor was added, i.e. this should be pos.

Warning:

Actions assume exclusive ownership of an actor, you can not add an actor to two actions at the same time.

Definition at line 299 of file OSGNewActionBase.cpp.

References osg::NewActionBase::_basicActors, osg::ActorBase::addEvent(), and osg::NewActionBase::getNumActors().

{
    UInt32 actorId = getNumActors();

    pActor      ->addEvent     (this,                       actorId);
    _basicActors. insert       (_basicActors.begin() + pos, pActor );
    this        ->addBasicEvent(pActor,                     pos    );

    return pos;
}

void NewActionBase::subBasicActor

(

UInt32

pos

)

[inherited]

Remove the basic actor at index pos. The actor may now be attached to another action.

Definition at line 315 of file OSGNewActionBase.cpp.

References osg::NewActionBase::_basicActors, osg::ActorBase::getActorId(), and osg::ActorBase::subEvent().

Referenced by osg::BasicActorBase::subHelper().

{
    BasicActorStoreIt  itActor = _basicActors.begin() + pos;
    BasicActorBase    *pActor  = *itActor;

    this  ->subBasicEvent(pActor, pos                 );
    pActor->subEvent     (this,   pActor->getActorId());

    _basicActors.erase(itActor);
}

UInt32 NewActionBase::findBasicActor

(

BasicActorBase *

pActor

)

const [inherited]

Return the index of the basic actor or TypeTraits<UInt32>::getMax() if the actor is not found. The return value may be used as the pos argument to the addBasicActor and subBasicActor methods.

Definition at line 332 of file OSGNewActionBase.cpp.

References osg::NewActionBase::_basicActors.

Referenced by osg::BasicActorBase::findHelper(), and osg::BasicActorBase::subHelper().

{
    BasicActorStoreConstIt itActors  = _basicActors.begin();
    BasicActorStoreConstIt endActors = _basicActors.end  ();

    UInt32            pos       = 0;
    bool              found     = false;

    for(; (itActors != endActors) && !found; ++itActors, ++pos)
    {
        if(*itActors == pActor)
        {
            found = true;
            break;
        }
    }

    return (found ? pos : TypeTraits<UInt32>::getMax());
}

UInt32 NewActionBase::getNumBasicActors

(

void

)

const [inherited]

Return the number of basic actors attached to the action.

Definition at line 356 of file OSGNewActionBase.cpp.

References osg::NewActionBase::_basicActors.

{
    return _basicActors.size();
}

UInt32 osg::NewActionBase::getTravMask

(

void

)

const [inline, inherited]

Return the traversal mask of this action. The action will only traverse a node if the bitwise AND of its traversal mask with the actions is nonzero.

Definition at line 76 of file OSGNewActionBase.inl.

References osg::NewActionBase::_travMask.

Referenced by osg::PriorityAction::enqueueChildren(), pushChildren(), and osg::DepthFirstAction::pushChildren().

{
    return _travMask;
}

void osg::NewActionBase::setTravMask

(

UInt32

travMask

)

[inline, inherited]

Set the actions traversal maks. The action will only traverse a node if the bitwise AND of its traversal mask with the actions is nonzero.

Definition at line 86 of file OSGNewActionBase.inl.

References osg::NewActionBase::_travMask.

{
    _travMask = travMask;
}

bool osg::NewActionBase::getChildrenListEnabled

(

void

)

const [inline, protected, inherited]

Return if the children list is enabled.

Definition at line 99 of file OSGNewActionBase.inl.

References osg::NewActionBase::_childrenListEnabled.

Referenced by osg::PriorityAction::enqueueChildren(), osg::ActorBase::getChildrenListEnabled(), pushChildren(), and osg::DepthFirstAction::pushChildren().

{
    return _childrenListEnabled;
}

void osg::NewActionBase::setChildrenListEnabled

(

bool

enabled

)

[inline, protected, inherited]

Enable or disable the children list.

Ext: Actors should avoid enabling the children list without need as it has a negative impact on performance, e.g. if you do not want to traverse any children it is far more effective to return NewActionTypes::Skip instead of enabling the children list and setting all children inactive.

Definition at line 115 of file OSGNewActionBase.inl.

References osg::NewActionBase::_childrenList, osg::NewActionBase::_childrenListEnabled, and osg::ChildrenList::reset().

Referenced by osg::PriorityAction::enqueueChildren(), pushChildren(), osg::DepthFirstAction::pushChildren(), and osg::ActorBase::setChildrenListEnabled().

{
    if((enabled == true) && (_childrenListEnabled == false))
    {
        _childrenList.reset();
    }

    _childrenListEnabled = enabled;
}

const ChildrenList & osg::NewActionBase::getChildrenList

(

void

)

const [inline, protected, inherited]

Return a const reference to the children list.

Ext: ExtendActorBase and BasicActorBase have convenience functions for children management, use them instead of manipulating the list directly.

Definition at line 134 of file OSGNewActionBase.inl.

References osg::NewActionBase::_childrenList.

Referenced by osg::PriorityAction::enqueueChildren(), osg::ActorBase::getChild(), osg::ActorBase::getChildActive(), osg::ActorBase::getChildPriority(), osg::ActorBase::getNode(), osg::ActorBase::getNumChildren(), pushChildren(), osg::DepthFirstAction::pushChildren(), osg::ActorBase::setChildActive(), osg::ActorBase::setChildPriority(), osg::PriorityAction::traverseEnter(), traverseEnter(), osg::DepthFirstAction::traverseEnter(), traverseEnterLeave(), and osg::DepthFirstAction::traverseEnterLeave().

{
    return _childrenList;
}

ChildrenList & osg::NewActionBase::getChildrenList

(

void

)

[inline, protected, inherited]

Return a reference to the children list.

Ext: ExtendActorBase and BasicActorBase have convenience functions for children management, use them instead of manipulating the list directly.

Definition at line 148 of file OSGNewActionBase.inl.

References osg::NewActionBase::_childrenList.

{
    return _childrenList;
}

const ExtraChildrenList & osg::NewActionBase::getExtraChildrenList

(

void

)

const [inline, protected, inherited]

Return a const reference to the extra children list.

Ext: ExtendActorBase and BasicActorBase have convenience functions for extra children management, use them instead of manipulating the list directly.

Definition at line 162 of file OSGNewActionBase.inl.

References osg::NewActionBase::_extraChildrenList.

Referenced by osg::ExtendActorBase::addExtraChild(), osg::PriorityAction::enqueueChildren(), osg::ActorBase::getExtraChild(), osg::ActorBase::getExtraChildActive(), osg::ActorBase::getExtraChildPriority(), osg::ActorBase::getNumExtraChildren(), pushChildren(), osg::DepthFirstAction::pushChildren(), osg::ActorBase::setExtraChildActive(), and osg::ActorBase::setExtraChildPriority().

{
    return _extraChildrenList;
}

ExtraChildrenList & osg::NewActionBase::getExtraChildrenList

(

void

)

[inline, protected, inherited]

Return a reference to the children list.

Ext: ExtendActorBase and BasicActorBase have convenience functions for extra children management, use them instead of manipulating the list directly.

Definition at line 176 of file OSGNewActionBase.inl.

References osg::NewActionBase::_extraChildrenList.

{
    return _extraChildrenList;
}

UInt32 osg::NewActionBase::getNumPasses

(

void

)

const [inline, protected, inherited]

Definition at line 186 of file OSGNewActionBase.inl.

References osg::NewActionBase::_numPasses.

Referenced by osg::ActorBase::getNumPasses(), osg::PriorityAction::traverseEnter(), traverseEnter(), osg::DepthFirstAction::traverseEnter(), traverseEnterLeave(), and osg::DepthFirstAction::traverseEnterLeave().

{
    return _numPasses;
}

void osg::NewActionBase::setNumPasses

(

UInt32

numPasses

)

[inline, protected, inherited]

Definition at line 192 of file OSGNewActionBase.inl.

References osg::NewActionBase::_numPasses.

Referenced by osg::PriorityAction::enqueueChildren(), pushChildren(), osg::DepthFirstAction::pushChildren(), and osg::ExtendActorBase::setNumPasses().

{
    _numPasses = numPasses;
}

NewActionBase::ExtendActorStoreConstIt osg::NewActionBase::beginExtend

(

void

)

const [inline, protected, inherited]

Return a const iterator to the beginning of the extend actors.

Definition at line 205 of file OSGNewActionBase.inl.

References osg::NewActionBase::_extendActors.

Referenced by osg::PriorityAction::addExtendEvent(), addExtendEvent(), osg::DepthFirstAction::addExtendEvent(), cloneState(), decRefCount(), getState(), setState(), osg::NewActionBase::startActors(), and osg::NewActionBase::stopActors().

{
    return _extendActors.begin();
}

NewActionBase::ExtendActorStoreIt osg::NewActionBase::beginExtend

(

void

)

[inline, protected, inherited]

Return an iterator to the beginning of the extend actors.

Definition at line 214 of file OSGNewActionBase.inl.

References osg::NewActionBase::_extendActors.

{
    return _extendActors.begin();
}

NewActionBase::ExtendActorStoreConstIt osg::NewActionBase::endExtend

(

void

)

const [inline, protected, inherited]

Return a const iterator to the end of the extend actors.

Definition at line 223 of file OSGNewActionBase.inl.

References osg::NewActionBase::_extendActors.

Referenced by osg::PriorityAction::cloneState(), cloneState(), osg::PriorityAction::decRefCount(), decRefCount(), enterNode(), osg::DepthFirstAction::enterNode(), getState(), leaveNode(), osg::DepthFirstAction::leaveNode(), osg::PriorityAction::setState(), setState(), osg::NewActionBase::startActors(), and osg::NewActionBase::stopActors().

{
    return _extendActors.end();
}

NewActionBase::ExtendActorStoreIt osg::NewActionBase::endExtend

(

void

)

[inline, protected, inherited]

Return an iterator to the end of the extend actors.

Definition at line 232 of file OSGNewActionBase.inl.

References osg::NewActionBase::_extendActors.

{
    return _extendActors.end();
}

NewActionBase::BasicActorStoreConstIt osg::NewActionBase::beginBasic

(

void

)

const [inline, protected, inherited]

Return a const iterator to the beginning of the basic actors.

Definition at line 241 of file OSGNewActionBase.inl.

References osg::NewActionBase::_basicActors.

Referenced by osg::PriorityAction::addBasicEvent(), addBasicEvent(), osg::DepthFirstAction::addBasicEvent(), cloneState(), decRefCount(), osg::PriorityAction::enterNode(), getState(), setState(), osg::NewActionBase::startActors(), and osg::NewActionBase::stopActors().

{
    return _basicActors.begin();
}

NewActionBase::BasicActorStoreIt osg::NewActionBase::beginBasic

(

void

)

[inline, protected, inherited]

Return an iterator to the beginning of the basic actors.

Definition at line 250 of file OSGNewActionBase.inl.

References osg::NewActionBase::_basicActors.

{
    return _basicActors.begin();
}

NewActionBase::BasicActorStoreConstIt osg::NewActionBase::endBasic

(

void

)

const [inline, protected, inherited]

Return a const iterator to the end of the basic actors.

Definition at line 259 of file OSGNewActionBase.inl.

References osg::NewActionBase::_basicActors.

Referenced by osg::PriorityAction::cloneState(), cloneState(), osg::PriorityAction::decRefCount(), decRefCount(), osg::PriorityAction::enterNode(), enterNode(), osg::DepthFirstAction::enterNode(), getState(), leaveNode(), osg::DepthFirstAction::leaveNode(), setState(), osg::NewActionBase::startActors(), and osg::NewActionBase::stopActors().

{
    return _basicActors.end();
}

NewActionBase::BasicActorStoreIt osg::NewActionBase::endBasic

(

void

)

[inline, protected, inherited]

Return an iterator to the end of the basic actors.

Definition at line 268 of file OSGNewActionBase.inl.

References osg::NewActionBase::_basicActors.

{
    return _basicActors.end();
}

NewActionBase::ResultE NewActionBase::startActors

(

void

)

[protected, inherited]

Return a const iterator to the beginning of the extend actors.

Definition at line 428 of file OSGNewActionBase.cpp.

References osg::NewActionBase::beginBasic(), osg::NewActionBase::beginExtend(), osg::NewActionTypes::Continue, osg::NewActionBase::endBasic(), osg::NewActionBase::endExtend(), and osg::NewActionTypes::Quit.

Referenced by osg::PriorityAction::apply(), apply(), and osg::DepthFirstAction::apply().

{
    ResultE            result      = NewActionTypes::Continue;

    ExtendActorStoreIt itExtend    = beginExtend();
    ExtendActorStoreIt endItExtend = endExtend  ();

    for(; (itExtend != endItExtend         ) &&
         !(result   &  NewActionTypes::Quit);    ++itExtend)
    {
        result = (*itExtend)->start();
    }

    BasicActorStoreIt itBasic    = beginBasic();
    BasicActorStoreIt endItBasic = endBasic  ();

    for(;  (itBasic != endItBasic          ) &&
          !(result  &  NewActionTypes::Quit);    ++itBasic)
    {
        result = (*itBasic)->start();
    }

    return result;
}

NewActionBase::ResultE NewActionBase::stopActors

(

void

)

[protected, inherited]

Return a const iterator to the beginning of the extend actors.

Definition at line 454 of file OSGNewActionBase.cpp.

References osg::NewActionBase::beginBasic(), osg::NewActionBase::beginExtend(), osg::NewActionTypes::Continue, osg::NewActionBase::endBasic(), osg::NewActionBase::endExtend(), and osg::NewActionTypes::Quit.

Referenced by osg::PriorityAction::apply(), apply(), and osg::DepthFirstAction::apply().

{
    ResultE            result      = NewActionTypes::Continue;

    ExtendActorStoreIt itExtend    = beginExtend();
    ExtendActorStoreIt endItExtend = endExtend  ();

    for(; (itExtend != endItExtend         ) &&
         !(result   &  NewActionTypes::Quit);    ++itExtend)
    {
        result = (*itExtend)->stop();
    }

    BasicActorStoreIt itBasic    = beginBasic();
    BasicActorStoreIt endItBasic = endBasic  ();

    for(;  (itBasic != endItBasic          ) &&
          !(result  &  NewActionTypes::Quit);    ++itBasic)
    {
        result = (*itBasic)->stop();
    }

    return result;
}

---

Friends And Related Function Documentation

friend class StateRefCount [friend]

Definition at line 169 of file OSGDepthFirstStateAction.h.

Referenced by cloneState(), and getState().

friend class NodeStackEntry [friend]

Definition at line 171 of file OSGDepthFirstStateAction.h.

Referenced by apply(), pushChildren(), traverseEnter(), and traverseEnterLeave().

friend class osg::ActorBase [friend, inherited]

Definition at line 168 of file OSGNewActionBase.h.

friend class osg::ExtendActorBase [friend, inherited]

Definition at line 169 of file OSGNewActionBase.h.

friend class osg::BasicActorBase [friend, inherited]

Definition at line 170 of file OSGNewActionBase.h.

---

Member Data Documentation

StatElemDesc< StatIntElem > DepthFirstStateAction::statStateClones [static]

Definition at line 72 of file OSGDepthFirstStateAction.h.

Referenced by beginEditStateEvent(), and startEvent().

StatElemDesc< StatIntElem > DepthFirstStateAction::statStateRestores [static]

Definition at line 73 of file OSGDepthFirstStateAction.h.

Referenced by startEvent(), traverseEnter(), and traverseEnterLeave().

NodeStack osg::DepthFirstStateAction::_nodeStack [private]

Definition at line 248 of file OSGDepthFirstStateAction.h.

Referenced by apply(), beginEditStateEvent(), pushChildren(), traverseEnter(), and traverseEnterLeave().

StateRefCountStore osg::DepthFirstStateAction::_stateRefCountStore [private]

Definition at line 249 of file OSGDepthFirstStateAction.h.

Referenced by apply(), cloneState(), decRefCount(), and getState().

StateStore osg::DepthFirstStateAction::_stateStore [private]

Definition at line 252 of file OSGDepthFirstStateAction.h.

Referenced by apply(), cloneState(), decRefCount(), and getState().

StateRefCountStoreIt osg::DepthFirstStateAction::_itInitialState [private]

Definition at line 255 of file OSGDepthFirstStateAction.h.

Referenced by apply().

StateRefCountStoreIt osg::DepthFirstStateAction::_itActiveState [private]

Definition at line 256 of file OSGDepthFirstStateAction.h.

Referenced by apply(), beginEditStateEvent(), pushChildren(), traverseEnter(), and traverseEnterLeave().

bool osg::DepthFirstStateAction::_stateClonedFlag [private]

Definition at line 258 of file OSGDepthFirstStateAction.h.

Referenced by apply(), beginEditStateEvent(), traverseEnter(), and traverseEnterLeave().

ExtendActorStore osg::DepthFirstStateAction::_extendEnterActors [private]

Definition at line 260 of file OSGDepthFirstStateAction.h.

Referenced by addExtendEvent(), enterNode(), and subExtendEvent().

ExtendActorStore osg::DepthFirstStateAction::_extendLeaveActors [private]

Definition at line 261 of file OSGDepthFirstStateAction.h.

Referenced by addExtendEvent(), apply(), leaveNode(), and subExtendEvent().

BasicActorStore osg::DepthFirstStateAction::_basicEnterActors [private]

Definition at line 263 of file OSGDepthFirstStateAction.h.

Referenced by addBasicEvent(), enterNode(), and subBasicEvent().

BasicActorStore osg::DepthFirstStateAction::_basicLeaveActors [private]

Definition at line 264 of file OSGDepthFirstStateAction.h.

Referenced by addBasicEvent(), apply(), leaveNode(), and subBasicEvent().

StatElemDesc< StatIntElem > NewActionBase::statNodesEnter [static, inherited]

Definition at line 83 of file OSGNewActionBase.h.

Referenced by osg::NewActionBase::startEvent(), osg::PriorityAction::traverseEnter(), traverseEnter(), osg::DepthFirstAction::traverseEnter(), traverseEnterLeave(), and osg::DepthFirstAction::traverseEnterLeave().

StatElemDesc< StatIntElem > NewActionBase::statNodesLeave [static, inherited]

Definition at line 84 of file OSGNewActionBase.h.

Referenced by osg::NewActionBase::startEvent(), traverseEnterLeave(), and osg::DepthFirstAction::traverseEnterLeave().

---

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

• OSGDepthFirstStateAction.h
• OSGDepthFirstStateAction.cpp
• OSGDepthFirstStateAction.inl