Inheritance diagram for osg::StateAttribute:
Public Types | |
| 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. | |
| 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, VALIDATOR, VIEWMATRIXEXTRACTOR, OSGNV_PARAMETER_BLOCK, OSGNVEXT_TEXTURE_SHADER, OSGNVEXT_VERTEX_PROGRAM, OSGNVEXT_REGISTER_COMBINERS, OSGNVCG_PROGRAM, OSGNVSLANG_PROGRAM, OSGNVPARSE_PROGRAM_PARSER } |
| Values of StateAttribute::Type used to aid identification of different StateAttribute subclasses. More... | |
Public Member Functions | |
| StateAttribute () | |
| StateAttribute (const StateAttribute &sa, const CopyOp ©op=CopyOp::SHALLOW_COPY) | |
| virtual Object * | cloneType () const=0 |
| Clone the type of an attribute, with Object* return type. | |
| virtual Object * | clone (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 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 ParentList & | getParents () const |
| Get the parent list of this StateAttribute. | |
| StateSet * | getParent (unsigned int i) |
| const StateSet * | getParent (unsigned int i) const |
| Get a single const parent of this StateAttribute. | |
| unsigned int | getNumParents () const |
| Get the number of parents of this StateAttribute. | |
| virtual bool | getModeUsage (ModeUsage &) const |
| Return the modes associated with this StateAttribute. | |
| void | setUpdateCallback (Callback *uc) |
| Set the UpdateCallback which allows users to attach customize the updating of an object during the update traversal. | |
| Callback * | getUpdateCallback () |
| Get the non const UpdateCallback. | |
| const Callback * | getUpdateCallback () const |
| Get the const UpdateCallback. | |
| void | setEventCallback (Callback *ec) |
| Set the EventCallback which allows users to attach customize the updating of an object during the Event traversal. | |
| Callback * | getEventCallback () |
| Get the non const EventCallback. | |
| const Callback * | getEventCallback () const |
| Get the const EventCallback. | |
| virtual void | apply (State &) const=0 |
| apply the OpenGL state attributes. | |
| virtual void | compileGLObjects (State &) const |
| default to nothing to compile - all state is applied immediately. | |
| virtual void | releaseGLObjects (State *=0) const |
| release OpenGL objects in specified graphics context if State object is passed, otherwise release OpenGL objexts 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< Callback > | _updateCallback |
| ref_ptr< Callback > | _eventCallback |
|
|
GLMode is the value used in glEnable/glDisable(mode).
|
|
|
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. |
|
|
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.
|
|
|
Simple pairing between an attribute type and the member within that attribute type group.
|
|
|
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.
|
|
|
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 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(..).
|
|
|
|
|
||||||||||||
|
|
|
|
|
|
|
|
|
|
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::BlendColor, osg::BlendEquation, osg::BlendFunc, osg::ClipPlane, osg::ColorMask, osg::ColorMatrix, osg::CullFace, osg::Depth, osg::Fog, osg::FragmentProgram, osg::FrameBufferObject, osg::FrontFace, osg::Light, osg::LightModel, osg::LineStipple, osg::LineWidth, osg::LogicOp, osg::Material, osg::Multisample, osg::Point, osg::PointSprite, osg::PolygonMode, osg::PolygonOffset, osg::PolygonStipple, osg::Program, osg::Scissor, osg::ShadeModel, osg::Stencil, osg::TexEnv, osg::TexEnvCombine, osg::TexEnvFilter, osg::TexGen, osg::TexMat, osg::Texture, osg::Texture1D, osg::Texture2D, osg::Texture3D, osg::TextureCubeMap, osg::TextureRectangle, osg::VertexProgram, osg::Viewport, osgFX::Validator, and osgText::Font::GlyphTexture. |
|
|
Return the name of the attribute's class type.
Implements osg::Object. Reimplemented in osg::Texture, and osgText::Font::GlyphTexture. |
|
|
Clone an attribute, with Object* return type. Must be defined by derived classes. Implements osg::Object. Implemented in osg::Texture. |
|
|
Clone the type of an attribute, with Object* return type. Must be defined by derived classes. Implements osg::Object. Implemented in osg::Texture. |
|
|
Return -1 if *this < *rhs, 0 if *this==*rhs, 1 if *this>*rhs.
Implemented in osg::AlphaFunc, osg::BlendColor, osg::BlendEquation, osg::BlendFunc, osg::ClipPlane, osg::ColorMask, osg::ColorMatrix, osg::CullFace, osg::Depth, osg::Fog, osg::FrameBufferObject, osg::FrontFace, osg::Light, osg::LightModel, osg::LineStipple, osg::LineWidth, osg::LogicOp, osg::Material, osg::Multisample, osg::Point, osg::PointSprite, osg::PolygonMode, osg::PolygonOffset, osg::PolygonStipple, osg::Scissor, osg::ShadeModel, osg::Stencil, osg::TexEnv, osg::TexEnvCombine, osg::TexEnvFilter, osg::TexGen, osg::TexMat, osg::Texture1D, osg::Texture2D, osg::Texture3D, osg::TextureCubeMap, osg::TextureRectangle, and osg::Viewport. |
|
|
default to nothing to compile - all state is applied immediately.
Reimplemented in osg::FragmentProgram, osg::Program, osg::Texture, osg::VertexProgram, and osgFX::Validator. |
|
|
Get the const EventCallback.
|
|
|
Get the non const EventCallback.
|
|
|
Return the member identifier within the attribute's class type. Used for light number/clip plane number etc. Reimplemented in osg::ClipPlane, and osg::Light. |
|
|
Return the modes associated with this StateAttribute.
Reimplemented in osg::AlphaFunc, osg::BlendColor, osg::BlendEquation, osg::BlendFunc, osg::ClipPlane, osg::CullFace, osg::Depth, osg::Fog, osg::FragmentProgram, osg::Light, osg::LineStipple, osg::LogicOp, osg::Material, osg::Point, osg::PointSprite, osg::PolygonOffset, osg::PolygonStipple, osg::Scissor, osg::Stencil, osg::TexGen, osg::Texture, and osg::VertexProgram. |
|
|
Get the number of parents of this StateAttribute.
|
|
|
Get a single const parent of this StateAttribute.
|
|
|
|
|
|
Get the parent list of this StateAttribute.
|
|
|
Return the Type identifier of the attribute's class type.
Implemented in osg::Texture. |
|
|
Return the TypeMemberPair that uniquely identifies this type member.
|
|
|
Get the const UpdateCallback.
|
|
|
Get the non const UpdateCallback.
|
|
|
Return true if this and obj are of the same kind of object.
Reimplemented from osg::Object. |
|
|
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::PointSprite, osg::TexEnv, osg::TexEnvCombine, osg::TexEnvFilter, osg::TexGen, osg::TexMat, and osg::Texture. |
|
|
Return the name of the attribute's library.
Implements osg::Object. Reimplemented in osg::Texture. |
|
|
|
|
|
|
|
|
|
|
|
release OpenGL objects in specified graphics context if State object is passed, otherwise release OpenGL objexts for all graphics context if State object pointer NULL.
Reimplemented from osg::Object. Reimplemented in osg::FragmentProgram, osg::Program, osg::Texture, and osg::VertexProgram. |
|
|
|
|
|
Set the EventCallback which allows users to attach customize the updating of an object during the Event traversal.
|
|
|
Set the UpdateCallback which allows users to attach customize the updating of an object during the update traversal.
|
|
|
|
|
|
|
|
|
|