Node class to define a non linear data mapping. More...

#include <MeshViz/nodes/PoNonLinearDataMapping2.h>

Inheritance diagram for PoNonLinearDataMapping2:

Public Types
enum	Type { NON_LINEAR_PER_LEVEL , LINEAR_PER_LEVEL }
	Data mapping type. More...

Public Member Functions
virtual SoType	getTypeId () const
	Returns the type identifier for this specific instance.

	PoNonLinearDataMapping2 ()
	Constructor.

virtual const SbColor *	getColor (float value)
	Returns the color associated to a value.

virtual const SbColor *	getColor (float value, float &transparency)
	Returns the color and 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 PoDataMapping
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
SoSFEnum	type
	Defines the type of data mapping.

SoMFFloat	value
	Defines the list of values for the data mapping.

SoMFColor	color
	Defines the list of colors for the data mapping.

SoMFFloat	transparency
	Defines the list of transparencies for the data mapping.

Public Attributes inherited from PoDataMapping
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

Node class to define a non linear data mapping.

This node defines the current data mapping for all subsequent MeshViz representations which use it. There is no data mapping until a PoDataMapping node is traversed.

This node defines a non linear association between colors, transparencies and floating-point values. In other words, this association is defined by 2 functions F(c,v) and F(c,t):

      F(c,v)(V) = C (with c being a color and v being a value).
      F(t,v)(V) = T (with t being a transparency and v being a value).

There are two ways to express F(c,v)(V):

F(c,v)(V) is non linear, but linear per level, so a list of values sorted in increasing order and a list of colors associated define this function. Thus, the association is (V1,C1), (V2,C2),...,(Vn,Cn) with V1 < V2 <...< Vn. For a given value vi, Vk <= vi <= Vk+1, the associated color ci is determined by a linear interpolation between (Vk,Ck) and (Vk+1,Ck+1).
F(c,v)(V) is defined by level, so a list of n values sorted in increasing order and a list of n+1 colors associated define this function. Thus, the association is C1, (V1,C2), (V2,C3),...,(Vn,Cn+1) with V1 < V2 <...< Vn. For a given value vi, Vk <= vi < Vk+1, the associated color ci is Ck+1. If vi < V1, the associated color ci is C1. In the two methods, the list of values is sorted in increasing order (and the associated colors also).

There are as well, two ways to express F(t,v)(V)

FILE FORMAT/DEFAULT

PoNonLinearDataMapping2

type	LINEAR_PER_LEVEL
value	0
color	0 0 0
transparency	0
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 92 of file PoNonLinearDataMapping2.h.

Member Enumeration Documentation

◆ Type

enum PoNonLinearDataMapping2::Type

Data mapping type.

Enumerator
NON_LINEAR_PER_LEVEL	The data mapping is non linear per level.
LINEAR_PER_LEVEL	The data mapping is non linear but linear per level.

Definition at line 101 of file PoNonLinearDataMapping2.h.

Constructor & Destructor Documentation

◆ PoNonLinearDataMapping2()

PoNonLinearDataMapping2::PoNonLinearDataMapping2 ( )

Constructor.

Member Function Documentation

◆ getClassTypeId()

static SoType PoNonLinearDataMapping2::getClassTypeId ( )

static

Returns the type identifier for this class.

◆ getColor() [1/2]

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

virtual

Returns the color associated to a value.

Implements PoDataMapping.

◆ getColor() [2/2]

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

virtual

Returns the color and transparency associated to a value.

Implements PoDataMapping.

◆ getTypeId()

virtual SoType PoNonLinearDataMapping2::getTypeId ( ) const

virtual

Returns the type identifier for this specific instance.

Reimplemented from PoDataMapping.

Member Data Documentation

◆ color

SoMFColor PoNonLinearDataMapping2::color

Defines the list of colors for the data mapping.

The number of colors must be >= the number of values + 1 if the type is NON_LINEAR_PER_LEVEL and >= the number of values otherwise.

Definition at line 130 of file PoNonLinearDataMapping2.h.

◆ transparency

SoMFFloat PoNonLinearDataMapping2::transparency

Defines the list of transparencies for the data mapping.

To be taken into account the number of transparencies must be equal to the number of colors, otherwise transparencies are ignored.

Definition at line 137 of file PoNonLinearDataMapping2.h.

◆ type

SoSFEnum PoNonLinearDataMapping2::type

Defines the type of data mapping.

Definition at line 117 of file PoNonLinearDataMapping2.h.

◆ value

SoMFFloat PoNonLinearDataMapping2::value

Defines the list of values for the data mapping.

Definition at line 122 of file PoNonLinearDataMapping2.h.

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

MeshViz/nodes/PoNonLinearDataMapping2.h

Open Inventor Release 2024.2.1

Public Types

Public Member Functions

Static Public Member Functions

Public Attributes

Detailed Description

FILE FORMAT/DEFAULT

Member Enumeration Documentation

◆ Type

Constructor & Destructor Documentation

◆ PoNonLinearDataMapping2()

Member Function Documentation

◆ getClassTypeId()

◆ getColor() [1/2]

◆ getColor() [2/2]

◆ getTypeId()

Member Data Documentation

◆ color

◆ transparency

◆ type

◆ value