Open Inventor Release 2024.1.0
 
Loading...
Searching...
No Matches
PoMeshProperty Class Referenceabstract

MeshViz Abstract Inventor node defining a mesh. More...

#include <MeshViz/nodes/PoMeshProperty.h>

+ Inheritance diagram for PoMeshProperty:

Public Types

enum  DataBinding {
  PER_CELL ,
  PER_NODE
}
 Data binding. More...
 

Public Member Functions

virtual SoType getTypeId () const
 Returns the type identifier for this specific instance.
 
 PoMeshProperty ()
 Constructor.
 
virtual const PbMeshgetMesh () const =0
 Gets the instance of a derived class of PbMesh.
 
virtual void addValuesSet (int index, const float *val, const SbString &set_name="")
 Convenience method to add a new set of scalar values to the mesh.
 
virtual void addValuesSet (int index, const float *val, DataBinding binding, const SbString &set_name="")
 Adds a set of scalar values that can be located either at nodes or at cells.
 
virtual void addStringsSet (int index, const SbString *val, const SbString &set_name="")
 Convenience method to add a new set of string values to the mesh.
 
virtual void addVecsSet (int index, const SbVec3f *val, const SbString &set_name="")
 Convenience method to add a new set of vector values to the mesh.
 
- 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 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 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.
 

Detailed Description

MeshViz Abstract Inventor node defining a mesh.

Definition at line 43 of file PoMeshProperty.h.

Member Enumeration Documentation

◆ DataBinding

Data binding.

Specifies how data is specified (i.e., per cell or per node) for a data set.

Enumerator
PER_CELL 

The data set contains one data value per cell.

PER_NODE 

The data set contains one data value per node.

Definition at line 54 of file PoMeshProperty.h.

Constructor & Destructor Documentation

◆ PoMeshProperty()

PoMeshProperty::PoMeshProperty ( )

Constructor.

Member Function Documentation

◆ addStringsSet()

virtual void PoMeshProperty::addStringsSet ( int  index,
const SbString val,
const SbString set_name = "" 
)
virtual

Convenience method to add a new set of string values to the mesh.

See also PbMesh::addStringsSet().

◆ addValuesSet() [1/2]

virtual void PoMeshProperty::addValuesSet ( int  index,
const float *  val,
const SbString set_name = "" 
)
virtual

Convenience method to add a new set of scalar values to the mesh.

The values are localized at nodes so the number of values in a set must be equal to the number of nodes in the mesh.

Parameters
indexthe index of the new set added
valthe array of values. Its size must be the number of nodes
set_namestring associated to this set of values
See also
PbMesh::addValuesSet()

NOTE: This method must be called after a setGeometry method because the size of the argument val is determined by the number of nodes in the mesh. The setGeometry methods are defined in subclasses of PoMeshProperty.

◆ addValuesSet() [2/2]

virtual void PoMeshProperty::addValuesSet ( int  index,
const float *  val,
DataBinding  binding,
const SbString set_name = "" 
)
virtual

Adds a set of scalar values that can be located either at nodes or at cells.

Parameters
indexthe index of the new set added.
valthe array of values. Its size must be either the number of nodes or the number of cells depending on the binding argument.
bindingspecifies the location of the values.
set_namestring associated with this set of values.
See also
PbMesh::addValuesSet().

NOTE: This method must be called after a setGeometry method because the size of the argument val is determined by the number of nodes in the mesh. The setGeometry methods are defined in subclasses of PoMeshProperty.

◆ addVecsSet()

virtual void PoMeshProperty::addVecsSet ( int  index,
const SbVec3f val,
const SbString set_name = "" 
)
virtual

Convenience method to add a new set of vector values to the mesh.

See also PbMesh::addVecsSet().

◆ getClassTypeId()

static SoType PoMeshProperty::getClassTypeId ( )
static

Returns the type identifier for this class.


◆ getMesh()

◆ getTypeId()


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