Click or drag to resize
SoVRMLGroup Class

Note: This API is now obsolete.

Group node.

Inheritance Hierarchy
SystemObject
  OIV.InventorSoNetBase
    OIV.InventorSoDisposable
      OIV.Inventor.MiscSoBase
        OIV.Inventor.FieldsSoFieldContainer
          OIV.Inventor.NodesSoNode
            OIV.Inventor.NodesSoGroup
              OIV.Inventor.VRMLnodesSoVRMLParent
                OIV.Inventor.VRMLnodesSoVRMLGroup
                  OIV.Inventor.GeoSoVRMLGeoLocation
                  OIV.Inventor.VRMLnodesSoVRMLAnchor
                  OIV.Inventor.VRMLnodesSoVRMLBillboard
                  OIV.Inventor.VRMLnodesSoVRMLCollision
                  OIV.Inventor.VRMLnodesSoVRMLTransform

Namespace: OIV.Inventor.VRMLnodes
Assembly: OIV.Inventor (in OIV.Inventor.dll) Version: 9.9.13.0 (9.9.13.0)
Syntax
[EditorBrowsableAttribute(EditorBrowsableState.Never)]
[ObsoleteAttribute("See documentation for more details")]
public class SoVRMLGroup : SoVRMLParent

The SoVRMLGroup type exposes the following members.

Constructors
  NameDescription
Public methodSoVRMLGroup

Default constructor.

Public methodSoVRMLGroup(Int32)

Constructor that takes approximate number of children.

Top
Methods
  NameDescription
Public methodAddChild

Adds a child as last one in group.

(Inherited from SoVRMLParent.)
Public methodAffectsState

Returns true if a node has an effect on the state during traversal.

(Inherited from SoVRMLParent.)
Public methodCallback
Public methodCopy
Calls Copy(false).
(Inherited from SoNode.)
Public methodCopy(Boolean)

Creates and returns an exact copy of the node.

(Inherited from SoNode.)
Public methodCopyFieldValues(SoFieldContainer)
Calls CopyFieldValues(fc, false).
(Inherited from SoFieldContainer.)
Public methodCopyFieldValues(SoFieldContainer, Boolean)

Copies the contents of fc's fields into this object's fields.

(Inherited from SoFieldContainer.)
Public methodDispose
Releases all resources used by SoDisposable.
(Inherited from SoDisposable.)
Public methodDistribute
Public methodDoAction
Public methodEnableNotify

Notification at this Field Container is enabled (if flag == true) or disabled (if flag == false).

(Inherited from SoFieldContainer.)
Public methodEquals
Determines whether the specified Object is equal to the current Object.
(Inherited from Object.)
Public methodFieldsAreEqual

Returns true if this object's fields are exactly equal to fc's fields.

(Inherited from SoFieldContainer.)
Public methodFindChild

Finds index of given child within group.

(Inherited from SoVRMLParent.)
Public methodGet

Returns the values of the fields of this object in the Open Inventor ASCII file format in the given string.

(Inherited from SoFieldContainer.)
Public methodGetAllFields

Returns a list of fields, including the eventIn's and eventOut's.

(Inherited from SoFieldContainer.)
Public methodGetAlternateRep

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.)
Public methodGetBoundingBox
Public methodGetChild

Returns the nth child node.

(Inherited from SoVRMLParent.)
Public methodGetEventIn

Returns a the eventIn with the given name.

(Inherited from SoFieldContainer.)
Public methodGetEventOut

Returns the eventOut with the given name.

(Inherited from SoFieldContainer.)
Public methodGetField

Returns a the field of this object whose name is fieldName.

(Inherited from SoFieldContainer.)
Public methodGetFieldName

Returns the name of the given field in the fieldName argument.

(Inherited from SoFieldContainer.)
Public methodGetFields

Appends references to all of this object's fields to resultList, and returns the number of fields appended.

(Inherited from SoFieldContainer.)
Public methodGetHashCode
Overrides GetHashCode().
(Inherited from SoNetBase.)
Public methodGetMatrix
Public methodGetName

Returns the name of an instance.

(Inherited from SoBase.)
Public methodGetNumChildren

Returns number of children.

(Inherited from SoVRMLParent.)
Public methodStatic memberGetNumRenderCaches Obsolete.

Returns the current number of render caches.

Public methodGetPrimitiveCount
Public methodGetRenderUnitID
(Inherited from SoNode.)
Public methodGetStringName (Inherited from SoBase.)
Public methodGetType
Gets the Type of the current instance.
(Inherited from Object.)
Public methodGLRender
Public methodGLRenderBelowPath
Public methodGLRenderInPath
Public methodGLRenderOffPath
Public methodGrabEventsCleanup
(Inherited from SoNode.)
Public methodGrabEventsSetup
(Inherited from SoNode.)
Public methodHandleEvent
(Inherited from SoGroup.)
Public methodHasDefaultValues

Returns true if all of the object's fields have their default values.

(Inherited from SoFieldContainer.)
Public methodInsertChild

