osgGA::StateSetManipulator Class Reference

Experimental class, not been looked at for a while, but which will be returned to at some point :-. More...

Inheritance diagram for osgGA::StateSetManipulator:

Public Member Functions
	StateSetManipulator (osg::StateSet *stateset=0)
virtual const char *	className () const
	return the name of the object's class type. More...
virtual void	setStateSet (osg::StateSet *)
	attach a StateSet to the manipulator to be used for specifying view. More...
virtual osg::StateSet *	getStateSet ()
	get the attached a StateSet. More...
virtual const osg::StateSet *	getStateSet () const
	get the attached a StateSet. More...
virtual bool	handle (const GUIEventAdapter &ea, GUIActionAdapter &us)
	Handle events, return true if handled, false otherwise. More...
virtual void	getUsage (osg::ApplicationUsage &usage) const
	Get the keyboard and mouse usage of this manipulator. More...
void	setMaximumNumOfTextureUnits (unsigned int i)
unsigned int	getMaximumNumOfTextureUnits () const
void	setBackfaceEnabled (bool newbackface)
bool	getBackfaceEnabled () const
void	setLightingEnabled (bool newlighting)
bool	getLightingEnabled () const
void	setTextureEnabled (bool newtexture)
bool	getTextureEnabled () const
void	setPolygonMode (osg::PolygonMode::Mode newpolygonmode)
osg::PolygonMode::Mode	getPolygonMode () const
void	cyclePolygonMode ()
void	setKeyEventToggleBackfaceCulling (int key)
int	getKeyEventToggleBackfaceCulling () const
void	setKeyEventToggleLighting (int key)
int	getKeyEventToggleLighting () const
void	setKeyEventToggleTexturing (int key)
int	getKeyEventToggleTexturing () const
void	setKeyEventCyclePolygonMode (int key)
int	getKeyEventCyclePolygonMode () const
Public Member Functions inherited from osgGA::GUIEventHandler
	GUIEventHandler ()
	GUIEventHandler (const GUIEventHandler &eh, const osg::CopyOp &copyop=osg::CopyOp::SHALLOW_COPY)
	META_Object (osgGA, GUIEventHandler)
virtual bool	handle (osgGA::Event *event, osg::Object *object, osg::NodeVisitor *nv)
	Handle event. More...
virtual bool	handle (const GUIEventAdapter &ea, GUIActionAdapter &aa, osg::Object *, osg::NodeVisitor *)
	Handle events, return true if handled, false otherwise. More...
Public Member Functions inherited from osgGA::EventHandler
	EventHandler ()
	EventHandler (const EventHandler &eh, const osg::CopyOp &copyop=osg::CopyOp::SHALLOW_COPY)
	META_Object (osgGA, EventHandler)
virtual NodeCallback *	asNodeCallback ()
virtual const NodeCallback *	asNodeCallback () const
virtual DrawableEventCallback *	asDrawableEventCallback ()
virtual const DrawableEventCallback *	asDrawableEventCallback () const
virtual EventHandler *	asEventHandler ()
virtual const EventHandler *	asEventHandler () const
virtual bool	run (osg::Object *object, osg::Object *data)
	NodeCallback overrides the Callback::run() method to adapt it the old style NodeCallback::operator()(Node* node, NodeVisitor* nv) method. More...
virtual void	operator() (osg::Node *node, osg::NodeVisitor *nv)
	Event traversal node callback method. More...
virtual void	event (osg::NodeVisitor *nv, osg::Drawable *drawable)
	Event traversal drawable callback method. More...
Public Member Functions inherited from osg::NodeCallback
	NodeCallback ()
	NodeCallback (const NodeCallback &nc, const CopyOp &copyop)
	META_Object (osg, NodeCallback)
Public Member Functions inherited from osg::Callback
	Callback ()
	Callback (const Callback &cb, const CopyOp &copyop)
	META_Object (osg, Callback)
virtual Callback *	asCallback ()
	Convert 'this' into a Callback pointer if Object is a Callback, otherwise return 0. More...
virtual const Callback *	asCallback () const
	convert 'const this' into a const Callback pointer if Object is a Callback, otherwise return 0. More...
virtual CallbackObject *	asCallbackObject ()
	Convert 'this' into a CallbackObject pointer if Object is a CallbackObject, otherwise return 0. More...
