com.openinventor.inventor.vrmlnodes

Class SoVRMLShape

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.vrmlnodes.SoVRMLNode

com.openinventor.inventor.vrmlnodes.SoVRMLShape

All Implemented Interfaces:

SafeDisposable

Deprecated.

As of Open Inventor 9500 See documentation for more details

public class SoVRMLShape
extends SoVRMLNode

Defines a shape by specifying its appearance and geometry. See the VRML97 Specification, below.

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

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:

SoGLRenderAction, SoRayPickAction, SoGetBoundingBoxAction, SoCallbackAction
Sets: SoCacheElement

EVENTS

eventIn

SoSFNode	set_appearance
SoSFNode	set_geometry
SoSFNode	set_metadata

eventOut

SoSFNode	appearance_changed
SoSFNode	geometry_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	SoVRMLShape.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
SoSFNode	appearance Deprecated. Specifies an SoVRMLAppearance node that defines the visual attributes.
static int	AUTO Deprecated. Use SoVRMLShape.Cachings.AUTO instead.
SoSFVec3f	bboxCenter Deprecated. Center of a bounding box that encloses the children.
SoSFVec3f	bboxSize Deprecated. Size of a bounding box that encloses the children.
SoSFEnum<SoVRMLShape.Cachings>	boundingBoxCaching Deprecated. Whether to cache during bounding box traversal.
SoSFNode	geometry Deprecated. A geometry node.
static int	OFF Deprecated. Use SoVRMLShape.Cachings.OFF instead.
static int	ON Deprecated. Use SoVRMLShape.Cachings.ON instead.
SoSFEnum<SoVRMLShape.Cachings>	renderCaching Deprecated. Whether to cache during rendering traversal.

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

metadata

Fields inherited from class com.openinventor.inventor.Inventor

VERBOSE_LEVEL, ZeroHandle

Constructor Summary

Constructors

Constructor and Description
SoVRMLShape() Deprecated. Constructor.

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.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 SoVRMLShape.Cachings.OFF instead.

ON

@Deprecated
public static final int ON

Deprecated. Use SoVRMLShape.Cachings.ON instead.

AUTO

@Deprecated
public static final int AUTO

Deprecated. Use SoVRMLShape.Cachings.AUTO instead.

appearance

public final SoSFNode appearance

Deprecated.

Specifies an SoVRMLAppearance node that defines the visual attributes.

geometry

public final SoSFNode geometry

Deprecated.

A geometry node.

bboxCenter

public final SoSFVec3f bboxCenter

Deprecated.

Center of a bounding box that encloses the children.

bboxSize

public final SoSFVec3f bboxSize

Deprecated.

Size of a bounding box that encloses the children.

renderCaching

public final SoSFEnum<SoVRMLShape.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<SoVRMLShape.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.

Constructor Detail

SoVRMLShape

public SoVRMLShape()

Deprecated.

Constructor.

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.