SoVRMLSwitch Class

SoVRMLSwitch Class

Note: This API is now obsolete.

Group node that traverses one chosen child.

Inheritance Hierarchy

SystemObject
  OIV.InventorSoNetBase
    OIV.InventorSoDisposable
      OIV.Inventor.MiscSoBase
        OIV.Inventor.FieldsSoFieldContainer
          OIV.Inventor.NodesSoNode
            OIV.Inventor.NodesSoGroup
              OIV.Inventor.VRMLnodesSoVRMLParent
                OIV.Inventor.VRMLnodesSoVRMLSwitch

Namespace: OIV.Inventor.VRMLnodes
Assembly: OIV.Inventor (in OIV.Inventor.dll) Version: 9.9.13.0 (9.9.13.0)

Syntax

C++

Copy

[ObsoleteAttribute("See documentation for more details")]
[EditorBrowsableAttribute(EditorBrowsableState.Never)]
public class SoVRMLSwitch : SoVRMLParent

<ObsoleteAttribute("See documentation for more details")>
<EditorBrowsableAttribute(EditorBrowsableState.Never)>
Public Class SoVRMLSwitch
	Inherits SoVRMLParent

[ObsoleteAttribute(L"See documentation for more details")]
[EditorBrowsableAttribute(EditorBrowsableState::Never)]
public ref class SoVRMLSwitch : public SoVRMLParent

[<ObsoleteAttribute("See documentation for more details")>]
[<EditorBrowsableAttribute(EditorBrowsableState.Never)>]
type SoVRMLSwitch =  
    class
        inherit SoVRMLParent
    end

The SoVRMLSwitch type exposes the following members.

Constructors

	Name	Description
	SoVRMLSwitch	Constructor.
	SoVRMLSwitch(Int32)	Constructor that takes approximate number of choices.

Top

