com.openinventor.inventor.vrmlnodes

Class SoVRMLGroup

java.lang.Object

com.openinventor.inventor.Inventor

com.openinventor.inventor.misc.SoBase

com.openinventor.inventor.fields.SoFieldContainer

com.openinventor.inventor.nodes.SoNode

com.openinventor.inventor.nodes.SoGroup

com.openinventor.inventor.vrmlnodes.SoVRMLParent

com.openinventor.inventor.vrmlnodes.SoVRMLGroup

All Implemented Interfaces:

SafeDisposable

Direct Known Subclasses:

SoVRMLAnchor, SoVRMLBillboard, SoVRMLCollision, SoVRMLGeoLocation, SoVRMLTransform

Deprecated.

As of Open Inventor 9500 See documentation for more details

public class SoVRMLGroup
extends SoVRMLParent

Group node. 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

SoMFNode	addChildren
SoMFNode	removeChildren
SoMFNode	set_children
SoSFNode	set_metadata

eventOut

SoMFNode	children_changed
SoSFNode	metadata_changed

Deprecated since 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.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	SoVRMLGroup.Cachings Deprecated. Possible values for caching.

Nested classes/interfaces inherited from class com.openinventor.inventor.Inventor

Inventor.ConstructorCommand

Field Summary

Fields

Modifier and Type	Field and Description
static int	AUTO Deprecated. Use SoVRMLGroup.Cachings.AUTO instead.
SoSFEnum<SoVRMLGroup.Cachings>	boundingBoxCaching Deprecated. Whether to cache during bounding box traversal.
SoSFEnum<SoVRMLGroup.Cachings>	directVizCaching Deprecated. Whether to cache during DirectViz rendering traversal.
static int	OFF Deprecated. Use SoVRMLGroup.Cachings.OFF instead.
static int	ON Deprecated. Use SoVRMLGroup.Cachings.ON instead.
SoSFEnum<SoVRMLGroup.Cachings>	pickCulling Deprecated. Whether to cull during pick traversal.
SoSFEnum<SoVRMLGroup.Cachings>	renderCaching Deprecated. Whether to cache during rendering traversal.
SoSFEnum<SoVRMLGroup.Cachings>	renderCulling Deprecated. Whether to cull during rendering traversal.
SoSFInt32	renderUnitId Deprecated. Used during the ScaleViz depth compositing process, this field specifies which render unit (OIRU) will render the sub scene graph below this separator.

Fields inherited from class com.openinventor.inventor.vrmlnodes.SoVRMLParent

bboxCenter, bboxSize, children, metadata

Fields inherited from class com.openinventor.inventor.nodes.SoGroup

boundingBoxIgnoring

Fields inherited from class com.openinventor.inventor.Inventor

VERBOSE_LEVEL, ZeroHandle

Constructor Summary

Constructors

Constructor and Description
SoVRMLGroup() Deprecated. Default constructor.
SoVRMLGroup(int nChildren) Deprecated. Constructor that takes approximate number of children.

Method Summary

Modifier and Type	Method and Description
static int	getNumRenderCaches() Deprecated. As of Open Inventor 8.0, use SoDB.getNumRenderCaches() instead.
static void	setNumRenderCaches(int howMany) Deprecated. As of Open Inventor 8.0, use SoDB.setNumRenderCaches(int) instead.

Methods inherited from class com.openinventor.inventor.nodes.SoGroup

addChild, findChild, getChild, getNumChildren, insertChild, removeAllChildren, removeChild, removeChild, replaceChild, replaceChild

Methods inherited from class com.openinventor.inventor.nodes.SoNode

affectsState, callback, copy, copy, distribute, doAction, getAlternateRep, getBoundingBox, getByName, getMatrix, getPrimitiveCount, getRenderUnitID, GLRender, GLRenderBelowPath, GLRenderInPath, GLRenderOffPath, grabEventsCleanup, grabEventsSetup, handleEvent, isBoundingBoxIgnoring, isOverride, pick, rayPick, search, setOverride, touch, write

Methods inherited from class com.openinventor.inventor.fields.SoFieldContainer

copyFieldValues, copyFieldValues, enableNotify, fieldsAreEqual, get, getAllFields, getEventIn, getEventOut, getField, getFieldName, hasDefaultValues, isNotifyEnabled, set, setToDefaults

Methods inherited from class com.openinventor.inventor.misc.SoBase

dispose, getEXTERNPROTO, getName, getPROTO, isDisposable, isSynchronizable, setName, setSynchronizable

Methods inherited from class com.openinventor.inventor.Inventor

getAddress, getNativeResourceHandle, startInternalThreads, stopInternalThreads

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

OFF

@Deprecated
public static final int OFF

Deprecated. Use SoVRMLGroup.Cachings.OFF instead.

ON

@Deprecated
public static final int ON

Deprecated. Use SoVRMLGroup.Cachings.ON instead.

AUTO

@Deprecated
public static final int AUTO

Deprecated. Use SoVRMLGroup.Cachings.AUTO instead.

renderCaching

public final SoSFEnum<SoVRMLGroup.Cachings> renderCaching

Deprecated.

Whether to cache during rendering traversal. . Default is AUTO.

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.

boundingBoxCaching

public final SoSFEnum<SoVRMLGroup.Cachings> boundingBoxCaching

Deprecated.

Whether to cache during bounding box traversal. . Default is AUTO.

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.

renderCulling

public final SoSFEnum<SoVRMLGroup.Cachings> renderCulling

Deprecated.

Whether to cull during rendering traversal. . Default is AUTO.

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.

pickCulling

public final SoSFEnum<SoVRMLGroup.Cachings> pickCulling

Deprecated.

Whether to cull during pick traversal. . Default is AUTO.

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.

directVizCaching

public final SoSFEnum<SoVRMLGroup.Cachings> directVizCaching

Deprecated.

Whether to cache during DirectViz rendering traversal. . Default is OFF. 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.

Since:

Open Inventor 7.0

renderUnitId

public final SoSFInt32 renderUnitId

Deprecated.

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

• 0, the sub scene graph is rendered on the local machine.
• > 0, the sub scene graph is rendered by the OIRU with the specified ID. If the specified renderUnitId is larger than the number of available render units, the sub scene graph is distributed to the specified render unit ID modulo the number of render units actually available. That is:
  
  RenderUnitUsed = ((renderUnitId-1)%(ActualNumberOfRenderUnits))+1
• -1 (SO_RENDERUNITID_NONE), this separator is not assigned to any OIRU.
  
  NOTE: This is the default value, which means that by default the sub scene graph is *not* distributed to any node. In order to use depth compositing, you must modify renderUnitId from the default, otherwise nothing will be rendered.
• -2 (SO_RENDERUNITID_INHERIT), this separator inherits its value from parent SoSeparator.
• -3 (SO_RENDERUNITID_ALL), the sub scene graph is rendered by all OIRUs.

Since:

Open Inventor 6.1

Constructor Detail

SoVRMLGroup

public SoVRMLGroup()

Deprecated.

Default constructor.

SoVRMLGroup

public SoVRMLGroup(int nChildren)

Deprecated.

Constructor that takes approximate number of children.

Method Detail

getNumRenderCaches

@Deprecated
public static int getNumRenderCaches()

Deprecated. As of Open Inventor 8.0, use SoDB.getNumRenderCaches() instead.

Returns the current number of render caches.

setNumRenderCaches

@Deprecated
public static void setNumRenderCaches(int howMany)

Deprecated. As of Open Inventor 8.0, use SoDB.setNumRenderCaches(int) instead.

Sets the maximum number of render caches.