OpenSceneGraph  3.0.1
Classes | Public Types | Public Member Functions | Protected Member Functions | Protected Attributes | Friends
osg::StateAttribute Class Reference

Base class for state attributes. More...

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

List of all members.

Classes

struct  ModeUsage

Public Types

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, VALIDATOR,
  VIEWMATRIXEXTRACTOR, OSGNV_PARAMETER_BLOCK, OSGNVEXT_TEXTURE_SHADER, OSGNVEXT_VERTEX_PROGRAM,
  OSGNVEXT_REGISTER_COMBINERS, OSGNVCG_PROGRAM, OSGNVSLANG_PROGRAM, OSGNVPARSE_PROGRAM_PARSER,
  UNIFORMBUFFERBINDING, TRANSFORMFEEDBACKBUFFERBINDING
}
 Type identifier to differentiate between different state types. More...
typedef GLenum GLMode
 GLMode is the value used in glEnable/glDisable(mode)
typedef unsigned int GLModeValue
 GLModeValue is used to specify whether a mode is enabled (ON) or disabled (OFF).
typedef unsigned int OverrideValue
 Override is used to specify the override behavior of StateAttributes from parent to children.
typedef std::pair< Type,
unsigned int > 
TypeMemberPair
 Simple pairing between an attribute type and the member within that attribute type group.
typedef std::vector< StateSet * > ParentList
 A vector of osg::StateSet pointers which is used to store the parent(s) of this StateAttribute.
typedef osg::StateAttributeCallback Callback

Public Member Functions

 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.
virtual Objectclone (const CopyOp &) const =0
 Clone an attribute, with Object* return type.
virtual bool isSameKindAs (const Object *obj) const
 Return true if this and obj are of the same kind of object.
virtual const char * libraryName () const
 Return the name of the attribute's library.
virtual const char * className () const
 Return the name of the attribute's class type.
virtual TextureasTexture ()
 Fast alternative to dynamic_cast<> for determining if state attribute is a Texture.
virtual const TextureasTexture () const
 Fast alternative to dynamic_cast<> for determining if state attribute is a Texture.
virtual Type getType () const =0
 Return the Type identifier of the attribute's class type.
virtual unsigned int getMember () const
 Return the member identifier within the attribute's class type.
TypeMemberPair getTypeMemberPair () const
 Return the TypeMemberPair that uniquely identifies this type member.
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.
virtual int compare (const StateAttribute &sa) const =0
 Return -1 if *this < *rhs, 0 if *this==*rhs, 1 if *this>*rhs.
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.
StateSetgetParent (unsigned int i)
const StateSetgetParent (unsigned int i) const
 Get a single const parent of this StateAttribute.
unsigned int getNumParents () const
 Get the number of parents of this StateAttribute.
void setShaderComponent (ShaderComponent *sc)
ShaderComponentgetShaderComponent ()
const ShaderComponentgetShaderComponent () const
virtual bool getModeUsage (ModeUsage &) const
 Return the modes associated with this StateAttribute.
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.
void setUpdateCallback (StateAttributeCallback *uc)
 Set the UpdateCallback which allows users to attach customize the updating of an object during the update traversal.
StateAttributeCallbackgetUpdateCallback ()
 Get the non const UpdateCallback.
const StateAttributeCallbackgetUpdateCallback () const
 Get the const UpdateCallback.
void setEventCallback (StateAttributeCallback *ec)
 Set the EventCallback which allows users to attach customize the updating of an object during the Event traversal.
StateAttributeCallbackgetEventCallback ()
 Get the non const EventCallback.
const StateAttributeCallbackgetEventCallback () const
 Get the const EventCallback.
virtual void apply (State &) const
 apply the OpenGL state attributes.
virtual void compileGLObjects (State &) const
 Default to nothing to compile - all state is applied immediately.
virtual void resizeGLObjectBuffers (unsigned int)
 Resize any per context GLObject buffers to specified size.
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.

Protected Member Functions

virtual ~StateAttribute ()
void addParent (osg::StateSet *object)
void removeParent (osg::StateSet *object)

Protected Attributes

ParentList _parents
ref_ptr< ShaderComponent_shaderComponent
ref_ptr< StateAttributeCallback_updateCallback
ref_ptr< StateAttributeCallback_eventCallback

Friends

class osg::StateSet

Detailed Description

Base class for state attributes.


Member Typedef Documentation

GLMode is the value used in glEnable/glDisable(mode)

typedef unsigned int osg::StateAttribute::GLModeValue

GLModeValue is used to specify whether a mode is enabled (ON) or disabled (OFF).

GLMoveValue is also used to specify the override behavior of modes from parent to children. See enum Value description for more details.

