NAME

       SoCube -

       The SoCube class is for rendering cubes.

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

SYNOPSIS

       #include <Inventor/nodes/SoCube.h>

       Inherits SoShape.

   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.
       SoCube (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 width
       SoSFFloat height
       SoSFFloat depth

   Protected Member Functions
       virtual const SoFieldData * getFieldData (void) const
       virtual ~SoCube ()
       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 SoCube class is for rendering cubes.

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

       (Strictly speaking, as you can have different width, height and depth values for the 'cube', instances of
       this class actually represents boxes.)

       The SoCube node class is provided as a convenient abstraction for the application programmer to use
       'complex' shapes of this type without having to do the calculation and book-keeping of the polygon sides
       and other low-level programming herself.

       FILE FORMAT/DEFAULTS:

       Cube {
           width 2
           height 2
           depth 2
       }

       See Also:
           SoCylinder, SoSphere, SoCone

Constructor & Destructor Documentation

   SoCube::SoCube (void)
       Constructor.

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

Member Function Documentation

   SoType SoCube::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 SoShape.

   const SoFieldData * SoCube::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 SoShape.

   void SoCube::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 SoCube::rayPick (SoRayPickAction *action) [virtual]
       Calculates picked point based on primitives generated by subclasses.

       Reimplemented from SoShape.

   void SoCube::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 SoCube::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 SoCube::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 SoCube::width
       X axis dimension of cube, defaults to 2.0.

   SoSFFloat SoCube::height
       Y axis dimension of cube, defaults to 2.0.

   SoSFFloat SoCube::depth
       Z axis dimension of cube, defaults to 2.0.

Author

       Generated automatically by Doxygen for Coin from the source code.