SoVRMLShape Class Reference
[VRML97 nodes]
Defines a shape by specifying its appearance and geometry.
More...
#include <Inventor/VRMLnodes/SoVRMLShape.h>
Public Types | |
| enum | CacheEnabled { OFF = SO_RENDERCACHING_OFF, ON = SO_RENDERCACHING_ON, AUTO = SO_RENDERCACHING_AUTO } |
Public Member Functions | |
| virtual SoType | getTypeId () const |
| SoVRMLShape () | |
| virtual void | setOverride (const SbBool state) |
| virtual SbBool | isOverride () const |
Static Public Member Functions | |
| static SoType | getClassTypeId () |
Public Attributes | |
| SoSFNode | appearance |
| SoSFNode | geometry |
| SoSFVec3f | bboxCenter |
| SoSFVec3f | bboxSize |
| SoSFEnum | renderCaching |
| SoSFEnum | boundingBoxCaching |
Friends | |
| class | SoPath |
| class | SoTraversalPassImpl |
Deprecated | |
|
| |
| static SoDEPRECATED void | setNumRenderCaches (int howMany) |
| static SoDEPRECATED int | getNumRenderCaches () |
Detailed Description
Defines a shape by specifying its appearance and geometry.
See the VRML97 Specification, below.
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 .
The SoVRMLShape node has four fields: appearance and geometry which are used to create rendered objects in the world. The appearance field specifies an SoVRMLAppearance node that specifies the visual attributes (e.g. material and texture) to be applied to the geometry. The geometry field specifies a geometry node. The specified geometry node is rendered with the specified appearance nodes applied.
The bboxCenter and bboxSize fields specify a bounding box that encloses the SoVRMLShape node's geometry. 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.
See "Concepts - Lighting Model" for details of the VRML lighting model and the interaction between SoVRMLAppearance and geometry nodes.
If the geometry field is NULL the object is not drawn.
Note: The following fields -- renderCaching and boundingBoxCaching -- are specific to the VSG Open Inventor implementation 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.
FILE FORMAT/DEFAULT
- VRMLShape {
| appearance | NULL |
| geometry | NULL |
| bboxCenter | 0 0 0 |
| bboxSize | -1 -1 -1 |
| metadata | NULL |
| renderCaching | AUTO |
| boundingBoxCaching | AUTO |
ACTION BEHAVIOR
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. - Inventor/VRMLnodes/SoVRMLShape.h
eventIn
| SoSFNode | set_appearance |
| SoSFNode | set_geometry |
| SoSFNode | set_metadata |
eventOut
| SoSFNode | appearance_changed |
| SoSFNode | geometry_changed |
| SoSFNode | metadata_changed |
Member Enumeration Documentation
Constructor & Destructor Documentation
| SoVRMLShape::SoVRMLShape | ( | ) |
Constructor.
Member Function Documentation
| static SoType SoVRMLShape::getClassTypeId | ( | ) | [static] |
Returns the type identifier for this class.
Reimplemented from SoVRMLNode.
| static SoDEPRECATED int SoVRMLShape::getNumRenderCaches | ( | ) | [static] |
Returns the current number of render caches.
| virtual SoType SoVRMLShape::getTypeId | ( | ) | const [virtual] |
Returns the type identifier for this specific instance.
Reimplemented from SoVRMLNode.
| virtual SbBool SoVRMLShape::isOverride | ( | ) | const [inline, virtual] |
Returns the state of the override field.
Reimplemented from SoNode.
| static SoDEPRECATED void SoVRMLShape::setNumRenderCaches | ( | int | howMany | ) | [static] |
Sets the maximum number of render caches.
| virtual void SoVRMLShape::setOverride | ( | const SbBool | state | ) | [inline, virtual] |
Friends And Related Function Documentation
friend class SoPath [friend] |
friend class SoTraversalPassImpl [friend] |
Member Data Documentation
Specifies an SoVRMLAppearance node that defines the visual attributes.
Center of a bounding box that encloses the children.
Size of a bounding box that encloses the children.
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.
A geometry node.
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.
The documentation for this class was generated from the following file: