OSG  3.4.0
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Pages
Public Types | Public Member Functions | Protected Member Functions | Protected Attributes | List of all members
osg::Material Class Reference

#include <Material.h>

Inheritance diagram for osg::Material:
Inheritance graph
[legend]
Collaboration diagram for osg::Material:
Collaboration 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
}
 
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
}
 
typedef GLenum GLMode
 
typedef unsigned int GLModeValue
 
typedef unsigned int OverrideValue
 
typedef std::pair< Type,
unsigned int > 		TypeMemberPair
 
typedef std::vector< StateSet * > ParentList
 
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)
 
 META_StateAttribute (osg, Material, MATERIAL)
 
virtual int compare (const StateAttribute &sa) const
 
Material & operator= (const Material &rhs)
 
virtual bool getModeUsage (StateAttribute::ModeUsage &) const
 
virtual void apply (State &state) const
 
void setColorMode (ColorMode mode)
 
ColorMode getColorMode () const
 
void setAmbient (Face face, const Vec4 &ambient)
 
const Vec4 & getAmbient (Face face) const
 
bool getAmbientFrontAndBack () const
 
void setDiffuse (Face face, const Vec4 &diffuse)
 
const Vec4 & getDiffuse (Face face) const
 
bool getDiffuseFrontAndBack () const
 
void setSpecular (Face face, const Vec4 &specular)
 
const Vec4 & getSpecular (Face face) const
 
bool getSpecularFrontAndBack () const
 
void setEmission (Face face, const Vec4 &emission)
 
const Vec4 & getEmission (Face face) const
 
bool getEmissionFrontAndBack () const
 
void setShininess (Face face, float shininess)
 
float getShininess (Face face) const
 
bool getShininessFrontAndBack () const
 
void setTransparency (Face face, float trans)
 
void setAlpha (Face face, float alpha)
 
- Public Member Functions inherited from osg::StateAttribute
 StateAttribute ()
 
 StateAttribute (const StateAttribute &sa, const CopyOp &copyop=CopyOp::SHALLOW_COPY)
 
virtual Object * cloneType () const =0
 
virtual Object * clone (const CopyOp &) const =0
 
virtual bool isSameKindAs (const Object *obj) const
 
virtual const char * libraryName () const
 
virtual const char * className () const
 
virtual StateAttribute * asStateAttribute ()
 
virtual const StateAttribute * asStateAttribute () const
 
virtual Texture * asTexture ()
 
virtual const Texture * asTexture () const
 
virtual Type getType () const =0
 
virtual unsigned int getMember () const
 
TypeMemberPair getTypeMemberPair () const
 
virtual bool isTextureAttribute () const
 
bool operator< (const StateAttribute &rhs) const
 
bool operator== (const StateAttribute &rhs) const
 
bool operator!= (const StateAttribute &rhs) const
 
const ParentList & getParents () const
 
StateSet * getParent (unsigned int i)
 
const StateSet * getParent (unsigned int i) const
 
unsigned int getNumParents () const
 
void setShaderComponent (ShaderComponent *sc)
 
ShaderComponent * getShaderComponent ()
 
const ShaderComponent * getShaderComponent () const
 
virtual bool checkValidityOfAssociatedModes (osg::State &) const
 
void setUpdateCallback (StateAttributeCallback *uc)
 
StateAttributeCallback * getUpdateCallback ()
 
const StateAttributeCallback * getUpdateCallback () const
 
void setEventCallback (StateAttributeCallback *ec)
 
StateAttributeCallback * getEventCallback ()
 
const StateAttributeCallback * getEventCallback () const
 
virtual void compileGLObjects (State &) const
 
virtual void resizeGLObjectBuffers (unsigned int)
 
virtual void releaseGLObjects (State *=0) const
 
- Public Member Functions inherited from osg::Object
 Object ()
 
 Object (bool threadSafeRefUnref)
 
 Object (const Object &, const CopyOp &copyop=CopyOp::SHALLOW_COPY)
 
std::string getCompoundClassName () const
 
virtual Node * asNode ()
 
virtual const Node * asNode () const
 
virtual NodeVisitor * asNodeVisitor ()
 
virtual const NodeVisitor * asNodeVisitor () const
 
virtual Uniform * asUniform ()
 
virtual const Uniform * asUniform () const
 
virtual void setThreadSafeRefUnref (bool threadSafe)
 
virtual void setName (const std::string &name)
 
void setName (const char *name)
 
const std::string & getName () const
 
void setDataVariance (DataVariance dv)
 
DataVariance getDataVariance () const
 
virtual void computeDataVariance ()
 
void setUserDataContainer (osg::UserDataContainer *udc)
 
osg::UserDataContainer * getUserDataContainer ()
 
const osg::UserDataContainer * getUserDataContainer () const
 
