openscenegraph
Public Types | Public Member Functions | Protected Member Functions | Protected Attributes | List of all members
osgSim::MultiSwitch Class Reference

#include <MultiSwitch>

Inheritance diagram for osgSim::MultiSwitch:
osg::Group osg::Node osg::Object osg::Referenced

Public Types

typedef std::vector< bool > ValueList
 
typedef std::vector< ValueListSwitchSetList
 
typedef std::vector< std::string > SwitchSetNameList
 
- Public Types inherited from osg::Node
typedef std::vector< Group * > ParentList
 
typedef unsigned int NodeMask
 
typedef std::vector< std::string > DescriptionList
 
- Public Types inherited from osg::Object
enum  DataVariance { DYNAMIC , STATIC , UNSPECIFIED }
 

Public Member Functions

 MultiSwitch ()
 
 MultiSwitch (const MultiSwitch &, const osg::CopyOp &copyop=osg::CopyOp::SHALLOW_COPY)
 
 META_Node (osgSim, MultiSwitch)
 
virtual void traverse (osg::NodeVisitor &nv)
 
void setNewChildDefaultValue (bool value)
 
bool getNewChildDefaultValue () const
 
virtual bool addChild (osg::Node *child)
 
virtual bool insertChild (unsigned int index, osg::Node *child)
 
virtual bool removeChild (osg::Node *child)
 
void setValue (unsigned int switchSet, unsigned int pos, bool value)
 
bool getValue (unsigned int switchSet, unsigned int pos) const
 
void setChildValue (const osg::Node *child, unsigned int switchSet, bool value)
 
bool getChildValue (const osg::Node *child, unsigned int switchSet) const
 
bool setAllChildrenOff (unsigned int switchSet)
 
bool setAllChildrenOn (unsigned int switchSet)
 
bool setSingleChildOn (unsigned int switchSet, unsigned int pos)
 
void setActiveSwitchSet (unsigned int switchSet)
 
unsigned int getActiveSwitchSet () const
 
void setSwitchSetList (const SwitchSetList &switchSetList)
 
const SwitchSetListgetSwitchSetList () const
 
void setValueList (unsigned int switchSet, const ValueList &values)
 
const ValueListgetValueList (unsigned int switchSet) const
 
void setValueName (unsigned int switchSet, const std::string &name)
 
const std::string & getValueName (unsigned int switchSet) const
 
- Public Member Functions inherited from osg::Group
 Group ()
 
 Group (const Group &, const CopyOp &copyop=CopyOp::SHALLOW_COPY)
 
 META_Node (osg, Group)
 
virtual GroupasGroup ()
 
virtual const GroupasGroup () const
 
template<class T >
bool addChild (const ref_ptr< T > &child)
 
template<class T >
bool insertChild (unsigned int index, const ref_ptr< T > &child)
 
template<class T >
bool removeChild (const ref_ptr< T > &child)
 
bool removeChild (unsigned int pos, unsigned int numChildrenToRemove=1)
 
virtual bool removeChildren (unsigned int pos, unsigned int numChildrenToRemove)
 
virtual bool replaceChild (Node *origChild, Node *newChild)
 
template<class T , class R >
bool replaceChild (const ref_ptr< T > &origChild, const ref_ptr< R > &newChild)
 
virtual unsigned int getNumChildren () const
 
virtual bool setChild (unsigned int i, Node *node)
 
NodegetChild (unsigned int i)
 
const NodegetChild (unsigned int i) const
 
bool containsNode (const Node *node) const
 
template<class T >
bool containsNode (const ref_ptr< T > &node) const
 
unsigned int getChildIndex (const Node *node) const
 
virtual void setThreadSafeRefUnref (bool threadSafe)
 
virtual void resizeGLObjectBuffers (unsigned int maxSize)
 
virtual void releaseGLObjects (osg::State *=0) const
 
virtual BoundingSphere computeBound () const
 
- Public Member Functions inherited from osg::Node
 Node ()
 
 Node (const Node &, const CopyOp &copyop=CopyOp::SHALLOW_COPY)
 
