Open Inventor Release 2024.2.0
 
Loading...
Searching...
No Matches
MoPredefinedColorMapping Class Reference

MeshViz Property node that selects a predefined color mapping. More...

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

+ Inheritance diagram for MoPredefinedColorMapping:

Public Types

enum  PredefColorMapping {
  NONE ,
  GREY ,
  TEMPERATURE ,
  PHYSICS ,
  STANDARD ,
  GLOW ,
  BLUE_RED ,
  SEISMIC ,
  BLUE_WHITE_RED ,
  INTENSITY ,
  RAINBOW_TURBO
}
 Predefined colormaps. More...
 

Public Member Functions

virtual SoType getTypeId () const
 Returns the type identifier for this specific instance.
 
 MoPredefinedColorMapping ()
 Constructor.
 
const MiColorMapping< double, SbColorRGBA > * getColorMapping ()
 Retrieves the interface to the color mapping object.
 
- 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 SoNodecopy (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 SoFieldgetField (const SbName &fieldName) const
 Returns a the field of this object whose name is fieldName.
 
virtual SoFieldgetEventIn (const SbName &fieldName) const
 Returns a the eventIn with the given name.
 
virtual SoFieldgetEventOut (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 SoNodegetByName (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

SoSFFloat minValue
 The min and max values defining the range of scalar values.
 
SoSFFloat maxValue
 
SoSFEnum predefColorMap
 Predefined color map to use.
 

Detailed Description

MeshViz Property node that selects a predefined color mapping.

The range of the scalar values must be given to adjust the color map to the scalar set. If a value is less than minValue, the first color in the map is used. If a value is greater than maxValue, the last color in the map is used. If a value is between minValue and maxValue, linear interpolation is used to determine the color.

FILE FORMAT/DEFAULT

    PredefinedColorMapping {
    minValue 0
    maxValue 1
    predefColorMap NONE
    }

ACTION BEHAVIOR

SEE ALSO

MoCombineColorMapping, MoCustomColorMapping, MoLevelColorMapping, MoLinearColorMapping

Definition at line 66 of file MoPredefinedColorMapping.h.

Member Enumeration Documentation

◆ PredefColorMapping

Predefined colormaps.

Enumerator
NONE 

Turn off color mapping (Default value)

GREY 

Greyscale color map.

TEMPERATURE 

Temperature color map.

PHYSICS 

Physics color map.

STANDARD 

Standard color map.

GLOW 

Glow color map.

BLUE_RED 

Blue to Red color map.

SEISMIC 

Seismic color map.

BLUE_WHITE_RED 

Blue to White to Red color map.

INTENSITY 

Intensity color map.

RAINBOW_TURBO 

Turbo (improved rainbow) color map.

Definition at line 89 of file MoPredefinedColorMapping.h.

Constructor & Destructor Documentation

◆ MoPredefinedColorMapping()

MoPredefinedColorMapping::MoPredefinedColorMapping ( )

Constructor.

The initial color map is NONE (node has no effect).

Member Function Documentation

◆ getClassTypeId()

static SoType MoPredefinedColorMapping::getClassTypeId ( )
static

Returns the type identifier for this class.


◆ getColorMapping()

const MiColorMapping< double, SbColorRGBA > * MoPredefinedColorMapping::getColorMapping ( )

Retrieves the interface to the color mapping object.

◆ getTypeId()

virtual SoType MoPredefinedColorMapping::getTypeId ( ) const
virtual

Returns the type identifier for this specific instance.

Reimplemented from MoColorMapping.

Member Data Documentation

◆ maxValue

SoSFFloat MoPredefinedColorMapping::maxValue

Definition at line 83 of file MoPredefinedColorMapping.h.

◆ minValue

SoSFFloat MoPredefinedColorMapping::minValue

The min and max values defining the range of scalar values.

Default values are 0 and 1.

Definition at line 82 of file MoPredefinedColorMapping.h.

◆ predefColorMap

SoSFEnum MoPredefinedColorMapping::predefColorMap

Predefined color map to use.

Use enum PredefColorMapping. Default is NONE.

NONE Default (node is ignored)
GREY or GRAY

TEMPERATURE

PHYSICS

STANDARD

GLOW

BLUE_RED

SEISMIC

BLUE_WHITE_RED

INTENSITY

RAINBOW_TURBO

NOTE: The checkerboard pattern shows through where the color map alpha (opacity) value is less than 1.0.

Definition at line 124 of file MoPredefinedColorMapping.h.


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