osg::UserDataContainer * getOrCreateUserDataContainer ()
 
virtual void setUserData (Referenced *obj)
 
virtual Referenced * getUserData ()
 
virtual const Referenced * getUserData () const
 
template<typename T >
bool getUserValue (const std::string &name, T &value) const
 
template<typename T >
void setUserValue (const std::string &name, const T &value)
 
template<typename T >
BoolValueObject
UCharValueObject
UShortValueObject
UIntValueObject
DoubleValueObject
Vec3fValueObject
Vec2dValueObject
Vec4dValueObject
PlaneValueObject
MatrixdValueObject
BoundingBoxdValueObject
BoundingSpheredValueObject
bool 		getUserValue (const std::string &name, T &value) const
 
- Public Member Functions inherited from osg::Referenced
 Referenced ()
 
 Referenced (bool threadSafeRefUnref)
 
 Referenced (const Referenced &)
 
Referenced & operator= (const Referenced &)
 
bool getThreadSafeRefUnref () const
 
OpenThreads::Mutex * getRefMutex () const
 
int ref () const
 
int unref () const
 
int unref_nodelete () const
 
int referenceCount () const
 
ObserverSet * getObserverSet () const
 
ObserverSet * getOrCreateObserverSet () const
 
void addObserver (Observer *observer) const
 
void removeObserver (Observer *observer) const
 

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 ()
 
- 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 ()
 
static void setThreadSafeReferenceCounting (bool enableThreadSafeReferenceCounting)
 
static bool getThreadSafeReferenceCounting ()
 
static void setDeleteHandler (DeleteHandler *handler)
 
static DeleteHandler * getDeleteHandler ()
 

Detailed Description

Material - encapsulates OpenGL glMaterial state.

Definition at line 31 of file Material.h.

Member Enumeration Documentation

enum osg::Material::ColorMode
Enumerator
AMBIENT 
DIFFUSE 
SPECULAR 
EMISSION 
AMBIENT_AND_DIFFUSE 
OFF 

Definition at line 105 of file Material.h.

enum osg::Material::Face
Enumerator
FRONT 
BACK 
FRONT_AND_BACK 

Definition at line 99 of file Material.h.

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.

Definition at line 38 of file Material.h.

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.

Definition at line 60 of file Material.h.

const Vec4& osg::Material::getAmbient ( Face  face) const
bool osg::Material::getAmbientFrontAndBack ( ) const
inline

Definition at line 119 of file Material.h.

ColorMode osg::Material::getColorMode ( ) const
inline

Definition at line 115 of file Material.h.

const Vec4& osg::Material::getDiffuse ( Face  face) const
bool osg::Material::getDiffuseFrontAndBack ( ) const
inline

Definition at line 123 of file Material.h.

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

Get the emission value for specified face.

Here is the caller graph for this function:

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

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

Definition at line 149 of file Material.h.

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

Return the modes associated with this StateAttribute.

Reimplemented from osg::StateAttribute.

Definition at line 89 of file Material.h.

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.

Definition at line 162 of file Material.h.

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.

Definition at line 136 of file Material.h.

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

Definition at line 114 of file Material.h.

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.

Here is the caller graph for this function:

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

Definition at line 183 of file Material.h.

Vec4 osg::Material::_ambientFront
protected

Definition at line 182 of file Material.h.

bool osg::Material::_ambientFrontAndBack
protected

Definition at line 181 of file Material.h.

ColorMode osg::Material::_colorMode
protected

Definition at line 179 of file Material.h.

Vec4 osg::Material::_diffuseBack
protected

Definition at line 187 of file Material.h.

Vec4 osg::Material::_diffuseFront
protected

Definition at line 186 of file Material.h.

bool osg::Material::_diffuseFrontAndBack
protected

Definition at line 185 of file Material.h.

Vec4 osg::Material::_emissionBack
protected

Definition at line 195 of file Material.h.

Vec4 osg::Material::_emissionFront
protected

Definition at line 194 of file Material.h.

bool osg::Material::_emissionFrontAndBack
protected

Definition at line 193 of file Material.h.

float osg::Material::_shininessBack
protected

Definition at line 199 of file Material.h.

float osg::Material::_shininessFront
protected

Definition at line 198 of file Material.h.

bool osg::Material::_shininessFrontAndBack
protected

Definition at line 197 of file Material.h.

Vec4 osg::Material::_specularBack
protected

Definition at line 191 of file Material.h.

Vec4 osg::Material::_specularFront
protected

Definition at line 190 of file Material.h.

bool osg::Material::_specularFrontAndBack
protected

Definition at line 189 of file Material.h.

The documentation for this class was generated from the following file:
Generated on Tue Oct 4 2016 19:20:50 for OSG by   doxygen 1.8.8