virtual ObjectcloneType () const
 
virtual Objectclone (const CopyOp &copyop) const
 
virtual bool isSameKindAs (const Object *obj) const
 
virtual const char * libraryName () const
 
virtual const char * className () const
 
virtual NodeasNode ()
 
virtual const NodeasNode () const
 
virtual DrawableasDrawable ()
 
virtual const DrawableasDrawable () const
 
virtual GeometryasGeometry ()
 
virtual const GeometryasGeometry () const
 
virtual TransformasTransform ()
 
virtual const TransformasTransform () const
 
virtual SwitchasSwitch ()
 
virtual const SwitchasSwitch () const
 
virtual GeodeasGeode ()
 
virtual const GeodeasGeode () const
 
virtual osgTerrain::TerrainasTerrain ()
 
virtual const osgTerrain::TerrainasTerrain () const
 
virtual void accept (NodeVisitor &nv)
 
virtual void ascend (NodeVisitor &nv)
 
const ParentListgetParents () const
 
ParentList getParents ()
 
GroupgetParent (unsigned int i)
 
const GroupgetParent (unsigned int i) const
 
unsigned int getNumParents () const
 
NodePathList getParentalNodePaths (osg::Node *haltTraversalAtNode=0) const
 
MatrixList getWorldMatrices (const osg::Node *haltTraversalAtNode=0) const
 
void setUpdateCallback (Callback *nc)
 
template<class T >
void setUpdateCallback (const ref_ptr< T > &nc)
 
CallbackgetUpdateCallback ()
 
const CallbackgetUpdateCallback () const
 
void addUpdateCallback (Callback *nc)
 
template<class T >
void addUpdateCallback (const ref_ptr< T > &nc)
 
void removeUpdateCallback (Callback *nc)
 
template<class T >
void removeUpdateCallback (const ref_ptr< T > &nc)
 
unsigned int getNumChildrenRequiringUpdateTraversal () const
 
void setEventCallback (Callback *nc)
 
template<class T >
void setEventCallback (const ref_ptr< T > &nc)
 
CallbackgetEventCallback ()
 
const CallbackgetEventCallback () const
 
void addEventCallback (Callback *nc)
 
template<class T >
void addEventCallback (const ref_ptr< T > &nc)
 
void removeEventCallback (Callback *nc)
 
template<class T >
void removeEventCallback (const ref_ptr< T > &nc)
 
unsigned int getNumChildrenRequiringEventTraversal () const
 
void setCullCallback (Callback *nc)
 
template<class T >
void setCullCallback (const ref_ptr< T > &nc)
 
CallbackgetCullCallback ()
 
const CallbackgetCullCallback () const
 
void addCullCallback (Callback *nc)
 
template<class T >
void addCullCallback (const ref_ptr< T > &nc)
 
void removeCullCallback (Callback *nc)
 
template<class T >
void removeCullCallback (const ref_ptr< T > &nc)
 
void setCullingActive (bool active)
 
bool getCullingActive () const
 
unsigned int getNumChildrenWithCullingDisabled () const
 
bool isCullingActive () const
 
unsigned int getNumChildrenWithOccluderNodes () const
 
bool containsOccluderNodes () const
 
void setNodeMask (NodeMask nm)
 
NodeMask getNodeMask () const
 
void setStateSet (osg::StateSet *stateset)
 
template<class T >
void setStateSet (const osg::ref_ptr< T > &stateset)
 
osg::StateSetgetOrCreateStateSet ()
 
osg::StateSetgetStateSet ()
 
const osg::StateSetgetStateSet () const
 
void setDescriptions (const DescriptionList &descriptions)
 
DescriptionListgetDescriptions ()
 
const DescriptionListgetDescriptions () const
 
const std::string & getDescription (unsigned int i) const
 
std::string & getDescription (unsigned int i)
 
unsigned int getNumDescriptions () const
 
void addDescription (const std::string &desc)
 
