OpenSceneGraph  3.5.1
Public Types | Public Member Functions | Protected Member Functions | Protected Attributes | List of all members
osg::Material Class Reference

Material - encapsulates OpenGL glMaterial state. More...

Inheritance diagram for osg::Material:
Inheritance graph
[legend]

Public Types

enum  Face { FRONT = GL_FRONT, BACK = GL_BACK, FRONT_AND_BACK = GL_FRONT_AND_BACK }
 
enum  ColorMode {
  AMBIENT = GL_AMBIENT, DIFFUSE = GL_DIFFUSE, SPECULAR = GL_SPECULAR, EMISSION = GL_EMISSION,
  AMBIENT_AND_DIFFUSE = GL_AMBIENT_AND_DIFFUSE, OFF
}
 
- Public Types inherited from osg::StateAttribute
enum  Values {
  OFF = 0x0, ON = 0x1, OVERRIDE = 0x2, PROTECTED = 0x4,
  INHERIT = 0x8
}
 list values which can be used to set either GLModeValues or OverrideValues. More...
 
enum  Type {
  TEXTURE, POLYGONMODE, POLYGONOFFSET, MATERIAL,
  ALPHAFUNC, ANTIALIAS, COLORTABLE, CULLFACE,
  FOG, FRONTFACE, LIGHT, POINT,
  LINEWIDTH, LINESTIPPLE, POLYGONSTIPPLE, SHADEMODEL,
  TEXENV, TEXENVFILTER, TEXGEN, TEXMAT,
  LIGHTMODEL, BLENDFUNC, BLENDEQUATION, LOGICOP,
  STENCIL, COLORMASK, DEPTH, VIEWPORT,
  SCISSOR, BLENDCOLOR, MULTISAMPLE, CLIPPLANE,
  COLORMATRIX, VERTEXPROGRAM, FRAGMENTPROGRAM, POINTSPRITE,
  PROGRAM, CLAMPCOLOR, HINT, SAMPLEMASKI,
  PRIMITIVERESTARTINDEX, CLIPCONTROL, VALIDATOR, VIEWMATRIXEXTRACTOR,
  OSGNV_PARAMETER_BLOCK, OSGNVEXT_TEXTURE_SHADER, OSGNVEXT_VERTEX_PROGRAM, OSGNVEXT_REGISTER_COMBINERS,
  OSGNVCG_PROGRAM, OSGNVSLANG_PROGRAM, OSGNVPARSE_PROGRAM_PARSER, UNIFORMBUFFERBINDING,
  TRANSFORMFEEDBACKBUFFERBINDING, ATOMICCOUNTERBUFFERBINDING, PATCH_PARAMETER, FRAME_BUFFER_OBJECT,
  VERTEX_ATTRIB_DIVISOR, SHADERSTORAGEBUFFERBINDING, CAPABILITY = 100
}
 Type identifier to differentiate between different state types. More...
 
typedef GLenum GLMode
 GLMode is the value used in glEnable/glDisable(mode) More...
 
typedef unsigned int GLModeValue
 GLModeValue is used to specify whether a mode is enabled (ON) or disabled (OFF). More...
 
typedef unsigned int OverrideValue
 Override is used to specify the override behavior of StateAttributes from parent to children. More...
 
typedef std::pair< Type, unsigned int > TypeMemberPair
 Simple pairing between an attribute type and the member within that attribute type group. More...
 
typedef std::vector< StateSet * > ParentList
 A vector of osg::StateSet pointers which is used to store the parent(s) of this StateAttribute. More...
 
typedef osg::StateAttributeCallback Callback
 
- Public Types inherited from osg::Object
enum  DataVariance { DYNAMIC, STATIC, UNSPECIFIED }
 

Public Member Functions

 Material ()
 
 Material (const Material &mat, const CopyOp &copyop=CopyOp::SHALLOW_COPY)
 Copy constructor using CopyOp to manage deep vs shallow copy. More...
 
 META_StateAttribute (osg, Material, MATERIAL)
 
virtual int compare (const StateAttribute &sa) const
 return -1 if *this < *rhs, 0 if *this==*rhs, 1 if *this>*rhs. More...
 
Materialoperator= (const Material &rhs)
 
virtual bool getModeUsage (StateAttribute::ModeUsage &) const
 Return the modes associated with this StateAttribute. More...
 
virtual void apply (State &state) const
 apply the OpenGL state attributes. More...
 
