Linux Certif

Toute la documentation sur la certification Linux LPI

SoCone.3coin2

NAME

SoCone -

The SoCone class is for rendering cone shapes.

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

SYNOPSIS

#include <Inventor/nodes/SoCone.h>

Inherits SoShape.

Public Types

enum Part { SIDES = 0x01, BOTTOM = 0x02, ALL = (SIDES|BOTTOM) }

Public Member Functions

SoCone (void)

void addPart (SoCone::Part part)

void removePart (SoCone::Part part)

SbBool hasPart (SoCone::Part part) const

virtual void GLRender (SoGLRenderAction *action)

virtual void rayPick (SoRayPickAction *action)

virtual void getPrimitiveCount (SoGetPrimitiveCountAction *action)

Static Public Member Functions

static void initClass (void)

Public Attributes

SoSFBitMask parts

SoSFFloat bottomRadius

SoSFFloat height

Protected Member Functions

virtual ~SoCone ()

virtual void generatePrimitives (SoAction *action)

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

Detailed Description

The SoCone class is for rendering cone shapes.

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

The SoCone 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 cone is visualized by the underlying rendering system by first tessellating the conceptual cone into a set of polygons. To control the trade-off between an as much as possible correct visual appearance of the cone 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 cone 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.

FILE FORMAT/DEFAULTS:

     Cone {
         bottomRadius 1
         height 2
         parts (SIDES | BOTTOM)
     }
 
 

See also:

SoCylinder, SoSphere, SoCube

Member Enumeration Documentation

enum SoCone::PartEnumerates the various parts of the cone, for setting inclusion or exclusion from the shape.

Constructor & Destructor Documentation

SoCone::SoCone (void)Constructor.

References bottomRadius, height, and parts.

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

Member Function Documentation

void SoCone::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 SoCone::addPart (SoCone::Part part)Add a part to the cone.

See also:

removePart(), hasPart()

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

void SoCone::removePart (SoCone::Part part)Remove a part from the cone.

See also:

addPart(), hasPart()

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

SbBool SoCone::hasPart (SoCone::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 SoCone::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 bottomRadius, SoFieldContainer::get(), SoShape::getComplexityValue(), SoAction::getState(), height, parts, SoDebugError::postInfo(), and SoShape::shouldGLRender().

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

Reimplemented from SoShape.

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

void SoCone::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 SoCone::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 bottomRadius, SoFieldContainer::get(), SoShape::getComplexityValue(), SoAction::getState(), height, and parts.

void SoCone::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 bottomRadius, height, parts, SbBox3f::setBounds(), and SbVec3f::setValue().

Member Data Documentation

SoSFBitMask SoCone::partsThe parts to use for the cone shape. Defaults to SoCone::ALL.

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

SoSFFloat SoCone::bottomRadiusRadius of the cone's bottom disc. Default value is 1.0.

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

SoSFFloat SoCone::heightHeight of cone. Default value is 2.0.

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

Author

Generated automatically by Doxygen for Coin from the source code.