virtual const CallbackObject *	asCallbackObject () const
	convert 'const this' into a const CallbackObject pointer if Object is a CallbackObject, otherwise return 0. More...
virtual StateAttributeCallback *	asStateAttributeCallback ()
virtual const StateAttributeCallback *	asStateAttributeCallback () const
virtual UniformCallback *	asUniformCallback ()
virtual const UniformCallback *	asUniformCallback () const
virtual DrawableUpdateCallback *	asDrawableUpdateCallback ()
virtual const DrawableUpdateCallback *	asDrawableUpdateCallback () const
virtual DrawableCullCallback *	asDrawableCullCallback ()
virtual const DrawableCullCallback *	asDrawableCullCallback () const
bool	traverse (osg::Object *object, osg::Object *data)
	traverse the nested callbacks or call NodeVisitor::traverse() if the object is Node, and data is NodeVisitor. More...
void	setNestedCallback (osg::Callback *cb)
osg::Callback *	getNestedCallback ()
const osg::Callback *	getNestedCallback () const
void	addNestedCallback (osg::Callback *nc)
void	removeNestedCallback (osg::Callback *nc)
Public Member Functions inherited from osg::Object
	Object ()
	Construct an object. More...
	Object (bool threadSafeRefUnref)
	Object (const Object &, const CopyOp &copyop=CopyOp::SHALLOW_COPY)
	Copy constructor, optional CopyOp object can be used to control shallow vs deep copying of dynamic data. More...
virtual Object *	cloneType () const =0
	Clone the type of an object, with Object* return type. More...
virtual Object *	clone (const CopyOp &) const =0
	Clone an object, with Object* return type. More...
virtual bool	isSameKindAs (const Object *) const
virtual const char *	libraryName () const =0
	return the name of the object's library. More...
std::string	getCompoundClassName () const
	return the compound class name that combines the library name and class name. More...
virtual Node *	asNode ()
	Convert 'this' into a Node pointer if Object is a Node, otherwise return 0. More...
virtual const Node *	asNode () const
	convert 'const this' into a const Node pointer if Object is a Node, otherwise return 0. More...
virtual NodeVisitor *	asNodeVisitor ()
	Convert 'this' into a NodeVisitor pointer if Object is a NodeVisitor, otherwise return 0. More...
virtual const NodeVisitor *	asNodeVisitor () const
	convert 'const this' into a const NodeVisitor pointer if Object is a NodeVisitor, otherwise return 0. More...
virtual StateSet *	asStateSet ()
	Convert 'this' into a StateSet pointer if Object is a StateSet, otherwise return 0. More...
virtual const StateSet *	asStateSet () const
	convert 'const this' into a const StateSet pointer if Object is a StateSet, otherwise return 0. More...
virtual StateAttribute *	asStateAttribute ()
	Convert 'this' into a StateAttribute pointer if Object is a StateAttribute, otherwise return 0. More...
virtual const StateAttribute *	asStateAttribute () const
	convert 'const this' into a const StateAttribute pointer if Object is a StateAttribute, otherwise return 0. More...
virtual Uniform *	asUniform ()
	Convert 'this' into a Uniform pointer if Object is a Uniform, otherwise return 0. More...
virtual const UniformBase *	asUniformBase () const
	convert 'const this' into a const Uniform pointer if Object is a Uniform, otherwise return 0. More...
virtual UniformBase *	asUniformBase ()
	Convert 'this' into a Uniform pointer if Object is a Uniform, otherwise return 0. More...
virtual const Uniform *	asUniform () const
	convert 'const this' into a const Uniform pointer if Object is a Uniform, otherwise return 0. More...
virtual Camera *	asCamera ()
	Convert 'this' into a Camera pointer if Node is a Camera, otherwise return 0. More...
virtual const Camera *	asCamera () const
	convert 'const this' into a const Camera pointer if Node is a Camera, otherwise return 0. More...
virtual Drawable *	asDrawable ()
	Convert 'this' into a Drawable pointer if Object is a Drawable, otherwise return 0. More...
virtual const Drawable *	asDrawable () const
	convert 'const this' into a const Drawable pointer if Object is a Drawable, otherwise return 0. More...
