SoProjection Class Reference

Coordinate projection node More...

#include <Inventor/nodes/SoProjection.h>

Inheritance diagram for SoProjection:

Public Member Functions
virtual SoType	getTypeId () const
	Returns the type identifier for this specific instance.
	SoProjection ()
	Constructor.
void	addProjection (SbString &projectionName, SbProjection *projection, int id)
	Add a projection with the given name and id to the list.
void	setProjection (SbProjection *projection)
	Set the current projection.
void	getCurrentProjectionInfos (SbString &name, int &id)
	Return current projection name and id.
SbProjection *	getProjection () const
	Return current projection.
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 SbVec3f *	checkProjection (SoState *state, SoNode *node, int32_t numCoords, const SbVec3f *coords)
	Apply projection to given coordinates.
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
SoSFBool	isOn
	If set to FALSE, projection is inactive.
SoSFMatrix	matrix
	Matrix that can be applied before projecting a point.
SoSFInt32	projTypeId
	Current projection id.
SoMFFloat	floatParameters
	Float parameters stored for projections.
SoMFString	parameters
	String parameters stored for projections.
SoMFString	parametersIn
	String parameters stored for projections.

Detailed Description

Coordinate projection node

This property node defines a coordinate projection that will be applied to all subsequent shapes in the scene graph. Coordinate transform nodes like SoTransform can only apply transforms that can be expressed as a matrix. A coordinate projection can be any algorithm that takes a coordinate and returns a different coordinate. This is particularly useful for geospatial coordinate systems (see SoGeoProjection), but is also useful for using spherical, cylindrical and other coordinate systems directly.

This node works together with projection classes derived from the SbProjection class. The projection classes implement the projection computations applied to 3D points. Applications can create new subclasses of SbProjection.

To use a specific projection, call setProjection() with an instance of the SbProjection class. Each instance of SoProjection can also store a list of projections, each one associated with a unique id. This is convenient for switching between different geospatial projections. Changing the projTypeId value activates the projection registered with the corresponding id.

The default projection is spherical coordinates (SbSphericalProjection).

The projection classes will use the string parameters and float parameters in the fields parameters and floatParameters respectively. See the projection class documentation for relevant parameters.

Normal vectors

• If no normal vectors are given for the geometry (and normal vectors are needed), Open Inventor will automatically compute normal vectors using the projected vertices, i.e. the coordinates after projection has been applied. This is usually the desired result.
• If normal vectors are specified for the geometry, they are not projected. Therefore normal vectors must be specified in post-projection (world) coordinates.

LIMITATIONS

• Shapes
  The following shapes are not supported by SoProjection:
  • Text nodes (SoAnnoText3, SoAsciiText, SoText2, SoText3 )
  • SoCylinder, SoCube, SoCone
  • All classes inheriting from SoAlgebraicShape
  • SoImage
  • NURBS shapes
  • All VolumeViz shapes except
    • SoVolumeRender with some limitations (see SoVolumeRender doc for details)
    • Volume geometry nodes (e.g. SoVolumeIndexedFaceSet)
• Transform nodes
  The projection mechanism is not compatible with transform and manipulator nodes. Using nodes derived from SoTransformation, for example SoTransform or SoTabBoxManip will give unexpected results. To apply a transformation matrix to projected shapes, set the matrix field to the expected value. Shape vertices will be multiplied by the matrix before being projected.
• Draggers
  Because draggers are composed with SoTransformation nodes, they can't be projected using an SoProjection node.
• Memory
  Because shape coordinates must be duplicated, memory consumption will increase when using projections.
• Picking
  Projection is not applied when doing picking (SoRayPickAction). Results may be incorrect.

FILE FORMAT/DEFAULT

Projection {

parameters	""
matrix	identity
isOn	true
floatParameters	1
projTypeId	0

}

ACTION BEHAVIOR

Sets: SoCoordinateElement

SEE ALSO

SbProjection, SbSphericalProjection, SoGeoProjection

Definition at line 142 of file SoProjection.h.

Constructor & Destructor Documentation

SoProjection()

SoProjection::SoProjection

(

)

Constructor.

Member Function Documentation

addProjection()

void SoProjection::addProjection	(	SbString &	projectionName,
		SbProjection *	projection,
		int	id
	)

Add a projection with the given name and id to the list.

The projection name is just for convenience. The projection id value should be greater than zero because the default spherical projection already uses this id. If multiple projections are assigned the same id, the first one added to the list will be used.

checkProjection()

static SbVec3f * SoProjection::checkProjection ( SoState *  state, SoNode *  node, int32_t  numCoords, const SbVec3f *  coords  )

static

Apply projection to given coordinates.

Store projected coordinates in current SoCoordinate3 element.

getClassTypeId()

static SoType SoProjection::getClassTypeId ( )

static

Returns the type identifier for this class.

getCurrentProjectionInfos()

void SoProjection::getCurrentProjectionInfos	(	SbString &	name,
		int &	id
	)

Return current projection name and id.

getProjection()

SbProjection * SoProjection::getProjection ( ) const

inline

Return current projection.

Definition at line 209 of file SoProjection.h.

getTypeId()

virtual SoType SoProjection::getTypeId ( ) const

virtual

Returns the type identifier for this specific instance.

Reimplemented from SoNode.

Reimplemented in SoGeoProjection, and SoTransformProjection.

setProjection()

void SoProjection::setProjection

(

SbProjection *

projection

)

Set the current projection.

The specified projection is used regardless of whether it is in the list. In this case the value of the projTypeId field is not used.

Member Data Documentation

floatParameters

SoMFFloat SoProjection::floatParameters

Float parameters stored for projections.

Definition at line 173 of file SoProjection.h.

isOn

SoSFBool SoProjection::isOn

If set to FALSE, projection is inactive.

Default is TRUE.

Definition at line 157 of file SoProjection.h.

matrix

SoSFMatrix SoProjection::matrix

Matrix that can be applied before projecting a point.

Set to Identity by default

Definition at line 162 of file SoProjection.h.

parameters

SoMFString SoProjection::parameters

String parameters stored for projections.

Definition at line 178 of file SoProjection.h.

parametersIn

SoMFString SoProjection::parametersIn

String parameters stored for projections.

Definition at line 183 of file SoProjection.h.

projTypeId

SoSFInt32 SoProjection::projTypeId

Current projection id.

Default is zero.

Definition at line 168 of file SoProjection.h.

---

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

• Inventor/nodes/SoProjection.h