Open Inventor Release 2023.2.3
 
Loading...
Searching...
No Matches
MoDrawStyle Class Reference

MeshViz Property node that defines the draw style of representations. More...

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

+ Inheritance diagram for MoDrawStyle:

Public Member Functions

virtual SoType getTypeId () const
 Returns the type identifier for this specific instance.
 
 MoDrawStyle ()
 Constructor.
 
- 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 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 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.
 

Public Attributes

SoSFBool displayFaces
 The display mode for mesh faces.
 
SoSFBool displayEdges
 The display mode for mesh edges.
 
SoSFBool displayPoints
 The display mode for mesh node points.
 
SoSFFloat fadingThreshold
 Threshold allowing to fade out extra styles of a representation as it gets away from the view point.
 

Detailed Description

MeshViz Property node that defines the draw style of representations.

This node specifies the draw style to be used in subsequent nodes inheriting from MoMeshRepresentation and defining a surface or a line.

  • The displayFaces field controls drawing cell faces as solid.
  • The displayEdges field controls drawing cell edges.
  • The displayPoints field controls drawing node points.
  • The fadingThreshold field controls the edges and points fading out when used as additional styles.

    No Edge Fading Edge Fading

See MoMaterial for setting the rendering attributes of facets, edges and points.

Use this node, for example, to efficiently render a colored surface and the outlines of its cells using a single rendering node. When the fields displayFaces and displayEdges are TRUE, it is possible that a surface (for instance extracted by a MoMeshSkin or a MoMeshSlab) is rendered in 2 passes. The first pass draws the cell faces of the surface, and the second pass draws the cell edges in addition to the faces. The rendering in 2 passes can occur only for very large surface (containing millions of triangles or quadrangles) where the first pass can be done quickly before starting additional computations to display the edges. Note: The rendering of surfaces extracted from an unstructured grid is always done in one pass.

FILE FORMAT/DEFAULT

    DataBinding {
    displayFaces TRUE
    displayEdges FALSE
    displayPoints FALSE
    fadingThreshold 0
    }

SEE ALSO

MoMaterial

ACTION BEHAVIOR

Constructor & Destructor Documentation

◆ MoDrawStyle()

MoDrawStyle::MoDrawStyle ( )

Constructor.

Member Function Documentation

◆ getClassTypeId()

static SoType MoDrawStyle::getClassTypeId ( )
static

Returns the type identifier for this class.


◆ getTypeId()

virtual SoType MoDrawStyle::getTypeId ( ) const
virtual

Returns the type identifier for this specific instance.

Reimplemented from MoActionNode.

Member Data Documentation

◆ displayEdges

SoSFBool MoDrawStyle::displayEdges

The display mode for mesh edges.

When set to TRUE, the edges of faces are displayed. Otherwise, they are not displayed (Default).

Definition at line 104 of file MoDrawStyle.h.

◆ displayFaces

SoSFBool MoDrawStyle::displayFaces

The display mode for mesh faces.

When set to TRUE (default), the surface of mesh representations are filled. Otherwise, they are not filled.

Definition at line 97 of file MoDrawStyle.h.

◆ displayPoints

SoSFBool MoDrawStyle::displayPoints

The display mode for mesh node points.

When set to TRUE, the node points are displayed. Otherwise, they are not displayed (Default).

Definition at line 111 of file MoDrawStyle.h.

◆ fadingThreshold

SoSFFloat MoDrawStyle::fadingThreshold

Threshold allowing to fade out extra styles of a representation as it gets away from the view point.

If fadingThreshold is 0, no fading is done. This is the default behavior. If fadingThreshold > 0, a fading effect may occur on the rendering. In many cases, this field is just interpreted as a boolean value (fading/no fading) for edges rendering. That means that in many cases, the edge fading is done automatically without needing any threshold value, i.e. the floating value of the field is just ignored. However in some cases, we have some limitation that needs to use a threshold value. For those cases, this threshold defines the pixel length limit on screen under which edges start fading out. Setting the threshold to 5 leads to fade out edges with less than 5 pixels on screen.

Rendering a surface containing some polygons with more than 8 edges is a typical example where the threshold value is needed.

In any case, the floating value of the threshold is used to fade out the points.

Note: when the fading is activated, a transparency is required so be sure to check SoGLRenderAction::TransparencyType documentation in order to be aware of known transparency limitations (AA compatibility).

Definition at line 129 of file MoDrawStyle.h.


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