virtual UserDataContainer *	asUserDataContainer ()
	Convert 'this' into a UserDataContainer pointer if Object is a UserDataContainer, otherwise return 0. More...
virtual const UserDataContainer *	asUserDataContainer () const
	convert 'const this' into a const UserDataContainer pointer if Object is a UserDataContainer, otherwise return 0. More...
virtual ValueObject *	asValueObject ()
	Convert 'this' into a ValueObject pointer if Object is a ValueObject, otherwise return 0. More...
virtual const ValueObject *	asValueObject () const
	Convert 'this' into a ValueObject pointer if Object is a ValueObject, otherwise return 0. More...
virtual Image *	asImage ()
	Convert 'this' into a Image pointer if Object is a Image, otherwise return 0. More...
virtual const Image *	asImage () const
	Convert 'this' into a Image pointer if Object is a Image, otherwise return 0. More...
virtual void	setThreadSafeRefUnref (bool threadSafe)
	Set whether to use a mutex to ensure ref() and unref() are thread safe. More...
virtual void	setName (const std::string &name)
	Set the name of object using C++ style string. More...
void	setName (const char *name)
	Set the name of object using a C style string. More...
const std::string &	getName () const
	Get the name of object. More...
void	setDataVariance (DataVariance dv)
	Set the data variance of this object. More...
DataVariance	getDataVariance () const
	Get the data variance of this object. More...
virtual void	computeDataVariance ()
	Compute the DataVariance based on an assessment of callback etc. More...
void	setUserDataContainer (osg::UserDataContainer *udc)
	set the UserDataContainer object. More...
template<class T >
void	setUserDataContainer (const ref_ptr< T > &udc)
osg::UserDataContainer *	getUserDataContainer ()
	get the UserDataContainer attached to this object. More...
const osg::UserDataContainer *	getUserDataContainer () const
	get the const UserDataContainer attached to this object. More...
osg::UserDataContainer *	getOrCreateUserDataContainer ()
	Convenience method that returns the UserDataContainer, and if one doesn't already exist creates and assigns a DefaultUserDataContainer to the Object and then return this new UserDataContainer. More...
virtual void	setUserData (Referenced *obj)
	Set user data, data must be subclassed from Referenced to allow automatic memory handling. More...
template<class T >
void	setUserData (const ref_ptr< T > &ud)
virtual Referenced *	getUserData ()
	Get user data. More...
virtual const Referenced *	getUserData () const
	Get const user data. More...
template<typename T >
bool	getUserValue (const std::string &name, T &value) const
	Convenience method that casts the named UserObject to osg::TemplateValueObject<T> and gets the value. More...
template<typename T >
void	setUserValue (const std::string &name, const T &value)
	Convenience method that creates the osg::TemplateValueObject<T> to store the specified value and adds it as a named UserObject. More...
virtual void	resizeGLObjectBuffers (unsigned int)
	Resize any per context GLObject buffers to specified size. More...
virtual void	releaseGLObjects (osg::State *=0) const
	If State is non-zero, this function releases any associated OpenGL objects for the specified graphics context. More...
template<typename T >
BoolValueObject UCharValueObject UShortValueObject UIntValueObject DoubleValueObject Vec3fValueObject Vec2dValueObject Vec4dValueObject PlaneValueObject MatrixdValueObject BoundingBoxdValueObject BoundingSpheredValueObject bool	getUserValue (const std::string &name, T &value) const
	provide implementation of osg::Object::getUserValue(..) template More...
Public Member Functions inherited from osg::Referenced
	Referenced ()
	Referenced (bool threadSafeRefUnref)
	Deprecated, Referenced is now always uses thread safe ref/unref, use default Referenced() constructor instead. More...
	Referenced (const Referenced &)
Referenced &	operator= (const Referenced &)
bool	getThreadSafeRefUnref () const
	Get whether a mutex is used to ensure ref() and unref() are thread safe. More...
OpenThreads::Mutex *	getRefMutex () const
	Get the mutex used to ensure thread safety of ref()/unref(). More...
int	ref () const
	Increment the reference count by one, indicating that this object has another pointer which is referencing it. More...
int	unref () const
	Decrement the reference count by one, indicating that a pointer to this object is no longer referencing it. More...
int	unref_nodelete () const
	Decrement the reference count by one, indicating that a pointer to this object is no longer referencing it. More...
int	referenceCount () const
	Return the number of pointers currently referencing this object. More...
ObserverSet *	getObserverSet () const
	Get the ObserverSet if one is attached, otherwise return NULL. More...
ObserverSet *	getOrCreateObserverSet () const
	Get the ObserverSet if one is attached, otherwise create an ObserverSet, attach it, then return this newly created ObserverSet. More...
void	addObserver (Observer *observer) const
	Add a Observer that is observing this object, notify the Observer when this object gets deleted. More...
void	removeObserver (Observer *observer) const
	Remove Observer that is observing this object. More...
Public Member Functions inherited from osg::DrawableEventCallback
	DrawableEventCallback ()
	DrawableEventCallback (const DrawableEventCallback &org, const CopyOp &copyop)
	META_Object (osg, DrawableEventCallback)

Protected Member Functions
virtual	~StateSetManipulator ()
void	clone ()
osg::PolygonMode *	getOrCreatePolygonMode ()
Protected Member Functions inherited from osgGA::GUIEventHandler
virtual	~GUIEventHandler ()
Protected Member Functions inherited from osg::NodeCallback
virtual	~NodeCallback ()
Protected Member Functions inherited from osg::Callback
virtual	~Callback ()
Protected Member Functions inherited from osg::Object
virtual	~Object ()
	Object destructor. More...
Protected Member Functions inherited from osg::Referenced
virtual	~Referenced ()
void	signalObserversAndDelete (bool signalDelete, bool doDelete) const
void	deleteUsingDeleteHandler () const

Protected Attributes
osg::ref_ptr< osg::StateSet >	_stateset
bool	_initialized
bool	_backface
bool	_lighting
bool	_texture
unsigned int	_maxNumOfTextureUnits
int	_keyEventToggleBackfaceCulling
int	_keyEventToggleLighting
int	_keyEventToggleTexturing
int	_keyEventCyclePolygonMode
Protected Attributes inherited from osg::Callback
ref_ptr< Callback >	_nestedCallback
Protected Attributes inherited from osg::Object
std::string	_name
DataVariance	_dataVariance
osg::UserDataContainer *	_userDataContainer
Protected Attributes inherited from osg::Referenced
OpenThreads::AtomicPtr	_observerSet
OpenThreads::Atomic	_refCount

Additional Inherited Members
Public Types inherited from osg::Object
enum	DataVariance { DYNAMIC, STATIC, UNSPECIFIED }
Static Public Member Functions inherited from osg::Callback
template<typename T >
static T *	findNestedCallback (osg::Callback *callback)
	Convenience method to find a nested callback by type. More...
template<typename T >
static const T *	findNestedCallback (const osg::Callback *callback)
	Convenience method to find a nested callback by type. More...
Static Public Member Functions inherited from osg::Referenced
static OpenThreads::Mutex *	getGlobalReferencedMutex ()
	Get the optional global Referenced mutex, this can be shared between all osg::Referenced. More...
static void	setDeleteHandler (DeleteHandler *handler)
	Set a DeleteHandler to which deletion of all referenced counted objects will be delegated. More...
static DeleteHandler *	getDeleteHandler ()
	Get a DeleteHandler. More...

Detailed Description

Experimental class, not been looked at for a while, but which will be returned to at some point :-.

Constructor & Destructor Documentation

StateSetManipulator()

osgGA::StateSetManipulator::StateSetManipulator

(

osg::StateSet *

stateset = 0

)

~StateSetManipulator()

virtual osgGA::StateSetManipulator::~StateSetManipulator ( )

protectedvirtual

Member Function Documentation

className()

virtual const char* osgGA::StateSetManipulator::className ( ) const

inlinevirtual

return the name of the object's class type.

Must be defined by derived classes.

Implements osg::Object.

clone()

void osgGA::StateSetManipulator::clone ( )

protected

cyclePolygonMode()

void osgGA::StateSetManipulator::cyclePolygonMode

(

)

getBackfaceEnabled()

bool osgGA::StateSetManipulator::getBackfaceEnabled ( ) const

inline

getKeyEventCyclePolygonMode()

int osgGA::StateSetManipulator::getKeyEventCyclePolygonMode ( ) const

inline

References osg::clone().

getKeyEventToggleBackfaceCulling()

