BaseUniform base class for encapsulating glUniform values. More...

Inheritance diagram for osg::UniformBase:

Public Types
typedef std::vector< StateSet * >	ParentList
	A vector of osg::StateSet pointers which is used to store the parent(s) of this Uniform, the parents could be osg::Node or osg::Drawable. More...

Public Types inherited from osg::Object
enum	DataVariance { DYNAMIC, STATIC, UNSPECIFIED }

Public Member Functions
	UniformBase ()

	UniformBase (const std::string &name)

	UniformBase (const UniformBase &rhs, const CopyOp &copyop)

	META_Object (osg, UniformBase)

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 void	setName (const std::string &name)
	Set the name of the glUniform, ensuring it is only set once. More...

void	setName (const std::string &baseName, unsigned int unit)
	Set the name of the glUniform appending [unit] such as osg_Light[0]. More...

unsigned int	getNameID () const

virtual int	compare (const UniformBase &rhs) const
	return -1 if this < rhs, 0 if this==rhs, 1 if this>rhs. More...

virtual int	compareData (const UniformBase &rhs) const

bool	operator< (const UniformBase &rhs) const

bool	operator== (const UniformBase &rhs) const

bool	operator!= (const UniformBase &rhs) const

const ParentList &	getParents () const
	Get the parent list of this Uniform. More...

ParentList	getParents ()
	Get the a copy of parent list of node. More...

StateSet *	getParent (unsigned int i)

const StateSet *	getParent (unsigned int i) const
	Get a single const parent of this Uniform. More...

unsigned int	getNumParents () const
	Get the number of parents of this Uniform. More...

void	setUpdateCallback (UniformCallback *uc)
	Set the UpdateCallback which allows users to attach customize the updating of an object during the update traversal. More...

UniformCallback *	getUpdateCallback ()
	Get the non const UpdateCallback. More...

const UniformCallback *	getUpdateCallback () const
	Get the const UpdateCallback. More...

void	setEventCallback (UniformCallback *ec)
	Set the EventCallback which allows users to attach customize the updating of an object during the Event traversal. More...

UniformCallback *	getEventCallback ()
	Get the non const EventCallback. More...

const UniformCallback *	getEventCallback () const
	Get the const EventCallback. More...

void	dirty ()
	Increment the modified count on the Uniform so Programs watching it know it update themselves. More...

void	setModifiedCount (unsigned int mc)

unsigned int	getModifiedCount () const

virtual void	apply (const GLExtensions *ext, GLint location) const

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...

virtual const char *	className () const =0
	return the name of the object's class type. 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 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 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 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...

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...

Protected Member Functions
virtual	~UniformBase ()

void	addParent (osg::StateSet *object)

void	removeParent (osg::StateSet *object)

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
ParentList	_parents

unsigned int	_nameID

unsigned int	_modifiedCount

ref_ptr< UniformCallback >	_updateCallback

ref_ptr< UniformCallback >	_eventCallback

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

Friends
class	osg::StateSet

Additional Inherited Members
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

BaseUniform base class for encapsulating glUniform values.

Member Typedef Documentation

◆ ParentList

typedef std::vector<StateSet*> osg::UniformBase::ParentList

A vector of osg::StateSet pointers which is used to store the parent(s) of this Uniform, the parents could be osg::Node or osg::Drawable.

Constructor & Destructor Documentation

◆ UniformBase() [1/3]

osg::UniformBase::UniformBase ( )

◆ UniformBase() [2/3]

osg::UniformBase::UniformBase ( const std::string & name )

◆ UniformBase() [3/3]

osg::UniformBase::UniformBase	(	const UniformBase &	rhs,
		const CopyOp &	copyop
	)

◆ ~UniformBase()

virtual osg::UniformBase::~UniformBase ( )

protectedvirtual

Member Function Documentation

◆ addParent()

void osg::UniformBase::addParent ( osg::StateSet * object )

protected

◆ apply()

virtual void osg::UniformBase::apply	(	const GLExtensions *	ext,
		GLint	location
	)		const

virtual

Reimplemented in osg::TemplateArrayUniform< T >, and osg::TemplateUniform< T >.

Referenced by osg::Program::PerContextProgram::apply().

◆ asUniformBase() [1/2]

virtual const UniformBase* osg::UniformBase::asUniformBase ( ) const

inlinevirtual

convert 'const this' into a const Uniform pointer if Object is a Uniform, otherwise return 0.

Equivalent to dynamic_cast<const UniformBase*>(this).

Reimplemented from osg::Object.

◆ asUniformBase() [2/2]

virtual UniformBase* osg::UniformBase::asUniformBase ( )

inlinevirtual

Convert 'this' into a Uniform pointer if Object is a Uniform, otherwise return 0.

Equivalent to dynamic_cast<UniformBase*>(this).

Reimplemented from osg::Object.

◆ compare()

virtual int osg::UniformBase::compare ( const UniformBase & rhs ) const

virtual

return -1 if *this < *rhs, 0 if *this==*rhs, 1 if *this>*rhs.

◆ compareData()

virtual int osg::UniformBase::compareData ( const UniformBase & rhs ) const

virtual

◆ dirty()

void osg::UniformBase::dirty ( )

inline

