MoCellFilter Class Reference

Property node that defines a cell filter. More...

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

Inheritance diagram for MoCellFilter:

Public Member Functions
virtual SoType	getTypeId () const
	Returns the type identifier for this specific instance.
	MoCellFilter ()
	Constructor.
virtual void	setCellFilter (const MiCellFilter *cellFilter)
	Provides a common interface to set all cell filter types (MiCellFilterI, MiCellFilterIj and MiCellFilterIjk) and marks the node as modified by calling touch().
virtual void	reset ()
	Reset the cell filter interface to NULL (as if setCellFilter was given a NULL pointer).
virtual const MiCellFilter *	getCellFilter ()
	Gets the cell filter interface.
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 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 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 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.

Detailed Description

Property node that defines a cell filter.

Filtering cells is a way to specify which cells are used and which cells are ignored during a mesh extraction. The application must create a class implementing the MiCellFilter interface. A cell filter class must implement the method acceptCell() with either 1, 2 or 3 indices as arguments. When the method acceptCell() returns false, the cell identified by these indices is not taken into account by the extraction. It is as if the mesh does not contain this cell.

Note

Each time the current MiCellFilter is updated, touch() must be called to mark the node as modified. However MiCellFilter::getTimeStamp() must return a different value than before to actually trigger a new rendering.

FILE FORMAT/DEFAULT

CellFilter { }

ACTION BEHAVIOR

Sets the current cell filter. See MoCellFilterElement.

SEE ALSO

MiCellFilter, MiCellFilterI, MiCellFilterIj, MiCellFilterIjk

Definition at line 63 of file MoCellFilter.h.

Constructor & Destructor Documentation

MoCellFilter()

MoCellFilter::MoCellFilter

(

)

Constructor.

Member Function Documentation

getCellFilter()

virtual const MiCellFilter * MoCellFilter::getCellFilter ( )

virtual

Gets the cell filter interface.

Use RTTI to find out which derived class it is.

getClassTypeId()

static SoType MoCellFilter::getClassTypeId ( )

static

Returns the type identifier for this class.

getTypeId()

virtual SoType MoCellFilter::getTypeId ( ) const

virtual

Returns the type identifier for this specific instance.

Reimplemented from MoActionNode.

reset()

virtual void MoCellFilter::reset ( )

virtual

Reset the cell filter interface to NULL (as if setCellFilter was given a NULL pointer).

Marks this node as modified by calling touch()

setCellFilter()

virtual void MoCellFilter::setCellFilter ( const MiCellFilter *  cellFilter )

virtual

Provides a common interface to set all cell filter types (MiCellFilterI, MiCellFilterIj and MiCellFilterIjk) and marks the node as modified by calling touch().

The given cellFilter is checked to ensure a required type is provided. If not, NULL is set instead.

Note

When setting a new filter, the MiCellFilter::getTimeStamp() must return a different value than previously to actually take into account the change of filter.

---

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

• MeshVizXLM/mapping/nodes/MoCellFilter.h