Coin Logo http://www.sim.no
http://www.coin3d.org

SoGeoSeparator Class Reference
[Nodes]

The SoGeoSeparator class is used to georeference a scene graph.

FILE FORMAT/DEFAULTS:. More...

#include <Inventor/nodes/SoGeoSeparator.h>

Inheritance diagram for SoGeoSeparator:

SoSeparator SoGroup SoNode SoFieldContainer SoBase

List of all members.

Public Member Functions

virtual SoType getTypeId (void) const
 SoGeoSeparator (void)
virtual void callback (SoCallbackAction *action)
virtual void GLRenderBelowPath (SoGLRenderAction *action)
virtual void GLRenderInPath (SoGLRenderAction *action)
virtual void getBoundingBox (SoGetBoundingBoxAction *action)
virtual void getMatrix (SoGetMatrixAction *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

SoSFVec3d geoCoords
SoMFString geoSystem

Protected Member Functions

virtual const SoFieldDatagetFieldData (void) const
virtual ~SoGeoSeparator ()

Static Protected Member Functions

static const SoFieldData ** getFieldDataPtr (void)


Detailed Description

The SoGeoSeparator class is used to georeference a scene graph.

FILE FORMAT/DEFAULTS:.

    GeoSeparator {
      geoSystem ["GD", "WE"]
      geoCoords ""
    }

This node specifies an absolute geographic coordinate system for the children. When rendering (or applying other actions), Coin will add a transformation which transforms the geometry into the SoGeoOrigin coordinate system. All objects will be rotated to make the local Z axis point up from the ground (at the specified geo-location), the Y axis will point towards the north pole, and the X axis is found using the right hand rule.

See also:
SoGeoOrigin
Since:
Coin 2.5

Constructor & Destructor Documentation

SoGeoSeparator::SoGeoSeparator ( void   ) 

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

Destructor.


Member Function Documentation

SoType SoGeoSeparator::getClassTypeId ( void   )  [static]

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

Reimplemented from SoSeparator.

Referenced by initClass().

SoType SoGeoSeparator::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 SoSeparator.

const SoFieldData ** SoGeoSeparator::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 SoSeparator.

const SoFieldData * SoGeoSeparator::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 SoSeparator.

void SoGeoSeparator::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 SoSeparator.

References SoRayPickAction::addMethod(), getClassTypeId(), SoNode::rayPickS(), and SoNode::VRML1.

void SoGeoSeparator::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 SoSeparator.

References SoAction::getState(), SoState::pop(), and SoState::push().

void SoGeoSeparator::GLRenderBelowPath ( SoGLRenderAction action  )  [virtual]

SGI Open Inventor v2.1 obsoleted support for SoGLRenderAction::addMethod(). Instead, GLRender() might be called directly, and to optimize traversal, the SoSeparator node calls GLRenderBelowPath whenever the path code is BELOW_PATH or NO_PATH (path code is guaranteed not to change). To be compatible with SGI's Inventor (and thereby also TGS') we have chosen to follow their implementation in this respect.

SoSeparator::GLRenderBelowPath() do not traverse its children using SoChildList::traverse(), but calls GLRenderBelowPath() directly for all its children.

Reimplemented from SoSeparator.

References SoAction::getState(), SoState::pop(), and SoState::push().

void SoGeoSeparator::GLRenderInPath ( SoGLRenderAction action  )  [virtual]

Implements the SoAction::IN_PATH traversal method for the rendering action.

Reimplemented from SoSeparator.

References SoAction::getState(), SoState::pop(), and SoState::push().

void SoGeoSeparator::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 SoSeparator.

References SoAction::getState(), SoState::pop(), and SoState::push().

void SoGeoSeparator::getMatrix ( SoGetMatrixAction action  )  [virtual]

Action method for SoGetMatrixAction.

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

Reimplemented from SoSeparator.

References SoGetMatrixAction::getInverse(), SoGetMatrixAction::getMatrix(), SoAction::getState(), and SbMatrix::inverse().

void SoGeoSeparator::rayPick ( SoRayPickAction action  )  [virtual]

Action method for SoRayPickAction.

Checks the ray specification of the action and tests for intersection with the data of the node.

Nodes influencing relevant state variables for how picking is done also overrides this method.

Reimplemented from SoSeparator.

References SoAction::getState(), SoState::pop(), and SoState::push().

void SoGeoSeparator::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 SoSeparator.

References SoAction::getState(), SoState::pop(), and SoState::push().


Member Data Documentation

Used for specifying the geographic coordinates.

See also:
SoGeoOrigin::geoCoords

Referenced by SoGeoSeparator().

Used to specify a spatial reference frame.

See also:
SoGeoOrigin::geoSystem

Referenced by SoGeoSeparator().


The documentation for this class was generated from the following files:

Copyright © 1998-2007 by Systems in Motion AS. All rights reserved.

Generated on Mon Feb 23 16:33:49 2009 for Coin by Doxygen. 1.5.8