int osgGA::StateSetManipulator::getKeyEventToggleBackfaceCulling ( ) const

inline

getKeyEventToggleLighting()

int osgGA::StateSetManipulator::getKeyEventToggleLighting ( ) const

inline

getKeyEventToggleTexturing()

int osgGA::StateSetManipulator::getKeyEventToggleTexturing ( ) const

inline

getLightingEnabled()

bool osgGA::StateSetManipulator::getLightingEnabled ( ) const

inline

getMaximumNumOfTextureUnits()

unsigned int osgGA::StateSetManipulator::getMaximumNumOfTextureUnits ( ) const

inline

getOrCreatePolygonMode()

osg::PolygonMode* osgGA::StateSetManipulator::getOrCreatePolygonMode ( )

protected

getPolygonMode()

osg::PolygonMode::Mode osgGA::StateSetManipulator::getPolygonMode

(

)

const

getStateSet() [1/2]

virtual osg::StateSet* osgGA::StateSetManipulator::getStateSet ( )

virtual

get the attached a StateSet.

getStateSet() [2/2]

virtual const osg::StateSet* osgGA::StateSetManipulator::getStateSet ( ) const

virtual

get the attached a StateSet.

getTextureEnabled()

bool osgGA::StateSetManipulator::getTextureEnabled ( ) const

inline

getUsage()

virtual void osgGA::StateSetManipulator::getUsage ( osg::ApplicationUsage &  usage ) const

virtual

Get the keyboard and mouse usage of this manipulator.

Reimplemented from osgGA::EventHandler.

handle()

virtual bool osgGA::StateSetManipulator::handle ( const GUIEventAdapter &  ea, GUIActionAdapter &  us  )

virtual

Handle events, return true if handled, false otherwise.

Reimplemented from osgGA::GUIEventHandler.

setBackfaceEnabled()

void osgGA::StateSetManipulator::setBackfaceEnabled

(

bool

newbackface

)

setKeyEventCyclePolygonMode()

void osgGA::StateSetManipulator::setKeyEventCyclePolygonMode ( int  key )

inline

setKeyEventToggleBackfaceCulling()

void osgGA::StateSetManipulator::setKeyEventToggleBackfaceCulling ( int  key )

inline

setKeyEventToggleLighting()

void osgGA::StateSetManipulator::setKeyEventToggleLighting ( int  key )

inline

setKeyEventToggleTexturing()

void osgGA::StateSetManipulator::setKeyEventToggleTexturing ( int  key )

inline

setLightingEnabled()

void osgGA::StateSetManipulator::setLightingEnabled

(

bool

newlighting

)

setMaximumNumOfTextureUnits()

void osgGA::StateSetManipulator::setMaximumNumOfTextureUnits ( unsigned int  i )

inline

setPolygonMode()

void osgGA::StateSetManipulator::setPolygonMode

(

osg::PolygonMode::Mode

newpolygonmode

)

setStateSet()

virtual void osgGA::StateSetManipulator::setStateSet ( osg::StateSet *  )

virtual

attach a StateSet to the manipulator to be used for specifying view.

setTextureEnabled()

void osgGA::StateSetManipulator::setTextureEnabled

(

bool

newtexture

)

Member Data Documentation

_backface

bool osgGA::StateSetManipulator::_backface

protected

_initialized

bool osgGA::StateSetManipulator::_initialized

protected

_keyEventCyclePolygonMode

int osgGA::StateSetManipulator::_keyEventCyclePolygonMode

protected

_keyEventToggleBackfaceCulling

int osgGA::StateSetManipulator::_keyEventToggleBackfaceCulling

protected

_keyEventToggleLighting

int osgGA::StateSetManipulator::_keyEventToggleLighting

protected

_keyEventToggleTexturing

int osgGA::StateSetManipulator::_keyEventToggleTexturing

protected

_lighting

bool osgGA::StateSetManipulator::_lighting

protected

_maxNumOfTextureUnits

unsigned int osgGA::StateSetManipulator::_maxNumOfTextureUnits

protected

_stateset

osg::ref_ptr<osg::StateSet> osgGA::StateSetManipulator::_stateset

protected

_texture

bool osgGA::StateSetManipulator::_texture

protected

---

The documentation for this class was generated from the following file:

• osgGA/StateSetManipulator