typedef unsigned int osg::StateAttribute::OverrideValue

Override is used to specify the override behavior of StateAttributes from parent to children.

See enum Value description for more details.

A vector of osg::StateSet pointers which is used to store the parent(s) of this StateAttribute.

typedef std::pair<Type,unsigned int> osg::StateAttribute::TypeMemberPair

Simple pairing between an attribute type and the member within that attribute type group.


Member Enumeration Documentation

Type identifier to differentiate between different state types.

Values of StateAttribute::Type used to aid identification of different StateAttribute subclasses. Each subclass defines its own value in the virtual Type getType() method. When extending the osg's StateAttribute's simply define your own Type value which is unique, using the StateAttribute::Type enum as a guide of what values to use. If your new subclass needs to override a standard StateAttriubte then simply use that type's value.

Enumerator:
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 

osgFX namespace

VIEWMATRIXEXTRACTOR 
OSGNV_PARAMETER_BLOCK 

osgNV namespace

OSGNVEXT_TEXTURE_SHADER 
OSGNVEXT_VERTEX_PROGRAM 
OSGNVEXT_REGISTER_COMBINERS 
OSGNVCG_PROGRAM 

osgNVCg namespace

OSGNVSLANG_PROGRAM 
OSGNVPARSE_PROGRAM_PARSER 
UNIFORMBUFFERBINDING 
TRANSFORMFEEDBACKBUFFERBINDING 

list values which can be used to set either GLModeValues or OverrideValues.

When using in conjunction with GLModeValues, all Values have meaning. When using in conjunction with StateAttribute OverrideValue only OFF,OVERRIDE and INHERIT are meaningful. However, they are useful when using GLModeValue and OverrideValue in conjunction with each other as when using StateSet::setAttributeAndModes(..).

Enumerator:
OFF 

means that associated GLMode and Override is disabled.

ON 

means that associated GLMode is enabled and Override is disabled.

OVERRIDE 

Overriding of GLMode's or StateAttributes is enabled, so that state below it is overridden.

PROTECTED 

Protecting of GLMode's or StateAttributes is enabled, so that state from above cannot override this and below state.

INHERIT 

means that GLMode or StateAttribute should be inherited from above.


Constructor & Destructor Documentation

osg::StateAttribute::StateAttribute ( )
osg::StateAttribute::StateAttribute ( const StateAttribute sa,
const CopyOp copyop = CopyOp::SHALLOW_COPY 
) [inline]
virtual osg::StateAttribute::~StateAttribute ( ) [inline, protected, virtual]

Member Function Documentation

void osg::StateAttribute::addParent ( osg::StateSet object) [protected]
virtual void osg::StateAttribute::apply ( State ) const [inline, virtual]
virtual Texture* osg::StateAttribute::asTexture ( ) [inline, virtual]

Fast alternative to dynamic_cast<> for determining if state attribute is a Texture.

Reimplemented in osg::Texture.

virtual const Texture* osg::StateAttribute::asTexture ( ) const [inline, virtual]

Fast alternative to dynamic_cast<> for determining if state attribute is a Texture.

Reimplemented in osg::Texture.

virtual bool osg::StateAttribute::checkValidityOfAssociatedModes ( osg::State ) const [inline, virtual]

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.

Return true if all associated modes are valid.

Reimplemented in osg::PointSprite.

virtual const char* osg::StateAttribute::className ( ) const [inline, virtual]

Return the name of the attribute's class type.

Implements osg::Object.

Reimplemented in osg::Texture, osgText::GlyphTexture, osg::Light, osg::ClipPlane, osg::Hint, and osg::ShaderAttribute.

virtual Object* osg::StateAttribute::clone ( const CopyOp ) const [pure virtual]

Clone an attribute, with Object* return type.

Must be defined by derived classes.

Implements osg::Object.

Implemented in osg::Texture, osg::Light, osg::ClipPlane, osg::Hint, and osg::ShaderAttribute.

virtual Object* osg::StateAttribute::cloneType ( ) const [pure virtual]

Clone the type of an attribute, with Object* return type.

Must be defined by derived classes.

Implements osg::Object.

Implemented in osg::Texture, osg::Light, osg::ClipPlane, osg::Hint, and osg::ShaderAttribute.

Referenced by osg::State::applyAttribute(), and osg::State::applyAttributeOnTexUnit().

virtual int osg::StateAttribute::compare ( const StateAttribute sa) const [pure virtual]
virtual void osg::StateAttribute::compileGLObjects ( State ) const [inline, virtual]

Default to nothing to compile - all state is applied immediately.

Reimplemented in osg::Texture, osg::VertexProgram, osg::FragmentProgram, osg::Program, osg::ShaderAttribute, and osgFX::Validator.

