Home Hierarchy Members Alphabetical Related Pages

Switch Class Reference
[Standard Node Types]

#include <switch.h>

Inherits Node.

Inheritance diagram for Switch:

Inheritance graph
[legend]
List of all members.

Public Member Functions

 Switch (const char *name="")
virtual ~Switch ()
virtual unsigned int nbFields () const
virtual FieldHandle field (const std::string &n)
virtual FieldHandle field (const unsigned int i)
virtual bool isSetToDefaultValue (const unsigned int i) const
virtual unsigned int nbEventsIn () const
virtual EventInHandle eventIn (const std::string &n)
virtual EventInHandle eventIn (const unsigned int i)
virtual unsigned int nbEventsOut () const
virtual EventOutHandle eventOut (const std::string &n)
virtual EventOutHandle eventOut (const unsigned int i)
const char * typeName () const
virtual Node * duplicate () const
virtual Node * duplicate (std::map< const Node *, Node * > &) const

Public Attributes

Exposed Fields
A field that is capable of receiving events via an eventIn to change its value(s), and generating events via an eventOut when its value(s) change.

MFNode choice
SFInt32 whichChoice
Events In
EventIn< MFNode > set_choice
EventIn< SFInt32 > set_whichChoice
Events Out
EventOut< MFNode > choice_changed
EventOut< SFInt32 > whichChoice_changed

Detailed Description

Here is the documentation for this node type, from the ISO standard.

+6.65 Switch

The Switch grouping node traverses zero or one of the nodes specified in the choice field.

4.6.5, Grouping and children nodes, describes details on the types of nodes that are legal values for choice.

The whichChoice field specifies the index of the child to traverse, with the first child having index 0. If whichChoice is less than zero or greater than the number of nodes in the choice field, nothing is chosen.

All nodes under a Switch continue to receive and send events regardless of the value of whichChoice. For example, if an active TimeSensor is contained within an inactive choice of an Switch, the TimeSensor sends events regardless of the Switch's state.

--- VRML separator bar ---

Constructor & Destructor Documentation

Switch (  const char *  name = ""  ) 
 

Construct a node with all its fields set to default value, which is equivalent to the code below: 

  whichChoice = -1;

~Switch (   )  [virtual]
 

Virtual destructor, does nothing

Member Function Documentation

wrl::Node * duplicate (  std::map< const Node *, Node * > &   )  const [virtual]
 

Implements Node.

wrl::Node * duplicate (   )  const [virtual]
 

Returns a deep copy of this node, that is a fully independant node with all children (if any) also copied. This is mainly useful for instanciating protos.

Implements Node.

wrl::Node::EventInHandle eventIn (  const unsigned int  n  )  [virtual]
 

Return a handle on the i th event in of the node or a "unknown" typed handle if there is no such node. emarks This class has no eventIn. This function is useful, with nbEventsIn() if you want to traverse all events in of a Node.

Implements Node.

wrl::Node::EventInHandle eventIn (  const std::string &  n  )  [virtual]
 

Return a handle on the event in named n of the node or a "unknown" typed handle if there is no such event. Valid names are:

  • set_choice
  • set_whichChoice

Implements Node.

wrl::Node::EventOutHandle eventOut (  const unsigned int  n  )  [virtual]
 

Return a handle on the i th event out of the node or a "unknown" typed handle if there is no such node. Here is how i is related to fields:

  • 0 : choice_changed
  • 1 : whichChoice_changed This function is useful, with nbEventsOut() if you want to traverse all events in of a Node.

Implements Node.

wrl::Node::EventOutHandle eventOut (  const std::string &  n  )  [virtual]
 

Return a handle on the event out named n of the node or a "unknown" typed handle if there is no such event. Valid names are:

  • choice_changed
  • whichChoice_changed

Implements Node.

wrl::Node::FieldHandle field (  const unsigned int  n  )  [virtual]
 

Return a handle on the i th field of the node or a "unknown" typed handle if there is no such node. Here is how i is related to fields:

  • 0 : choice
  • 1 : whichChoice This function is useful, with nbFields() if you want to traverse all fields of a Node.

Implements Node.

wrl::Node::FieldHandle field (  const std::string &  n  )  [virtual]
 

Return a handle on the field named n of the node or a "unknown" typed handle if there is no such field. Valid names are:

  • choice
  • whichChoice

Implements Node.

bool isSetToDefaultValue (  const unsigned int  i  )  const [virtual]
 

Implements Node.

unsigned int nbEventsIn (   )  const [inline, virtual]
 

Returns the number of events in for this node type.

Implements Node.

unsigned int nbEventsOut (   )  const [inline, virtual]
 

Returns the number of events out for this node type.

Implements Node.

unsigned int nbFields (   )  const [inline, virtual]
 

Returns the number of fields (exposed or not) for this node type.

Implements Node.

const char * typeName (   )  const [inline, virtual]
 

Returns "Switch". Useful for printing.

Implements Node.

Member Data Documentation

MFNode choice
 

See Detailed Description for meaning of this field. Default value is set to MFNode default value

EventOut<MFNode> choice_changed
 

Changed event associated to exposedField choice

EventIn<MFNode> set_choice
 

Set event associated to exposedField choice

EventIn<SFInt32> set_whichChoice
 

Set event associated to exposedField whichChoice

SFInt32 whichChoice
 

See Detailed Description for meaning of this field. Default value is set to 

       whichChoice = -1;

EventOut<SFInt32> whichChoice_changed
 

Changed event associated to exposedField whichChoice

Generated on 24 Feb 2005 with doxygen version 1.3.9.1. Valid HTML 4.0! Valid CSS!