Increment the modified count on the Uniform so Programs watching it know it update themselves.

NOTE: automatically called during osg::Uniform::set*(); you must call if modifying the internal data array directly.

◆ getEventCallback() [1/2]

UniformCallback* osg::UniformBase::getEventCallback ( )

inline

Get the non const EventCallback.

◆ getEventCallback() [2/2]

const UniformCallback* osg::UniformBase::getEventCallback ( ) const

inline

Get the const EventCallback.

◆ getModifiedCount()

unsigned int osg::UniformBase::getModifiedCount ( ) const

inline

Referenced by osg::Program::PerContextProgram::apply().

◆ getNameID()

unsigned int osg::UniformBase::getNameID ( ) const

inline

Referenced by osg::Program::PerContextProgram::apply().

◆ getNumParents()

unsigned int osg::UniformBase::getNumParents ( ) const

inline

Get the number of parents of this Uniform.

Returns: the number of parents of this Uniform.

◆ getParent() [1/2]

StateSet* osg::UniformBase::getParent ( unsigned int i )

inline

◆ getParent() [2/2]

const StateSet* osg::UniformBase::getParent ( unsigned int i ) const

inline

Get a single const parent of this Uniform.

Parameters

i	index of the parent to get.

Returns: the parent i.

◆ getParents() [1/2]

const ParentList& osg::UniformBase::getParents ( ) const

inline

Get the parent list of this Uniform.

◆ getParents() [2/2]

ParentList osg::UniformBase::getParents ( )

inline

Get the a copy of parent list of node.

A copy is returned to prevent modification of the parent list.

◆ getUpdateCallback() [1/2]

UniformCallback* osg::UniformBase::getUpdateCallback ( )

inline

Get the non const UpdateCallback.

◆ getUpdateCallback() [2/2]

const UniformCallback* osg::UniformBase::getUpdateCallback ( ) const

inline

Get the const UpdateCallback.

◆ META_Object()

osg::UniformBase::META_Object	(	osg	,
		UniformBase
	)

◆ operator!=()

bool osg::UniformBase::operator!= ( const UniformBase & rhs ) const

inline

◆ operator<()

bool osg::UniformBase::operator< ( const UniformBase & rhs ) const

inline

◆ operator==()

bool osg::UniformBase::operator== ( const UniformBase & rhs ) const

inline

◆ removeParent()

void osg::UniformBase::removeParent ( osg::StateSet * object )

protected

◆ setEventCallback()

void osg::UniformBase::setEventCallback ( UniformCallback * ec )

Set the EventCallback which allows users to attach customize the updating of an object during the Event traversal.

◆ setModifiedCount()

void osg::UniformBase::setModifiedCount ( unsigned int mc )

inline

◆ setName() [1/2]

virtual void osg::UniformBase::setName ( const std::string & name )

virtual

Set the name of the glUniform, ensuring it is only set once.

Reimplemented from osg::Object.

◆ setName() [2/2]

void osg::UniformBase::setName	(	const std::string &	baseName,
		unsigned int	unit
	)

Set the name of the glUniform appending [unit] such as osg_Light[0].

◆ setUpdateCallback()

void osg::UniformBase::setUpdateCallback ( UniformCallback * uc )

Set the UpdateCallback which allows users to attach customize the updating of an object during the update traversal.

Friends And Related Function Documentation

◆ osg::StateSet

friend class osg::StateSet

friend

Member Data Documentation

◆ _eventCallback

ref_ptr<UniformCallback> osg::UniformBase::_eventCallback

protected

◆ _modifiedCount

unsigned int osg::UniformBase::_modifiedCount

protected

◆ _nameID

unsigned int osg::UniformBase::_nameID

protected

◆ _parents

ParentList osg::UniformBase::_parents

protected

◆ _updateCallback

ref_ptr<UniformCallback> osg::UniformBase::_updateCallback

protected

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

osg/UniformBase

Public Types

Public Member Functions

Protected Member Functions

Protected Attributes

Friends

Additional Inherited Members

Detailed Description

Member Typedef Documentation

◆ ParentList

Constructor & Destructor Documentation

◆ UniformBase() [1/3]

◆ UniformBase() [2/3]

◆ UniformBase() [3/3]

◆ ~UniformBase()

Member Function Documentation

◆ addParent()

◆ apply()

◆ asUniformBase() [1/2]

◆ asUniformBase() [2/2]

◆ compare()

◆ compareData()

◆ dirty()

◆ getEventCallback() [1/2]

◆ getEventCallback() [2/2]

◆ getModifiedCount()

◆ getNameID()

◆ getNumParents()

◆ getParent() [1/2]

◆ getParent() [2/2]

◆ getParents() [1/2]

◆ getParents() [2/2]

◆ getUpdateCallback() [1/2]

◆ getUpdateCallback() [2/2]

◆ META_Object()

◆ operator!=()

◆ operator<()

◆ operator==()

◆ removeParent()

◆ setEventCallback()

◆ setModifiedCount()

◆ setName() [1/2]

◆ setName() [2/2]

◆ setUpdateCallback()

Friends And Related Function Documentation

◆ osg::StateSet

Member Data Documentation

◆ _eventCallback

◆ _modifiedCount

◆ _nameID

◆ _parents

◆ _updateCallback