Methods

	Name	Description
	AddChild	Adds a child as last one in group. (Inherited from SoVRMLParent.)
	AddChoice	Adds a choice/child as last one in group.
	AffectsState	Overrides method in SoNode to return false if there is no selected child or the selected child does not affect the state. (Overrides SoVRMLParentAffectsState.)
	Callback	(Overrides SoGroupCallback(SoCallbackAction).)
	Copy	Calls Copy(false). (Inherited from SoNode.)
	Copy(Boolean)	Creates and returns an exact copy of the node. (Inherited from SoNode.)
	CopyFieldValues(SoFieldContainer)	Calls CopyFieldValues(fc, false). (Inherited from SoFieldContainer.)
	CopyFieldValues(SoFieldContainer, Boolean)	Copies the contents of fc's fields into this object's fields. (Inherited from SoFieldContainer.)
	Dispose	Releases all resources used by SoDisposable. (Inherited from SoDisposable.)
	Distribute	(Inherited from SoNode.)
	DoAction	(Overrides SoVRMLParentDoAction(SoAction).)
	EnableNotify	Notification at this Field Container is enabled (if flag == true) or disabled (if flag == false). (Inherited from SoFieldContainer.)
	Equals	Determines whether the specified Object is equal to the current Object. (Inherited from Object.)
	FieldsAreEqual	Returns true if this object's fields are exactly equal to fc's fields. (Inherited from SoFieldContainer.)
	FindChild	Finds index of given child within group. (Inherited from SoVRMLParent.)
	FindChoice	Finds index of given choice/child within group.
	Get	Returns the values of the fields of this object in the Open Inventor ASCII file format in the given string. (Inherited from SoFieldContainer.)
	GetAllFields	Returns a list of fields, including the eventIn's and eventOut's. (Inherited from SoFieldContainer.)
	GetAlternateRep	This method is called by actions to allow the node to provide an "alternate representation" when appropriate (typically depending on the action type). (Inherited from SoNode.)
	GetBoundingBox	(Overrides SoGroupGetBoundingBox(SoGetBoundingBoxAction).)
	GetChild	Returns the nth child node. (Inherited from SoVRMLParent.)
	GetChoice	Returns the nth choice/child node.
	GetEventIn	Returns a the eventIn with the given name. (Inherited from SoFieldContainer.)
	GetEventOut	Returns the eventOut with the given name. (Inherited from SoFieldContainer.)
	GetField	Returns a the field of this object whose name is fieldName. (Inherited from SoFieldContainer.)
	GetFieldName	Returns the name of the given field in the fieldName argument. (Inherited from SoFieldContainer.)
	GetFields	Appends references to all of this object's fields to resultList, and returns the number of fields appended. (Inherited from SoFieldContainer.)
	GetHashCode	Overrides GetHashCode(). (Inherited from SoNetBase.)
	GetMatrix	(Overrides SoGroupGetMatrix(SoGetMatrixAction).)
	GetName	Returns the name of an instance. (Inherited from SoBase.)
	GetNumChildren	Returns number of children. (Inherited from SoVRMLParent.)
	GetNumChoices	Returns number of choices/children.
	GetPrimitiveCount	(Inherited from SoVRMLParent.)
	GetRenderUnitID	(Inherited from SoNode.)
	GetStringName	(Inherited from SoBase.)
	GetType	Gets the Type of the current instance. (Inherited from Object.)
	GLRender	(Overrides SoGroupGLRender(SoGLRenderAction).)
	GLRenderBelowPath	(Inherited from SoNode.)
	GLRenderInPath	(Inherited from SoNode.)
	GLRenderOffPath	(Inherited from SoNode.)
	GrabEventsCleanup	(Inherited from SoNode.)
	GrabEventsSetup	(Inherited from SoNode.)
	HandleEvent	(Overrides SoGroupHandleEvent(SoHandleEventAction).)
	HasDefaultValues	Returns true if all of the object's fields have their default values. (Inherited from SoFieldContainer.)
	InsertChild	Adds a child so that it becomes the one with the given index. (Inherited from SoVRMLParent.)
	InsertChoice	Adds a choice/child so that it becomes the one with the given index.
	IsBoundingBoxIgnoring	Used by BoundingBoxAction to known if bounding box computation should be ignored or not. (Inherited from SoGroup.)
	IsNotifyEnabled	Notification is the process of telling interested objects that this object has changed. (Inherited from SoFieldContainer.)
	IsOverride	Returns the state of the override flag. (Inherited from SoNode.)
	IsSynchronizable	Gets the ScaleViz synchronizable state of this object. (Inherited from SoBase.)
	Pick	(Overrides SoGroupPick(SoPickAction).)
	RayPick	(Inherited from SoNode.)
	RemoveAllChildren	Removes all children from group. (Inherited from SoVRMLParent.)
	RemoveAllChoices	Removes all choices/children from group.
	RemoveChild(Int32)	Removes child with given index from group. (Inherited from SoVRMLParent.)
	RemoveChild(SoNode)	Removes first instance of given child from group. (Inherited from SoVRMLParent.)
	RemoveChoice(Int32)	Removes choice/child with given index from group.
	RemoveChoice(SoNode)	Removes first instance of given choice/child from group.
	ReplaceChild(Int32, SoNode)	Replaces child with given index with new child. (Inherited from SoVRMLParent.)
	ReplaceChild(SoNode, SoNode)	Replaces first instance of given child with new child. (Inherited from SoVRMLParent.)
	ReplaceChoice(Int32, SoNode)	Replaces choice with given index with new choice/child.
	ReplaceChoice(SoNode, SoNode)	Replaces first instance of given choice/child with new choice/child.
	Search	(Overrides SoVRMLParentSearch(SoSearchAction).)
	Set	Sets one or more fields in this object to the values specified in the given string, which should be a string in the Open Inventor file format. (Inherited from SoFieldContainer.)
	SetName	(Inherited from SoBase.)
	SetOverride	Turns the override flag on or off. (Inherited from SoNode.)
	SetSynchronizable	Sets this to be a ScaleViz synchronizable object. (Inherited from SoBase.)
	SetToDefaults	Sets all fields in this object to their default values. (Inherited from SoFieldContainer.)
	ToString	Converts this SoBase structure to a human readable string. (Inherited from SoBase.)
	Touch	Marks an instance as modified, simulating a change to it. (Inherited from SoNode.)
	Write	(Overrides SoGroupWrite(SoWriteAction).)

Top

