SoVRMLCylinder Class Reference
[VRML97 nodes]
Cylinder shape node.
More...
#include <Inventor/VRMLnodes/SoVRMLCylinder.h>
Classes | |
| struct | MTstruct |
Public Member Functions | |
| virtual SoType | getTypeId () const |
| SoVRMLCylinder () | |
Static Public Member Functions | |
| static SoType | getClassTypeId () |
Public Attributes | |
| SoSFFloat | radius |
| SoSFFloat | height |
| SoSFBool | side |
| SoSFBool | top |
| SoSFBool | bottom |
| SoSFBool | solid |
Detailed Description
Cylinder shape node.
See the VRML97 Specification, below.
NOTE: 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
- 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. - Inventor/VRMLnodes/SoVRMLCylinder.h
eventIn
| SoSFNode | set_metadata |
eventOut
| SoSFNode | metadata_changed |
Constructor & Destructor Documentation
| SoVRMLCylinder::SoVRMLCylinder | ( | ) |
Constructor.
Member Function Documentation
| static SoType SoVRMLCylinder::getClassTypeId | ( | ) | [static] |
Returns the type identifier for this class.
Reimplemented from SoVRMLGeometry.
| virtual SoType SoVRMLCylinder::getTypeId | ( | ) | const [virtual] |
Returns the type identifier for this specific instance.
Reimplemented from SoVRMLGeometry.
Member Data Documentation
Specifies whether the bottom cap is created.
Specifies the cylinder's height and radius; values must be greater than 0.0.
Specifies whether the sides are created.
Determines whether the cylinder is visible when viewed from the inside. NOTE: field available 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.
Specifies whether the top cap is created.
The documentation for this class was generated from the following file: