SoVRMLGroup Class Reference
[VRML97 nodes]
Group node.
More...
#include <Inventor/VRMLnodes/SoVRMLGroup.h>
Public Types | |
| enum | CacheEnabled { OFF = SO_RENDERCACHING_OFF, ON = SO_RENDERCACHING_ON, AUTO = SO_RENDERCACHING_AUTO } |
Public Member Functions | |
| virtual SoType | getTypeId () const |
| SoVRMLGroup () | |
| SoVRMLGroup (int nChildren) | |
Static Public Member Functions | |
| static SoType | getClassTypeId () |
Public Attributes | |
| SoSFEnum | renderCaching |
| SoSFEnum | boundingBoxCaching |
| SoSFEnum | renderCulling |
| SoSFEnum | pickCulling |
| SoSFEnum | directVizCaching |
| SoSFInt32 | renderUnitId |
Friends | |
| class | SoTraversalPassImpl |
Deprecated | |
|
| |
| static SoDEPRECATED void | setNumRenderCaches (int howMany) |
| static SoDEPRECATED int | getNumRenderCaches () |
Detailed Description
Group node.
An SoVRMLGroup node is equivalent to an SoVRMLTransform node, without the transformation fields.
NOTE: 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
- Deprecated:
-
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. - Deprecated:
-
Deprecated since Open Inventor 8000
Use SoDB::getNumRenderCaches instead. - Deprecated:
-
Deprecated since Open Inventor 8000
Use SoDB::setNumRenderCaches instead. - 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.
- Inventor/VRMLnodes/SoVRMLGroup.h
eventIn
| SoMFNode | addChildren |
| SoMFNode | removeChildren |
| SoMFNode | set_children |
| SoSFNode | set_metadata |
eventOut
| SoMFNode | children_changed |
| SoSFNode | metadata_changed |
Member Enumeration Documentation
Constructor & Destructor Documentation
| SoVRMLGroup::SoVRMLGroup | ( | ) |
Default constructor.
| SoVRMLGroup::SoVRMLGroup | ( | int | nChildren | ) |
Constructor that takes approximate number of children.
Member Function Documentation
| static SoType SoVRMLGroup::getClassTypeId | ( | ) | [static] |
Returns the type identifier for this class.
Reimplemented from SoVRMLParent.
Reimplemented in SoVRMLGeoLocation, SoVRMLAnchor, SoVRMLBillboard, SoVRMLCollision, and SoVRMLTransform.
| static SoDEPRECATED int SoVRMLGroup::getNumRenderCaches | ( | ) | [static] |
Returns the current number of render caches.
| virtual SoType SoVRMLGroup::getTypeId | ( | ) | const [virtual] |
Returns the type identifier for this specific instance.
Reimplemented from SoVRMLParent.
Reimplemented in SoVRMLGeoLocation, SoVRMLAnchor, SoVRMLBillboard, SoVRMLCollision, and SoVRMLTransform.
| static SoDEPRECATED void SoVRMLGroup::setNumRenderCaches | ( | int | howMany | ) | [static] |
Sets the maximum number of render caches.
Friends And Related Function Documentation
friend class SoTraversalPassImpl [friend] |
Member Data Documentation
Whether to cache during bounding box traversal.
Use enum CacheEnabled. 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.
Whether to cache during DirectViz rendering traversal.
Use enum CacheEnabled. 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.
NOTE: field available since Open Inventor 7.0
Whether to cull during pick traversal.
Use enum CacheEnabled. 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.
Whether to cache during rendering traversal.
Use enum CacheEnabled. 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.
Whether to cull during rendering traversal.
Use enum CacheEnabled. 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.
Used during the ScaleViz depth compositing process, this field specifies which render unit (OIRU) will render the sub scene graph below this separator.
The documentation for this class was generated from the following file: