SoVRMLShape Class

SoVRMLShape Class

Note: This API is now obsolete.

Defines a shape by specifying its appearance and geometry.

Inheritance Hierarchy

SystemObject
  OIV.InventorSoNetBase
    OIV.InventorSoDisposable
      OIV.Inventor.MiscSoBase
        OIV.Inventor.FieldsSoFieldContainer
          OIV.Inventor.NodesSoNode
            OIV.Inventor.VRMLnodesSoVRMLNode
              OIV.Inventor.VRMLnodesSoVRMLShape

Namespace: OIV.Inventor.VRMLnodes
Assembly: OIV.Inventor (in OIV.Inventor.dll) Version: 9.9.13.0 (9.9.13.0)

Syntax

C++

Copy

[ObsoleteAttribute("See documentation for more details")]
[EditorBrowsableAttribute(EditorBrowsableState.Never)]
public class SoVRMLShape : SoVRMLNode

<ObsoleteAttribute("See documentation for more details")>
<EditorBrowsableAttribute(EditorBrowsableState.Never)>
Public Class SoVRMLShape
	Inherits SoVRMLNode

[ObsoleteAttribute(L"See documentation for more details")]
[EditorBrowsableAttribute(EditorBrowsableState::Never)]
public ref class SoVRMLShape : public SoVRMLNode

[<ObsoleteAttribute("See documentation for more details")>]
[<EditorBrowsableAttribute(EditorBrowsableState.Never)>]
type SoVRMLShape =  
    class
        inherit SoVRMLNode
    end

The SoVRMLShape type exposes the following members.

Constructors

	Name	Description
	SoVRMLShape	Constructor.

Top

Methods

	Name	Description
	AffectsState	Returns true if a node has an effect on the state during traversal. (Overrides SoNodeAffectsState.)
	Callback	(Overrides SoNodeCallback(SoCallbackAction).)
	Copy	Calls Copy(false). (Inherited from SoNode.)
	Copy(Boolean)	Creates and returns an exact copy of the node. (Inherited from SoNode.)
	CopyFieldValues(SoFieldContainer)	Calls CopyFieldValues(fc, false). (Inherited from SoFieldContainer.)
	CopyFieldValues(SoFieldContainer, Boolean)	Copies the contents of fc's fields into this object's fields. (Inherited from SoFieldContainer.)
	Dispose	Releases all resources used by SoDisposable. (Inherited from SoDisposable.)
	Distribute	(Inherited from SoNode.)
	DoAction	(Overrides SoNodeDoAction(SoAction).)
	EnableNotify	Notification at this Field Container is enabled (if flag == true) or disabled (if flag == false). (Inherited from SoFieldContainer.)
	Equals	Determines whether the specified Object is equal to the current Object. (Inherited from Object.)
	FieldsAreEqual	Returns true if this object's fields are exactly equal to fc's fields. (Inherited from SoFieldContainer.)
	Get	Returns the values of the fields of this object in the Open Inventor ASCII file format in the given string. (Inherited from SoFieldContainer.)
	GetAllFields	Returns a list of fields, including the eventIn's and eventOut's. (Inherited from SoFieldContainer.)
	GetAlternateRep	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.)
	GetBoundingBox	(Overrides SoNodeGetBoundingBox(SoGetBoundingBoxAction).)
	GetEventIn	Returns a the eventIn with the given name. (Inherited from SoFieldContainer.)
	GetEventOut	Returns the eventOut with the given name. (Inherited from SoFieldContainer.)
	GetField	Returns a the field of this object whose name is fieldName. (Inherited from SoFieldContainer.)
	GetFieldName	Returns the name of the given field in the fieldName argument. (Inherited from SoFieldContainer.)
	GetFields	Appends references to all of this object's fields to resultList, and returns the number of fields appended. (Inherited from SoFieldContainer.)
	GetHashCode	Overrides GetHashCode(). (Inherited from SoNetBase.)
	GetMatrix	(Inherited from SoNode.)
	GetName	Returns the name of an instance. (Inherited from SoBase.)
	GetNumRenderCaches	Obsolete. Returns the current number of render caches.
	GetPrimitiveCount	(Overrides SoNodeGetPrimitiveCount(SoGetPrimitiveCountAction).)
	GetRenderUnitID	(Inherited from SoNode.)
	GetStringName	(Inherited from SoBase.)
	GetType	Gets the Type of the current instance. (Inherited from Object.)
	GLRender	(Overrides SoVRMLNodeGLRender(SoGLRenderAction).)
	GLRenderBelowPath	(Inherited from SoNode.)
	GLRenderInPath	(Inherited from SoNode.)
	GLRenderOffPath	(Inherited from SoNode.)
	GrabEventsCleanup	(Inherited from SoNode.)
	GrabEventsSetup	(Inherited from SoNode.)
	HandleEvent	(Inherited from SoNode.)
	HasDefaultValues	Returns true if all of the object's fields have their default values. (Inherited from SoFieldContainer.)
	IsBoundingBoxIgnoring	This method is used by getBoundingBox action traversal to know if the current node must be traversed or not, ie the bounding should be ignored. (Inherited from SoNode.)
	IsNotifyEnabled	Notification is the process of telling interested objects that this object has changed. (Inherited from SoFieldContainer.)
	IsOverride	Returns the state of the override field. (Overrides SoNodeIsOverride.)
	IsSynchronizable	Gets the ScaleViz synchronizable state of this object. (Inherited from SoBase.)
	Pick	(Inherited from SoNode.)
	RayPick	(Overrides SoNodeRayPick(SoRayPickAction).)
	Search	(Overrides SoNodeSearch(SoSearchAction).)
	Set	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.)
	SetName	(Inherited from SoBase.)
	SetNumRenderCaches	Obsolete. Sets the maximum number of render caches.
	SetOverride	(Overrides SoNodeSetOverride(Boolean).)
	SetSynchronizable	Sets this to be a ScaleViz synchronizable object. (Inherited from SoBase.)
	SetToDefaults	Sets all fields in this object to their default values. (Inherited from SoFieldContainer.)
	ToString	Converts this SoBase structure to a human readable string. (Inherited from SoBase.)
	Touch	Marks an instance as modified, simulating a change to it. (Inherited from SoNode.)
	Write	(Inherited from SoNode.)

Top

Properties

	Name	Description
	appearance	Specifies an SoVRMLAppearance node that defines the visual attributes.
	bboxCenter	Center of a bounding box that encloses the children.
	bboxSize	Size of a bounding box that encloses the children.
	boundingBoxCaching	Whether to cache during bounding box traversal.
	geometry	A geometry node.
	IsDisposable	ISafeDisposable interface implementation. (Inherited from SoDisposable.)
	metadata	Specifies the metadata node. (Inherited from SoVRMLNode.)
	renderCaching	Whether to cache during rendering traversal.
	UserData	Gets or sets the user data to be contained by the field container. (Inherited from SoFieldContainer.)

Top

Remarks

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

Reference

OIV.Inventor.VRMLnodes Namespace

appearance	NULL
geometry	NULL
bboxCenter	0 0 0
bboxSize	-1 -1 -1
metadata	NULL
renderCaching	AUTO
boundingBoxCaching	AUTO

SoSFNode	set_appearance
SoSFNode	set_geometry
SoSFNode	set_metadata

SoSFNode	appearance_changed
SoSFNode	geometry_changed
SoSFNode	metadata_changed