void setInitialBound (const osg::BoundingSphere &bsphere)
 
const BoundingSpheregetInitialBound () const
 
void dirtyBound ()
 
const BoundingSpheregetBound () const
 
void setComputeBoundingSphereCallback (ComputeBoundingSphereCallback *callback)
 
template<class T >
void setComputeBoundingSphereCallback (const ref_ptr< T > &callback)
 
ComputeBoundingSphereCallbackgetComputeBoundingSphereCallback ()
 
const ComputeBoundingSphereCallbackgetComputeBoundingSphereCallback () const
 
- Public Member Functions inherited from osg::Object
 Object ()
 
 Object (bool threadSafeRefUnref)
 
 Object (const Object &, const CopyOp &copyop=CopyOp::SHALLOW_COPY)
 
std::string getCompoundClassName () const
 
virtual NodeVisitorasNodeVisitor ()
 
virtual const NodeVisitorasNodeVisitor () const
 
virtual StateSetasStateSet ()
 
virtual const StateSetasStateSet () const
 
virtual StateAttributeasStateAttribute ()
 
virtual const StateAttributeasStateAttribute () const
 
virtual UniformasUniform ()
 
virtual const UniformasUniform () const
 
virtual CameraasCamera ()
 
virtual const CameraasCamera () const
 
virtual CallbackasCallback ()
 
virtual const CallbackasCallback () const
 
virtual CallbackObjectasCallbackObject ()
 
virtual const CallbackObjectasCallbackObject () const
 
virtual UserDataContainerasUserDataContainer ()
 
virtual const UserDataContainerasUserDataContainer () const
 
virtual ValueObjectasValueObject ()
 
virtual const ValueObjectasValueObject () const
 
virtual ImageasImage ()
 
virtual const ImageasImage () const
 
virtual void setName (const std::string &name)
 
void setName (const char *name)
 
const std::string & getName () const
 
void setDataVariance (DataVariance dv)
 
DataVariance getDataVariance () const
 
virtual void computeDataVariance ()
 
void setUserDataContainer (osg::UserDataContainer *udc)
 
template<class T >
void setUserDataContainer (const ref_ptr< T > &udc)
 
osg::UserDataContainergetUserDataContainer ()
 
const osg::UserDataContainergetUserDataContainer () const
 
osg::UserDataContainergetOrCreateUserDataContainer ()
 
virtual void setUserData (Referenced *obj)
 
template<class T >
void setUserData (const ref_ptr< T > &ud)
 
virtual ReferencedgetUserData ()
 
virtual const ReferencedgetUserData () const
 
template<typename T >
bool getUserValue (const std::string &name, T &value) const
 
template<typename T >
void setUserValue (const std::string &name, const T &value)
 
template<typename T >
BoolValueObject UCharValueObject UShortValueObject UIntValueObject DoubleValueObject Vec3fValueObject Vec2dValueObject Vec4dValueObject PlaneValueObject MatrixdValueObject BoundingBoxdValueObject BoundingSpheredValueObject bool getUserValue (const std::string &name, T &value) const
 
- Public Member Functions inherited from osg::Referenced
 Referenced ()
 
 Referenced (bool threadSafeRefUnref)
 
 Referenced (const Referenced &)
 
Referencedoperator= (const Referenced &)
 
bool getThreadSafeRefUnref () const
 
OpenThreads::MutexgetRefMutex () const
 
int ref () const
 
int unref () const
 
int unref_nodelete () const
 
int referenceCount () const
 
ObserverSetgetObserverSet () const
 
ObserverSetgetOrCreateObserverSet () const
 
void addObserver (Observer *observer) const
 
void removeObserver (Observer *observer) const
 

Protected Member Functions

virtual ~MultiSwitch ()
 
void expandToEncompassSwitchSet (unsigned int switchSet)
 
- Protected Member Functions inherited from osg::Group
virtual ~Group ()
 
virtual void childRemoved (unsigned int, unsigned int)
 
virtual void childInserted (unsigned int)
 
