NAME

       SoVRMLCone -

       The SoVRMLCone class is used to represent a Cone object.

       The detailed class documentation is taken verbatim from the VRML97 standard (ISO/IEC
       14772-1:1997). It is copyright The Web3D Consortium, and is used by permission of the
       Consortium:

SYNOPSIS

       #include <Inventor/VRMLnodes/SoVRMLCone.h>

       Inherits SoVRMLGeometry.

   Public Member Functions
       virtual SoType getTypeId (void) const
           Returns the type identification of an object derived from a class inheriting SoBase.
           This is used for run-time type checking and 'downward' casting.
       SoVRMLCone (void)
       virtual void GLRender (SoGLRenderAction *action)
       virtual void rayPick (SoRayPickAction *action)
       virtual void getPrimitiveCount (SoGetPrimitiveCountAction *action)

   Static Public Member Functions
       static SoType getClassTypeId (void)
       static void initClass (void)

   Public Attributes
       SoSFFloat bottomRadius
       SoSFFloat height
       SoSFBool side
       SoSFBool bottom

   Protected Member Functions
       virtual const SoFieldData * getFieldData (void) const
       virtual ~SoVRMLCone ()
       virtual void generatePrimitives (SoAction *action)
       virtual void computeBBox (SoAction *action, SbBox3f &box, SbVec3f &center)

   Static Protected Member Functions
       static const SoFieldData ** getFieldDataPtr (void)

   Additional Inherited Members

Detailed Description

       The SoVRMLCone class is used to represent a Cone object.

       The detailed class documentation is taken verbatim from the VRML97 standard (ISO/IEC
       14772-1:1997). It is copyright The Web3D Consortium, and is used by permission of the
       Consortium:

       Cone {
         field     SFFloat   bottomRadius 1        # (0, inf)
         field     SFFloat   height       2        # (0, inf)
         field     SFBool    side         TRUE
         field     SFBool    bottom       TRUE
       }

       The Cone node specifies a cone which is centred in the local coordinate system and whose
       central axis is aligned with the local Y-axis. The bottomRadius field specifies the radius
       of the cone's base, and the height field specifies the height of the cone from the centre
       of the base to the apex. By default, the cone has a radius of 1.0 at the bottom and a
       height of 2.0, with its apex at y = height/2 and its bottom at y = -height/2. Both
       bottomRadius and height shall be greater than zero. Figure 6.3 illustrates the Cone node.

         Figure 6.3

       The side field specifies whether sides of the cone are created and the bottom field
       specifies whether the bottom cap of the cone is created. A value of TRUE specifies that
       this part of the cone exists, while a value of FALSE specifies that this part does not
       exist (not rendered or eligible for collision or sensor intersection tests). When a
       texture is applied to the sides of the cone, the texture wraps counterclockwise (from
       above) starting at the back of the cone. The texture has a vertical seam at the back in
       the X=0 plane, from the apex (0, height/2, 0) to the point (0, -height/2, - bottomRadius).
       For the bottom cap, a circle is cut out of the texture square centred at (0, -height/2, 0)
       with dimensions (2 × bottomRadius) by (2 × bottomRadius). The bottom cap texture appears
       right side up when the top of the cone is rotated towards the -Z-axis.
       SoVRMLTextureTransform affects the texture coordinates of the Cone.

       The Cone geometry requires outside faces only. When viewed from the inside the results are
       undefined.

Constructor & Destructor Documentation

   SoVRMLCone::SoVRMLCone (void)
       Constructor.

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

Member Function Documentation

   SoType SoVRMLCone::getTypeId (void) const [virtual]
       Returns the type identification of an object derived from a class inheriting SoBase. This
       is used for run-time type checking and 'downward' casting. Usage example:

       void foo(SoNode * node)
       {
         if (node->getTypeId() == SoFile::getClassTypeId()) {
           SoFile * filenode = (SoFile *)node;  // safe downward cast, knows the type
         }
       }

       For application programmers wanting to extend the library with new nodes, engines,
       nodekits, draggers or others: this method needs to be overridden in all subclasses. This
       is typically done as part of setting up the full type system for extension classes, which
       is usually accomplished by using the pre-defined macros available through for instance
       Inventor/nodes/SoSubNode.h (SO_NODE_INIT_CLASS and SO_NODE_CONSTRUCTOR for node classes),
       Inventor/engines/SoSubEngine.h (for engine classes) and so on.

       For more information on writing Coin extensions, see the class documentation of the
       toplevel superclasses for the various class groups.

       Reimplemented from SoVRMLGeometry.

   const SoFieldData * SoVRMLCone::getFieldData (void) const [protected],  [virtual]
       Returns a pointer to the class-wide field data storage object for this instance. If no
       fields are present, returns NULL.

       Reimplemented from SoVRMLGeometry.

   void SoVRMLCone::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.

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

       Reimplemented from SoShape.

   void SoVRMLCone::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.

   void SoVRMLCone::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.

   void SoVRMLCone::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.

Member Data Documentation

   SoSFFloat SoVRMLCone::bottomRadius
       The cone bottom radius. Default value is 1.0.

   SoSFFloat SoVRMLCone::height
       The cone height. Default value is 2.0.

   SoSFBool SoVRMLCone::side
       Enable/disable the cone side wall. Default value is TRUE.

   SoSFBool SoVRMLCone::bottom
       Enable/disable the cone bottom. Default value is TRUE.

Author

       Generated automatically by Doxygen for Coin from the source code.