class SG_EXPORT osg::State

State class for managing a state stack.

Inheritance:

Public Methods

State()

virtual ~State()

void pushStateSet(const StateSet* dstate)

push stateset onto state stack

void popStateSet()

pop drawstate off state stack

void captureCurrentState(StateSet& stateset) const

copy the modes and attributes which captures the current state

void reset()

reset the state object to an empty stack

inline const bool apply_mode(const StateAttribute::GLMode mode, const bool enabled)

apply an OpenGL mode if required.

inline const bool apply_attribute(const StateAttribute* attribute)

apply an attribute if required.

void apply(const StateSet* dstate)

apply stateset

void apply()

apply the state

void have_applied(const StateAttribute::GLMode mode, const StateAttribute::GLModeValue value)

mode has been set externally, update state to reflect this setting

void have_applied(const StateAttribute* attribute)

attribute has been applied externally, update state to reflect this setting

inline void setContextID(unsigned int contextID)

Set the current OpenGL context uniqueID.

inline const unsigned int getContextID() const

Get the current OpenGL context unique ID

inline void setFrameStamp(FrameStamp* fs)

Set the frame stamp for the current frame

inline const FrameStamp* getFrameStamp() const

Set the frame stamp for the current frame

inline void setCamera(Camera* camera)

Set the camera.

inline const Camera* getCamera() const

Get the camera

inline void setDisplaySettings(DisplaySettings* vs)

Set the DisplaySettings.

inline const DisplaySettings* getDisplaySettings() const

Get the DisplaySettings

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

State class for managing a state stack. Lazy state updating is used to minimize state changes.

State()

virtual ~State()

void pushStateSet(const StateSet* dstate)

push stateset onto state stack

void popStateSet()

pop drawstate off state stack

void captureCurrentState(StateSet& stateset) const

copy the modes and attributes which captures the current state

void reset()

reset the state object to an empty stack

inline const bool apply_mode(const StateAttribute::GLMode mode, const bool enabled)

apply an OpenGL mode if required.

inline const bool apply_attribute(const StateAttribute* attribute)

apply an attribute if required.

void apply(const StateSet* dstate)

apply stateset

void apply()

apply the state

void have_applied(const StateAttribute::GLMode mode, const StateAttribute::GLModeValue value)

mode has been set externally, update state to reflect this setting

void have_applied(const StateAttribute* attribute)

attribute has been applied externally, update state to reflect this setting

inline void setContextID(unsigned int contextID)

Set the current OpenGL context uniqueID. Note, it is the application developers responsibility to set up unique ID for each OpenGL context. This value is then used by osg::StateAttribure's and osg::Drawable's to help manage OpenGL display list and texture binds appropriate for each context.

inline const unsigned int getContextID() const

Get the current OpenGL context unique ID

inline void setFrameStamp(FrameStamp* fs)

Set the frame stamp for the current frame

inline const FrameStamp* getFrameStamp() const

Set the frame stamp for the current frame

inline void setCamera(Camera* camera)

Set the camera. Note, nothing is applied, the camera is just used used in the State object to pass the current camera to Drawables during rendering.

inline const Camera* getCamera() const

Get the camera

inline void setDisplaySettings(DisplaySettings* vs)

Set the DisplaySettings. Note, nothing is applied, the visual settings are just used used in the State object to pass the current visual settings to Drawables during rendering.

inline const DisplaySettings* getDisplaySettings() const

Get the DisplaySettings

ModeStack()

bool changed

bool last_applied_value

bool global_default_value

ValueVec valueVec

AttributeStack()

bool changed

apply an attribute if required, passing in attribute and appropriate attribute stack

const StateAttribute* last_applied_attribute

ref_ptr<StateAttribute> global_default_attribute

AttributeVec attributeVec

This class has no child classes.

Alphabetic index HTML hierarchy of classes or Java