Rendering node that displays a vector data set. More...
#include <MeshVizXLM/mapping/nodes/MoMeshVector.h>
Public Member Functions | |
virtual SoType | getTypeId () const |
Returns the type identifier for this specific instance. | |
MoMeshVector () | |
Constructor. | |
Public Member Functions inherited from MoMeshRepresentation | |
virtual void | setExtractorCallback (MiExtractorCallback *extractorCallback) |
Set the extraction callback which will be called each time an extraction is performed. | |
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 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 | |
SoSFInt32 | vectorSetId |
Specifies the vector set to display. | |
SoSFFloat | scaleFactor |
The scale factor to apply to the vector field to resize the representation. | |
SoSFFloat | shiftFactor |
The shift factor to apply to the representation of each vector. | |
SoSFFloat | thicknessFactor |
The thickness factor to apply to the representation of each vector. | |
SoSFBool | arrow |
Draw arrows on vectors. | |
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. | |
Rendering node that displays a vector data set.
Each value of the vector data set is represented by a line plus an optional small arrow or a cylinder and an optional cone depending of the thicknessFactor. The vectors are located at the cell centers for per cell data sets or at the node positions for per node data sets. The vectorSetId field defines the index of the vector set to display. This is an index into the list of vector sets existing in the traversal state (see the MoVec3Setxxx nodes).
The vectors can be colored using a scalar set defined in the colorScalarSetId inherited field. This is an index into the list of scalar sets existing in the traversal state (see the MoScalarSetxxx nodes). To disable coloring set this field to -1.
colorScalarSetId | 0 |
vectorSetId | 0 |
scaleFactor | 1.0 |
shiftFactor | 0.0 |
thicknessFactor | 0.0 |
arrow | true |
Definition at line 81 of file MoMeshVector.h.
MoMeshVector::MoMeshVector | ( | ) |
Constructor.
|
static |
Returns the type identifier for this class.
|
virtual |
Returns the type identifier for this specific instance.
Reimplemented from MoMeshRepresentation.
SoSFBool MoMeshVector::arrow |
SoSFFloat MoMeshVector::scaleFactor |
The scale factor to apply to the vector field to resize the representation.
Default is 1.0. All values are accepted. If scaleFactor is 0, the representation is empty.
Definition at line 104 of file MoMeshVector.h.
SoSFFloat MoMeshVector::shiftFactor |
The shift factor to apply to the representation of each vector.
Each vector is translated along its direction by the value of shiftFactor.
Default is 0.0 (no shift). All values are accepted.
The following images illustrate the effect of shiftFactor on the vector field representation, with a vector set using a PER_NODE binding.
Definition at line 120 of file MoMeshVector.h.
SoSFFloat MoMeshVector::thicknessFactor |
The thickness factor to apply to the representation of each vector.
If the thickness factor is:
Factor values > 0 control both the radius of the cylinder and the radius of the cone. For example, when the factor is 1 the radius of the cylinder is 5% of the average vector length in the data set. Larger factors also proportionally increase the height of the cone up to a maximum of half the vector length. When this limit is reached, larger values of the factor have no effect unless the arrow is removed by setting arrow to false.
Default is 0.0.
NOTE: field available since Open Inventor 10.1
Definition at line 139 of file MoMeshVector.h.
SoSFInt32 MoMeshVector::vectorSetId |
Specifies the vector set to display.
During traversal of the scene graph, vector sets are accumulated in a list of vector sets. vectorSetId is an index in this list. Default is 0 meaning the first set in the list.
Definition at line 97 of file MoMeshVector.h.