Base class for state attributes. More...

Inherits osg::Object.

Inherited by osg::AlphaFunc, osg::BindImageTexture, 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::DepthRangeIndexed, 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::Sampler, osg::Scissor, osg::ScissorIndexed, osg::ShadeModel, osg::ShaderAttribute, osg::Stencil, osg::StencilTwoSided, osg::TexEnvCombine, osg::TexEnvFilter, osg::TexMat, osg::TextureAttribute, osg::VertexAttribDivisor, osg::VertexProgram, osg::Viewport, and osgFX::Validator.

Classes
struct	ModeUsage

struct	ReassignToParents
	Helper class that make is easy to handle changes in a member value. More...

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, 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, INDIRECTDRAWBUFFERBINDING, VIEWPORTINDEXED, DEPTHRANGEINDEXED, SCISSORINDEXED, BINDIMAGETEXTURE, SAMPLER, 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
	StateAttribute ()

	StateAttribute (const StateAttribute &sa, const CopyOp &copyop=CopyOp::SHALLOW_COPY)

virtual Object *	cloneType () const =0
	Clone the type of an attribute, with Object* return type. More...

virtual Object *	clone (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 StateAttribute *	asStateAttribute ()
	Convert 'this' into a StateAttribute pointer if Object is a StateAttribute, otherwise return 0. More...

virtual const StateAttribute *	asStateAttribute () const
	convert 'const this' into a const StateAttribute pointer if Object is a StateAttribute, otherwise return 0. More...

virtual Texture *	asTexture ()
	Fast alternative to dynamic_cast<> for determining if state attribute is a Texture. More...

virtual const Texture *	asTexture () 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...

virtual int	compare (const StateAttribute &sa) const =0
	Return -1 if this < rhs, 0 if this==rhs, 1 if this>rhs. More...

bool	operator< (const StateAttribute &rhs) const

bool	operator== (const StateAttribute &rhs) const

bool	operator!= (const StateAttribute &rhs) const

const ParentList &	getParents () const
	Get the parent list of this StateAttribute. More...

StateSet *	getParent (unsigned int i)

const StateSet *	getParent (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)

ShaderComponent *	getShaderComponent ()

const ShaderComponent *	getShaderComponent () const

virtual bool	getModeUsage (ModeUsage &) const
	Return the modes associated with this StateAttribute. More...

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...

StateAttributeCallback *	getUpdateCallback ()
	Get the non const UpdateCallback. More...

const StateAttributeCallback *	getUpdateCallback () 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...

StateAttributeCallback *	getEventCallback ()
	Get the non const EventCallback. More...

const StateAttributeCallback *	getEventCallback () const
	Get the const EventCallback. More...

virtual void	apply (State &) const
	apply the OpenGL state attributes. 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 Node *	asNode ()
	Convert 'this' into a Node pointer if Object is a Node, otherwise return 0. More...

virtual const Node *	asNode () const
	convert 'const this' into a const Node pointer if Object is a Node, otherwise return 0. More...

virtual NodeVisitor *	asNodeVisitor ()
	Convert 'this' into a NodeVisitor pointer if Object is a NodeVisitor, otherwise return 0. More...

virtual const NodeVisitor *	asNodeVisitor () const
	convert 'const this' into a const NodeVisitor pointer if Object is a NodeVisitor, otherwise return 0. More...

virtual StateSet *	asStateSet ()
	Convert 'this' into a StateSet pointer if Object is a StateSet, otherwise return 0. More...

virtual const StateSet *	asStateSet () const
	convert 'const this' into a const StateSet pointer if Object is a StateSet, otherwise return 0. More...

virtual Uniform *	asUniform ()
	Convert 'this' into a Uniform pointer if Object is a Uniform, otherwise return 0. More...

virtual const UniformBase *	asUniformBase () const
	convert 'const this' into a const Uniform pointer if Object is a Uniform, otherwise return 0. More...

virtual UniformBase *	asUniformBase ()
	Convert 'this' into a Uniform pointer if Object is a Uniform, otherwise return 0. More...

virtual const Uniform *	asUniform () const
	convert 'const this' into a const Uniform pointer if Object is a Uniform, otherwise return 0. More...

virtual Camera *	asCamera ()
	Convert 'this' into a Camera pointer if Node is a Camera, otherwise return 0. More...

virtual const Camera *	asCamera () const
	convert 'const this' into a const Camera pointer if Node is a Camera, otherwise return 0. More...

virtual Drawable *	asDrawable ()
	Convert 'this' into a Drawable pointer if Object is a Drawable, otherwise return 0. More...

virtual const Drawable *	asDrawable () const
	convert 'const this' into a const Drawable pointer if Object is a Drawable, otherwise return 0. More...

virtual Callback *	asCallback ()
	Convert 'this' into a Callback pointer if Object is a Callback, otherwise return 0. More...

virtual const Callback *	asCallback () const
	convert 'const this' into a const Callback pointer if Object is a Callback, otherwise return 0. More...

virtual CallbackObject *	asCallbackObject ()
	Convert 'this' into a CallbackObject pointer if Object is a CallbackObject, otherwise return 0. More...

virtual const CallbackObject *	asCallbackObject () const
	convert 'const this' into a const CallbackObject pointer if Object is a CallbackObject, otherwise return 0. More...

virtual UserDataContainer *	asUserDataContainer ()
	Convert 'this' into a UserDataContainer pointer if Object is a UserDataContainer, otherwise return 0. More...

virtual const UserDataContainer *	asUserDataContainer () const
	convert 'const this' into a const UserDataContainer pointer if Object is a UserDataContainer, otherwise return 0. More...

virtual ValueObject *	asValueObject ()
	Convert 'this' into a ValueObject pointer if Object is a ValueObject, otherwise return 0. More...

virtual const ValueObject *	asValueObject () const
	Convert 'this' into a ValueObject pointer if Object is a ValueObject, otherwise return 0. More...

virtual Image *	asImage ()
	Convert 'this' into a Image pointer if Object is a Image, otherwise return 0. More...

virtual const Image *	asImage () const
	Convert 'this' into a Image pointer if Object is a Image, 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::UserDataContainer *	getUserDataContainer ()
	get the UserDataContainer attached to this object. More...

const osg::UserDataContainer *	getUserDataContainer () const
	get the const UserDataContainer attached to this object. More...

osg::UserDataContainer *	getOrCreateUserDataContainer ()
	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 Referenced *	getUserData ()
	Get user data. More...

virtual const Referenced *	getUserData () 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)
	Deprecated, Referenced is now always uses thread safe ref/unref, use default Referenced() constructor instead. More...

	Referenced (const Referenced &)

Referenced &	operator= (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...

ObserverSet *	getObserverSet () const
	Get the ObserverSet if one is attached, otherwise return NULL. More...

ObserverSet *	getOrCreateObserverSet () 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	~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
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::Mutex *	getGlobalReferencedMutex ()
	Get the optional global Referenced mutex, this can be shared between all osg::Referenced. More...

static void	setDeleteHandler (DeleteHandler *handler)
	Set a DeleteHandler to which deletion of all referenced counted objects will be delegated. More...

static DeleteHandler *	getDeleteHandler ()
	Get a DeleteHandler. More...

Detailed Description

Base class for state attributes.

Member Typedef Documentation

◆ Callback

typedef osg::StateAttributeCallback osg::StateAttribute::Callback

◆ GLMode

typedef GLenum osg::StateAttribute::GLMode

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

◆ GLModeValue

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.

◆ OverrideValue

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.

◆ ParentList

typedef std::vector<StateSet*> osg::StateAttribute::ParentList

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

◆ TypeMemberPair

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

enum osg::StateAttribute::Type

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
INDIRECTDRAWBUFFERBINDING
VIEWPORTINDEXED
DEPTHRANGEINDEXED
SCISSORINDEXED
BINDIMAGETEXTURE
SAMPLER
CAPABILITY

◆ Values

enum osg::StateAttribute::Values

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

◆ StateAttribute() [1/2]

osg::StateAttribute::StateAttribute ( )

◆ StateAttribute() [2/2]

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

inline

References osg::clone(), and osg::cloneType().

◆ ~StateAttribute()

virtual osg::StateAttribute::~StateAttribute ( )

inlineprotectedvirtual

Member Function Documentation

◆ addParent()

void osg::StateAttribute::addParent ( osg::StateSet * object )

protected

◆ apply()

virtual void osg::StateAttribute::apply ( State & ) const

inlinevirtual

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 in osg::Texture, osg::FrameBufferObject, osg::TexEnvCombine, osg::FragmentProgram, osg::VertexProgram, osg::Light, osg::Stencil, osg::BlendFunc, osg::Texture2D, osg::Disablei, osg::Texture3D, osg::StencilTwoSided, osg::TextureRectangle, osg::Texture1D, osg::Viewport, osg::Texture2DArray, osg::TextureCubeMap, osg::Enablei, osg::Fog, osg::ClipPlane, osg::LogicOp, osg::BlendEquation, osg::BufferIndexBinding, osg::Material, osg::Depth, osg::Sampler, osg::Scissor, osg::Multisample, osg::BindImageTexture, osg::TexGen, osg::Point, osg::TextureBuffer, osg::AlphaFunc, osg::ColorMask, osg::ScissorIndexed, osg::Texture2DMultisample, osg::ClampColor, osg::LightModel, osg::TexEnv, osg::PolygonMode, osg::TexMat, osg::VertexAttribDivisor, osg::PatchParameter, osg::ClipControl, osg::PolygonOffset, osg::DepthRangeIndexed, osg::Hint, osg::LineStipple, osg::CullFace, osg::BlendColor, osg::BlendEquationi, osg::Program, osg::BlendFunci, osg::ShadeModel, osg::ColorMaski, osg::ViewportIndexed, osg::PointSprite, osg::TexEnvFilter, osg::ColorMatrix, osg::ShaderAttribute, osg::FrontFace, osg::PolygonStipple, osg::LineWidth, osgFX::Validator, osg::PrimitiveRestartIndex, and osg::SampleMaski.

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

◆ asStateAttribute() [1/2]

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.

◆ asStateAttribute() [2/2]

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.

◆ asTexture() [1/2]

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

inlinevirtual

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

Reimplemented in osg::Texture.

◆ asTexture() [2/2]

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.

◆ checkValidityOfAssociatedModes()

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.

◆ className()

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.

◆ clone()

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.

◆ cloneType()

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.

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

◆ compare()

virtual int osg::StateAttribute::compare ( const StateAttribute & sa ) const

pure virtual

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

Implemented in osg::FrameBufferObject, osgText::GlyphTexture, osg::ShaderStorageBufferBinding, osg::AtomicCounterBufferBinding, osg::TransformFeedbackBufferBinding, osg::FragmentProgram, osg::VertexProgram, osg::UniformBufferBinding, osg::Sampler, osg::TexEnvCombine, osg::BindImageTexture, osg::BlendFunc, osg::Capabilityi, osg::LogicOp, osg::Fog, osg::BlendEquation, osg::Light, osg::Multisample, osg::ClipPlane, osg::Program, osg::Stencil, osg::ClampColor, osg::Material, osg::PolygonMode, osg::TextureRectangle, osg::Depth, osg::TexGen, osg::AlphaFunc, osg::ClipControl, osg::TexEnv, osg::Texture1D, osg::Viewport, osg::Point, osg::StencilTwoSided, osg::ColorMask, osg::ShadeModel, osg::Texture3D, osg::PointSprite, osg::ScissorIndexed, osg::Texture2D, osg::Hint, osgFX::Validator, osg::BlendEquationi, osg::VertexAttribDivisor, osg::BlendFunci, osg::CullFace, osg::Scissor, osg::DepthRangeIndexed, osg::LineStipple, osg::PolygonOffset, osg::TexEnvFilter, osg::FrontFace, osg::TexMat, osg::Texture2DMultisample, osg::BlendColor, osg::PatchParameter, osg::ColorMaski, osg::PolygonStipple, osg::Texture2DArray, osg::TextureBuffer, osg::ViewportIndexed, osg::LightModel, osg::Capability, osg::ShaderAttribute, osg::ColorMatrix, osg::LineWidth, and osg::TextureCubeMap.

◆ compileGLObjects()

virtual void osg::StateAttribute::compileGLObjects ( State & ) const

inlinevirtual

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

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

◆ getEventCallback() [1/2]

StateAttributeCallback* osg::StateAttribute::getEventCallback ( )

inline

Get the non const EventCallback.

◆ getEventCallback() [2/2]

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

inline

Get the const EventCallback.

◆ getMember()

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::BindImageTexture, osg::Light, osg::ClipPlane, osg::ScissorIndexed, osg::Hint, osg::VertexAttribDivisor, osg::BlendEquationi, osg::DepthRangeIndexed, osg::BlendFunci, osg::ColorMaski, osg::ViewportIndexed, osg::BufferIndexBinding, and osg::TextureAttribute.

◆ getModeUsage()

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

inlinevirtual

Return the modes associated with this StateAttribute.

Reimplemented in osg::FragmentProgram, osg::VertexProgram, osg::BlendFunc, osg::Light, osg::Fog, osg::Material, osg::LogicOp, osg::BlendEquation, osg::ClipPlane, osg::Stencil, osg::TexGen, osg::Depth, osg::AlphaFunc, osg::Point, osg::Scissor, osg::CullFace, osg::LineStipple, osg::PolygonOffset, osg::ShaderAttribute, osg::BlendColor, osg::StencilTwoSided, osg::Texture2DMultisample, osg::PointSprite, osg::Texture2DArray, and osg::PolygonStipple.

◆ getNumParents()

unsigned int osg::StateAttribute::getNumParents ( ) const

inline

Get the number of parents of this StateAttribute.

Returns: the number of parents of this StateAttribute.

◆ getParent() [1/2]

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

inline

◆ getParent() [2/2]

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

inline

Get a single const parent of this StateAttribute.

Parameters

i	index of the parent to get.

Returns: the parent i.

◆ getParents()

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

inline

Get the parent list of this StateAttribute.

◆ getShaderComponent() [1/2]

ShaderComponent* osg::StateAttribute::getShaderComponent ( )

inline

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

◆ getShaderComponent() [2/2]

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

inline

◆ getType()

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.

◆ getTypeMemberPair()

TypeMemberPair osg::StateAttribute::getTypeMemberPair ( ) const

inline

Return the TypeMemberPair that uniquely identifies this type member.

Referenced by osg::State::applyAttribute(), osg::State::applyTextureAttribute(), osg::State::getAttributeVec(), osg::State::setGlobalDefaultAttribute(), and osg::State::setGlobalDefaultTextureAttribute().

◆ getUpdateCallback() [1/2]

StateAttributeCallback* osg::StateAttribute::getUpdateCallback ( )

inline

Get the non const UpdateCallback.

◆ getUpdateCallback() [2/2]

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

inline

Get the const UpdateCallback.

◆ isSameKindAs()

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.

References NULL.

◆ isTextureAttribute()

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::PointSprite, osg::TexEnvFilter, osg::TexMat, and osg::TextureAttribute.

◆ libraryName()

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.

◆ operator!=()

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

inline

◆ operator<()

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

inline

◆ operator==()

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

inline

◆ releaseGLObjects()

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

◆ removeParent()

void osg::StateAttribute::removeParent ( osg::StateSet * object )

protected

◆ resizeGLObjectBuffers()

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::FragmentProgram, osg::VertexProgram, osg::Program, and osg::ShaderAttribute.

◆ setEventCallback()

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

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

◆ setShaderComponent()

void osg::StateAttribute::setShaderComponent ( ShaderComponent * sc )

inline

◆ setUpdateCallback()

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

◆ osg::StateSet

friend class osg::StateSet

friend

Member Data Documentation

◆ _eventCallback

ref_ptr<StateAttributeCallback> osg::StateAttribute::_eventCallback

protected

◆ _parents

ParentList osg::StateAttribute::_parents

protected

◆ _shaderComponent

ref_ptr<ShaderComponent> osg::StateAttribute::_shaderComponent

protected

◆ _updateCallback

ref_ptr<StateAttributeCallback> osg::StateAttribute::_updateCallback

protected

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

osg/StateAttribute

Classes

Public Types

Public Member Functions

Protected Member Functions

Protected Attributes

Friends

Additional Inherited Members

Detailed Description

Member Typedef Documentation

◆ Callback

◆ GLMode

◆ GLModeValue

◆ OverrideValue

◆ ParentList

◆ TypeMemberPair

Member Enumeration Documentation

◆ Type

◆ Values

Constructor & Destructor Documentation

◆ StateAttribute() [1/2]

◆ StateAttribute() [2/2]

◆ ~StateAttribute()

Member Function Documentation

◆ addParent()

◆ apply()

◆ asStateAttribute() [1/2]

◆ asStateAttribute() [2/2]

◆ asTexture() [1/2]

◆ asTexture() [2/2]

◆ checkValidityOfAssociatedModes()

◆ className()

◆ clone()

◆ cloneType()

◆ compare()

◆ compileGLObjects()

◆ getEventCallback() [1/2]

◆ getEventCallback() [2/2]

◆ getMember()

◆ getModeUsage()

◆ getNumParents()

◆ getParent() [1/2]

◆ getParent() [2/2]

◆ getParents()

◆ getShaderComponent() [1/2]

◆ getShaderComponent() [2/2]

◆ getType()

◆ getTypeMemberPair()

◆ getUpdateCallback() [1/2]

◆ getUpdateCallback() [2/2]

◆ isSameKindAs()

◆ isTextureAttribute()

◆ libraryName()

◆ operator!=()

◆ operator<()

◆ operator==()

◆ releaseGLObjects()

◆ removeParent()

◆ resizeGLObjectBuffers()

◆ setEventCallback()

◆ setShaderComponent()

◆ setUpdateCallback()

Friends And Related Function Documentation

◆ osg::StateSet

Member Data Documentation

◆ _eventCallback

◆ _parents

◆ _shaderComponent

◆ _updateCallback