- Protected Member Functions inherited from osg::Node
virtual ~Node ()
 
void addParent (osg::Group *parent)
 
void removeParent (osg::Group *parent)
 
void setNumChildrenRequiringUpdateTraversal (unsigned int num)
 
void setNumChildrenRequiringEventTraversal (unsigned int num)
 
void setNumChildrenWithCullingDisabled (unsigned int num)
 
void setNumChildrenWithOccluderNodes (unsigned int num)
 
- Protected Member Functions inherited from osg::Object
virtual ~Object ()
 
- Protected Member Functions inherited from osg::Referenced
virtual ~Referenced ()
 
void signalObserversAndDelete (bool signalDelete, bool doDelete) const
 
void deleteUsingDeleteHandler () const
 

Protected Attributes

bool _newChildDefaultValue
 
unsigned int _activeSwitchSet
 
SwitchSetList _values
 
SwitchSetNameList _valueNames
 
- Protected Attributes inherited from osg::Group
NodeList _children
 
- Protected Attributes inherited from osg::Node
BoundingSphere _initialBound
 
ref_ptr< ComputeBoundingSphereCallback_computeBoundCallback
 
BoundingSphere _boundingSphere
 
bool _boundingSphereComputed
 
ParentList _parents
 
ref_ptr< Callback_updateCallback
 
unsigned int _numChildrenRequiringUpdateTraversal
 
ref_ptr< Callback_eventCallback
 
unsigned int _numChildrenRequiringEventTraversal
 
ref_ptr< Callback_cullCallback
 
bool _cullingActive
 
unsigned int _numChildrenWithCullingDisabled
 
unsigned int _numChildrenWithOccluderNodes
 
NodeMask _nodeMask
 
ref_ptr< StateSet_stateset
 
- Protected Attributes inherited from osg::Object
std::string _name
 
DataVariance _dataVariance
 
osg::UserDataContainer_userDataContainer
 
- Protected Attributes inherited from osg::Referenced
OpenThreads::AtomicPtr _observerSet
 
OpenThreads::Atomic _refCount
 

Additional Inherited Members

- Static Public Member Functions inherited from osg::Referenced
static OpenThreads::MutexgetGlobalReferencedMutex ()
 
static void setDeleteHandler (DeleteHandler *handler)
 
static DeleteHandlergetDeleteHandler ()
 

Detailed Description

MultiSwitch is a Group node which allows switching between sets of selected children. MultiSwitch is based on the OpenFlight switch behaviour.

Member Typedef Documentation

◆ SwitchSetList

◆ SwitchSetNameList

typedef std::vector<std::string> osgSim::MultiSwitch::SwitchSetNameList

◆ ValueList

typedef std::vector<bool> osgSim::MultiSwitch::ValueList

Constructor & Destructor Documentation

◆ MultiSwitch() [1/2]

osgSim::MultiSwitch::MultiSwitch ( )

◆ MultiSwitch() [2/2]

osgSim::MultiSwitch::MultiSwitch ( const MultiSwitch ,
const osg::CopyOp copyop = osg::CopyOp::SHALLOW_COPY 
)

Copy constructor using CopyOp to manage deep vs shallow copy.

◆ ~MultiSwitch()

virtual osgSim::MultiSwitch::~MultiSwitch ( )
inlineprotectedvirtual

Member Function Documentation

◆ addChild()

virtual bool osgSim::MultiSwitch::addChild ( osg::Node child)
virtual

Add Node to Group. If node is not NULL then increment its reference count, add it to the child list and dirty the bounding sphere to force it to recompute on next getBound() and return true for success. Otherwise return false. Scene nodes can't be added as child nodes.

Reimplemented from osg::Group.

◆ expandToEncompassSwitchSet()

void osgSim::MultiSwitch::expandToEncompassSwitchSet ( unsigned int  switchSet)
protected

◆ getActiveSwitchSet()

unsigned int osgSim::MultiSwitch::getActiveSwitchSet ( ) const
inline

Get which of the available switch set lists to use.

