openscenegraph
Public Types | Public Member Functions | Protected Member Functions | Protected Attributes | List of all members
osg::Material Class Reference
Inheritance diagram for osg::Material:
osg::StateAttribute osg::Object osg::Referenced

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, VALIDATOR,
  VIEWMATRIXEXTRACTOR, OSGNV_PARAMETER_BLOCK, OSGNVEXT_TEXTURE_SHADER, OSGNVEXT_VERTEX_PROGRAM,
  OSGNVEXT_REGISTER_COMBINERS, OSGNVCG_PROGRAM, OSGNVSLANG_PROGRAM, OSGNVPARSE_PROGRAM_PARSER,
  UNIFORMBUFFERBINDING, TRANSFORMFEEDBACKBUFFERBINDING
}
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
Materialoperator= (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 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)
const Vec4getSpecular (Face face) const
bool getSpecularFrontAndBack () const
void setEmission (Face face, const Vec4 &emission)
const Vec4getEmission (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 ObjectcloneType () const =0
virtual Objectclone (const CopyOp &) const =0
virtual bool isSameKindAs (const Object *obj) const
virtual const char * libraryName () const
virtual const char * className () const
virtual TextureasTexture ()
virtual const TextureasTexture () 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 ParentListgetParents () const
StateSetgetParent (unsigned int i)
const StateSetgetParent (unsigned int i) const
unsigned int getNumParents () const
void setShaderComponent (ShaderComponent *sc)
ShaderComponentgetShaderComponent ()
const ShaderComponentgetShaderComponent () const
virtual bool checkValidityOfAssociatedModes (osg::State &) const
void setUpdateCallback (StateAttributeCallback *uc)
StateAttributeCallbackgetUpdateCallback ()
const StateAttributeCallbackgetUpdateCallback () const
void setEventCallback (StateAttributeCallback *ec)
StateAttributeCallbackgetEventCallback ()
const StateAttributeCallbackgetEventCallback () 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)
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::UserDataContainergetUserDataContainer ()
const osg::UserDataContainergetUserDataContainer () const
osg::UserDataContainergetOrCreateUserDataContainer ()
virtual void setUserData (Referenced *obj)
virtual ReferencedgetUserData ()
virtual const ReferencedgetUserData () 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)
- Public Member Functions inherited from osg::Referenced
 Referenced ()
 Referenced (bool threadSafeRefUnref)
 Referenced (const Referenced &)
Referencedoperator= (const Referenced &)
bool getThreadSafeRefUnref () const
OpenThreads::MutexgetRefMutex () const
int ref () const
int unref () const
int unref_nodelete () const
int referenceCount () const
ObserverSetgetObserverSet () const
ObserverSetgetOrCreateObserverSet () 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::MutexgetGlobalReferencedMutex ()
static void setThreadSafeReferenceCounting (bool enableThreadSafeReferenceCounting)
static bool getThreadSafeReferenceCounting ()
static void setDeleteHandler (DeleteHandler *handler)
static DeleteHandlergetDeleteHandler ()

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.

References COMPARE_StateAttribute_Parameter, and COMPARE_StateAttribute_Types.

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.

Referenced by osgFX::Cartoon::getOutlineColor(), and osgFX::Scribe::getWireframeColor().

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.

Referenced by osgFX::Cartoon::setOutlineColor(), and osgFX::Scribe::setWireframeColor().

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: