MoMeshAnnotatedIsoline Class Reference

Rendering node that displays annotated isolines. More...

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

Inheritance diagram for MoMeshAnnotatedIsoline:

Public Types
enum	AnnotPath {   TANGENTIAL_PATH ,   HORIZONTAL_PATH ,   VERTICAL_PATH }
	Path of annotation text. More...

Public Member Functions
virtual SoType	getTypeId () const
	Returns the type identifier for this specific instance.
	MoMeshAnnotatedIsoline ()
	Constructor.
void	setExtractorCallback (MiExtractorCallback *extractorCallback)
	Set the extraction callback which will be called each time an extraction is performed.
Public Member Functions inherited from MoMeshIsoline
	MoMeshIsoline ()
	Constructor.
const MiIsolineExtractUnstructured *	getUnstructuredExtractor ()
	Get extractor for reuse outside this node.
const MiIsolineExtractIj *	getIjExtractor ()
Public Member Functions inherited from MoMeshRepresentation
virtual SoDEPRECATED void	setExtractorCallback (MiExtractorCallback &extractorCallback)
Public Member Functions inherited from MoMeshBaseRepresentation
virtual SbBool	affectsState () const
	Returns TRUE if a node has an effect on the state during traversal.
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 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 MoMeshIsoline
static SoType	getClassTypeId ()
	Returns the type identifier for this class.
Static Public Member Functions inherited from MoMeshRepresentation
static SoType	getClassTypeId ()
	Returns the type identifier for this class.
Static Public Member Functions inherited from MoMeshBaseRepresentation
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
SoSFBool	isVisible
	Contour line annotation visibility.
SoSFBool	isText2D
	If TRUE, draw text using a SoText2D primitive (bitmapped text).
SoSFEnum	path
	Annotation path.
SoSFVec3f	upVector
	Annotation text up vector.
SoSFFloat	gap
	Curvilinear distance between two annotations of the same contour line.
SoSFFloat	fontSize
	Font size of annotation text in mesh coordinates units.
SoSFColor	color
	Color used for the annotation text Default is white = SbColor(1,1,1)
SoSFBool	isBackground
	Defines if the annotations are framed by a background.
SoSFColor	backgroundColor
	Color used for the annotation background Default is gray = SbColor(0.3,0.3,0.3)
SoSFColor	borderColor
	Color used for the annotation background border.
Public Attributes inherited from MoMeshIsoline
SoMFFloat	isovalues
	List of isovalues to display.
SoSFInt32	isoScalarSetId
	Field representing the scalar set node to be used to compute the iso values.
SoSFUShort	majorPeriod
	Defines the major and the minor contour lines.
SoSFUShort	firstMajor
	Defines the first major contour lines.
SoSFUShort	majorLinePattern
	Defines the line pattern for major contour lines.
SoSFUShort	minorLinePattern
	Defines the line pattern for minor contour lines.
Public Attributes inherited from MoMeshRepresentation
SoSFInt32	colorScalarSetId
	Field representing the scalar set node to be used to map colors onto the representation.
SoSFBool	parallel
	If TRUE, the node tries to launch the extraction in parallel if this is supported by the associated extractor.

Detailed Description

Rendering node that displays annotated isolines.

This class is similar to MoMeshIsoline except that isolines can be annotated with their isovalue.

Only major contour lines defined by the firstMajor and majorPeriod inherited fields can be annotated. The scalar set used to extract the isolines is defined by the inherited isoScalarSetId field. This is an index into the list of scalar sets existing in the traversal state (see the MoScalarSetxxx nodes). This scalar set must be defined per node to be valid.

The isolines can be colored using a scalar set defined in the colorScalarSetId inherited field. To disable coloring set this field to -1.

FILE FORMAT/DEFAULT

MeshIsoline {

colorScalarSetId	0
parallel	TRUE
isovalues	0.0
isoScalarSetId	0
majorPeriod	3
firstMajor	0
majorLinePattern	0xFFFF
minorLinePattern	0xFFFF
isVisible	TRUE
isText2D	FALSE
path	TANGENTIAL_PATH
upVector	SbVec3f(0,1,0)
gap	0.0
fontSize	0.01
color	SbColor(1,1,1)
isBackground	FALSE
backgroundColor	SbColor(0.3,0.3,0.3)
borderColor	SbColor(1,1,1)

}