void setColorMode (ColorMode mode)
 
ColorMode getColorMode () const
 
void setAmbient (Face face, const Vec4 &ambient)
 
const Vec4getAmbient (Face face) const
 
bool getAmbientFrontAndBack () const
 
void setDiffuse (Face face, const Vec4 &diffuse)
 
const Vec4getDiffuse (Face face) const
 
bool getDiffuseFrontAndBack () const
 
void setSpecular (Face face, const Vec4 &specular)
 Set specular value of specified face(s) of the material, valid specular[0..3] range is 0.0 to 1.0. More...
 
const Vec4getSpecular (Face face) const
 Get the specular value for specified face. More...
 
bool getSpecularFrontAndBack () const
 Return whether specular values are equal for front and back faces or not. More...
 
void setEmission (Face face, const Vec4 &emission)
 Set emission value of specified face(s) of the material, valid emission[0..3] range is 0.0 to 1.0. More...
 
const Vec4getEmission (Face face) const
 Get the emission value for specified face. More...
 
bool getEmissionFrontAndBack () const
 Return whether emission values are equal for front and back faces or not. More...
 
void setShininess (Face face, float shininess)
 Set shininess of specified face(s) of the material. More...
 
float getShininess (Face face) const
 Get the shininess value for specified face. More...
 
bool getShininessFrontAndBack () const
 Return whether shininess values are equal for front and back faces or not. More...
 
void setTransparency (Face face, float trans)
 Set the alpha value of ambient, diffuse, specular and emission colors of specified face, to 1-transparency. More...
 
void setAlpha (Face face, float alpha)
 Set the alpha value of ambient, diffuse, specular and emission colors. More...
 
- Public Member Functions inherited from osg::StateAttribute
 StateAttribute ()
 
 StateAttribute (const StateAttribute &sa, const CopyOp &copyop=CopyOp::SHALLOW_COPY)
 
virtual ObjectcloneType () const =0
 Clone the type of an attribute, with Object* return type. More...
 
virtual Objectclone (const CopyOp &) const =0
 Clone an attribute, with Object* return type. More...
 
virtual bool isSameKindAs (const Object *obj) const
 Return true if this and obj are of the same kind of object. More...
 
virtual const char * libraryName () const
 Return the name of the attribute's library. More...
 
virtual const char * className () const
 Return the name of the attribute's class type. More...
 
virtual StateAttributeasStateAttribute ()
 Convert 'this' into a StateAttribute pointer if Object is a StateAttribute, otherwise return 0. More...
 
virtual const StateAttributeasStateAttribute () const
 convert 'const this' into a const StateAttribute pointer if Object is a StateAttribute, otherwise return 0. More...
 
virtual TextureasTexture ()
 Fast alternative to dynamic_cast<> for determining if state attribute is a Texture. More...
 
virtual const TextureasTexture () const
 Fast alternative to dynamic_cast<> for determining if state attribute is a Texture. More...
 
virtual Type getType () const =0
 Return the Type identifier of the attribute's class type. More...
 
virtual unsigned int getMember () const
 Return the member identifier within the attribute's class type. More...
 
TypeMemberPair getTypeMemberPair () const
 Return the TypeMemberPair that uniquely identifies this type member. More...
 
virtual bool isTextureAttribute () const
 Return true if StateAttribute is a type which controls texturing and needs to be issued w.r.t to specific texture unit. More...
 
bool operator< (const StateAttribute &rhs) const
 
bool operator== (const StateAttribute &rhs) const
 
bool operator!= (const StateAttribute &rhs) const
 
const ParentListgetParents () const
 Get the parent list of this StateAttribute. More...
 
StateSetgetParent (unsigned int i)
 
const StateSetgetParent (unsigned int i) const
 Get a single const parent of this StateAttribute. More...
 
unsigned int getNumParents () const
 Get the number of parents of this StateAttribute. More...
 
void setShaderComponent (ShaderComponent *sc)
 
ShaderComponentgetShaderComponent ()
 
const ShaderComponentgetShaderComponent () const
 
virtual bool checkValidityOfAssociatedModes (osg::State &) const
 Check the modes associated with this StateAttribute are supported by current OpenGL drivers, and if not set the associated mode in osg::State to be black listed/invalid. More...
 
void setUpdateCallback (StateAttributeCallback *uc)
 Set the UpdateCallback which allows users to attach customize the updating of an object during the update traversal. More...
 
