SoVRMLSphere.3coin3 man page

SoVRMLSphere — The SoVRMLSphere class is used to represent a spherical 3D 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/SoVRMLSphere.h>

Inherits SoVRMLGeometry.

Public Member Functions

virtual SoType getTypeId (void) const

SoVRMLSphere (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 radius

Protected Member Functions

virtual const SoFieldData * getFieldData (void) const

virtual ~SoVRMLSphere ()

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 SoVRMLSphere class is used to represent a spherical 3D 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:

Sphere {
  field SFFloat radius  1    # (0, inf)
}

The Sphere node specifies a sphere centred at (0, 0, 0) in the local coordinate system. The radius field specifies the radius of the sphere and shall be greater than zero. Figure 6.15 depicts the fields of the Sphere node.

Figure 6.15 -- Sphere node

When a texture is applied to a sphere, the texture covers the entire surface, wrapping counterclockwise from the back of the sphere (i.e., longitudinal arc intersecting the -Z-axis) when viewed from the top of the sphere. The texture has a seam at the back where the X=0 plane intersects the sphere and Z values are negative. TextureTransform affects the texture coordinates of the Sphere. The Sphere node's geometry requires outside faces only. When viewed from the inside the results are undefined.

Constructor & Destructor Documentation

SoVRMLSphere::SoVRMLSphere (void)

Constructor.

SoVRMLSphere::~SoVRMLSphere () [protected], [virtual]

Destructor.

Member Function Documentation

SoType SoVRMLSphere::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 * SoVRMLSphere::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 SoVRMLSphere::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 SoVRMLSphere::rayPick (SoRayPickAction * action) [virtual]

Calculates picked point based on primitives generated by subclasses.

Reimplemented from SoShape.

void SoVRMLSphere::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 SoVRMLSphere::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 SoVRMLSphere::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 SoVRMLSphere::radius

Sphere radius. Default value is 1.0.

Author

Generated automatically by Doxygen for Coin from the source code.

Referenced By

SoVRMLSphere.3coin2(3) is an alias of SoVRMLSphere.3coin3(3).

Mon Sep 5 2016 Version 3.1.3 Coin