SEE ALSO

MoMeshIsoline, MiIsolineExtractIj, MiIsolineExtractUnstructured, MoLineDetail

Definition at line 97 of file MoMeshAnnotatedIsoline.h.

Member Enumeration Documentation

AnnotPath

enum MoMeshAnnotatedIsoline::AnnotPath

Path of annotation text.

Enumerator
TANGENTIAL_PATH	Annotations are tangential to the contour lines.
HORIZONTAL_PATH	Annotations are horizontal.
VERTICAL_PATH	Annotations are vertical.

Definition at line 125 of file MoMeshAnnotatedIsoline.h.

Constructor & Destructor Documentation

MoMeshAnnotatedIsoline()

MoMeshAnnotatedIsoline::MoMeshAnnotatedIsoline

(

)

Constructor.

Member Function Documentation

getClassTypeId()

static SoType MoMeshAnnotatedIsoline::getClassTypeId ( )

static

Returns the type identifier for this class.

getTypeId()

virtual SoType MoMeshAnnotatedIsoline::getTypeId ( ) const

virtual

Returns the type identifier for this specific instance.

Reimplemented from MoMeshIsoline.

setExtractorCallback()

void MoMeshAnnotatedIsoline::setExtractorCallback ( MiExtractorCallback *  extractorCallback )

virtual

Set the extraction callback which will be called each time an extraction is performed.

Reimplemented from MoMeshRepresentation.

Member Data Documentation

backgroundColor

SoSFColor MoMeshAnnotatedIsoline::backgroundColor

Color used for the annotation background Default is gray = SbColor(0.3,0.3,0.3)

Definition at line 178 of file MoMeshAnnotatedIsoline.h.

borderColor

SoSFColor MoMeshAnnotatedIsoline::borderColor

Color used for the annotation background border.

Default is white = SbColor(1,1,1)

Definition at line 184 of file MoMeshAnnotatedIsoline.h.

color

SoSFColor MoMeshAnnotatedIsoline::color

Color used for the annotation text Default is white = SbColor(1,1,1)

Definition at line 166 of file MoMeshAnnotatedIsoline.h.

fontSize

SoSFFloat MoMeshAnnotatedIsoline::fontSize

Font size of annotation text in mesh coordinates units.

When isText2D = FALSE, the real font size is a factor of this value and of the size of the mesh. When isText2D = TRUE, the font size is given in points (same as SoText2D). Default is 0.01

Definition at line 160 of file MoMeshAnnotatedIsoline.h.

gap

SoSFFloat MoMeshAnnotatedIsoline::gap

Curvilinear distance between two annotations of the same contour line.

Default is 0 (a single annotation in the middle of the line).

Definition at line 152 of file MoMeshAnnotatedIsoline.h.

isBackground

SoSFBool MoMeshAnnotatedIsoline::isBackground

Defines if the annotations are framed by a background.

Default is FALSE.

Note

When isText2D = TRUE , isBackground has no effect.

Definition at line 172 of file MoMeshAnnotatedIsoline.h.

isText2D

SoSFBool MoMeshAnnotatedIsoline::isText2D

If TRUE, draw text using a SoText2D primitive (bitmapped text).

Otherwise use a SoAnnoText3 (polygonal text). Default is FALSE.

Note

2D text cannot have a background

Definition at line 120 of file MoMeshAnnotatedIsoline.h.

isVisible

SoSFBool MoMeshAnnotatedIsoline::isVisible

Contour line annotation visibility.

Default is TRUE.

Definition at line 112 of file MoMeshAnnotatedIsoline.h.

path

SoSFEnum MoMeshAnnotatedIsoline::path

Annotation path.

• TANGENTIAL_PATH, annotations are tangential to the contour lines.
• HORIZONTAL_PATH, annotations are horizontal.
• VERTICAL_PATH, annotations are vertical.

Use enum AnnotPath. Default is TANGENTIAL_PATH.

Definition at line 140 of file MoMeshAnnotatedIsoline.h.

upVector

SoSFVec3f MoMeshAnnotatedIsoline::upVector

Annotation text up vector.

This vector is used as the vertical axis of all annotations. Default is (0,1,0).

Definition at line 146 of file MoMeshAnnotatedIsoline.h.

---

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

• MeshVizXLM/mapping/nodes/MoMeshAnnotatedIsoline.h