PbDefinedValue Class Reference

Class used to manage "defined" and "undefined" values. More...

#include <MeshViz/3Ddata/PbDefinedValue.h>

Public Member Functions
virtual	~PbDefinedValue ()
	Destructor.
virtual SbBool	operator() (float node_value, int node_index, int set_index)
	The default instance of PbDefinedValue always returns TRUE.
virtual float	getUndef (int set_index)
	The default instance of PbDefinedValue always returns 0.0, the default float value used to indicate an "undefined" value.

Detailed Description

Class used to manage "defined" and "undefined" values.

This class manages "defined" and "undefined" values. By default, it assumes that all mesh nodes are "defined" and that the value used to indicate an "undefined" value is 0.0.

In order to change this default behavior, this class must be subclassed by overriding operator()() and/or getUndef().

Undefined values are used when applying a "data mapping". See PbDataMapping and PbDataMapping::setMinThreshold() or PbDataMapping::setMaxThreshold().

Definition at line 47 of file PbDefinedValue.h.

Constructor & Destructor Documentation

~PbDefinedValue()

virtual PbDefinedValue::~PbDefinedValue ( )

inlinevirtual

Destructor.

Definition at line 52 of file PbDefinedValue.h.

Member Function Documentation

getUndef()

float PbDefinedValue::getUndef ( int  set_index )

inlinevirtual

The default instance of PbDefinedValue always returns 0.0, the default float value used to indicate an "undefined" value.

This float value is used by MeshViz to set a node's value to something that means "undefined". This method should be overridden (by subclassing) if the application wants a value other than 0.0 to indicate an "undefined" value.

Definition at line 91 of file PbDefinedValue.h.

operator()()

SbBool PbDefinedValue::operator() ( float  node_value, int  node_index, int  set_index  )

inlinevirtual

The default instance of PbDefinedValue always returns TRUE.

This operator should be overridden (by subclassing) when the application needs to manage undefined values on mesh nodes. This operator is used by MeshViz (specifically in PbMesh2D::getFaultMesh()) to determine if the node specified by the following:

• value is node_value
• index in the mesh is node_index
• set index in the mesh is set_index

should be considered defined or undefined. FALSE is returned to indicate "undefined", TRUE otherwise.

Definition at line 84 of file PbDefinedValue.h.

---

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

• MeshViz/3Ddata/PbDefinedValue.h