Linux Certif

Toute la documentation sur la certification Linux LPI

SoUnits

NAME

SoUnits -

SYNOPSIS

#include <Inventor/nodes/SoUnits.h>

Inherits SoTransformation.

Detailed Description

The SoUnits class is a node for setting unit types.

Even though Coin doesn't care what units you are using in your scene graph per se, there's an advantage to using SoUnits nodes: you have a way to split your scene graph into different 'conceptual' parts.

When encountering SoUnit nodes, the traversal actions methods makes sure the following geometry is scaled accordingly.

FILE FORMAT/DEFAULTS:

     Units {
         units METERS
     }
 
 

 

Public Types

enum Units { METERS, CENTIMETERS, MILLIMETERS, MICROMETERS, MICRONS, NANOMETERS, ANGSTROMS, KILOMETERS, FEET, INCHES, POINTS, YARDS, MILES, NAUTICAL_MILES }

Public Member Functions

virtual SoType getTypeId (void) const

SoUnits (void)

virtual void doAction (SoAction *action)

virtual void callback (SoCallbackAction *action)

virtual void getBoundingBox (SoGetBoundingBoxAction *action)

virtual void getMatrix (SoGetMatrixAction *action)

virtual void GLRender (SoGLRenderAction *action)

virtual void pick (SoPickAction *action)

virtual void getPrimitiveCount (SoGetPrimitiveCountAction *action)

Static Public Member Functions

static SoType getClassTypeId (void)

static void initClass (void)

Public Attributes

SoSFEnum units

Protected Member Functions

virtual const SoFieldData * getFieldData (void) const

virtual ~SoUnits ()

Static Protected Member Functions

static const SoFieldData ** getFieldDataPtr (void)

Member Enumeration Documentation

enum SoUnits::Units

Enumerates the available unit settings.

Constructor & Destructor Documentation

SoUnits::SoUnits (void)

Constructor.

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

Destructor.

Member Function Documentation

SoType SoUnits::getClassTypeId (void) [static]

This static method returns the SoType object associated with objects of this class.

Reimplemented from SoTransformation.

SoType SoUnits::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
     }
     else if (node->getTypeId().isOfType(SoGroup::getClassTypeId())) {
       SoGroup * group = (SoGroup *)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 SoTransformation.

const SoFieldData ** SoUnits::getFieldDataPtr (void) [static, protected]

This API member is considered internal to the library, as it is not likely to be of interest to the application programmer.

Reimplemented from SoTransformation.

const SoFieldData * SoUnits::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 SoTransformation.

void SoUnits::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 SoTransformation.

Referenced by SoNode::initClasses().

void SoUnits::doAction (SoAction * action) [virtual]

This function performs the typical operation of a node for any action.

Reimplemented from SoNode.

References SoSFEnum::getValue(), and units.

Referenced by getBoundingBox(), and pick().

void SoUnits::callback (SoCallbackAction * action) [virtual]

Action method for SoCallbackAction.

Simply updates the state according to how the node behaves for the render action, so the application programmer can use the SoCallbackAction for extracting information about the scene graph.

Reimplemented from SoNode.

References SoAction::getState(), SoField::isIgnored(), and units.

void SoUnits::getBoundingBox (SoGetBoundingBoxAction * action) [virtual]

Action method for the SoGetBoundingBoxAction.

Calculates bounding box and center coordinates for node and modifies the values of the action to encompass the bounding box for this node and to shift the center point for the scene more towards the one for this node.

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

Reimplemented from SoNode.

References doAction().

void SoUnits::getMatrix (SoGetMatrixAction * action) [virtual]

Action method for SoGetMatrixAction.

Updates action by accumulating with the transformation matrix of this node (if any).

Reimplemented from SoNode.

References SoGetMatrixAction::getInverse(), SoGetMatrixAction::getMatrix(), SoSFEnum::getValue(), SbMatrix::multLeft(), SbMatrix::multRight(), SbMatrix::setScale(), and units.

void SoUnits::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 SoNode.

References SoAction::getState(), SoField::isIgnored(), and units.

void SoUnits::pick (SoPickAction * action) [virtual]

Action method for SoPickAction.

Does common processing for SoPickAction action instances.

Reimplemented from SoNode.

References doAction().

void SoUnits::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 SoNode.

Member Data Documentation

SoSFEnum SoUnits::units

The units which will be used for nodes following this node in the traversal (until the next SoUnit node, if any). Default value of the field is SoUnits::METERS.

Referenced by callback(), doAction(), getMatrix(), and GLRender().

Author

Generated automatically by Doxygen for Coin from the source code.