edb15e17bc
support for the unsigned int member to be paired with types in osg::StateSet so that lights, clipplanes and other attributes that have a type group but then need to differentiate within that group via a member uint.
271 lines
10 KiB
C++
271 lines
10 KiB
C++
/* -*-c++-*- OpenSceneGraph - Copyright (C) 1998-2003 Robert Osfield
|
|
*
|
|
* This library is open source and may be redistributed and/or modified under
|
|
* the terms of the OpenSceneGraph Public License (OSGPL) version 0.0 or
|
|
* (at your option) any later version. The full license is in LICENSE file
|
|
* included with this distribution, and on the openscenegraph.org website.
|
|
*
|
|
* This library is distributed in the hope that it will be useful,
|
|
* but WITHOUT ANY WARRANTY; without even the implied warranty of
|
|
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
|
|
* OpenSceneGraph Public License for more details.
|
|
*/
|
|
|
|
#ifndef OSG_STATEATTRIBUTE
|
|
#define OSG_STATEATTRIBUTE 1
|
|
|
|
#include <osg/Export>
|
|
#include <osg/Object>
|
|
#include <osg/GL>
|
|
|
|
#include <typeinfo>
|
|
#include <utility>
|
|
|
|
namespace osg {
|
|
|
|
|
|
// forward declare State & StateSet
|
|
class State;
|
|
class StateSet;
|
|
|
|
/** META_StateAttribute macro define the standard clone, isSameKindAs,
|
|
* className and getType methods.
|
|
* Use when subclassing from Object to make it more convenient to define
|
|
* the standard pure virtual methods which are required for all Object
|
|
* subclasses.*/
|
|
#define META_StateAttribute(library,name,type) \
|
|
virtual osg::Object* cloneType() const { return new name(); } \
|
|
virtual osg::Object* clone(const osg::CopyOp& copyop) const { return new name (*this,copyop); } \
|
|
virtual bool isSameKindAs(const osg::Object* obj) const { return dynamic_cast<const name *>(obj)!=NULL; } \
|
|
virtual const char* libraryName() const { return #library; } \
|
|
virtual const char* className() const { return #name; } \
|
|
virtual Type getType() const { return type; }
|
|
|
|
/** COMPARE_StateAttribute_Types macro is a helper for implementing the StateAtribute::compare(..) method.*/
|
|
#define COMPARE_StateAttribute_Types(TYPE,rhs_attribute) \
|
|
if (this==&rhs_attribute) return 0;\
|
|
const std::type_info* type_lhs = &typeid(*this);\
|
|
const std::type_info* type_rhs = &typeid(rhs_attribute);\
|
|
if (type_lhs->before(*type_rhs)) return -1;\
|
|
if (*type_lhs != *type_rhs) return 1;\
|
|
const TYPE& rhs = static_cast<const TYPE&>(rhs_attribute);
|
|
|
|
|
|
/** COMPARE_StateAttribute_Parameter macro is a helper for implementing the StatateAtribute::compare(..) method.
|
|
* Macro assumes that variable rhs has been correctly defined by preceding code
|
|
* macro.*/
|
|
#define COMPARE_StateAttribute_Parameter(parameter) \
|
|
if (parameter<rhs.parameter) return -1; \
|
|
if (rhs.parameter<parameter) return 1;
|
|
|
|
|
|
// define for the GL_EXT_secondary_color extension, GL_COLOR_SUM is OpenGL
|
|
// mode to be used to enable and disable the second color.
|
|
#ifndef GL_COLOR_SUM
|
|
#define GL_COLOR_SUM 0x8458
|
|
#endif
|
|
|
|
/** Base class for state attributes.
|
|
*/
|
|
class SG_EXPORT StateAttribute : public Object
|
|
{
|
|
public :
|
|
|
|
/** GLMode is the value used in glEnable/glDisable(mode) */
|
|
typedef GLenum GLMode;
|
|
/** 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 GLModeValue;
|
|
/** Override is used to specify the override behavior of StateAttributes
|
|
* from parent to children.
|
|
* See enum Value description for more details.*/
|
|
typedef unsigned int OverrideValue;
|
|
|
|
/** 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(..).*/
|
|
enum Values
|
|
{
|
|
/** means that associated GLMode and Override is disabled.*/
|
|
OFF = 0x0,
|
|
/** means that associated GLMode is enabled and Override is disabled.*/
|
|
ON = 0x1,
|
|
/** Overriding of GLMode's or StateAttributes is enabled, so that state below it is overridden.*/
|
|
OVERRIDE = 0x2,
|
|
/** Protecting of GLMode's or StateAttributes is enabled, so that state from above cannot override this and below state.*/
|
|
PROTECTED = 0x4,
|
|
/** means that GLMode or StateAttribute should be inherited from above.*/
|
|
INHERIT = 0x8
|
|
};
|
|
|
|
/** Type identifier to differentiate between different state types. */
|
|
// typedef unsigned int Type;
|
|
|
|
/** 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. */
|
|
enum Type
|
|
{
|
|
TEXTURE,
|
|
|
|
POLYGONMODE,
|
|
POLYGONOFFSET,
|
|
MATERIAL,
|
|
ALPHAFUNC,
|
|
ANTIALIAS,
|
|
COLORTABLE,
|
|
CULLFACE,
|
|
FOG,
|
|
FRONTFACE,
|
|
|
|
LIGHT,
|
|
|
|
POINT,
|
|
LINEWIDTH,
|
|
LINESTIPPLE,
|
|
POLYGONSTIPPLE,
|
|
SHADEMODEL,
|
|
TEXENV,
|
|
TEXGEN,
|
|
TEXMAT,
|
|
LIGHTMODEL,
|
|
BLENDFUNC,
|
|
STENCIL,
|
|
COLORMASK,
|
|
DEPTH,
|
|
VIEWPORT,
|
|
BLENDCOLOR,
|
|
MULTISAMPLE,
|
|
|
|
|
|
CLIPPLANE,
|
|
|
|
COLORMATRIX,
|
|
|
|
VERTEXPROGRAM,
|
|
FRAGMENTPROGRAM,
|
|
|
|
|
|
POINTSPRITE,
|
|
|
|
/// osgGL2 namespace
|
|
PROGRAMOBJECT,
|
|
|
|
/// osgFX namespace
|
|
VALIDATOR,
|
|
VIEWMATRIXEXTRACTOR,
|
|
};
|
|
|
|
/** Simple pairing between an attribute type and the member within that attribute type group.*/
|
|
typedef std::pair<Type,unsigned int> TypeMemberPair;
|
|
|
|
/*
|
|
struct TypeMember
|
|
{
|
|
inline TypeMember(Type type, unsigned int member=0):
|
|
_type(type),
|
|
_member(member) {}
|
|
|
|
inline bool operator < (const TypeMember& tm) const
|
|
{
|
|
return (_type<tm._type) ? true : ( (tm._type<_type) ? false : (_member<tm._member) );
|
|
}
|
|
|
|
Type _type;
|
|
unsigned int _member;
|
|
};
|
|
*/
|
|
|
|
|
|
StateAttribute() { setDataVariance(STATIC); }
|
|
|
|
StateAttribute(const StateAttribute& sa,const CopyOp& copyop=CopyOp::SHALLOW_COPY):
|
|
Object(sa,copyop) {}
|
|
|
|
|
|
/** Clone the type of an attribute, with Object* return type.
|
|
Must be defined by derived classes.*/
|
|
virtual Object* cloneType() const = 0;
|
|
|
|
/** Clone an attribute, with Object* return type.
|
|
Must be defined by derived classes.*/
|
|
virtual Object* clone(const CopyOp&) const = 0;
|
|
|
|
/** Return true if this and obj are of the same kind of object.*/
|
|
virtual bool isSameKindAs(const Object* obj) const { return dynamic_cast<const StateAttribute*>(obj)!=NULL; }
|
|
|
|
/** Return the name of the attribute's library.*/
|
|
virtual const char* libraryName() const { return "osg"; }
|
|
|
|
/** Return the name of the attribute's class type.*/
|
|
virtual const char* className() const { return "StateAttribute"; }
|
|
|
|
/** Return the Type identifier of the attribute's class type.*/
|
|
virtual Type getType() const = 0;
|
|
|
|
/** Return the member identifier within the attribute's class type. Used for light number/clip plane number etc.*/
|
|
virtual unsigned int getMember() const { return 0; }
|
|
|
|
/** Return the TypeMemberPair that uniquely identifies this type member.*/
|
|
inline TypeMemberPair getTypeMemberPair() const { return TypeMemberPair(getType(),getMember()); }
|
|
|
|
/** Return true if StateAttribute is a type which controls texturing and needs to be issued w.r.t to specific texture unit.*/
|
|
virtual bool isTextureAttribute() const { return false; }
|
|
|
|
/** Return -1 if *this < *rhs, 0 if *this==*rhs, 1 if *this>*rhs.*/
|
|
virtual int compare(const StateAttribute& sa) const = 0;
|
|
|
|
bool operator < (const StateAttribute& rhs) const { return compare(rhs)<0; }
|
|
bool operator == (const StateAttribute& rhs) const { return compare(rhs)==0; }
|
|
bool operator != (const StateAttribute& rhs) const { return compare(rhs)!=0; }
|
|
|
|
|
|
struct ModeUsage
|
|
{
|
|
virtual void usesMode(GLMode mode) = 0;
|
|
virtual void usesTextureMode(GLMode mode) = 0;
|
|
};
|
|
|
|
/** Return the modes associated with this StateAttribute.*/
|
|
virtual bool getModeUsage(ModeUsage&) const
|
|
{
|
|
// default to no GLMode's associated with use of the StateAttribute.
|
|
return false;
|
|
}
|
|
|
|
/** 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 apply(State&) const = 0;
|
|
|
|
/** default to nothing to compile - all state is applied immediately. */
|
|
virtual void compileGLObjects(State&) 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.*/
|
|
virtual void releaseGLObjects(State* =0) const {}
|
|
|
|
|
|
protected:
|
|
|
|
virtual ~StateAttribute() {}
|
|
|
|
};
|
|
|
|
}
|
|
|
|
#endif
|