Adds a child so that it becomes the one with the given index.

(Inherited from SoVRMLParent.)
Public methodIsBoundingBoxIgnoring

Used by BoundingBoxAction to known if bounding box computation should be ignored or not.

(Inherited from SoGroup.)
Public methodIsNotifyEnabled

Notification is the process of telling interested objects that this object has changed.

(Inherited from SoFieldContainer.)
Public methodIsOverride

Returns the state of the override flag.

(Inherited from SoNode.)
Public methodIsSynchronizable

Gets the ScaleViz synchronizable state of this object.

(Inherited from SoBase.)
Public methodPick
(Inherited from SoGroup.)
Public methodRayPick
Public methodRemoveAllChildren

Removes all children from group.

(Inherited from SoVRMLParent.)
Public methodRemoveChild(Int32)

Removes child with given index from group.

(Inherited from SoVRMLParent.)
Public methodRemoveChild(SoNode)

Removes first instance of given child from group.

(Inherited from SoVRMLParent.)
Public methodReplaceChild(Int32, SoNode)

Replaces child with given index with new child.

(Inherited from SoVRMLParent.)
Public methodReplaceChild(SoNode, SoNode)

Replaces first instance of given child with new child.

(Inherited from SoVRMLParent.)
Public methodSearch
Public methodSet

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.)
Public methodSetName (Inherited from SoBase.)
Public methodStatic memberSetNumRenderCaches Obsolete.

Sets the maximum number of render caches.

Public methodSetOverride

Turns the override flag on or off.

(Inherited from SoNode.)
Public methodSetSynchronizable

Sets this to be a ScaleViz synchronizable object.

(Inherited from SoBase.)
Public methodSetToDefaults

Sets all fields in this object to their default values.

(Inherited from SoFieldContainer.)
Public methodToString
Converts this SoBase structure to a human readable string.
(Inherited from SoBase.)
Public methodTouch

Marks an instance as modified, simulating a change to it.

(Inherited from SoNode.)
Public methodWrite
Top
Properties
  NameDescription
Public propertybboxCenter

The bboxCenter and bboxSize fields specify a bounding box that encloses the SoVRMLParent's children.

(Inherited from SoVRMLParent.)
Public propertybboxSize

The bboxCenter and bboxSize fields specify a bounding box that encloses the SoVRMLParents's children.

(Inherited from SoVRMLParent.)
Public propertyboundingBoxCaching

Whether to cache during bounding box traversal.

Public propertyboundingBoxIgnoring

Whether to ignore this node during bounding box traversal.

(Inherited from SoGroup.)
Public propertychildren

Field that contains a list of children nodes.

(Inherited from SoVRMLParent.)
Public propertydirectVizCaching

Whether to cache during DirectViz rendering traversal.

Public propertyIsDisposable
ISafeDisposable interface implementation.
(Inherited from SoDisposable.)
Public propertymetadata

Specifies the metadata node.

(Inherited from SoVRMLParent.)
Public propertypickCulling

Whether to cull during pick traversal.

Public propertyrenderCaching

Whether to cache during rendering traversal.

Public propertyrenderCulling

Whether to cull during rendering traversal.

Public propertyrenderUnitId

Used during the ScaleViz depth compositing process, this field specifies which render unit (OIRU) will render the sub scene graph below this separator.

Public propertyUserData
Gets or sets the user data to be contained by the field container.
(Inherited from SoFieldContainer.)
Top
Remarks

An SoVRMLGroup node is equivalent to an SoVRMLTransform node, without the transformation fields.

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

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.

An SoVRMLGroup node is equivalent to an SoVRMLTransform node, without the transformation fields.

See the "Concepts - Grouping and Children Nodes" section for a description of the children , addChildren , and removeChildren fields and eventIns.

The bboxCenter and bboxSize fields specify a bounding box that encloses the SoVRMLGroup'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: The following fields renderCaching, boundingBoxCaching,directVizCaching, renderCulling, and pickCulling are specific to the Open Inventor implementation by VSG and are not part of the VRML97 specification. These fields are very useful for performance tuning, but are not written out if the output file is specified as VRML97 format. See SoSeparator for a discussion of Open Inventor caching and culling. The field renderUnitId is likewise not part of the VRML97 specification. It is used with ScaleViz for cluster rendering.

FILE FORMAT/DEFAULT

VRMLGroup {
children []
bboxCenter 0 0 0
bboxSize -1 -1 -1
metadata NULL
renderCaching AUTO (see note above)
boundingBoxCaching AUTO (see note above)
renderCulling AUTO (see note above)
pickCulling AUTO (see note above)
directVizCaching OFF (see note above)
renderUnitId -1 (see note above)
}

ACTION BEHAVIOR

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

EVENTS

eventIn

SoMFNodeaddChildren
SoMFNoderemoveChildren
SoMFNodeset_children
SoSFNodeset_metadata

eventOut

SoMFNodechildren_changed
SoSFNodemetadata_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.

See Also