StateAttributeCallbackgetUpdateCallback ()
 Get the non const UpdateCallback. More...
 
const StateAttributeCallbackgetUpdateCallback () const
 Get the const UpdateCallback. More...
 
void setEventCallback (StateAttributeCallback *ec)
 Set the EventCallback which allows users to attach customize the updating of an object during the Event traversal. More...
 
StateAttributeCallbackgetEventCallback ()
 Get the non const EventCallback. More...
 
const StateAttributeCallbackgetEventCallback () const
 Get the const EventCallback. More...
 
virtual void compileGLObjects (State &) const
 Default to nothing to compile - all state is applied immediately. More...
 
virtual void resizeGLObjectBuffers (unsigned int)
 Resize any per context GLObject buffers to specified size. More...
 
virtual void releaseGLObjects (State *=0) const
 Release OpenGL objects in specified graphics context if State object is passed, otherwise release OpenGL objects for all graphics context if State object pointer NULL. More...
 
- Public Member Functions inherited from osg::Object
 Object ()
 Construct an object. More...
 
 Object (bool threadSafeRefUnref)
 
 Object (const Object &, const CopyOp &copyop=CopyOp::SHALLOW_COPY)
 Copy constructor, optional CopyOp object can be used to control shallow vs deep copying of dynamic data. More...
 
std::string getCompoundClassName () const
 return the compound class name that combines the library name and class name. More...
 
virtual NodeasNode ()
 Convert 'this' into a Node pointer if Object is a Node, otherwise return 0. More...
 
virtual const NodeasNode () const
 convert 'const this' into a const Node pointer if Object is a Node, otherwise return 0. More...
 
virtual NodeVisitorasNodeVisitor ()
 Convert 'this' into a NodeVisitor pointer if Object is a NodeVisitor, otherwise return 0. More...
 
virtual const NodeVisitorasNodeVisitor () const
 convert 'const this' into a const NodeVisitor pointer if Object is a NodeVisitor, otherwise return 0. More...
 
virtual UniformasUniform ()
 Convert 'this' into a Uniform pointer if Object is a Uniform, otherwise return 0. More...
 
virtual const UniformasUniform () const
 convert 'const this' into a const Uniform pointer if Object is a Uniform, otherwise return 0. More...
 
virtual void setThreadSafeRefUnref (bool threadSafe)
 Set whether to use a mutex to ensure ref() and unref() are thread safe. More...
 
virtual void setName (const std::string &name)
 Set the name of object using C++ style string. More...
 
void setName (const char *name)
 Set the name of object using a C style string. More...
 
const std::string & getName () const
 Get the name of object. More...
 
void setDataVariance (DataVariance dv)
 Set the data variance of this object. More...
 
DataVariance getDataVariance () const
 Get the data variance of this object. More...
 
virtual void computeDataVariance ()
 Compute the DataVariance based on an assessment of callback etc. More...
 
void setUserDataContainer (osg::UserDataContainer *udc)
 set the UserDataContainer object. More...
 
template<class T >
void setUserDataContainer (const ref_ptr< T > &udc)
 
osg::UserDataContainergetUserDataContainer ()
 get the UserDataContainer attached to this object. More...
 
const osg::UserDataContainergetUserDataContainer () const
 get the const UserDataContainer attached to this object. More...
 
osg::UserDataContainergetOrCreateUserDataContainer ()
 Convenience method that returns the UserDataContainer, and if one doesn't already exist creates and assigns a DefaultUserDataContainer to the Object and then return this new UserDataContainer. More...
 
virtual void setUserData (Referenced *obj)
 Set user data, data must be subclassed from Referenced to allow automatic memory handling. More...
 
template<class T >
void setUserData (const ref_ptr< T > &ud)
 
virtual ReferencedgetUserData ()
 Get user data. More...
 
virtual const ReferencedgetUserData () const
 Get const user data. More...
 
template<typename T >
bool getUserValue (const std::string &name, T &value) const
 Convenience method that casts the named UserObject to osg::TemplateValueObject<T> and gets the value. More...
 
template<typename T >
void setUserValue (const std::string &name, const T &value)
 Convenience method that creates the osg::TemplateValueObject<T> to store the specified value and adds it as a named UserObject. More...
 
