Linux Certif

Toute la documentation sur la certification Linux LPI

SoCylinder.3coin2

NAME

SoCylinder -

The SoCylinder class is for rendering cylinder shapes.

Insert a cylinder shape into the scenegraph. The cylinder is rendered with the current material, texture and drawstyle settings (if any, otherwise the default settings are used).

SYNOPSIS

#include <Inventor/nodes/SoCylinder.h>

Inherits SoShape.

Public Types

enum Part { SIDES = 0x1, TOP = 0x2, BOTTOM = 0x4, ALL = SIDES|TOP|BOTTOM }

Public Member Functions

SoCylinder (void)

void addPart (SoCylinder::Part part)

void removePart (SoCylinder::Part part)

SbBool hasPart (SoCylinder::Part part) const

virtual void rayPick (SoRayPickAction *action)

virtual void getPrimitiveCount (SoGetPrimitiveCountAction *action)

virtual void GLRender (SoGLRenderAction *action)

Static Public Member Functions

static void initClass (void)

Public Attributes

SoSFFloat radius

SoSFFloat height

SoSFBitMask parts

Protected Member Functions

virtual ~SoCylinder ()

virtual void generatePrimitives (SoAction *action)

virtual void computeBBox (SoAction *action, SbBox3f &box, SbVec3f &center)

Detailed Description

The SoCylinder class is for rendering cylinder shapes.

Insert a cylinder shape into the scenegraph. The cylinder is rendered with the current material, texture and drawstyle settings (if any, otherwise the default settings are used).

The SoCylinder node class is provided as a convenient abstraction for the application programmer to use 'complex' shapes of this type without having to do the tessellation to polygons and other low-level programming herself.

A cylinder is visualized by the underlying rendering system by first tessellating the conceptual cylinder into a set of polygons. To control the trade-off between an as much as possible correct visual appearance of the cylinder versus fast rendering, use an SoComplexity node to influence the number of polygons generated from the tessellation process. (The higher the complexity value, the more polygons will be generated, the more rounded the sides of the cylinder will look.) Set the SoComplexity::value field to what you believe would be a good trade-off between correctness and speed for your particular application.

A nice trick for rendering a disc is to render an SoCylinder with SoCylinder::height set to zero:

   #Inventor V2.1 ascii
   
   ShapeHints { # to get two-sided lighting on the disc
      vertexOrdering COUNTERCLOCKWISE
      shapeType UNKNOWN_SHAPE_TYPE
   }
   
   Cylinder {
      height 0
      parts TOP
   }
 

FILE FORMAT/DEFAULTS:

     Cylinder {
         radius 1
         height 2
         parts (SIDES | TOP | BOTTOM)
     }
 
 

See also:

SoCone, SoSphere, SoCube

Member Enumeration Documentation

enum SoCylinder::PartThe parts of a cylinder shape.

Constructor & Destructor Documentation

SoCylinder::SoCylinder (void)Constructor.

References height, parts, and radius.

SoCylinder::~SoCylinder () [protected, virtual]Destructor.

Member Function Documentation

void SoCylinder::initClass (void) [static]Sets up initialization for data common to all instances of this class, like submitting necessary information to the Coin type system.

Reimplemented from SoShape.

References SoNode::VRML1.

void SoCylinder::addPart (SoCylinder::Part part)Add a part to the cylinder.

See also:

removePart(), hasPart()

References hasPart(), parts, and SoDebugError::postWarning().

void SoCylinder::removePart (SoCylinder::Part part)Remove a part from the cylinder.

See also:

addPart(), hasPart()

References hasPart(), parts, and SoDebugError::postWarning().

SbBool SoCylinder::hasPart (SoCylinder::Part part) constReturns TRUE if rendering of the given part is currently turned on.

See also:

addPart(), removePart()

References parts.

Referenced by addPart(), and removePart().

void SoCylinder::rayPick (SoRayPickAction * action) [virtual]Calculates picked point based on primitives generated by subclasses.

Reimplemented from SoShape.

References SoFieldContainer::get(), SoAction::getState(), height, parts, radius, and SoShape::shouldRayPick().

void SoCylinder::getPrimitiveCount (SoGetPrimitiveCountAction * action) [virtual]Action method for the SoGetPrimitiveCountAction.

Calculates the number of triangle, line segment and point primitives for the node and adds these to the counters of the action.

Nodes influencing how geometry nodes calculates their primitive count also overrides this method to change the relevant state variables.

Reimplemented from SoShape.

References SoGetPrimitiveCountAction::addNumTriangles(), SoShape::getComplexityValue(), parts, and SoShape::shouldPrimitiveCount().

void SoCylinder::GLRender (SoGLRenderAction * action) [virtual]Action method for the SoGLRenderAction.

This is called during rendering traversals. Nodes influencing the rendering state in any way or who wants to throw geometry primitives at OpenGL overrides this method.

Reimplemented from SoShape.

References SoFieldContainer::get(), SoShape::getComplexityValue(), SoAction::getState(), height, parts, radius, and SoShape::shouldGLRender().

void SoCylinder::generatePrimitives (SoAction * action) [protected, virtual]The method implements action behavior for shape nodes for SoCallbackAction. It is invoked from SoShape::callback(). (Subclasses should not override SoNode::callback().)

The subclass implementations uses the convenience methods SoShape::beginShape(), SoShape::shapeVertex(), and SoShape::endShape(), with SoDetail instances, to pass the primitives making up the shape back to the caller.

Implements SoShape.

References SoFieldContainer::get(), SoShape::getComplexityValue(), SoAction::getState(), height, parts, and radius.

void SoCylinder::computeBBox (SoAction * action, SbBox3f & box, SbVec3f & center) [protected, virtual]Implemented by SoShape subclasses to let the SoShape superclass know the exact size and weighted center point of the shape's bounding box.

The bounding box and center point should be calculated and returned in the local coordinate system.

The method implements action behavior for shape nodes for SoGetBoundingBoxAction. It is invoked from SoShape::getBoundingBox(). (Subclasses should not override SoNode::getBoundingBox().)

The box parameter sent in is guaranteed to be an empty box, while center is undefined upon function entry.

Implements SoShape.

References height, parts, radius, SbBox3f::setBounds(), and SbVec3f::setValue().

Member Data Documentation

SoSFFloat SoCylinder::radiusRadius of cylinder. Default value 1.0.

Referenced by computeBBox(), generatePrimitives(), GLRender(), rayPick(), and SoCylinder().

SoSFFloat SoCylinder::heightHeight of cylinder. Default is 2.0.

Referenced by computeBBox(), generatePrimitives(), GLRender(), rayPick(), and SoCylinder().

SoSFBitMask SoCylinder::partsWhich parts to use for rendering, picking, etc. Defaults to SoCylinder::ALL.

Referenced by addPart(), computeBBox(), generatePrimitives(), getPrimitiveCount(), GLRender(), hasPart(), rayPick(), removePart(), and SoCylinder().

Author

Generated automatically by Doxygen for Coin from the source code.