SoVRMLCylinder Class

Note: This API is now obsolete.

Cylinder shape node.

Inheritance Hierarchy

SystemObject
  OIV.InventorSoNetBase
    OIV.InventorSoDisposable
      OIV.Inventor.MiscSoBase
        OIV.Inventor.FieldsSoFieldContainer
          OIV.Inventor.NodesSoNode
            OIV.Inventor.NodesSoShape
              OIV.Inventor.VRMLnodesSoVRMLGeometry
                OIV.Inventor.VRMLnodesSoVRMLCylinder

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 SoVRMLCylinder : SoVRMLGeometry

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

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

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

The SoVRMLCylinder type exposes the following members.

Constructors

	Name	Description
	SoVRMLCylinder	Constructor.

Top

Methods

	Name	Description
	AffectsState	Overrides default method on SoNode. (Inherited from SoShape.)
	BeginShape(SoAction, SoShapeTriangleShapes)	Calls BeginShape(action, shapeType, (OIV.Inventor.Details.SoFaceDetail ^)nullptr). (Inherited from SoShape.)
	BeginShape(SoAction, SoShapeTriangleShapes, SoFaceDetail)	These methods can be used by subclasses to generate triangles more easily when those triangles are part of a larger structure, such as a triangle strip, triangle fan, or triangulated polygon, according to the TriangleShape enumerated type. (Inherited from SoShape.)
	Callback	Implements primitive generation for all shapes. (Inherited from SoShape.)
	CallShouldGLRender	Obsolete. Calls CallShouldGLRender(action, false). (Inherited from SoShape.)
	ComputeBBox(SoAction, SbXfBox3d, SbVec3d)	Compute object oriented bounding box (OOB) for subclass using information in the given action (which may not necessarily be an SoGetBoundingBoxAction). (Inherited from SoShape.)
	ComputeBBox(SoAction, SbBox3f, SbVec3f)	Compute axis aligned bounding box (AABB) for subclass using information in the given action (which may not necessarily be an SoGetBoundingBoxAction). (Overrides SoShapeComputeBBox(SoAction, SbBox3f, SbVec3f).)
	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	(Inherited from SoNode.)
	EnableNotify	Notification at this Field Container is enabled (if flag == true) or disabled (if flag == false). (Inherited from SoFieldContainer.)
	EndShape	end shape previously started with beginShape(). (Inherited from SoShape.)
	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.)
	GeneratePick	(Overrides SoVRMLGeometryGeneratePick(SoRayPickAction, SoNode).)
	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	Implements bounding box method using virtual computeBBox() method. (Inherited from SoShape.)
	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.)
	GetPrimitiveCount	Counts number of primitives produced by this shape. (Overrides SoShapeGetPrimitiveCount(SoGetPrimitiveCountAction).)
	GetRenderUnitID	(Inherited from SoNode.)
	GetShapeType	Gets the current shape Full Scene Antialiasing type. (Inherited from SoShape.)
	GetStringName	(Inherited from SoBase.)
	GetType	Gets the Type of the current instance. (Inherited from Object.)
	GLRender	Implements rendering by rendering each primitive generated by subclass. (Overrides SoShapeGLRender(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.)
	HandleInvisibleOrBBox	Obsolete. Calls HandleInvisibleOrBBox(action, false). (Inherited from SoShape.)
	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 flag. (Inherited from SoNode.)
	IsSynchronizable	Gets the ScaleViz synchronizable state of this object. (Inherited from SoBase.)
	IsTransparent	(Inherited from SoVRMLGeometry.)
	Pick	(Inherited from SoNode.)
	RayPick	Implements picking along a ray by intersecting the ray with each primitive generated by subclass. (Inherited from SoShape.)
	Search	(Inherited from SoNode.)
	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.)
	SetOverride	Turns the override flag on or off. (Inherited from SoNode.)
	SetShapeType	set the antialiasing type for this shape. (Inherited from SoShape.)
	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.)
	ShapeVertex	add a primitive vertex to the shape prevously started with beginShape(). (Inherited from SoShape.)
	ShouldGLRender	Obsolete. Calls ShouldGLRender(action, false). (Inherited from SoVRMLGeometry.)
	ShouldGLRenderCore(SoGLRenderAction)	Obsolete. Calls ShouldGLRenderCore(action, false, false). (Inherited from SoShape.)
	ShouldGLRenderCore(SoGLRenderAction, Boolean)	Obsolete. Calls ShouldGLRenderCore(action, isPointsOrLines, false). (Inherited from SoShape.)
	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
	bottom	Specifies whether the bottom cap is created.
	boundingBoxIgnoring	Whether to ignore this node during bounding box traversal. (Inherited from SoShape.)
	height
	IsDisposable	ISafeDisposable interface implementation. (Inherited from SoDisposable.)
	metadata	Specifies the metadata node. (Inherited from SoVRMLGeometry.)
	radius	Specifies the cylinder's height and radius; values must be greater than 0.0.
	side	Specifies whether the sides are created.
	solid	Determines whether the cylinder is visible when viewed from the inside.
	top	Specifies whether the top cap is created.
	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.

OpenGL vertex arrays are used if they are available and if the environment variable IV_NO_VERTEX_ARRAY is not set.

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 SoVRMLCylinder node specifies a capped cylinder centered at (0,0,0) in the local coordinate system and with a central axis oriented along the local Y-axis. By default, the cylinder is sized at -1 to +1 in all three dimensions. The radius field specifies the cylinder's radius and the height field specifies the cylinder's height along the central axis. Both radius and height must be greater than 0.0.

The cylinder has three parts : the side, the top (Y = +height) and the bottom (Y = -height). Each part has an associated SFBool field that indicates whether the part exists (true) or does not exist (false). If the parts do not exist, they are not considered during collision detection.

When a texture is applied to a cylinder, it is applied differently to the sides, top, and bottom. On the sides, the texture wraps counterclockwise (from above) starting at the back of the cylinder. The texture has a vertical seam at the back, intersecting the YZ plane. For the top and bottom caps, a circle is cut out of the unit texture square centered at (0, +/- height, 0) with dimensions 2*radius by 2*radius. The top texture appears right side up when the top of the cylinder is tilted toward the +Z axis, and the bottom texture appears right side up when the top of the cylinder is tilted toward the -Z axis. SoVRMLTextureTransform affects the texture coordinates of the SoVRMLCylinder.

The SoVRMLCylinder geometry is considered to be solid and thus requires outside faces only. When viewed from the inside the results are undefined.

FILE FORMAT/DEFAULT

VRMLCylinder {
bottom true
height 2
radius 1
side true
top true
solid true
metadata NULL
}

ACTION BEHAVIOR

SoGLRenderAction, SoRayPickAction, SoGetBoundingBoxAction, SoCallbackAction

eventIn

SoSFNode set_metadata

eventOut

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

bottom	true
height	2
radius	1
side	true
top	true
solid	true
metadata	NULL