template<typename T >
BoolValueObject UCharValueObject UShortValueObject UIntValueObject DoubleValueObject Vec3fValueObject Vec2dValueObject Vec4dValueObject PlaneValueObject MatrixdValueObject BoundingBoxdValueObject BoundingSpheredValueObject bool getUserValue (const std::string &name, T &value) const
 provide implementation of osg::Object::getUserValue(..) template More...
 
- Public Member Functions inherited from osg::Referenced
 Referenced ()
 
 Referenced (bool threadSafeRefUnref)
 
 Referenced (const Referenced &)
 
Referencedoperator= (const Referenced &)
 
bool getThreadSafeRefUnref () const
 Get whether a mutex is used to ensure ref() and unref() are thread safe. More...
 
OpenThreads::Mutex * getRefMutex () const
 Get the mutex used to ensure thread safety of ref()/unref(). More...
 
int ref () const
 Increment the reference count by one, indicating that this object has another pointer which is referencing it. More...
 
int unref () const
 Decrement the reference count by one, indicating that a pointer to this object is no longer referencing it. More...
 
int unref_nodelete () const
 Decrement the reference count by one, indicating that a pointer to this object is no longer referencing it. More...
 
int referenceCount () const
 Return the number of pointers currently referencing this object. More...
 
ObserverSetgetObserverSet () const
 Get the ObserverSet if one is attached, otherwise return NULL. More...
 
ObserverSetgetOrCreateObserverSet () const
 Get the ObserverSet if one is attached, otherwise create an ObserverSet, attach it, then return this newly created ObserverSet. More...
 
void addObserver (Observer *observer) const
 Add a Observer that is observing this object, notify the Observer when this object gets deleted. More...
 
void removeObserver (Observer *observer) const
 Remove Observer that is observing this object. More...
 

Protected Member Functions

virtual ~Material ()
 
- Protected Member Functions inherited from osg::StateAttribute
virtual ~StateAttribute ()
 
void addParent (osg::StateSet *object)
 
void removeParent (osg::StateSet *object)
 
- Protected Member Functions inherited from osg::Object
virtual ~Object ()
 Object destructor. More...
 
- Protected Member Functions inherited from osg::Referenced
virtual ~Referenced ()
 
void signalObserversAndDelete (bool signalDelete, bool doDelete) const
 
void deleteUsingDeleteHandler () const
 

Protected Attributes

ColorMode _colorMode
 
bool _ambientFrontAndBack
 
Vec4 _ambientFront
 
Vec4 _ambientBack
 
bool _diffuseFrontAndBack
 
Vec4 _diffuseFront
 
Vec4 _diffuseBack
 
bool _specularFrontAndBack
 
Vec4 _specularFront
 
Vec4 _specularBack
 
bool _emissionFrontAndBack
 
Vec4 _emissionFront
 
Vec4 _emissionBack
 
bool _shininessFrontAndBack
 
float _shininessFront
 
float _shininessBack
 
- Protected Attributes inherited from osg::StateAttribute
ParentList _parents
 
ref_ptr< ShaderComponent_shaderComponent
 
ref_ptr< StateAttributeCallback_updateCallback
 
ref_ptr< StateAttributeCallback_eventCallback
 
- Protected Attributes inherited from osg::Object
std::string _name
 
DataVariance _dataVariance
 
osg::UserDataContainer_userDataContainer
 
- Protected Attributes inherited from osg::Referenced
OpenThreads::AtomicPtr _observerSet
 
OpenThreads::Atomic _refCount
 

Additional Inherited Members

- Static Public Member Functions inherited from osg::Referenced
static OpenThreads::Mutex * getGlobalReferencedMutex ()
 Get the optional global Referenced mutex, this can be shared between all osg::Referenced. More...
 
static void setThreadSafeReferenceCounting (bool enableThreadSafeReferenceCounting)
 Set whether reference counting should use a mutex for thread safe reference counting. More...
 
static bool getThreadSafeReferenceCounting ()
 Get whether reference counting is active. More...
 
static void setDeleteHandler (DeleteHandler *handler)
 Set a DeleteHandler to which deletion of all referenced counted objects will be delegated. More...
 
static DeleteHandlergetDeleteHandler ()
 Get a DeleteHandler. More...
 

Detailed Description

Material - encapsulates OpenGL glMaterial state.

Member Enumeration Documentation

Enumerator
AMBIENT 
DIFFUSE 
SPECULAR 
EMISSION 
AMBIENT_AND_DIFFUSE 
OFF 
Enumerator
FRONT 
BACK 
FRONT_AND_BACK 

