Main Page   Namespace List   Class Hierarchy   Alphabetical List   Compound List   File List   Namespace Members   Compound Members   File Members   Related Pages  

osg::StateAttribute Class Reference

Base class for state attribuets. More...

Inheritance diagram for osg::StateAttribute:

Inheritance graph
[legend]
List of all members.

Public Types

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.

typedef unsigned int Type
 Type identifier to differentiate between different state types.

enum  Values {
  OFF = 0x0, ON = 0x1, OVERRIDE = 0x2, PROTECTED = 0x4,
  INHERIT = 0x8
}
 list values which can be used in to set either GLModeValues or OverrideValues. More...

enum  Types {
  TEXTURE, POLYGONMODE, POLYGONOFFSET, MATERIAL,
  ALPHAFUNC, ANTIALIAS, COLORTABLE, CULLFACE,
  FOG, FRONTFACE, LIGHT, LIGHT_0 = LIGHT,
  LIGHT_1, LIGHT_2, LIGHT_3, LIGHT_4,
  LIGHT_5, LIGHT_6, LIGHT_7, POINT,
  LINEWIDTH, LINESTIPPLE, SHADEMODEL, TEXENV,
  TEXGEN, TEXMAT, LIGHTMODEL, BLENDFUNC,
  STENCIL, COLORMASK, DEPTH, VIEWPORT,
  CLIPPLANE, CLIPPLANE_0 = CLIPPLANE, CLIPPLANE_1, CLIPPLANE_2,
  CLIPPLANE_3, CLIPPLANE_4, CLIPPLANE_5, COLORMATRIX
}
 Values of StateAttribute::Type used to aid identification of different StateAttribute subclasses. More...


Public Methods

 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 const Type getType () const=0
 return the Type identifier of the attribute's class type.

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
virtual void getAssociatedModes (std::vector< GLMode > &) const
 return the modes associated with this StateSet

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.


Protected Methods

virtual ~StateAttribute ()

Detailed Description

Base class for state attribuets.


Member Typedef Documentation

typedef GLenum osg::StateAttribute::GLMode
 

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

typedef unsigned int osg::StateAttribute::GLModeValue
 

GLModeValue is used to specified whether an 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 specified the override behavior of StateAttributes from from parent to children.

See enum Value description for more details.

typedef unsigned int osg::StateAttribute::Type
 

Type identifier to differentiate between different state types.


Member Enumeration Documentation

enum osg::StateAttribute::Types
 

Values of StateAttribute::Type used to aid identification of different 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.

Enumeration values:
TEXTURE 
POLYGONMODE 
POLYGONOFFSET 
MATERIAL 
ALPHAFUNC 
ANTIALIAS 
COLORTABLE 
CULLFACE 
FOG 
FRONTFACE 
LIGHT 
LIGHT_0 
LIGHT_1 
LIGHT_2 
LIGHT_3 
LIGHT_4 
LIGHT_5 
LIGHT_6 
LIGHT_7 
POINT 
LINEWIDTH 
LINESTIPPLE 
SHADEMODEL 
TEXENV 
TEXGEN 
TEXMAT 
LIGHTMODEL 
BLENDFUNC 
STENCIL 
COLORMASK 
DEPTH 
VIEWPORT 
CLIPPLANE 
CLIPPLANE_0 
CLIPPLANE_1 
CLIPPLANE_2 
CLIPPLANE_3 
CLIPPLANE_4 
CLIPPLANE_5 
COLORMATRIX 

enum osg::StateAttribute::Values
 

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

When using in conjunction 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(..).

Enumeration values:
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 overriden.
PROTECTED  Protecting of GLMode's os StateAttributes is enabled, so that state from above connot override this and below state.
INHERIT  means that GLMode or StateAttribute should in inherited from above.


Constructor & Destructor Documentation

osg::StateAttribute::StateAttribute   [inline]
 

osg::StateAttribute::StateAttribute const StateAttribute &    sa,
const CopyOp   copyop = CopyOp::SHALLOW_COPY
[inline]
 

virtual osg::StateAttribute::~StateAttribute   [inline, protected, virtual]
 


Member Function Documentation

virtual void osg::StateAttribute::apply State   const [pure virtual]
 

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.

Implemented in osg::AlphaFunc, osg::BlendFunc, osg::ClipPlane, osg::ColorMask, osg::ColorMatrix, osg::CullFace, osg::Depth, osg::Fog, osg::FrontFace, osg::Light, osg::LightModel, osg::LineStipple, osg::LineWidth, osg::Material, osg::Point, osg::PolygonMode, osg::PolygonOffset, osg::ShadeModel, osg::Stencil, osg::TexEnv, osg::TexEnvCombine, osg::TexGen, osg::TexMat, osg::Texture, osg::Texture1D, osg::Texture2D, osg::Texture3D, osg::TextureCubeMap, and osg::Viewport.

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.

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.

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.

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::AlphaFunc, osg::BlendFunc, osg::ClipPlane, osg::ColorMask, osg::ColorMatrix, osg::CullFace, osg::Depth, osg::Fog, osg::FrontFace, osg::Light, osg::LightModel, osg::LineStipple, osg::LineWidth, osg::Material, osg::Point, osg::PolygonMode, osg::PolygonOffset, osg::ShadeModel, osg::Stencil, osg::TexEnv, osg::TexEnvCombine, osg::TexGen, osg::TexMat, osg::Texture1D, osg::Texture2D, osg::Texture3D, osg::TextureCubeMap, and osg::Viewport.

virtual void osg::StateAttribute::compile State   const [inline, virtual]
 

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

Reimplemented in osg::Texture.

virtual void osg::StateAttribute::getAssociatedModes std::vector< GLMode > &    const [inline, virtual]
 

return the modes associated with this StateSet

Reimplemented in osg::AlphaFunc, osg::BlendFunc, osg::ClipPlane, osg::CullFace, osg::Depth, osg::Fog, osg::Light, osg::LineStipple, osg::Material, osg::Point, osg::PolygonOffset, osg::Stencil, osg::TexGen, osg::Texture1D, osg::Texture2D, and osg::Texture3D.

virtual const Type osg::StateAttribute::getType   const [pure virtual]
 

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

Implemented in osg::Texture.

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.

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::TexEnv, osg::TexEnvCombine, osg::TexGen, osg::TexMat, and osg::Texture.

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

return the name of the attribute's library.

Implements osg::Object.

Reimplemented in osg::Texture.

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]
 


The documentation for this class was generated from the following file:
Generated at Wed Sep 18 13:55:42 2002 for the Open Scene Graph by doxygen 1.2.16.