PoDataMapping Class Reference

Abstract base class for all data mapping nodes. More...

#include <MeshViz/nodes/PoDataMapping.h>

Inheritance diagram for PoDataMapping:

Public Member Functions
virtual SoType	getTypeId () const
	Returns the type identifier for this specific instance.
virtual const SbColor *	getColor (float value)=0
	Returns the color associated to a value.
virtual const SbColor *	getColor (float value, float &transparency)=0
	Returns the color and the transparency associated to a value.
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 PoNode
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
SoSFBool	minThresholdEnabled
	Defines if the minimum threshold is enabled.
SoSFFloat	minThreshold
	Minimum threshold value.
SoSFColor	minThresholdColor
	Color associated to values <= minThreshold.
SoSFFloat	minThresholdTransparency
	Transparency associated to values <= minThreshold.
SoSFBool	maxThresholdEnabled
	Defines if the maximum threshold is enabled.
SoSFFloat	maxThreshold
	Maximum threshold value.
SoSFColor	maxThresholdColor
	Color associated to values >= maxThreshold.
SoSFFloat	maxThresholdTransparency
	Transparency associated to values >= maxThreshold.
SoSFBool	transparencyEnabled
	Enable/Disable the taking into account of transparency.
SoSFFloat	transparencyValueDeletedParts
	Each primitive part of which transparency >= transparencyValueDeletedParts, is deleted.

Detailed Description

Abstract base class for all data mapping nodes.

This node is the abstract base class for all data mapping nodes. Data mapping defines an association between colors, transparencies and floating-point values. Giving transparencies is not compulsory. When they are not given, they are supposed to be equal to 0 , i.e. each color is opaque.

Whatever data mapping, two threshold values can be defined, minThreshold and maxThreshold. One color (minThresholdColor) and one transparency (minThresholdTransparency) are associated to minThreshold. As well, maxThresholdColor and maxThresholdTransparency are associated to maxThreshold. For a given value vi <= minThreshold, the associated color ci is minThresholdColor and the associated transparency ti is minThresholdTransparency. As well, for a given value vi >= maxThreshold, the associated color ci is maxThresholdColor and the associated transparency ti is maxThresholdTransparency.

FILE FORMAT/DEFAULT

PoDataMapping {

minThresholdEnabled	FALSE
minThreshold	0
minThresholdColor	0 0 0
minThresholdTransparency	0.0
maxThresholdEnabled	FALSE
maxThreshold	1
maxThresholdColor	0 0 0
maxThresholdTransparency	0.0
transparencyEnabled	FALSE
transparencyValueDeletedParts	0.95

}

Definition at line 79 of file PoDataMapping.h.

Member Function Documentation

getClassTypeId()

static SoType PoDataMapping::getClassTypeId ( )

static

Returns the type identifier for this class.

getColor() [1/2]

virtual const SbColor * PoDataMapping::getColor ( float  value )

pure virtual

Returns the color associated to a value.

Implemented in PoLinearDataMapping, PoNonLinearDataMapping, and PoNonLinearDataMapping2.

getColor() [2/2]

virtual const SbColor * PoDataMapping::getColor ( float  value, float &  transparency  )

pure virtual

Returns the color and the transparency associated to a value.

Implemented in PoLinearDataMapping, PoNonLinearDataMapping, and PoNonLinearDataMapping2.

getTypeId()

virtual SoType PoDataMapping::getTypeId ( ) const

virtual

Returns the type identifier for this specific instance.

Reimplemented from PoNode.

Reimplemented in PoLinearDataMapping, PoNonLinearDataMapping, and PoNonLinearDataMapping2.

Member Data Documentation

maxThreshold

SoSFFloat PoDataMapping::maxThreshold

Maximum threshold value.

Default is 0.

Definition at line 121 of file PoDataMapping.h.

maxThresholdColor

SoSFColor PoDataMapping::maxThresholdColor

Color associated to values >= maxThreshold.

Default is 0,0,0.

Definition at line 127 of file PoDataMapping.h.

maxThresholdEnabled

SoSFBool PoDataMapping::maxThresholdEnabled

Defines if the maximum threshold is enabled.

Default is false.

Definition at line 115 of file PoDataMapping.h.

maxThresholdTransparency

SoSFFloat PoDataMapping::maxThresholdTransparency

Transparency associated to values >= maxThreshold.

Default is 0.

Definition at line 133 of file PoDataMapping.h.

minThreshold

SoSFFloat PoDataMapping::minThreshold

Minimum threshold value.

Default is 0.

Definition at line 97 of file PoDataMapping.h.

minThresholdColor

SoSFColor PoDataMapping::minThresholdColor

Color associated to values <= minThreshold.

Default is 0,0,0.

Definition at line 103 of file PoDataMapping.h.

minThresholdEnabled

SoSFBool PoDataMapping::minThresholdEnabled

Defines if the minimum threshold is enabled.

Default is false.

Definition at line 91 of file PoDataMapping.h.

minThresholdTransparency

SoSFFloat PoDataMapping::minThresholdTransparency

Transparency associated to values <= minThreshold.

Default is 0.

Definition at line 109 of file PoDataMapping.h.

transparencyEnabled

SoSFBool PoDataMapping::transparencyEnabled

Enable/Disable the taking into account of transparency.

If it is disabled, the different shape are always opaque. Default is false.

Note: DataMapping does not support data PER_CELL binding when transparencyEnabled is set to TRUE and transparencyValueDeletedParts <= 1.0.

Definition at line 142 of file PoDataMapping.h.

transparencyValueDeletedParts

SoSFFloat PoDataMapping::transparencyValueDeletedParts

Each primitive part of which transparency >= transparencyValueDeletedParts, is deleted.

Default is 0.95.

Definition at line 148 of file PoDataMapping.h.

---

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

• MeshViz/nodes/PoDataMapping.h