Constructor & Destructor Documentation

osg::Material::Material ( )
osg::Material::Material ( const Material mat,
const CopyOp copyop = CopyOp::SHALLOW_COPY 
)
inline

Copy constructor using CopyOp to manage deep vs shallow copy.

virtual osg::Material::~Material ( )
protectedvirtual

Member Function Documentation

virtual void osg::Material::apply ( State ) const
virtual

apply the OpenGL state attributes.

The render info for the current OpenGL context is passed in to allow the StateAttribute to obtain details on the the current context and state.

Reimplemented from osg::StateAttribute.

virtual int osg::Material::compare ( const StateAttribute sa) const
inlinevirtual

return -1 if *this < *rhs, 0 if *this==*rhs, 1 if *this>*rhs.

Implements osg::StateAttribute.

const Vec4& osg::Material::getAmbient ( Face  face) const
bool osg::Material::getAmbientFrontAndBack ( ) const
inline
ColorMode osg::Material::getColorMode ( ) const
inline
const Vec4& osg::Material::getDiffuse ( Face  face) const
bool osg::Material::getDiffuseFrontAndBack ( ) const
inline
const Vec4& osg::Material::getEmission ( Face  face) const

Get the emission value for specified face.

bool osg::Material::getEmissionFrontAndBack ( ) const
inline

Return whether emission values are equal for front and back faces or not.

virtual bool osg::Material::getModeUsage ( StateAttribute::ModeUsage ) const
inlinevirtual

Return the modes associated with this StateAttribute.

Reimplemented from osg::StateAttribute.

float osg::Material::getShininess ( Face  face) const

Get the shininess value for specified face.

bool osg::Material::getShininessFrontAndBack ( ) const
inline

Return whether shininess values are equal for front and back faces or not.

const Vec4& osg::Material::getSpecular ( Face  face) const

Get the specular value for specified face.

bool osg::Material::getSpecularFrontAndBack ( ) const
inline

Return whether specular values are equal for front and back faces or not.

osg::Material::META_StateAttribute ( osg  ,
Material  ,
MATERIAL   
)
Material& osg::Material::operator= ( const Material rhs)
void osg::Material::setAlpha ( Face  face,
float  alpha 
)

Set the alpha value of ambient, diffuse, specular and emission colors.

Valid transparency range is 0.0 to 1.0.

void osg::Material::setAmbient ( Face  face,
const Vec4 ambient 
)
void osg::Material::setColorMode ( ColorMode  mode)
inline
void osg::Material::setDiffuse ( Face  face,
const Vec4 diffuse 
)
void osg::Material::setEmission ( Face  face,
const Vec4 emission 
)

Set emission value of specified face(s) of the material, valid emission[0..3] range is 0.0 to 1.0.

void osg::Material::setShininess ( Face  face,
float  shininess 
)

Set shininess of specified face(s) of the material.

valid shininess range is 0.0 to 128.0.

void osg::Material::setSpecular ( Face  face,
const Vec4 specular 
)

Set specular value of specified face(s) of the material, valid specular[0..3] range is 0.0 to 1.0.

void osg::Material::setTransparency ( Face  face,
float  trans 
)

Set the alpha value of ambient, diffuse, specular and emission colors of specified face, to 1-transparency.

Valid transparency range is 0.0 to 1.0.

Member Data Documentation

Vec4 osg::Material::_ambientBack
protected
Vec4 osg::Material::_ambientFront
protected
bool osg::Material::_ambientFrontAndBack
protected
ColorMode osg::Material::_colorMode
protected
Vec4 osg::Material::_diffuseBack
protected
Vec4 osg::Material::_diffuseFront
protected
bool osg::Material::_diffuseFrontAndBack
protected
Vec4 osg::Material::_emissionBack
protected
Vec4 osg::Material::_emissionFront
protected
bool osg::Material::_emissionFrontAndBack
protected
float osg::Material::_shininessBack
protected
float osg::Material::_shininessFront
protected
bool osg::Material::_shininessFrontAndBack
protected
Vec4 osg::Material::_specularBack
protected
Vec4 osg::Material::_specularFront
protected
bool osg::Material::_specularFrontAndBack
protected

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

osg logo
Generated at Wed Nov 11 2015 22:14:36 for the OpenSceneGraph by doxygen 1.8.10.