MoLinearColorMapping Class Reference

Property node that defines a color mapping with interpolated color in each interval. More...

#include <MeshVizXLM/mapping/nodes/MoLinearColorMapping.h>

Inheritance diagram for MoLinearColorMapping:

Public Member Functions
virtual SoType	getTypeId () const
	Returns the type identifier for this specific instance.
	MoLinearColorMapping ()
	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 MoColorMapping
static SoType	getClassTypeId ()
	Returns the type identifier for this class.
Static Public Member Functions inherited from MoActionNode
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
SoMFFloat	values
	Contains a set of N scalar values defining the levels of the colormap.
SoMFVec4f	colors
	Contains a set of N colors defining the color at each scalar value.
SoSFBool	minThresholdEnable
	Min Threshold enable flag.
SoSFFloat	minThresholdValue
	Min Threshold value.
SoSFVec4f	minThresholdColor
	Min Threshold color (R, G, B and A values in the range 0..1).
SoSFBool	maxThresholdEnable
	Max Threshold enable flag.
SoSFFloat	maxThresholdValue
	Max Threshold value.
SoSFVec4f	maxThresholdColor
	Max Threshold color (R, G, B and A values in the range 0..1).

Detailed Description

Property node that defines a color mapping with interpolated color in each interval.

This node defines a linear color mapping defined by a set of scalar values and their corresponding colors. For a given value v, Vk <= v <= Vk+1, the associated color c is determined by a linear interpolation between (Vk,Ck) and (Vk+1,Ck+1). Where Vk,Ck is pair number k of the colormap.

Notes:

• The number of colors must be exactly the same as the number of scalars.
• If either the number of scalars or the number of colors is zero, the color mapping is ignored.
• Values less than the first scalar are assigned the first color.
• Values greater than the last value are assigned the last color.

FILE FORMAT/DEFAULT

LinearColorMapping {

values	0
colors	0,0,0,0
minThresholdEnable	FALSE
minThresholdValue	0
minThresholdColor	0,0,0,0
maxThresholdEnable	FALSE
maxThresholdValue	0
maxThresholdColor	0,0,0,0

}

ACTION BEHAVIOR

Sets the current color mapping. See MoColorMappingElement.

SEE ALSO

MoCombineColorMapping, MoCustomColorMapping, MoLevelColorMapping, MoPredefinedColorMapping

Definition at line 77 of file MoLinearColorMapping.h.

Constructor & Destructor Documentation

MoLinearColorMapping()

MoLinearColorMapping::MoLinearColorMapping

(

)

Constructor.

Initially the color mapping is empty and has no effect.

Member Function Documentation

getClassTypeId()

static SoType MoLinearColorMapping::getClassTypeId ( )

static

Returns the type identifier for this class.

getTypeId()

virtual SoType MoLinearColorMapping::getTypeId ( ) const

virtual

Returns the type identifier for this specific instance.

Reimplemented from MoColorMapping.

Member Data Documentation

colors

SoMFVec4f MoLinearColorMapping::colors

Contains a set of N colors defining the color at each scalar value.

Each color consists of R, G, B and A values in the range 0..1. Default is empty.

Definition at line 97 of file MoLinearColorMapping.h.

maxThresholdColor

SoSFVec4f MoLinearColorMapping::maxThresholdColor

Max Threshold color (R, G, B and A values in the range 0..1).

Default is transparent black (0,0,0,0).

Definition at line 131 of file MoLinearColorMapping.h.

maxThresholdEnable

SoSFBool MoLinearColorMapping::maxThresholdEnable

Max Threshold enable flag.

When TRUE, values higher than maxThresholdValue are displayed using the maxThresholdColor. Default is FALSE.

Definition at line 121 of file MoLinearColorMapping.h.

maxThresholdValue

SoSFFloat MoLinearColorMapping::maxThresholdValue

Max Threshold value.

Default is 0.

Definition at line 126 of file MoLinearColorMapping.h.

minThresholdColor

SoSFVec4f MoLinearColorMapping::minThresholdColor

Min Threshold color (R, G, B and A values in the range 0..1).

Default is transparent black (0,0,0,0).

Definition at line 114 of file MoLinearColorMapping.h.

minThresholdEnable

SoSFBool MoLinearColorMapping::minThresholdEnable

Min Threshold enable flag.

When TRUE, values lower than minThresholdValue are displayed using the minThresholdColor. Default is FALSE.

Definition at line 104 of file MoLinearColorMapping.h.

minThresholdValue

SoSFFloat MoLinearColorMapping::minThresholdValue

Min Threshold value.

Default is 0.

Definition at line 109 of file MoLinearColorMapping.h.

values

SoMFFloat MoLinearColorMapping::values

Contains a set of N scalar values defining the levels of the colormap.

Default is empty.

Definition at line 91 of file MoLinearColorMapping.h.

---

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

• MeshVizXLM/mapping/nodes/MoLinearColorMapping.h