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

#include <StateAttribute.h>

Inherits osg::Object.

Inherited by osg::AlphaFunc, osg::BlendColor, osg::BlendEquation, osg::BlendFunc, osg::BufferIndexBinding, osg::Capability, osg::ClampColor, osg::ClipControl, osg::ClipPlane, osg::ColorMask, osg::ColorMatrix, osg::CullFace, osg::Depth, osg::Fog, osg::FragmentProgram, osg::FrameBufferObject, osg::FrontFace, osg::Hint, osg::Light, osg::LightModel, osg::LineStipple, osg::LineWidth, osg::LogicOp, osg::Material, osg::Multisample, osg::PatchParameter, osg::Point, osg::PointSprite, osg::PolygonMode, osg::PolygonOffset, osg::PolygonStipple, osg::PrimitiveRestartIndex, osg::Program, osg::SampleMaski, osg::Scissor, osg::ShadeModel, osg::ShaderAttribute, osg::Stencil, osg::StencilTwoSided, osg::TexEnv, osg::TexEnvCombine, osg::TexEnvFilter, osg::TexGen, osg::TexMat, osg::Texture, osg::VertexAttribDivisor, osg::VertexProgram, osg::Viewport, and osgFX::Validator.

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

Classes

struct  ModeUsage
 

Public Types

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

 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 StateAttributeasStateAttribute ()
 
virtual const StateAttributeasStateAttribute () const
 
virtual TextureasTexture ()
 
virtual const TextureasTexture () const
 
virtual Type getType () const =0
 
virtual unsigned int getMember () const
 
TypeMemberPair getTypeMemberPair () const
 
virtual bool isTextureAttribute () const
 
virtual int compare (const StateAttribute &sa) const =0
 
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 getModeUsage (ModeUsage &) 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 apply (State &) 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 NodeasNode ()
 
virtual const NodeasNode () const
 
virtual NodeVisitorasNodeVisitor ()
 
virtual const NodeVisitorasNodeVisitor () const
 
virtual UniformasUniform ()
 
virtual const UniformasUniform () 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::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)
 
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 &)
 
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 ~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

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
 

Friends

class osg::StateSet
 

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

Base class for state attributes.

Definition at line 76 of file StateAttribute.h.

Member Typedef Documentation

Definition at line 322 of file StateAttribute.h.

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

Definition at line 81 of file StateAttribute.h.

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.

Definition at line 85 of file StateAttribute.h.

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.

Definition at line 89 of file StateAttribute.h.

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

Definition at line 275 of file StateAttribute.h.

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

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

Definition at line 209 of file StateAttribute.h.

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 StateAttribute 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 
SAMPLEMASKI 
PRIMITIVERESTARTINDEX 
CLIPCONTROL 
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 
ATOMICCOUNTERBUFFERBINDING 
PATCH_PARAMETER 
FRAME_BUFFER_OBJECT 
VERTEX_ATTRIB_DIVISOR 
SHADERSTORAGEBUFFERBINDING 
CAPABILITY 

Definition at line 123 of file StateAttribute.h.

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.

Definition at line 98 of file StateAttribute.h.

Constructor & Destructor Documentation

osg::StateAttribute::StateAttribute ( )
osg::StateAttribute::StateAttribute ( const StateAttribute sa,
const CopyOp copyop = CopyOp::SHALLOW_COPY 
)
inline

Definition at line 213 of file StateAttribute.h.

virtual osg::StateAttribute::~StateAttribute ( )
inlineprotectedvirtual

Definition at line 365 of file StateAttribute.h.

Member Function Documentation

void osg::StateAttribute::addParent ( osg::StateSet object)
protected
virtual void osg::StateAttribute::apply ( State ) const
inlinevirtual
virtual StateAttribute* osg::StateAttribute::asStateAttribute ( )
inlinevirtual

Convert 'this' into a StateAttribute pointer if Object is a StateAttribute, otherwise return 0. Equivalent to dynamic_cast<StateAttribute*>(this).

Reimplemented from osg::Object.

Definition at line 241 of file StateAttribute.h.

virtual const StateAttribute* osg::StateAttribute::asStateAttribute ( ) const
inlinevirtual

convert 'const this' into a const StateAttribute pointer if Object is a StateAttribute, otherwise return 0. Equivalent to dynamic_cast<const StateAttribute*>(this).

Reimplemented from osg::Object.

Definition at line 245 of file StateAttribute.h.

virtual Texture* osg::StateAttribute::asTexture ( )
inlinevirtual

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

Reimplemented in osg::Texture.

Definition at line 248 of file StateAttribute.h.

virtual const Texture* osg::StateAttribute::asTexture ( ) const
inlinevirtual

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

Reimplemented in osg::Texture.

Definition at line 251 of file StateAttribute.h.

virtual bool osg::StateAttribute::checkValidityOfAssociatedModes ( osg::State ) const
inlinevirtual

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.

Definition at line 315 of file StateAttribute.h.

virtual const char* osg::StateAttribute::className ( ) const
inlinevirtual

Return the name of the attribute's class type.

Implements osg::Object.

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

Definition at line 236 of file StateAttribute.h.

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, osg::VertexAttribDivisor, 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, osg::VertexAttribDivisor, and osg::ShaderAttribute.

Here is the caller graph for this function:

virtual int osg::StateAttribute::compare ( const StateAttribute sa) const
pure virtual
virtual void osg::StateAttribute::compileGLObjects ( State ) const
inlinevirtual

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.

Definition at line 352 of file StateAttribute.h.

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

Get the non const EventCallback.

Definition at line 338 of file StateAttribute.h.

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

Get the const EventCallback.

Definition at line 341 of file StateAttribute.h.

virtual unsigned int osg::StateAttribute::getMember ( ) const
inlinevirtual

Return the member identifier within the attribute's class type. Used for light number/clip plane number etc.

Reimplemented in osg::Capabilityi, osg::Light, osg::ClipPlane, osg::Hint, osg::BlendEquationi, osg::VertexAttribDivisor, osg::BlendFunci, osg::ColorMaski, and osg::BufferIndexBinding.

Definition at line 258 of file StateAttribute.h.

virtual bool osg::StateAttribute::getModeUsage ( ModeUsage ) const
inlinevirtual
unsigned int osg::StateAttribute::getNumParents ( ) const
inline

Get the number of parents of this StateAttribute.

Returns
the number of parents of this StateAttribute.

Definition at line 292 of file StateAttribute.h.

StateSet* osg::StateAttribute::getParent ( unsigned int  i)
inline

Definition at line 280 of file StateAttribute.h.

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.

Definition at line 286 of file StateAttribute.h.

const ParentList& osg::StateAttribute::getParents ( ) const
inline

Get the parent list of this StateAttribute.

Definition at line 278 of file StateAttribute.h.

ShaderComponent* osg::StateAttribute::getShaderComponent ( )
inline

Definition at line 295 of file StateAttribute.h.

Here is the caller graph for this function:

const ShaderComponent* osg::StateAttribute::getShaderComponent ( ) const
inline

Definition at line 296 of file StateAttribute.h.

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::Capability, osg::Hint, osg::ShaderAttribute, and osg::VertexAttribDivisor.

TypeMemberPair osg::StateAttribute::getTypeMemberPair ( ) const
inline

Return the TypeMemberPair that uniquely identifies this type member.

Definition at line 261 of file StateAttribute.h.

Here is the caller graph for this function:

StateAttributeCallback* osg::StateAttribute::getUpdateCallback ( )
inline

Get the non const UpdateCallback.

Definition at line 328 of file StateAttribute.h.

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

Get the const UpdateCallback.

Definition at line 331 of file StateAttribute.h.

virtual bool osg::StateAttribute::isSameKindAs ( const Object obj) const
inlinevirtual

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, osg::VertexAttribDivisor, and osg::ShaderAttribute.

Definition at line 230 of file StateAttribute.h.

virtual bool osg::StateAttribute::isTextureAttribute ( ) const
inlinevirtual

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.

Definition at line 264 of file StateAttribute.h.

virtual const char* osg::StateAttribute::libraryName ( ) const
inlinevirtual

Return the name of the attribute's library.

Implements osg::Object.

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

Definition at line 233 of file StateAttribute.h.

bool osg::StateAttribute::operator!= ( const StateAttribute rhs) const
inline

Definition at line 271 of file StateAttribute.h.

bool osg::StateAttribute::operator< ( const StateAttribute rhs) const
inline

Definition at line 269 of file StateAttribute.h.

bool osg::StateAttribute::operator== ( const StateAttribute rhs) const
inline

Definition at line 270 of file StateAttribute.h.

virtual void osg::StateAttribute::releaseGLObjects ( State = 0) const
inlinevirtual

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.

Definition at line 360 of file StateAttribute.h.

void osg::StateAttribute::removeParent ( osg::StateSet object)
protected
virtual void osg::StateAttribute::resizeGLObjectBuffers ( unsigned int  )
inlinevirtual

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.

Definition at line 355 of file StateAttribute.h.

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

Definition at line 294 of file StateAttribute.h.

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

Definition at line 371 of file StateAttribute.h.

Member Data Documentation

ref_ptr<StateAttributeCallback> osg::StateAttribute::_eventCallback
protected

Definition at line 376 of file StateAttribute.h.

ParentList osg::StateAttribute::_parents
protected

Definition at line 370 of file StateAttribute.h.

ref_ptr<ShaderComponent> osg::StateAttribute::_shaderComponent
protected

Definition at line 373 of file StateAttribute.h.

ref_ptr<StateAttributeCallback> osg::StateAttribute::_updateCallback
protected

Definition at line 375 of file StateAttribute.h.


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