StateAttributeCallback* osg::StateAttribute::getEventCallback ( ) [inline]

Get the non const EventCallback.

const StateAttributeCallback* osg::StateAttribute::getEventCallback ( ) const [inline]

Get the const EventCallback.

virtual unsigned int osg::StateAttribute::getMember ( ) const [inline, virtual]

Return the member identifier within the attribute's class type.

Used for light number/clip plane number etc.

Reimplemented in osg::Light, osg::ClipPlane, osg::Hint, and osg::BufferIndexBinding.

virtual bool osg::StateAttribute::getModeUsage ( ModeUsage ) const [inline, virtual]
unsigned int osg::StateAttribute::getNumParents ( ) const [inline]

Get the number of parents of this StateAttribute.

Returns:
the number of parents of this StateAttribute.
StateSet* osg::StateAttribute::getParent ( unsigned int  i) [inline]
const StateSet* osg::StateAttribute::getParent ( unsigned int  i) const [inline]

Get a single const parent of this StateAttribute.

Parameters:
iindex of the parent to get.
Returns:
the parent i.
const ParentList& osg::StateAttribute::getParents ( ) const [inline]

Get the parent list of this StateAttribute.

ShaderComponent* osg::StateAttribute::getShaderComponent ( ) [inline]
const ShaderComponent* osg::StateAttribute::getShaderComponent ( ) const [inline]
virtual Type osg::StateAttribute::getType ( ) const [pure virtual]

Return the Type identifier of the attribute's class type.

Implemented in osg::Texture, osg::Light, osg::ClipPlane, osg::Hint, and osg::ShaderAttribute.

TypeMemberPair osg::StateAttribute::getTypeMemberPair ( ) const [inline]
StateAttributeCallback* osg::StateAttribute::getUpdateCallback ( ) [inline]

Get the non const UpdateCallback.

const StateAttributeCallback* osg::StateAttribute::getUpdateCallback ( ) const [inline]

Get the const UpdateCallback.

virtual bool osg::StateAttribute::isSameKindAs ( const Object obj) const [inline, virtual]

Return true if this and obj are of the same kind of object.

Reimplemented from osg::Object.

Reimplemented in osg::Texture, osg::Light, osg::ClipPlane, osg::Hint, and osg::ShaderAttribute.

References NULL.

virtual bool osg::StateAttribute::isTextureAttribute ( ) const [inline, virtual]

Return true if StateAttribute is a type which controls texturing and needs to be issued w.r.t to specific texture unit.

Reimplemented in osg::Texture, osg::TexEnvCombine, osg::TexGen, osg::PointSprite, osg::TexEnv, osg::TexEnvFilter, and osg::TexMat.

virtual const char* osg::StateAttribute::libraryName ( ) const [inline, virtual]

Return the name of the attribute's library.

Implements osg::Object.

Reimplemented in osg::Texture, osg::Light, osg::ClipPlane, osg::Hint, and osg::ShaderAttribute.

bool osg::StateAttribute::operator!= ( const StateAttribute rhs) const [inline]
bool osg::StateAttribute::operator< ( const StateAttribute rhs) const [inline]
bool osg::StateAttribute::operator== ( const StateAttribute rhs) const [inline]
virtual void osg::StateAttribute::releaseGLObjects ( State = 0) const [inline, virtual]

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.

Reimplemented from osg::Object.

Reimplemented in osg::Texture, osg::FrameBufferObject, osg::VertexProgram, osg::FragmentProgram, osg::Program, and osg::ShaderAttribute.

void osg::StateAttribute::removeParent ( osg::StateSet object) [protected]
virtual void osg::StateAttribute::resizeGLObjectBuffers ( unsigned int  ) [inline, virtual]

Resize any per context GLObject buffers to specified size.

Reimplemented from osg::Object.

Reimplemented in osg::Texture, osg::FrameBufferObject, osgText::GlyphTexture, osg::VertexProgram, osg::FragmentProgram, osg::Program, and osg::ShaderAttribute.

void osg::StateAttribute::setEventCallback ( StateAttributeCallback ec)

Set the EventCallback which allows users to attach customize the updating of an object during the Event traversal.

void osg::StateAttribute::setShaderComponent ( ShaderComponent sc) [inline]
void osg::StateAttribute::setUpdateCallback ( StateAttributeCallback uc)

Set the UpdateCallback which allows users to attach customize the updating of an object during the update traversal.


Friends And Related Function Documentation

friend class osg::StateSet [friend]

Member Data Documentation


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

osg logo
Generated at Mon Oct 3 2011 12:39:44 for the OpenSceneGraph by doxygen 1.7.5.