SoGeoOrigin Class Reference

Specifies a local geospatial coordinate system. More...

#include <Inventor/geo/SoGeoOrigin.h>

Inheritance diagram for SoGeoOrigin:

Public Member Functions
virtual SoType	getTypeId () const
	Returns the type identifier for this specific instance.
	SoGeoOrigin ()
	Constructor.
Public Member Functions inherited from SoNode
virtual void	setOverride (const SbBool state)
	Turns the override flag on or off.
virtual SbBool	isOverride () const
	Returns the state of the override flag.
virtual SoNode *	copy (SbBool copyConnections=FALSE) const
	Creates and returns an exact copy of the node.
virtual SbBool	affectsState () const
	Returns TRUE if a node has an effect on the state during traversal.
virtual void	touch ()
	Marks an instance as modified, simulating a change to it.
Public Member Functions inherited from SoFieldContainer
void	setToDefaults ()
	Sets all fields in this object to their default values.
SbBool	hasDefaultValues () const
	Returns TRUE if all of the object's fields have their default values.
SbBool	fieldsAreEqual (const SoFieldContainer *fc) const
	Returns TRUE if this object's fields are exactly equal to fc's fields.
void	copyFieldValues (const SoFieldContainer *fc, SbBool copyConnections=FALSE)
	Copies the contents of fc's fields into this object's fields.
SoNONUNICODE SbBool	set (const char *fieldDataString)
	Sets one or more fields in this object to the values specified in the given string, which should be a string in the Open Inventor file format.
SbBool	set (const SbString &fieldDataString)
	Sets one or more fields in this object to the values specified in the given string, which should be a string in the Open Inventor file format.
void	get (SbString &fieldDataString)
	Returns the values of the fields of this object in the Open Inventor ASCII file format in the given string.
virtual int	getFields (SoFieldList &list) const
	Appends references to all of this object's fields to resultList, and returns the number of fields appended.
virtual int	getAllFields (SoFieldList &list) const
	Returns a list of fields, including the eventIn's and eventOut's.
virtual SoField *	getField (const SbName &fieldName) const
	Returns a the field of this object whose name is fieldName.
virtual SoField *	getEventIn (const SbName &fieldName) const
	Returns a the eventIn with the given name.
virtual SoField *	getEventOut (const SbName &fieldName) const
	Returns the eventOut with the given name.
SbBool	getFieldName (const SoField *field, SbName &fieldName) const
	Returns the name of the given field in the fieldName argument.
SbBool	enableNotify (SbBool flag)
	Notification at this Field Container is enabled (if flag == TRUE) or disabled (if flag == FALSE).
SbBool	isNotifyEnabled () const
	Notification is the process of telling interested objects that this object has changed.
virtual void	setUserData (void *data)
	Sets application data.
void *	getUserData (void) const
	Gets user application data.
Public Member Functions inherited from SoBase
virtual SbName	getName () const
	Returns the name of an instance.
virtual void	setName (const SbName &name)
	Sets the name of an instance.
void	setSynchronizable (const bool b)
	Sets this to be a ScaleViz synchronizable object.
bool	isSynchronizable () const
	Gets the ScaleViz synchronizable state of this object.
Public Member Functions inherited from SoRefCounter
void	ref () const
	Adds a reference to an instance.
void	unref () const
	Removes a reference from an instance.
void	unrefNoDelete () const
	unrefNoDelete() should be called when it is desired to decrement the reference count, but not delete the instance if this brings the reference count to zero.
int	getRefCount () const
	Returns current reference count.
void	lock () const
	lock this instance.
void	unlock () const
	unlock this instance.
Public Member Functions inherited from SoTypedObject
SbBool	isOfType (const SoType &type) const
	Returns TRUE if this object is of the type specified in type or is derived from that type.
template<typename TypedObjectClass >
SbBool	isOfType () const
	Returns TRUE if this object is of the type of class TypedObjectClass or is derived from that class.

Static Public Member Functions
static SoType	getClassTypeId ()
	Returns the type identifier for this class.
Static Public Member Functions inherited from SoNode
static SoType	getClassTypeId ()
	Returns the type identifier for this class.
static SoNode *	getByName (const SbName &name)
	A node's name can be set using SoBase::setName().
static int	getByName (const SbName &name, SoNodeList &list)
	A node's name can be set using SoBase::setName().
Static Public Member Functions inherited from SoFieldContainer
static SoType	getClassTypeId ()
	Returns the type of this class.
Static Public Member Functions inherited from SoBase
static SoType	getClassTypeId ()
	Returns type identifier for this class.
Static Public Member Functions inherited from SoTypedObject
static SoType	getClassTypeId ()
	Returns the type identifier for this class.

Public Attributes
SoSFVec3d	geoCoords
	Specifies the local coordinate frame.
SoMFString	geoSystem
	Defines the spatial reference frame.
SoSFBool	rotateYUp
	Specifies whether coordinates of nodes that use this GeoOrigin are to be rotated such that their up direction is aligned with the world coordinate Y axis.

Detailed Description

Specifies a local geospatial coordinate system.

The SoGeoOrigin node specifies a local coordinate system for increased floating point precision.

The SoGeoOrigin node defines an absolute geospatial location and an implicit local coordinate frame against which geometry is referenced. This node is used to translate from geographical coordinates into a local Cartesian coordinate system which can be managed by a viewer. The geoCoords field is used to specify a local coordinate frame for extended precision as described in 25.2.5 Dealing with high-precision coordinates. The geoSystem field is used to define the spatial reference frame and is described in 25.2.3 Specifying a spatial reference frame. The rotateYUp field is used to specify whether coordinates of nodes that use this GeoOrigin are to be rotated such that their up direction is aligned with the Y axis. The default behavior is to not perform this operation. This means that the local up direction will depend upon the location of the GeoOrigin with respect to the planet surface.

FILE FORMAT/DEFAULT

GeoOrigin {

geoCoords	0 0 0
geoSystem	["GD","WE"]
rotateYUp	FALSE

}

ACTION BEHAVIOR

SoGLRenderAction, SoGetBoundingBoxAction, SoCallbackAction


Definition at line 69 of file SoGeoOrigin.h.

Constructor & Destructor Documentation

SoGeoOrigin()

SoGeoOrigin::SoGeoOrigin

(

)

Constructor.

Member Function Documentation

getClassTypeId()

static SoType SoGeoOrigin::getClassTypeId ( )

static

Returns the type identifier for this class.

getTypeId()

virtual SoType SoGeoOrigin::getTypeId ( ) const

virtual

Returns the type identifier for this specific instance.

Reimplemented from SoNode.

Member Data Documentation

geoCoords

SoSFVec3d SoGeoOrigin::geoCoords

Specifies the local coordinate frame.

Definition at line 79 of file SoGeoOrigin.h.

geoSystem

SoMFString SoGeoOrigin::geoSystem

Defines the spatial reference frame.

Valid values are:

• GC: Earth-fixed Geocentric with respect to the WGS84 ellipsoid.
• GD: Geodetic spatial reference frame.
  An optional second string may be used to specify the ellipsoid used. If no ellipsoid is specified, then "WE" is assumed (the WGS84 ellipsoid).
• UTM: Universal Transverse Mercator
  One further required argument must be supplied for UTM in order to specify the zone number (1..60). This is given in the form "Zn", where n is the zone number. An optional argument of "S" may be supplied in order to specify that the coordinates are in the southern hemisphere (otherwise, northern hemisphere will be assumed).

Definition at line 95 of file SoGeoOrigin.h.

rotateYUp

SoSFBool SoGeoOrigin::rotateYUp

Specifies whether coordinates of nodes that use this GeoOrigin are to be rotated such that their up direction is aligned with the world coordinate Y axis.

The default behavior is to not perform this operation. This means that the local up direction will depend upon the location of the GeoOrigin with respect to the planet surface.

Definition at line 104 of file SoGeoOrigin.h.

---

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

• Inventor/geo/SoGeoOrigin.h