class SG_EXPORT osg::StateAttribute

Base class for state attribues

Inheritance:

Public Methods

StateAttribute()

virtual Object* clone() const = 0

return a shallow copy of a node, 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* className() const

return the name of the attribute's class type

virtual const Type getType() const = 0

return the Type idenitifer of the attribute's class type

virtual void setStateSetModes(StateSet&, const GLModeValue) const

virtual void apply(State&) const = 0

apply the OpenGL state attributes.

virtual void compile(State&) const

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

Public Members

typedef GLenum GLMode

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

typedef unsigned int GLModeValue

GLModeValue is used to specified whether an mode is enabled (ON) or disabled (OFF).

typedef unsigned int OverrideValue

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

enum Values

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

enum Type

Values of StateAttribute::Type used to aid identification of diffenent StateAttribute subclasses.

Protected Methods

virtual ~StateAttribute()

Inherited from Object:

Inherited from Referenced:

Public Methods

inline Referenced& operator = (Referenced&)

inline void ref() const

inline void unref() const

inline const int referenceCount() const

Protected Fields

mutable int _refCount

Documentation

Base class for state attribues

typedef GLenum GLMode

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

typedef unsigned int GLModeValue

GLModeValue is used to specified whether an mode is enabled (ON) or disabled (OFF). GLMoveValue is also used to speficy the override behavior of modes from parent to children. See enum Value description for more details.

typedef unsigned int OverrideValue

Override is used to specified the override behavior of StateAttributes from from parent to children. See enum Value description for more details.

enum Values

list values which can be used in to set either GLModeValues or OverrideValues. When using in conjection with GLModeValues all Values have meaning. When using in conjection 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(..).

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

OVERRIDE_OFF

means that associated GLMode is disabled and Override is enabled

OVERRIDE_ON

means that associated GLMode and Override is enabled

INHERIT

means that GLMode or StateAttribute should in inherited from above

enum Type

Values of StateAttribute::Type used to aid identification of diffenent StateAttribute subclasses. Each subclass defines it 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 simple use that types value.

ALPHAFUNC

ANTIALIAS

COLORTABLE

CULLFACE

FOG

FRONTFACE

LIGHTING

MATERIAL

POINT

POLYGONMODE

POLYGONOFFSET

TEXENV

TEXGEN

TEXMAT

TEXTURE

TEXTURE_0

TEXTURE_1

TEXTURE_2

TEXTURE_3

TRANSPARENCY

STENCIL

COLORMASK

CLIPPLANE

CLIPPLANE_0

CLIPPLANE_1

CLIPPLANE_2

CLIPPLANE_3

CLIPPLANE_4

CLIPPLANE_5

DEPTH

StateAttribute()

virtual Object* clone() const = 0

return a shallow copy of a node, 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* className() const

return the name of the attribute's class type

virtual const Type getType() const = 0

return the Type idenitifer of the attribute's class type

virtual void setStateSetModes(StateSet&, const GLModeValue) const

virtual void apply(State&) const = 0

apply the OpenGL state attributes. The global state for the current OpenGL context is passed in to allow the StateAttribute to obtain details on the the current context and state.

virtual void compile(State&) const

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

virtual ~StateAttribute()

Direct child classes:

Transparency
Texture
TexMat
TexGen
TexEnv
Stencil
PolygonOffset
PolygonMode
Point
Material
Light
FrontFace
Fog
Depth
CullFace
ColorMask
ClipPlane
AlphaFunc

Alphabetic index HTML hierarchy of classes or Java