Provided by: libcoin80-doc_3.1.4~abc9f50-4ubuntu2_all bug

NAME

       SoGeoLocation -

       The SoGeoLocation class is used to georeference the following nodes.

       FILE FORMAT/DEFAULTS:

SYNOPSIS

       #include <Inventor/nodes/SoGeoLocation.h>

       Inherits SoTransformation.

   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.
       SoGeoLocation (void)
       virtual void doAction (SoAction *action)
       virtual void callback (SoCallbackAction *action)
       virtual void GLRender (SoGLRenderAction *action)
       virtual void getBoundingBox (SoGetBoundingBoxAction *action)
       virtual void getMatrix (SoGetMatrixAction *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
       SoSFVec3d geoCoords
       SoMFString geoSystem

   Protected Member Functions
       virtual const SoFieldData * getFieldData (void) const
       virtual ~SoGeoLocation ()

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

   Additional Inherited Members

Detailed Description

       The SoGeoLocation class is used to georeference the following nodes.

       FILE FORMAT/DEFAULTS:

       GeoLocation {
         geoSystem ["GD", "WE"]
         geoCoords 0 0 0
       }

       This node specifies an absolute geographic coordinate system for the following nodes. 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

   SoGeoLocation::SoGeoLocation (void)
       Constructor.

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

Member Function Documentation

   SoType SoGeoLocation::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 SoTransformation.

   const SoFieldData * SoGeoLocation::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 SoGeoLocation::doAction (SoAction *action) [virtual]
       This function performs the typical operation of a node for any action.

       Reimplemented from SoNode.

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

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

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

   void SoGeoLocation::getMatrix (SoGetMatrixAction *action) [virtual]
       Action method for SoGetMatrixAction.

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

       Reimplemented from SoNode.

   void SoGeoLocation::pick (SoPickAction *action) [virtual]
       Action method for SoPickAction.

       Does common processing for SoPickAction action instances.

       Reimplemented from SoNode.

   void SoGeoLocation::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

   SoSFString SoGeoLocation::geoCoords
       Used for specifying the geographic coordinates.

       See Also:
           SoGeoOrigin::geoCoords

   SoMFString SoGeoLocation::geoSystem
       Used to specify a spatial reference frame.

       See Also:
           SoGeoOrigin::geoSystem

Author

       Generated automatically by Doxygen for Coin from the source code.