openscenegraph
|
#include <StateAttribute>
Classes | |
struct | ModeUsage |
struct | ReassignToParents |
Public Member Functions | |
StateAttribute () | |
StateAttribute (const StateAttribute &sa, const CopyOp ©op=CopyOp::SHALLOW_COPY) | |
virtual Object * | cloneType () const =0 |
virtual Object * | clone (const CopyOp &) const =0 |
virtual bool | isSameKindAs (const Object *obj) const |
virtual const char * | libraryName () const |
virtual const char * | className () const |
virtual StateAttribute * | asStateAttribute () |
virtual const StateAttribute * | asStateAttribute () const |
virtual Texture * | asTexture () |
virtual const Texture * | asTexture () 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 ParentList & | getParents () const |
StateSet * | getParent (unsigned int i) |
const StateSet * | getParent (unsigned int i) const |
unsigned int | getNumParents () const |
void | setShaderComponent (ShaderComponent *sc) |
ShaderComponent * | getShaderComponent () |
const ShaderComponent * | getShaderComponent () const |
virtual bool | getModeUsage (ModeUsage &) const |
virtual bool | checkValidityOfAssociatedModes (osg::State &) const |
void | setUpdateCallback (StateAttributeCallback *uc) |
StateAttributeCallback * | getUpdateCallback () |
const StateAttributeCallback * | getUpdateCallback () const |
void | setEventCallback (StateAttributeCallback *ec) |
StateAttributeCallback * | getEventCallback () |
const StateAttributeCallback * | getEventCallback () const |
virtual void | apply (State &) const |
virtual void | compileGLObjects (State &) const |
virtual void | resizeGLObjectBuffers (unsigned int) |
virtual void | releaseGLObjects (State *=0) const |
![]() | |
Object () | |
Object (bool threadSafeRefUnref) | |
Object (const Object &, const CopyOp ©op=CopyOp::SHALLOW_COPY) | |
std::string | getCompoundClassName () const |
virtual Node * | asNode () |
virtual const Node * | asNode () const |
virtual NodeVisitor * | asNodeVisitor () |
virtual const NodeVisitor * | asNodeVisitor () const |
virtual StateSet * | asStateSet () |
virtual const StateSet * | asStateSet () const |
virtual Uniform * | asUniform () |
virtual const Uniform * | asUniform () const |
virtual Camera * | asCamera () |
virtual const Camera * | asCamera () const |
virtual Drawable * | asDrawable () |
virtual const Drawable * | asDrawable () const |
virtual Callback * | asCallback () |
virtual const Callback * | asCallback () const |
virtual CallbackObject * | asCallbackObject () |
virtual const CallbackObject * | asCallbackObject () const |
virtual UserDataContainer * | asUserDataContainer () |
virtual const UserDataContainer * | asUserDataContainer () const |
virtual ValueObject * | asValueObject () |
virtual const ValueObject * | asValueObject () const |
virtual Image * | asImage () |
virtual const Image * | asImage () 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) |
template<class T > | |
void | setUserDataContainer (const ref_ptr< T > &udc) |
osg::UserDataContainer * | getUserDataContainer () |
const osg::UserDataContainer * | getUserDataContainer () const |
osg::UserDataContainer * | getOrCreateUserDataContainer () |
virtual void | setUserData (Referenced *obj) |
template<class T > | |
void | setUserData (const ref_ptr< T > &ud) |
virtual Referenced * | getUserData () |
virtual const Referenced * | getUserData () 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 |
![]() | |
Referenced () | |
Referenced (bool threadSafeRefUnref) | |
Referenced (const Referenced &) | |
Referenced & | operator= (const Referenced &) |
bool | getThreadSafeRefUnref () const |
OpenThreads::Mutex * | getRefMutex () const |
int | ref () const |
int | unref () const |
int | unref_nodelete () const |
int | referenceCount () const |
ObserverSet * | getObserverSet () const |
ObserverSet * | getOrCreateObserverSet () 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) |
![]() | |
virtual | ~Object () |
![]() | |
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 |
![]() | |
std::string | _name |
DataVariance | _dataVariance |
osg::UserDataContainer * | _userDataContainer |
![]() | |
OpenThreads::AtomicPtr | _observerSet |
OpenThreads::Atomic | _refCount |
Friends | |
class | osg::StateSet |
Additional Inherited Members | |
![]() | |
static OpenThreads::Mutex * | getGlobalReferencedMutex () |
static void | setDeleteHandler (DeleteHandler *handler) |
static DeleteHandler * | getDeleteHandler () |
Base class for state attributes.
typedef GLenum osg::StateAttribute::GLMode |
GLMode is the value used in glEnable/glDisable(mode)
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.
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.
typedef std::vector<StateSet*> osg::StateAttribute::ParentList |
A vector of osg::StateSet pointers which is used to store the parent(s) of this StateAttribute.
typedef std::pair<Type,unsigned int> osg::StateAttribute::TypeMemberPair |
Simple pairing between an attribute type and the member within that attribute type group.
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 |
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. |
osg::StateAttribute::StateAttribute | ( | ) |
|
inline |
|
inlineprotectedvirtual |
|
protected |
|
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::BindImageTexture, osg::PointSprite, osg::Program, osgFX::Validator, osg::Enablei, osg::Disablei, osg::AlphaFunc, osg::BlendColor, osg::BlendEquation, osg::BlendEquationi, osg::BlendFunc, osg::BlendFunci, osg::BufferIndexBinding, osg::ClampColor, osg::ClipControl, osg::ClipPlane, osg::ColorMask, osg::ColorMaski, 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::PolygonMode, osg::PolygonOffset, osg::PolygonStipple, osg::PrimitiveRestartIndex, osg::SampleMaski, osg::Sampler, osg::Scissor, osg::ScissorIndexed, osg::ShadeModel, osg::ShaderAttribute, osg::Stencil, osg::StencilTwoSided, osg::TexEnv, osg::TexEnvCombine, osg::TexEnvFilter, osg::TexGen, osg::TexMat, osg::Texture1D, osg::Texture2D, osg::Texture2DArray, osg::Texture2DMultisample, osg::Texture3D, osg::TextureBuffer, osg::TextureCubeMap, osg::TextureRectangle, osg::VertexAttribDivisor, osg::VertexProgram, osg::Viewport, osg::ViewportIndexed, and osg::Texture.
|
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.
|
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.
|
inlinevirtual |
Fast alternative to dynamic_cast<> for determining if state attribute is a Texture.
Reimplemented in osg::Texture.
|
inlinevirtual |
Fast alternative to dynamic_cast<> for determining if state attribute is a Texture.
Reimplemented in osg::Texture.
|
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.
|
inlinevirtual |
Return the name of the attribute's class type.
Implements osg::Object.
Reimplemented in osg::ClipPlane, osg::Hint, osg::Light, osg::ShaderAttribute, osg::Texture, osg::VertexAttribDivisor, and osgText::GlyphTexture.
Clone an attribute, with Object* return type. Must be defined by derived classes.
Implements osg::Object.
Implemented in osg::Texture, osg::ClipPlane, osg::Hint, osg::Light, osg::ShaderAttribute, and osg::VertexAttribDivisor.
|
pure virtual |
Clone the type of an attribute, with Object* return type. Must be defined by derived classes.
Implements osg::Object.
Implemented in osg::ClipPlane, osg::Hint, osg::Light, osg::ShaderAttribute, osg::VertexAttribDivisor, and osg::Texture.
|
pure virtual |
Return -1 if *this < *rhs, 0 if *this==*rhs, 1 if *this>*rhs.
Implemented in osgText::GlyphTexture, osg::BindImageTexture, osg::FragmentProgram, osg::Program, osg::VertexProgram, osgFX::Validator, osg::UniformBufferBinding, osg::TransformFeedbackBufferBinding, osg::AtomicCounterBufferBinding, osg::ShaderStorageBufferBinding, osg::Texture1D, osg::Texture2D, osg::Texture2DArray, osg::Texture2DMultisample, osg::Texture3D, osg::TextureBuffer, osg::TextureCubeMap, osg::TextureRectangle, osg::AlphaFunc, osg::BlendColor, osg::BlendEquation, osg::BlendEquationi, osg::BlendFunc, osg::BlendFunci, osg::Capability, osg::Capabilityi, osg::ClampColor, osg::ClipControl, osg::ClipPlane, osg::ColorMask, osg::ColorMaski, osg::ColorMatrix, osg::CullFace, osg::Depth, osg::DepthRangeIndexed, osg::Fog, 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::Sampler, osg::Scissor, osg::ScissorIndexed, osg::ShadeModel, osg::ShaderAttribute, osg::Stencil, osg::StencilTwoSided, osg::TexEnv, osg::TexEnvCombine, osg::TexEnvFilter, osg::TexGen, osg::TexMat, osg::VertexAttribDivisor, osg::Viewport, and osg::ViewportIndexed.
|
inlinevirtual |
Default to nothing to compile - all state is applied immediately.
Reimplemented in osg::Program, osgFX::Validator, osg::Sampler, osg::FragmentProgram, osg::ShaderAttribute, osg::Texture, and osg::VertexProgram.
|
inline |
Get the non const EventCallback.
|
inline |
Get the const EventCallback.
|
inlinevirtual |
Return the member identifier within the attribute's class type. Used for light number/clip plane number etc.
Reimplemented in osg::BindImageTexture, osg::BlendEquationi, osg::BlendFunci, osg::BufferIndexBinding, osg::Capabilityi, osg::ClipPlane, osg::ColorMaski, osg::DepthRangeIndexed, osg::Hint, osg::Light, osg::ScissorIndexed, osg::VertexAttribDivisor, and osg::ViewportIndexed.
|
inlinevirtual |
Return the modes associated with this StateAttribute.
Reimplemented in osg::Material, osg::Texture2DArray, osg::Texture2DMultisample, 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::Point, osg::PointSprite, osg::PolygonOffset, osg::PolygonStipple, osg::Scissor, osg::ShaderAttribute, osg::Stencil, osg::StencilTwoSided, osg::TexGen, and osg::VertexProgram.
|
inline |
Get the number of parents of this StateAttribute.
|
inline |
|
inline |
Get a single const parent of this StateAttribute.
i | index of the parent to get. |
|
inline |
Get the parent list of this StateAttribute.
|
inline |
|
inline |
|
pure virtual |
Return the Type identifier of the attribute's class type.
Implemented in osg::Capability, osg::ClipPlane, osg::Hint, osg::Light, osg::ShaderAttribute, osg::Texture, and osg::VertexAttribDivisor.
|
inline |
Return the TypeMemberPair that uniquely identifies this type member.
|
inline |
Get the non const UpdateCallback.
|
inline |
Get the const UpdateCallback.
|
inlinevirtual |
Return true if this and obj are of the same kind of object.
Reimplemented from osg::Object.
Reimplemented in osg::ClipPlane, osg::Hint, osg::Light, osg::ShaderAttribute, osg::Texture, and osg::VertexAttribDivisor.
|
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::PointSprite, osg::TexEnv, osg::TexEnvCombine, osg::TexEnvFilter, osg::TexGen, osg::TexMat, and osg::Texture.
|
inlinevirtual |
Return the name of the attribute's library.
Implements osg::Object.
Reimplemented in osg::ClipPlane, osg::Hint, osg::Light, osg::ShaderAttribute, osg::Texture, and osg::VertexAttribDivisor.
|
inline |
|
inline |
|
inline |
|
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::FrameBufferObject, osg::Program, osg::FragmentProgram, osg::Sampler, osg::ShaderAttribute, osg::Texture, and osg::VertexProgram.
|
protected |
|
inlinevirtual |
Resize any per context GLObject buffers to specified size.
Reimplemented from osg::Object.
Reimplemented in osg::FragmentProgram, osg::FrameBufferObject, osg::Program, osg::ShaderAttribute, osg::Texture, osg::VertexProgram, and osgText::GlyphTexture.
void osg::StateAttribute::setEventCallback | ( | StateAttributeCallback * | ec | ) |
Set the EventCallback which allows users to attach customize the updating of an object during the Event traversal.
|
inline |
void osg::StateAttribute::setUpdateCallback | ( | StateAttributeCallback * | uc | ) |
Set the UpdateCallback which allows users to attach customize the updating of an object during the update traversal.
|
friend |
|
protected |
|
protected |
|
protected |
|
protected |