MoMaterial Class Reference

Property node that defines the material of surface representations. More...

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

Inheritance diagram for MoMaterial:

Public Types
enum	ColoringType {   COLOR ,   CONTOURING }
	Color Coloring type More...

Public Member Functions
virtual SoType	getTypeId () const
	Returns the type identifier for this specific instance.
	MoMaterial ()
	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 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.

Public Attributes
SoSFEnum	faceColoring
	The coloring method for faces.
SoSFColor	faceColor
	Uniform color used for faces when faceColoring is set to COLOR.
SoSFEnum	lineColoring
	The coloring method for lines.
SoSFColor	lineColor
	Uniform color used for lines and edges when lineColoring is set to COLOR.
SoSFEnum	pointColoring
	The coloring method for points.
SoSFColor	pointColor
	Uniform color used for points when pointColoring is set to COLOR.
SoSFFloat	transparency
	Transparency value used to display surfaces.
SoSFBool	enhancedColoring
	When set to TRUE, polygons with more than three points are colored using a technique that more accurately displays the color gradient.

Detailed Description

Property node that defines the material of surface representations.

This node specifies the coloring to be used in subsequent nodes inheriting from MoMeshRepresentation and defining a surface. Specifically the face, edge and point coloring methods which can be uniform or contouring.

• Uniform color means that all entities are drawn using the face, line or edge color.
• Contouring means that the rendering uses the color mapping defined by a scalar set and a color mapping function (see MoColorMapping) to display color contours.

When the enhanced coloring method is enabled (enhancedColoring field set to TRUE), polygons are colored using a technique allowing to display more accurately the color gradient than what can be achieved normally with OpenGL.

Note

This node applies only to surface representations.

FILE FORMAT/DEFAULT

DataBinding {

faceColoring	CONTOURING
faceColor	(1,1,1)
lineColoring	CONTOURING
lineColor	(1,0,0)
pointColoring	CONTOURING
pointColor	(0,1,0)
transparency	(0.0)
enhancedColoring	FALSE

}

SEE ALSO

MoDrawStyle for turning on display of facets, edges and points.

ACTION BEHAVIOR

Sets the current color and coloring options. See MoMaterialElement.

Definition at line 72 of file MoMaterial.h.

Member Enumeration Documentation

ColoringType

enum MoMaterial::ColoringType

Color Coloring type

Enumerator
COLOR	Use the color field to fill facets in an uniform color.
CONTOURING	(default) Use the color mapping defined by a scalar set and a color mapping function to display color contours.

Definition at line 85 of file MoMaterial.h.

Constructor & Destructor Documentation

MoMaterial()

MoMaterial::MoMaterial

(

)

Constructor.

Member Function Documentation

getClassTypeId()

static SoType MoMaterial::getClassTypeId ( )

static

Returns the type identifier for this class.

getTypeId()

virtual SoType MoMaterial::getTypeId ( ) const

virtual

Returns the type identifier for this specific instance.

Reimplemented from MoActionNode.

Member Data Documentation

enhancedColoring

SoSFBool MoMaterial::enhancedColoring

When set to TRUE, polygons with more than three points are colored using a technique that more accurately displays the color gradient.

The default interpolation (FALSE) provided by OpenGL is done by splitting the polygons into triangles and coloring each triangle independently, ignoring information about the other nodes of the polygon.

On the following image, you can see the difference between the coloring obtained with this flag set (left) and not set (right).

Note

This technique may significantly impact the rendering performance and requires a graphic board supporting OpenGL 2.0 or higher. This mode simulates the lighting of a single diffuse white light source. Other lights defined in the scene graph have no effect.

Definition at line 146 of file MoMaterial.h.

faceColor

SoSFColor MoMaterial::faceColor

Uniform color used for faces when faceColoring is set to COLOR.

Default is white (1,1,1).

Definition at line 99 of file MoMaterial.h.

faceColoring

SoSFEnum MoMaterial::faceColoring

The coloring method for faces.

Use enum ColoringType. Default is CONTOURING.

Definition at line 94 of file MoMaterial.h.

lineColor

SoSFColor MoMaterial::lineColor

Uniform color used for lines and edges when lineColoring is set to COLOR.

Default is red (1,0,0).

Definition at line 110 of file MoMaterial.h.

lineColoring

SoSFEnum MoMaterial::lineColoring

The coloring method for lines.

Use enum ColoringType. Default is CONTOURING.

Definition at line 105 of file MoMaterial.h.

pointColor

SoSFColor MoMaterial::pointColor

Uniform color used for points when pointColoring is set to COLOR.

Default is green (0,1,0).

Definition at line 120 of file MoMaterial.h.

pointColoring

SoSFEnum MoMaterial::pointColoring

The coloring method for points.

Default is CONTOURING.

Definition at line 115 of file MoMaterial.h.

transparency

SoSFFloat MoMaterial::transparency

Transparency value used to display surfaces.

1 means fully transparent, 0 opaque (default).

Definition at line 125 of file MoMaterial.h.

---

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

• MeshVizXLM/mapping/nodes/MoMaterial.h