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

Node that specifies how multiple materials are bound to shapes. More...

#include <Inventor/nodes/SoMaterialBinding.h>

+ Inheritance diagram for SoMaterialBinding:

Public Types

enum  Binding {
  OVERALL = SbVertexAttributeBinding::OVERALL ,
  PER_PART = SbVertexAttributeBinding::PER_PART ,
  PER_PART_INDEXED = SbVertexAttributeBinding::PER_PART_INDEXED ,
  PER_FACE = SbVertexAttributeBinding::PER_FACE ,
  PER_FACE_INDEXED = SbVertexAttributeBinding::PER_FACE_INDEXED ,
  PER_VERTEX = SbVertexAttributeBinding::PER_VERTEX ,
  PER_VERTEX_INDEXED = SbVertexAttributeBinding::PER_VERTEX_INDEXED ,
  DEFAULT = OVERALL ,
  NONE = OVERALL
}
 

Public Member Functions

virtual SoType getTypeId () const
 Returns the type identifier for this specific instance.
 
 SoMaterialBinding ()
 Creates a material binding node with default settings.
 
virtual void setOverride (const SbBool state)
 Set the state of the override field.
 
virtual SbBool isOverride () const
 Returns the state of the override field.
 
- Public Member Functions inherited from SoNode
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 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

SoSFEnum value
 Specifies how to bind materials to shapes.
 

Detailed Description

Node that specifies how multiple materials are bound to shapes.

This node specifies how the current materials are bound to shapes that follow in the scene graph. Each shape node may interpret bindings differently. The current material always has a base value, which is defined by the first value of all material fields. Since material fields may have multiple values, the binding determines how these values are distributed over a shape.

The bindings for faces and vertices are meaningful only for shapes that are made from faces and vertices. Similarly, the indexed bindings are only used by the shapes that allow indexing.

The bindings apply only to diffuse colors and transparency. Other materials (emissive, specular, ambient, shininess) will have the first value applied to the entire shape, regardless of the material binding or the number provided.

If the number of transparencies is less than the number of diffuse colors, only the first transparency value will be used, regardless of the material binding. If the number of diffuse colors in the state is less than the number required for the given binding, a debug warning will be printed and unpredictable colors will result.

FILE FORMAT/DEFAULT

    MaterialBinding {
    value OVERALL
    }

ACTION BEHAVIOR

SEE ALSO

SoMaterial, SoNormalBinding, SoShape, SoVertexProperty, SoTextureCoordinateBinding

Definition at line 114 of file SoMaterialBinding.h.

Member Enumeration Documentation

◆ Binding

Enumerator
OVERALL 

Whole object has same material.

PER_PART 

One material for each part of object.

PER_PART_INDEXED 

One material for each part, indexed.

PER_FACE 

One material for each face of object.

PER_FACE_INDEXED 

One material for each face, indexed.

PER_VERTEX 

One material for each vertex of object.

PER_VERTEX_INDEXED 

One material for each vertex, indexed.

DEFAULT 
NONE 

Definition at line 119 of file SoMaterialBinding.h.

Constructor & Destructor Documentation

◆ SoMaterialBinding()

SoMaterialBinding::SoMaterialBinding ( )

Creates a material binding node with default settings.

Member Function Documentation

◆ getClassTypeId()

static SoType SoMaterialBinding::getClassTypeId ( )
static

Returns the type identifier for this class.


◆ getTypeId()

virtual SoType SoMaterialBinding::getTypeId ( ) const
virtual

Returns the type identifier for this specific instance.

Reimplemented from SoNode.

◆ isOverride()

virtual SbBool SoMaterialBinding::isOverride ( ) const
inlinevirtual

Returns the state of the override field.

Reimplemented from SoNode.

Definition at line 177 of file SoMaterialBinding.h.

◆ setOverride()

virtual void SoMaterialBinding::setOverride ( const SbBool  state)
inlinevirtual

Set the state of the override field.

see SoNode::setOverride doc.

Reimplemented from SoNode.

Definition at line 171 of file SoMaterialBinding.h.

Member Data Documentation

◆ value

SoSFEnum SoMaterialBinding::value

Specifies how to bind materials to shapes.

Use enum Binding. Default is OVERALL.

Definition at line 160 of file SoMaterialBinding.h.


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