Properties

	Name	Description
	bboxCenter	The bboxCenter and bboxSize fields specify a bounding box that encloses the SoVRMLParent's children. (Inherited from SoVRMLParent.)
	bboxSize	The bboxCenter and bboxSize fields specify a bounding box that encloses the SoVRMLParents's children. (Inherited from SoVRMLParent.)
	boundingBoxIgnoring	Whether to ignore this node during bounding box traversal. (Inherited from SoGroup.)
	children	Field that contains a list of children nodes. (Inherited from SoVRMLParent.)
	choice	Nodes to chose from (VRML97 only).
	IsDisposable	ISafeDisposable interface implementation. (Inherited from SoDisposable.)
	metadata	Specifies the metadata node. (Inherited from SoVRMLParent.)
	UserData	Gets or sets the user data to be contained by the field container. (Inherited from SoFieldContainer.)
	whichChoice	Specifies the index of the child to traverse.

Top

Remarks

<font color="#0000FF">NOTE:</font> This class does not exist in Open Inventor 10.0 and later.

NOTE: This field is not compatible with VRML97. If you specify a non-default value for this field, when this node is written to a VRML file, the file will contain this incompatible field and standard VRML97 file readers will not be able to read it. See the VRML97 Specification, below.

VRML97 SPECIFICATION

This section describes the expected behavior of the node in a conforming VRML97 browser application. In some cases, the application is responsible for implementing portions of the expected behavior. Open Inventor viewer classes and IVF classes implement some of the application behaviors.

This section may reference portions of the VRML97 specification that are not present in this help file. The complete VRML97 spec is available at http://www.web3d.org.

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

See the "Concepts - Grouping and Children Nodes" section which describes "children nodes" for a details on the types of nodes that are legal values for choice.

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

SO_SWITCH_NONE (-1, the default) means do not traverse any children.
SO_SWITCH_INHERIT (-2) allows the index to be inherited from a previously-encountered SoSwitch node or from certain other nodes (such as SoArray or SoMultipleCopy) that set the switch value.
SO_SWITCH_ALL (-3) traverses all children, making the switch behave exactly like a regular SoGroup.

The bboxCenter and bboxSize fields specify a bounding box that encloses the SoVRMLSwitch's children. This is a hint that may be used for optimization purposes. If the specified bounding box is smaller than the actual bounding box of the children at any time, then the results are undefined. A default bboxSize value, (-1 -1 -1), implies that the bounding box is not specified and if needed must be calculated by the browser. See "Concepts - Bounding Boxes" for a description of the bboxCenter and bboxSize fields.

Note that all nodes under an SoVRMLSwitch continue to receive and send events regardless of the value of whichChoice.

FILE FORMAT/DEFAULT

VRMLSwitch {
choice [] // VRML97
children [] // X3D
whichChoice -1
metadata NULL
bboxCenter 0 0 0
bboxSize -1 -1 -1
}

ACTION BEHAVIOR

SoGLRenderAction, SoCallbackAction, SoGetBoundingBoxAction, SoHandleEventAction, SoRayPickAction, SoGetMatrixAction, SoSearchAction, SoWriteAction Sets: SoSwitchElement

EVENTS

eventIn

SoMFNode addChildren // X3D only
SoMFNode removeChildren // X3D only
SoMFNode set_choice // VRML97 only
SoMFNode set_children // X3D only
SoSFInt32 set_whichChoice
SoSFNode set_metadata

eventOut

SoMFNode choice_changed // VRML97 only
SoMFNode children_changed // X3D only
SoSFInt32 whichChoice_changed
SoSFNode metadata_changed
Obsoletesince Open Inventor 9500 The VRML API is no longer supported. See section http://oivdoc95.vsg3d.com/content/compatibility-notes-4#Deprecation of the Reference Manual.

Reference

OIV.Inventor.VRMLnodes Namespace

choice	[] // VRML97
children	[] // X3D
whichChoice	-1
metadata	NULL
bboxCenter	0 0 0
bboxSize	-1 -1 -1

SoMFNode	addChildren // X3D only
SoMFNode	removeChildren // X3D only
SoMFNode	set_choice // VRML97 only
SoMFNode	set_children // X3D only
SoSFInt32	set_whichChoice
SoSFNode	set_metadata

SoMFNode	choice_changed // VRML97 only
SoMFNode	children_changed // X3D only
SoSFInt32	whichChoice_changed
SoSFNode	metadata_changed