◆ getChildValue()

bool osgSim::MultiSwitch::getChildValue ( const osg::Node child,
unsigned int  switchSet 
) const

◆ getNewChildDefaultValue()

bool osgSim::MultiSwitch::getNewChildDefaultValue ( ) const
inline

◆ getSwitchSetList()

const SwitchSetList & osgSim::MultiSwitch::getSwitchSetList ( ) const
inline

Get the compile set of different values.

◆ getValue()

bool osgSim::MultiSwitch::getValue ( unsigned int  switchSet,
unsigned int  pos 
) const

◆ getValueList()

const ValueList & osgSim::MultiSwitch::getValueList ( unsigned int  switchSet) const
inline

Get the a single set of different values for a particular switch set.

◆ getValueName()

const std::string & osgSim::MultiSwitch::getValueName ( unsigned int  switchSet) const
inline

◆ insertChild()

virtual bool osgSim::MultiSwitch::insertChild ( unsigned int  index,
osg::Node child 
)
virtual

Insert Node to Group at specific location. The new child node is inserted into the child list before the node at the specified index. No nodes are removed from the group with this operation.

Reimplemented from osg::Group.

◆ META_Node()

osgSim::MultiSwitch::META_Node ( osgSim  ,
MultiSwitch   
)

◆ removeChild()

virtual bool osgSim::MultiSwitch::removeChild ( osg::Node child)
virtual

Remove Node from Group. If Node is contained in Group then remove it from the child list, decrement its reference count, and dirty the bounding sphere to force it to recompute on next getBound() and return true for success. If Node is not found then return false and do not change the reference count of the Node. Note, do not override, only override removeChildren(,) is required.

Reimplemented from osg::Group.

◆ setActiveSwitchSet()

void osgSim::MultiSwitch::setActiveSwitchSet ( unsigned int  switchSet)
inline

Set which of the available switch set lists to use.

◆ setAllChildrenOff()

bool osgSim::MultiSwitch::setAllChildrenOff ( unsigned int  switchSet)

Set all the children off (false), and set the new default child value to off (false).

◆ setAllChildrenOn()

bool osgSim::MultiSwitch::setAllChildrenOn ( unsigned int  switchSet)

Set all the children on (true), and set the new default child value to on (true).

◆ setChildValue()

void osgSim::MultiSwitch::setChildValue ( const osg::Node child,
unsigned int  switchSet,
bool  value 
)

◆ setNewChildDefaultValue()

void osgSim::MultiSwitch::setNewChildDefaultValue ( bool  value)
inline

◆ setSingleChildOn()

bool osgSim::MultiSwitch::setSingleChildOn ( unsigned int  switchSet,
unsigned int  pos 
)

Set a single child to be on, MultiSwitch off all other children.

◆ setSwitchSetList()

void osgSim::MultiSwitch::setSwitchSetList ( const SwitchSetList switchSetList)

Set the compile set of different values.

◆ setValue()

void osgSim::MultiSwitch::setValue ( unsigned int  switchSet,
unsigned int  pos,
bool  value 
)

◆ setValueList()

void osgSim::MultiSwitch::setValueList ( unsigned int  switchSet,
const ValueList values 
)

Set the a single set of different values for a particular switch set.

◆ setValueName()

void osgSim::MultiSwitch::setValueName ( unsigned int  switchSet,
const std::string &  name 
)

◆ traverse()

virtual void osgSim::MultiSwitch::traverse ( osg::NodeVisitor )
virtual

Traverse downwards : calls children's accept method with NodeVisitor.

Reimplemented from osg::Group.

Member Data Documentation

◆ _activeSwitchSet

unsigned int osgSim::MultiSwitch::_activeSwitchSet
protected

◆ _newChildDefaultValue

bool osgSim::MultiSwitch::_newChildDefaultValue
protected

◆ _valueNames

SwitchSetNameList osgSim::MultiSwitch::_valueNames
protected

◆ _values

SwitchSetList osgSim::MultiSwitch::_values
protected

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