2001-09-20 05:19:47 +08:00
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN">
< HTML >
< HEAD >
< TITLE > class SG_EXPORT osg::Switch< / TITLE >
< META NAME = "GENERATOR" CONTENT = "DOC++ 3.4.8" >
< / HEAD >
< BODY BGCOLOR = "#ffffff" >
< H2 > class SG_EXPORT < A HREF = "#DOC.DOCU" > osg::Switch< / A > < / H2 > < / H2 > < BLOCKQUOTE > Switch is a Group node which allows switching between children.< / BLOCKQUOTE >
< HR >
< H2 > Inheritance:< / H2 >
2002-04-22 05:53:03 +08:00
< APPLET CODE = "ClassGraph.class" WIDTH = 600 HEIGHT = 95 >
< param name = classes value = "MNode,M,CGroup,MGroup.html,CSwitch,MSwitch.html" >
< param name = before value = "M,M,M" >
< param name = after value = "Md_SP,Md_,M" >
< param name = indent value = "0,1,2" >
2001-09-20 05:19:47 +08:00
< param name = arrowdir value = "down" >
< / APPLET >
< HR >
< DL >
< P > < DL >
< DT > < H3 > Public Methods< / H3 > < DD > < DT >
2002-06-05 20:35:59 +08:00
< IMG ALT = "[more]" BORDER = 0 SRC = icon1.gif > < B > < A HREF = "#DOC.2.103.2" > Switch< / A > < / B > ()
2001-09-20 05:19:47 +08:00
< DT >
2002-06-05 20:35:59 +08:00
< IMG ALT = "[more]" BORDER = 0 SRC = icon1.gif > < B > < A HREF = "#DOC.2.103.3" > Switch< / A > < / B > (const <!1> < A HREF = "Switch.html#DOC.2.103.3" > Switch< / A > & , const <!1> < A HREF = "CopyOp.html" > CopyOp< / A > & copyop=CopyOp::SHALLOW_COPY)
2002-02-09 18:54:18 +08:00
< DD > < I > Copy constructor using CopyOp to manage deep vs shallow copy< / I >
2001-09-20 05:19:47 +08:00
< DT >
2002-06-05 20:35:59 +08:00
< IMG ALT = "[more]" BORDER = 0 SRC = icon1.gif > < B > < A HREF = "#DOC.2.103.4" > META_Node< / A > < / B > (<!1> < A HREF = "Switch.html" > Switch< / A > )
2001-09-20 05:19:47 +08:00
< DT >
2002-06-05 20:35:59 +08:00
< IMG ALT = "[more]" BORDER = 0 SRC = icon1.gif > virtual void < B > < A HREF = "#DOC.2.103.5" > traverse< / A > < / B > (<!1> < A HREF = "NodeVisitor.html" > NodeVisitor< / A > & nv)
2002-02-09 18:54:18 +08:00
< DT >
2002-06-05 20:35:59 +08:00
< IMG ALT = "[more]" BORDER = 0 SRC = icon1.gif > inline void < B > < A HREF = "#DOC.2.103.6" > setValue< / A > < / B > (const int value)
2001-09-20 05:19:47 +08:00
< DD > < I > Selects the active child Node or enables a special SwitchType mode.< / I >
< DT >
2002-06-05 20:35:59 +08:00
< IMG ALT = "[more]" BORDER = 0 SRC = icon1.gif > inline const int < B > < A HREF = "#DOC.2.103.7" > getValue< / A > < / B > () const
2001-09-20 05:19:47 +08:00
< DD > < I > Returns the number of the active child Node or the SwitchType< / I >
< / DL > < / P >
< P > < DL >
< DT > < H3 > Public Members< / H3 > < DD > < DT >
2002-06-05 20:35:59 +08:00
< IMG ALT = "[more]" BORDER = 0 SRC = icon1.gif > enum < B > < A HREF = "#DOC.2.103.1" > SwitchType< / A > < / B >
2001-09-20 05:19:47 +08:00
< DD > < I > Special mode values for the Switch.< / I >
< / DL > < / P >
< P > < DL >
< DT > < H3 > Protected Fields< / H3 > < DD > < DT >
2002-06-05 20:35:59 +08:00
< IMG ALT = "[more]" BORDER = 0 SRC = icon1.gif > int < B > < A HREF = "#DOC.2.103.9" > _value< / A > < / B >
2001-09-20 05:19:47 +08:00
< DD > < I > The current Switch value.< / I >
< / DL > < / P >
< P > < DL >
< DT > < H3 > Protected Methods< / H3 > < DD > < DT >
2002-06-05 20:35:59 +08:00
< IMG ALT = "[more]" BORDER = 0 SRC = icon1.gif > virtual < B > < A HREF = "#DOC.2.103.8" > ~Switch< / A > < / B > ()
2001-09-20 05:19:47 +08:00
< / DL > < / P >
< / DL >
< HR > < H3 > Inherited from < A HREF = "Group.html" > Group< / A > :< / H3 >
< DL >
< P > < DL >
< DT > < H3 > Public Methods< / H3 > < DD > < DT >
2002-04-22 05:53:03 +08:00
< IMG ALT = "o" SRC = icon2.gif > virtual bool < B > addChild< / B > ( Node* child )
2001-09-20 05:19:47 +08:00
< DT >
2002-04-22 05:53:03 +08:00
< IMG ALT = "o" SRC = icon2.gif > virtual bool < B > removeChild< / B > ( Node* child )
2001-09-20 05:19:47 +08:00
< DT >
2002-04-22 05:53:03 +08:00
< IMG ALT = "o" SRC = icon2.gif > virtual bool < B > replaceChild< / B > ( Node* origChild, Node* newChild )
2001-09-20 05:19:47 +08:00
< DT >
2002-04-26 21:45:01 +08:00
< IMG ALT = "o" SRC = icon2.gif > inline const unsigned int < B > getNumChildren< / B > () const
2001-09-20 05:19:47 +08:00
< DT >
2002-04-26 21:45:01 +08:00
< IMG ALT = "o" SRC = icon2.gif > inline Node* < B > getChild< / B > ( const unsigned int i )
2001-09-20 05:19:47 +08:00
< DT >
2002-04-26 21:45:01 +08:00
< IMG ALT = "o" SRC = icon2.gif > inline const Node* < B > getChild< / B > ( const unsigned int i ) const
2001-09-20 05:19:47 +08:00
< DT >
2002-04-22 05:53:03 +08:00
< IMG ALT = "o" SRC = icon2.gif > inline bool < B > containsNode< / B > ( const Node* node ) const
2001-09-20 05:19:47 +08:00
< DT >
2002-04-22 05:53:03 +08:00
< IMG ALT = "o" SRC = icon2.gif > inline ChildList::iterator < B > findNode< / B > ( const Node* node )
2001-09-20 05:19:47 +08:00
< DT >
2002-04-22 05:53:03 +08:00
< IMG ALT = "o" SRC = icon2.gif > inline ChildList::const_iterator < B > findNode< / B > ( const Node* node ) const
2001-09-20 05:19:47 +08:00
< / DL > < / P >
< P > < DL >
< DT > < H3 > Protected Fields< / H3 > < DD > < DT >
< IMG ALT = "o" SRC = icon2.gif > ChildList < B > _children< / B >
< / DL > < / P >
< P > < DL >
< DT > < H3 > Protected Methods< / H3 > < DD > < DT >
< IMG ALT = "o" SRC = icon2.gif > virtual const bool < B > computeBound< / B > () const
< / DL > < / P >
< / DL >
< A NAME = "DOC.DOCU" > < / A >
< HR >
< H2 > Documentation< / H2 >
< BLOCKQUOTE > Switch is a Group node which allows switching between children.
Typical uses would be for objects which might need to be rendered
differently at different times, for instance a switch could be used
to represent the different states of a traffic light.< / BLOCKQUOTE >
< DL >
< A NAME = "SwitchType" > < / A >
2002-06-05 20:35:59 +08:00
< A NAME = "DOC.2.103.1" > < / A >
2001-09-20 05:19:47 +08:00
< DT > < IMG ALT = "o" BORDER = 0 SRC = icon2.gif > < TT > < B > enum SwitchType< / B > < / TT >
< DD >
Special mode values for the Switch. Use these if you want to
turn on/off all child nodes.
< DL > < DT > < DD > < / DL > < P > < DL >
< A NAME = "ALL_CHILDREN_ON" > < / A >
2002-06-05 20:35:59 +08:00
< A NAME = "DOC.2.103.1.1" > < / A >
2001-09-20 05:19:47 +08:00
< DT > < IMG ALT = "o" BORDER = 0 SRC = icon2.gif > < TT > < B > ALL_CHILDREN_ON< / B > < / TT >
< DD > Turn on all children.
< DL > < DT > < DD > < / DL > < P >
< A NAME = "ALL_CHILDREN_OFF" > < / A >
2002-06-05 20:35:59 +08:00
< A NAME = "DOC.2.103.1.2" > < / A >
2001-09-20 05:19:47 +08:00
< DT > < IMG ALT = "o" BORDER = 0 SRC = icon2.gif > < TT > < B > ALL_CHILDREN_OFF< / B > < / TT >
< DD > Turn off all children.
< DL > < DT > < DD > < / DL > < P > < / DL >
< A NAME = "Switch" > < / A >
2002-06-05 20:35:59 +08:00
< A NAME = "DOC.2.103.2" > < / A >
2001-09-20 05:19:47 +08:00
< DT > < IMG ALT = "o" BORDER = 0 SRC = icon2.gif > < TT > < B > Switch()< / B > < / TT >
< DL > < DT > < DD > < / DL > < P >
2002-02-09 18:54:18 +08:00
< A NAME = "Switch" > < / A >
2002-06-05 20:35:59 +08:00
< A NAME = "DOC.2.103.3" > < / A >
< DT > < IMG ALT = "o" BORDER = 0 SRC = icon2.gif > < TT > < B > Switch(const <!1> < A HREF = "Switch.html#DOC.2.103.3" > Switch< / A > & , const <!1> < A HREF = "CopyOp.html" > CopyOp< / A > & copyop=CopyOp::SHALLOW_COPY)< / B > < / TT >
2002-02-09 18:54:18 +08:00
< DD > Copy constructor using CopyOp to manage deep vs shallow copy
< DL > < DT > < DD > < / DL > < P >
2001-09-22 10:42:08 +08:00
< A NAME = "META_Node" > < / A >
2002-06-05 20:35:59 +08:00
< A NAME = "DOC.2.103.4" > < / A >
2001-09-22 10:42:08 +08:00
< DT > < IMG ALT = "o" BORDER = 0 SRC = icon2.gif > < TT > < B > META_Node(<!1> < A HREF = "Switch.html" > Switch< / A > )< / B > < / TT >
2001-09-20 05:19:47 +08:00
< DL > < DT > < DD > < / DL > < P >
< A NAME = "traverse" > < / A >
2002-06-05 20:35:59 +08:00
< A NAME = "DOC.2.103.5" > < / A >
2001-09-20 05:19:47 +08:00
< DT > < IMG ALT = "o" BORDER = 0 SRC = icon2.gif > < TT > < B > virtual void traverse(<!1> < A HREF = "NodeVisitor.html" > NodeVisitor< / A > & nv)< / B > < / TT >
< DL > < DT > < DD > < / DL > < P >
< A NAME = "setValue" > < / A >
2002-06-05 20:35:59 +08:00
< A NAME = "DOC.2.103.6" > < / A >
2001-09-20 05:19:47 +08:00
< DT > < IMG ALT = "o" BORDER = 0 SRC = icon2.gif > < TT > < B > inline void setValue(const int value)< / B > < / TT >
< DD >
Selects the active child Node or enables a special
SwitchType mode.
< DL > < DT > < DT > < B > Parameters:< / B > < DD > < B > value< / B > - the number of the active child
2002-06-05 20:35:59 +08:00
(<!1> < A HREF = "ImpostorSpriteManager.html#DOC.2.52.3" > first< / A > child == number 0) or SwitchType. Invalid values
2001-09-20 05:19:47 +08:00
will be ignored.< BR > < DD > < / DL > < P >
< A NAME = "getValue" > < / A >
2002-06-05 20:35:59 +08:00
< A NAME = "DOC.2.103.7" > < / A >
2001-09-20 05:19:47 +08:00
< DT > < IMG ALT = "o" BORDER = 0 SRC = icon2.gif > < TT > < B > inline const int getValue() const < / B > < / TT >
< DD >
Returns the number of the active child Node or the SwitchType
< DL > < DT > < DD > < / DL > < P >
< A NAME = "~Switch" > < / A >
2002-06-05 20:35:59 +08:00
< A NAME = "DOC.2.103.8" > < / A >
2001-09-20 05:19:47 +08:00
< DT > < IMG ALT = "o" BORDER = 0 SRC = icon2.gif > < TT > < B > virtual ~Switch()< / B > < / TT >
< DL > < DT > < DD > < / DL > < P >
< A NAME = "_value" > < / A >
2002-06-05 20:35:59 +08:00
< A NAME = "DOC.2.103.9" > < / A >
2001-09-20 05:19:47 +08:00
< DT > < IMG ALT = "o" BORDER = 0 SRC = icon2.gif > < TT > < B > int _value< / B > < / TT >
< DD > The current Switch value.
< DL > < DT > < DD > < / DL > < P > < / DL >
< HR > < DL > < DT > < B > This class has no child classes.< / B > < / DL >
< DL > < DT > < DD > < / DL > < P > < P > < I > < A HREF = "index.html" > Alphabetic index< / A > < / I > < I > < A HREF = "HIER.html" > HTML hierarchy of classes< / A > or < A HREF = "HIERjava.html" > Java< / A > < / I > < / P > < HR >
< BR >
This page was generated with the help of < A HREF = "http://docpp.sourceforge.net" > DOC++< / A > .
< / BODY >
< / HTML >