com.openinventor.inventor.vrmlnodes

Class SoVRMLCylinder

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

com.openinventor.inventor.vrmlnodes.SoVRMLGeometry

com.openinventor.inventor.vrmlnodes.SoVRMLCylinder

All Implemented Interfaces:

SafeDisposable

Deprecated.

As of Open Inventor 9500 See documentation for more details

public class SoVRMLCylinder
extends SoVRMLGeometry

Cylinder shape node. 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

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/interfaces inherited from class com.openinventor.inventor.nodes.SoShape

SoShape.ShapeTypes

Nested classes/interfaces inherited from class com.openinventor.inventor.Inventor

Inventor.ConstructorCommand

Field Summary

Fields

Modifier and Type	Field and Description
SoSFBool	bottom Deprecated. Specifies whether the bottom cap is created.
SoSFFloat	height Deprecated.
SoSFFloat	radius Deprecated. Specifies the cylinder's height and radius; values must be greater than 0.0.
SoSFBool	side Deprecated. Specifies whether the sides are created.
SoSFBool	solid Deprecated. Determines whether the cylinder is visible when viewed from the inside.
SoSFBool	top Deprecated. Specifies whether the top cap is created.

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

metadata

Fields inherited from class com.openinventor.inventor.nodes.SoShape

boundingBoxIgnoring, LINES, POINTS, POLYGONS, TEXT

Fields inherited from class com.openinventor.inventor.Inventor

VERBOSE_LEVEL, ZeroHandle

Constructor Summary

Constructors

Constructor and Description
SoVRMLCylinder() Deprecated. Constructor.

Method Summary

Methods inherited from class com.openinventor.inventor.nodes.SoShape

getShapeType, isPrimitiveRestartAvailable, isPrimitiveRestartAvailable

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

radius

public final SoSFFloat radius

Deprecated.

Specifies the cylinder's height and radius; values must be greater than 0.0.

height

public final SoSFFloat height

Deprecated.

side

public final SoSFBool side

Deprecated.

Specifies whether the sides are created.

top

public final SoSFBool top

Deprecated.

Specifies whether the top cap is created.

bottom

public final SoSFBool bottom

Deprecated.

Specifies whether the bottom cap is created.

solid

public final SoSFBool solid

Deprecated.

Determines whether the cylinder is visible when viewed from the inside.

Since:

Open Inventor 5.0 NOTE 2: 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

SoVRMLCylinder

public SoVRMLCylinder()

Deprecated.

Constructor.