OpenSceneGraph  3.0.1
Classes | Public Types | Public Member Functions | Static Public Member Functions | Protected Member Functions | Protected Attributes | Friends | List of all members
osg::Uniform Class Reference

Uniform encapsulates glUniform values. More...

Inheritance diagram for osg::Uniform:
Inheritance graph
[legend]

Classes

struct  Callback

Public Types

enum  Type {
  FLOAT = GL_FLOAT, FLOAT_VEC2 = GL_FLOAT_VEC2, FLOAT_VEC3 = GL_FLOAT_VEC3, FLOAT_VEC4 = GL_FLOAT_VEC4,
  INT = GL_INT, INT_VEC2 = GL_INT_VEC2, INT_VEC3 = GL_INT_VEC3, INT_VEC4 = GL_INT_VEC4,
  BOOL = GL_BOOL, BOOL_VEC2 = GL_BOOL_VEC2, BOOL_VEC3 = GL_BOOL_VEC3, BOOL_VEC4 = GL_BOOL_VEC4,
  FLOAT_MAT2 = GL_FLOAT_MAT2, FLOAT_MAT3 = GL_FLOAT_MAT3, FLOAT_MAT4 = GL_FLOAT_MAT4, SAMPLER_1D = GL_SAMPLER_1D,
  SAMPLER_2D = GL_SAMPLER_2D, SAMPLER_3D = GL_SAMPLER_3D, SAMPLER_CUBE = GL_SAMPLER_CUBE, SAMPLER_1D_SHADOW = GL_SAMPLER_1D_SHADOW,
  SAMPLER_2D_SHADOW = GL_SAMPLER_2D_SHADOW, SAMPLER_1D_ARRAY = GL_SAMPLER_1D_ARRAY_EXT, SAMPLER_2D_ARRAY = GL_SAMPLER_2D_ARRAY_EXT, SAMPLER_1D_ARRAY_SHADOW = GL_SAMPLER_1D_ARRAY_SHADOW_EXT,
  SAMPLER_2D_ARRAY_SHADOW = GL_SAMPLER_2D_ARRAY_SHADOW_EXT, FLOAT_MAT2x3 = GL_FLOAT_MAT2x3, FLOAT_MAT2x4 = GL_FLOAT_MAT2x4, FLOAT_MAT3x2 = GL_FLOAT_MAT3x2,
  FLOAT_MAT3x4 = GL_FLOAT_MAT3x4, FLOAT_MAT4x2 = GL_FLOAT_MAT4x2, FLOAT_MAT4x3 = GL_FLOAT_MAT4x3, SAMPLER_BUFFER = GL_SAMPLER_BUFFER_EXT,
  SAMPLER_CUBE_SHADOW = GL_SAMPLER_CUBE_SHADOW_EXT, UNSIGNED_INT = GL_UNSIGNED_INT, UNSIGNED_INT_VEC2 = GL_UNSIGNED_INT_VEC2_EXT, UNSIGNED_INT_VEC3 = GL_UNSIGNED_INT_VEC3_EXT,
  UNSIGNED_INT_VEC4 = GL_UNSIGNED_INT_VEC4_EXT, INT_SAMPLER_1D = GL_INT_SAMPLER_1D_EXT, INT_SAMPLER_2D = GL_INT_SAMPLER_2D_EXT, INT_SAMPLER_3D = GL_INT_SAMPLER_3D_EXT,
  INT_SAMPLER_CUBE = GL_INT_SAMPLER_CUBE_EXT, INT_SAMPLER_2D_RECT = GL_INT_SAMPLER_2D_RECT_EXT, INT_SAMPLER_1D_ARRAY = GL_INT_SAMPLER_1D_ARRAY_EXT, INT_SAMPLER_2D_ARRAY = GL_INT_SAMPLER_2D_ARRAY_EXT,
  INT_SAMPLER_BUFFER = GL_INT_SAMPLER_BUFFER_EXT, UNSIGNED_INT_SAMPLER_1D = GL_UNSIGNED_INT_SAMPLER_1D_EXT, UNSIGNED_INT_SAMPLER_2D = GL_UNSIGNED_INT_SAMPLER_2D_EXT, UNSIGNED_INT_SAMPLER_3D = GL_UNSIGNED_INT_SAMPLER_3D_EXT,
  UNSIGNED_INT_SAMPLER_CUBE = GL_UNSIGNED_INT_SAMPLER_CUBE_EXT, UNSIGNED_INT_SAMPLER_2D_RECT = GL_UNSIGNED_INT_SAMPLER_2D_RECT_EXT, UNSIGNED_INT_SAMPLER_1D_ARRAY = GL_UNSIGNED_INT_SAMPLER_1D_ARRAY_EXT, UNSIGNED_INT_SAMPLER_2D_ARRAY = GL_UNSIGNED_INT_SAMPLER_2D_ARRAY_EXT,
  UNSIGNED_INT_SAMPLER_BUFFER = GL_UNSIGNED_INT_SAMPLER_BUFFER_EXT, UNDEFINED = 0x0
}
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.
- Public Types inherited from osg::Object
enum  DataVariance { DYNAMIC, STATIC, UNSPECIFIED }

Public Member Functions

 Uniform ()
 Uniform (Type type, const std::string &name, int numElements=1)
 Uniform (const Uniform &rhs, const CopyOp &copyop=CopyOp::SHALLOW_COPY)
 Copy constructor using CopyOp to manage deep vs shallow copy.
 META_Object (osg, Uniform)
bool setType (Type t)
 Set the type of glUniform, ensuring it is only set once.
Type getType () const
 Get the type of glUniform as enum.
virtual void setName (const std::string &name)
 Set the name of the glUniform, ensuring it is only set once.
void setNumElements (unsigned int numElements)
 Set the length of a uniform, ensuring it is only set once (1==scalar)
unsigned int getNumElements () const
 Get the number of GLSL elements of the osg::Uniform (1==scalar)
unsigned int getInternalArrayNumElements () const
 Get the number of elements required for the internal data array.
 Uniform (const char *name, float f)
 convenient scalar (non-array) constructors w/ assignment
 Uniform (const char *name, int i)
 Uniform (const char *name, unsigned int i)
 Uniform (const char *name, bool b)
 Uniform (const char *name, const osg::Vec2 &v2)
 Uniform (const char *name, const osg::Vec3 &v3)
 Uniform (const char *name, const osg::Vec4 &v4)
 Uniform (const char *name, const osg::Matrix2 &m2)
 Uniform (const char *name, const osg::Matrix3 &m3)
 Uniform (const char *name, const osg::Matrixf &m4)
 Uniform (const char *name, const osg::Matrixd &m4)
 Uniform (const char *name, int i0, int i1)
 Uniform (const char *name, int i0, int i1, int i2)
 Uniform (const char *name, int i0, int i1, int i2, int i3)
 Uniform (const char *name, unsigned int i0, unsigned int i1)
 Uniform (const char *name, unsigned int i0, unsigned int i1, unsigned int i2)
 Uniform (const char *name, unsigned int i0, unsigned int i1, unsigned int i2, unsigned int i3)
 Uniform (const char *name, bool b0, bool b1)
 Uniform (const char *name, bool b0, bool b1, bool b2)
 Uniform (const char *name, bool b0, bool b1, bool b2, bool b3)
virtual int compare (const Uniform &rhs) const
 return -1 if *this < *rhs, 0 if *this==*rhs, 1 if *this>*rhs.
virtual int compareData (const Uniform &rhs) const
bool operator< (const Uniform &rhs) const
bool operator== (const Uniform &rhs) const
bool operator!= (const Uniform &rhs) const
void copyData (const Uniform &rhs)
const ParentListgetParents () const
 Get the parent list of this Uniform.
ParentList getParents ()
 Get the a copy of parent list of node.
StateSetgetParent (unsigned int i)
const StateSetgetParent (unsigned int i) const
 Get a single const parent of this Uniform.
unsigned int getNumParents () const
 Get the number of parents of this Uniform.
bool set (float f)
 convenient scalar (non-array) value assignment
bool set (int i)
bool set (unsigned int i)
bool set (bool b)
bool set (const osg::Vec2 &v2)
bool set (const osg::Vec3 &v3)
bool set (const osg::Vec4 &v4)
bool set (const osg::Matrix2 &m2)
bool set (const osg::Matrix3 &m3)
bool set (const osg::Matrixf &m4)
bool set (const osg::Matrixd &m4)
bool set (int i0, int i1)
bool set (int i0, int i1, int i2)
bool set (int i0, int i1, int i2, int i3)
bool set (unsigned int i0, unsigned int i1)
bool set (unsigned int i0, unsigned int i1, unsigned int i2)
bool set (unsigned int i0, unsigned int i1, unsigned int i2, unsigned int i3)
bool set (bool b0, bool b1)
bool set (bool b0, bool b1, bool b2)
bool set (bool b0, bool b1, bool b2, bool b3)
bool get (float &f) const
 convenient scalar (non-array) value query
bool get (int &i) const
bool get (unsigned int &i) const
bool get (bool &b) const
bool get (osg::Vec2 &v2) const
bool get (osg::Vec3 &v3) const
bool get (osg::Vec4 &v4) const
bool get (osg::Matrix2 &m2) const
bool get (osg::Matrix3 &m3) const
bool get (osg::Matrixf &m4) const
bool get (osg::Matrixd &m4) const
bool get (int &i0, int &i1) const
bool get (int &i0, int &i1, int &i2) const
bool get (int &i0, int &i1, int &i2, int &i3) const
bool get (unsigned int &i0, unsigned int &i1) const
bool get (unsigned int &i0, unsigned int &i1, unsigned int &i2) const
bool get (unsigned int &i0, unsigned int &i1, unsigned int &i2, unsigned int &i3) const
bool get (bool &b0, bool &b1) const
bool get (bool &b0, bool &b1, bool &b2) const
bool get (bool &b0, bool &b1, bool &b2, bool &b3) const
bool setElement (unsigned int index, float f)
 value assignment for array uniforms
bool setElement (unsigned int index, int i)
bool setElement (unsigned int index, unsigned int i)
bool setElement (unsigned int index, bool b)
bool setElement (unsigned int index, const osg::Vec2 &v2)
bool setElement (unsigned int index, const osg::Vec3 &v3)
bool setElement (unsigned int index, const osg::Vec4 &v4)
bool setElement (unsigned int index, const osg::Matrix2 &m2)
bool setElement (unsigned int index, const osg::Matrix3 &m3)
bool setElement (unsigned int index, const osg::Matrixf &m4)
bool setElement (unsigned int index, const osg::Matrixd &m4)
bool setElement (unsigned int index, int i0, int i1)
bool setElement (unsigned int index, int i0, int i1, int i2)
bool setElement (unsigned int index, int i0, int i1, int i2, int i3)
bool setElement (unsigned int index, unsigned int i0, unsigned int i1)
bool setElement (unsigned int index, unsigned int i0, unsigned int i1, unsigned int i2)
bool setElement (unsigned int index, unsigned int i0, unsigned int i1, unsigned int i2, unsigned int i3)
bool setElement (unsigned int index, bool b0, bool b1)
bool setElement (unsigned int index, bool b0, bool b1, bool b2)
bool setElement (unsigned int index, bool b0, bool b1, bool b2, bool b3)
bool getElement (unsigned int index, float &f) const
 value query for array uniforms
bool getElement (unsigned int index, int &i) const
bool getElement (unsigned int index, unsigned int &i) const
bool getElement (unsigned int index, bool &b) const
bool getElement (unsigned int index, osg::Vec2 &v2) const
bool getElement (unsigned int index, osg::Vec3 &v3) const
bool getElement (unsigned int index, osg::Vec4 &v4) const
bool getElement (unsigned int index, osg::Matrix2 &m2) const
bool getElement (unsigned int index, osg::Matrix3 &m3) const
bool getElement (unsigned int index, osg::Matrixf &m4) const
bool getElement (unsigned int index, osg::Matrixd &m4) const
bool getElement (unsigned int index, int &i0, int &i1) const
bool getElement (unsigned int index, int &i0, int &i1, int &i2) const
bool getElement (unsigned int index, int &i0, int &i1, int &i2, int &i3) const
bool getElement (unsigned int index, unsigned int &i0, unsigned int &i1) const
bool getElement (unsigned int index, unsigned int &i0, unsigned int &i1, unsigned int &i2) const
bool getElement (unsigned int index, unsigned int &i0, unsigned int &i1, unsigned int &i2, unsigned int &i3) const
bool getElement (unsigned int index, bool &b0, bool &b1) const
bool getElement (unsigned int index, bool &b0, bool &b1, bool &b2) const
bool getElement (unsigned int index, bool &b0, bool &b1, bool &b2, bool &b3) const
void setUpdateCallback (Callback *uc)
 Set the UpdateCallback which allows users to attach customize the updating of an object during the update traversal.
CallbackgetUpdateCallback ()
 Get the non const UpdateCallback.
const CallbackgetUpdateCallback () const
 Get the const UpdateCallback.
void setEventCallback (Callback *ec)
 Set the EventCallback which allows users to attach customize the updating of an object during the Event traversal.
CallbackgetEventCallback ()
 Get the non const EventCallback.
const CallbackgetEventCallback () const
 Get the const EventCallback.
void dirty ()
 Increment the modified count on the Uniform so Programs watching it know it update themselves.
bool setArray (FloatArray *array)
 Set the internal data array for a osg::Uniform.
bool setArray (IntArray *array)
bool setArray (UIntArray *array)
FloatArraygetFloatArray ()
 Get the internal data array for a float osg::Uniform.
const FloatArraygetFloatArray () const
IntArraygetIntArray ()
 Get the internal data array for an int osg::Uniform.
const IntArraygetIntArray () const
UIntArraygetUIntArray ()
 Get the internal data array for an unsigned int osg::Uniform.
const UIntArraygetUIntArray () const
void setModifiedCount (unsigned int mc)
unsigned int getModifiedCount () const
unsigned int getNameID () const
 Get the number that the Uniform's name maps to uniquely.
void apply (const GL2Extensions *ext, GLint location) const
- Public Member Functions inherited from osg::Object
 Object ()
 Construct an object.
 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.
virtual ObjectcloneType () const =0
 Clone the type of an object, with Object* return type.
virtual Objectclone (const CopyOp &) const =0
 Clone an object, with Object* return type.
virtual bool isSameKindAs (const Object *) const
virtual const char * libraryName () const =0
 return the name of the object's library.
virtual const char * className () const =0
 return the name of the object's class type.
virtual void setThreadSafeRefUnref (bool threadSafe)
 Set whether to use a mutex to ensure ref() and unref() are thread safe.
void setName (const char *name)
 Set the name of object using a C style string.
const std::string & getName () const
 Get the name of object.
void setDataVariance (DataVariance dv)
 Set the data variance of this object.
DataVariance getDataVariance () const
 Get the data variance of this object.
virtual void computeDataVariance ()
 Compute the DataVariance based on an assessment of callback etc.
void setUserDataContainer (osg::UserDataContainer *udc)
 set the UserDataContainer object.
osg::UserDataContainergetUserDataContainer ()
 get the UserDataContainer attached to this object.
const osg::UserDataContainergetUserDataContainer () const
 get the const UserDataContainer attached to this object.
osg::UserDataContainergetOrCreateUserDataContainer ()
 Convinience 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.
virtual void setUserData (Referenced *obj)
 Set user data, data must be subclassed from Referenced to allow automatic memory handling.
virtual ReferencedgetUserData ()
 Get user data.
virtual const ReferencedgetUserData () const
 Get const user data.
template<typename T >
bool getUserValue (const std::string &name, T &value) const
 Convinience method that casts the named UserObject to osg::TemplateValueObject<T> and gets the value.
template<typename T >
void setUserValue (const std::string &name, const T &value)
 Convinience method that creates the osg::TemplateValueObject<T> to store the specified value and adds it as a named UserObject.
virtual void resizeGLObjectBuffers (unsigned int)
 Resize any per context GLObject buffers to specified size.
virtual void releaseGLObjects (osg::State *=0) const
 If State is non-zero, this function releases any associated OpenGL objects for the specified graphics context.
- Public Member Functions inherited from osg::Referenced
 Referenced ()
 Referenced (bool threadSafeRefUnref)
 Referenced (const Referenced &)
Referencedoperator= (const Referenced &)
bool getThreadSafeRefUnref () const
 Get whether a mutex is used to ensure ref() and unref() are thread safe.
OpenThreads::Mutex * getRefMutex () const
 Get the mutex used to ensure thread safety of ref()/unref().
int ref () const
 Increment the reference count by one, indicating that this object has another pointer which is referencing it.
int unref () const
 Decrement the reference count by one, indicating that a pointer to this object is referencing it.
int unref_nodelete () const
 Decrement the reference count by one, indicating that a pointer to this object is referencing it.
int referenceCount () const
 Return the number of pointers currently referencing this object.
ObserverSetgetObserverSet () const
 Get the ObserverSet if one is attached, otherwise return NULL.
ObserverSetgetOrCreateObserverSet () const
 Get the ObserverSet if one is attached, otherwise create an ObserverSet, attach it, then return this newly created ObserverSet.
void addObserver (Observer *observer) const
 Add a Observer that is observing this object, notify the Observer when this object gets deleted.
void removeObserver (Observer *observer) const
 Remove Observer that is observing this object.

Static Public Member Functions

static const char * getTypename (Type t)
 Return the name of a Type enum as string.
static int getTypeNumComponents (Type t)
 Return the the number of components for a GLSL type.
static Uniform::Type getTypeId (const std::string &tname)
 Return the Type enum of a Uniform typename string.
static Type getGlApiType (Type t)
 Return the GL API type corresponding to a GLSL type.
static GLenum getInternalArrayType (Type t)
 Return the internal data array type corresponding to a GLSL type.
static unsigned int getNameID (const std::string &name)
 Return the number that the name maps to uniquely.

Protected Member Functions

virtual ~Uniform ()
Uniformoperator= (const Uniform &)
bool isCompatibleType (Type t) const
bool isScalar () const
void allocateDataArray ()
void addParent (osg::StateSet *object)
void removeParent (osg::StateSet *object)
- Protected Member Functions inherited from osg::Object
virtual ~Object ()
 Object destructor.
- Protected Member Functions inherited from osg::Referenced
virtual ~Referenced ()
void signalObserversAndDelete (bool signalDelete, bool doDelete) const
void deleteUsingDeleteHandler () const

Protected Attributes

ParentList _parents
Type _type
unsigned int _numElements
unsigned int _nameID
ref_ptr< FloatArray_floatArray
ref_ptr< IntArray_intArray
ref_ptr< UIntArray_uintArray
ref_ptr< Callback_updateCallback
ref_ptr< Callback_eventCallback
unsigned int _modifiedCount
- 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

Detailed Description

Uniform encapsulates glUniform values.

Member Typedef Documentation

typedef std::vector<StateSet*> osg::Uniform::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.

Member Enumeration Documentation

Enumerator:
FLOAT 
FLOAT_VEC2 
FLOAT_VEC3 
FLOAT_VEC4 
INT 
INT_VEC2 
INT_VEC3 
INT_VEC4 
BOOL 
BOOL_VEC2 
BOOL_VEC3 
BOOL_VEC4 
FLOAT_MAT2 
FLOAT_MAT3 
FLOAT_MAT4 
SAMPLER_1D 
SAMPLER_2D 
SAMPLER_3D 
SAMPLER_CUBE 
SAMPLER_1D_SHADOW 
SAMPLER_2D_SHADOW 
SAMPLER_1D_ARRAY 
SAMPLER_2D_ARRAY 
SAMPLER_1D_ARRAY_SHADOW 
SAMPLER_2D_ARRAY_SHADOW 
FLOAT_MAT2x3 
FLOAT_MAT2x4 
FLOAT_MAT3x2 
FLOAT_MAT3x4 
FLOAT_MAT4x2 
FLOAT_MAT4x3 
SAMPLER_BUFFER 
SAMPLER_CUBE_SHADOW 
UNSIGNED_INT 
UNSIGNED_INT_VEC2 
UNSIGNED_INT_VEC3 
UNSIGNED_INT_VEC4 
INT_SAMPLER_1D 
INT_SAMPLER_2D 
INT_SAMPLER_3D 
INT_SAMPLER_CUBE 
INT_SAMPLER_2D_RECT 
INT_SAMPLER_1D_ARRAY 
INT_SAMPLER_2D_ARRAY 
INT_SAMPLER_BUFFER 
UNSIGNED_INT_SAMPLER_1D 
UNSIGNED_INT_SAMPLER_2D 
UNSIGNED_INT_SAMPLER_3D 
UNSIGNED_INT_SAMPLER_CUBE 
UNSIGNED_INT_SAMPLER_2D_RECT 
UNSIGNED_INT_SAMPLER_1D_ARRAY 
UNSIGNED_INT_SAMPLER_2D_ARRAY 
UNSIGNED_INT_SAMPLER_BUFFER 
UNDEFINED 

Constructor & Destructor Documentation

osg::Uniform::Uniform ( )
osg::Uniform::Uniform ( Type  type,
const std::string &  name,
int  numElements = 1 
)
osg::Uniform::Uniform ( const Uniform rhs,
const CopyOp copyop = CopyOp::SHALLOW_COPY 
)

Copy constructor using CopyOp to manage deep vs shallow copy.

osg::Uniform::Uniform ( const char *  name,
float  f 
)
explicit

convenient scalar (non-array) constructors w/ assignment

osg::Uniform::Uniform ( const char *  name,
int  i 
)
explicit
osg::Uniform::Uniform ( const char *  name,
unsigned int  i 
)
explicit
osg::Uniform::Uniform ( const char *  name,
bool  b 
)
explicit
osg::Uniform::Uniform ( const char *  name,
const osg::Vec2 v2 
)
osg::Uniform::Uniform ( const char *  name,
const osg::Vec3 v3 
)
osg::Uniform::Uniform ( const char *  name,
const osg::Vec4 v4 
)
osg::Uniform::Uniform ( const char *  name,
const osg::Matrix2 m2 
)
osg::Uniform::Uniform ( const char *  name,
const osg::Matrix3 m3 
)
osg::Uniform::Uniform ( const char *  name,
const osg::Matrixf m4 
)
osg::Uniform::Uniform ( const char *  name,
const osg::Matrixd m4 
)
osg::Uniform::Uniform ( const char *  name,
int  i0,
int  i1 
)
osg::Uniform::Uniform ( const char *  name,
int  i0,
int  i1,
int  i2 
)
osg::Uniform::Uniform ( const char *  name,
int  i0,
int  i1,
int  i2,
int  i3 
)
osg::Uniform::Uniform ( const char *  name,
unsigned int  i0,
unsigned int  i1 
)
osg::Uniform::Uniform ( const char *  name,
unsigned int  i0,
unsigned int  i1,
unsigned int  i2 
)
osg::Uniform::Uniform ( const char *  name,
unsigned int  i0,
unsigned int  i1,
unsigned int  i2,
unsigned int  i3 
)
osg::Uniform::Uniform ( const char *  name,
bool  b0,
bool  b1 
)
osg::Uniform::Uniform ( const char *  name,
bool  b0,
bool  b1,
bool  b2 
)
osg::Uniform::Uniform ( const char *  name,
bool  b0,
bool  b1,
bool  b2,
bool  b3 
)
virtual osg::Uniform::~Uniform ( )
protectedvirtual

Member Function Documentation

void osg::Uniform::addParent ( osg::StateSet object)
protected
void osg::Uniform::allocateDataArray ( )
protected
void osg::Uniform::apply ( const GL2Extensions ext,
GLint  location 
) const
virtual int osg::Uniform::compare ( const Uniform rhs) const
virtual

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

virtual int osg::Uniform::compareData ( const Uniform rhs) const
virtual
void osg::Uniform::copyData ( const Uniform rhs)
void osg::Uniform::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.

bool osg::Uniform::get ( float &  f) const
bool osg::Uniform::get ( int &  i) const
bool osg::Uniform::get ( unsigned int &  i) const
bool osg::Uniform::get ( bool &  b) const
bool osg::Uniform::get ( osg::Vec2 v2) const
bool osg::Uniform::get ( osg::Vec3 v3) const
bool osg::Uniform::get ( osg::Vec4 v4) const
bool osg::Uniform::get ( osg::Matrix2 m2) const
bool osg::Uniform::get ( osg::Matrix3 m3) const
bool osg::Uniform::get ( osg::Matrixf m4) const
bool osg::Uniform::get ( osg::Matrixd m4) const
bool osg::Uniform::get ( int &  i0,
int &  i1 
) const
bool osg::Uniform::get ( int &  i0,
int &  i1,
int &  i2 
) const
bool osg::Uniform::get ( int &  i0,
int &  i1,
int &  i2,
int &  i3 
) const
bool osg::Uniform::get ( unsigned int &  i0,
unsigned int &  i1 
) const
bool osg::Uniform::get ( unsigned int &  i0,
unsigned int &  i1,
unsigned int &  i2 
) const
bool osg::Uniform::get ( unsigned int &  i0,
unsigned int &  i1,
unsigned int &  i2,
unsigned int &  i3 
) const
bool osg::Uniform::get ( bool &  b0,
bool &  b1 
) const
bool osg::Uniform::get ( bool &  b0,
bool &  b1,
bool &  b2 
) const
bool osg::Uniform::get ( bool &  b0,
bool &  b1,
bool &  b2,
bool &  b3 
) const
bool osg::Uniform::getElement ( unsigned int  index,
float &  f 
) const

value query for array uniforms

bool osg::Uniform::getElement ( unsigned int  index,
int &  i 
) const
bool osg::Uniform::getElement ( unsigned int  index,
unsigned int &  i 
) const
bool osg::Uniform::getElement ( unsigned int  index,
bool &  b 
) const
bool osg::Uniform::getElement ( unsigned int  index,
osg::Vec2 v2 
) const
bool osg::Uniform::getElement ( unsigned int  index,
osg::Vec3 v3 
) const
bool osg::Uniform::getElement ( unsigned int  index,
osg::Vec4 v4 
) const
bool osg::Uniform::getElement ( unsigned int  index,
osg::Matrix2 m2 
) const
bool osg::Uniform::getElement ( unsigned int  index,
osg::Matrix3 m3 
) const
bool osg::Uniform::getElement ( unsigned int  index,
osg::Matrixf m4 
) const
bool osg::Uniform::getElement ( unsigned int  index,
osg::Matrixd m4 
) const
bool osg::Uniform::getElement ( unsigned int  index,
int &  i0,
int &  i1 
) const
bool osg::Uniform::getElement ( unsigned int  index,
int &  i0,
int &  i1,
int &  i2 
) const
bool osg::Uniform::getElement ( unsigned int  index,
int &  i0,
int &  i1,
int &  i2,
int &  i3 
) const
bool osg::Uniform::getElement ( unsigned int  index,
unsigned int &  i0,
unsigned int &  i1 
) const
bool osg::Uniform::getElement ( unsigned int  index,
unsigned int &  i0,
unsigned int &  i1,
unsigned int &  i2 
) const
bool osg::Uniform::getElement ( unsigned int  index,
unsigned int &  i0,
unsigned int &  i1,
unsigned int &  i2,
unsigned int &  i3 
) const
bool osg::Uniform::getElement ( unsigned int  index,
bool &  b0,
bool &  b1 
) const
bool osg::Uniform::getElement ( unsigned int  index,
bool &  b0,
bool &  b1,
bool &  b2 
) const
bool osg::Uniform::getElement ( unsigned int  index,
bool &  b0,
bool &  b1,
bool &  b2,
bool &  b3 
) const
Callback* osg::Uniform::getEventCallback ( )
inline

Get the non const EventCallback.

const Callback* osg::Uniform::getEventCallback ( ) const
inline

Get the const EventCallback.

FloatArray* osg::Uniform::getFloatArray ( )
inline

Get the internal data array for a float osg::Uniform.

const FloatArray* osg::Uniform::getFloatArray ( ) const
inline
static Type osg::Uniform::getGlApiType ( Type  t)
static

Return the GL API type corresponding to a GLSL type.

IntArray* osg::Uniform::getIntArray ( )
inline

Get the internal data array for an int osg::Uniform.

const IntArray* osg::Uniform::getIntArray ( ) const
inline
unsigned int osg::Uniform::getInternalArrayNumElements ( ) const

Get the number of elements required for the internal data array.

Returns 0 if the osg::Uniform is not properly configured.

static GLenum osg::Uniform::getInternalArrayType ( Type  t)
static

Return the internal data array type corresponding to a GLSL type.

unsigned int osg::Uniform::getModifiedCount ( ) const
inline
static unsigned int osg::Uniform::getNameID ( const std::string &  name)
static

Return the number that the name maps to uniquely.

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

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

Get the number that the Uniform's name maps to uniquely.

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

unsigned int osg::Uniform::getNumElements ( ) const
inline

Get the number of GLSL elements of the osg::Uniform (1==scalar)

unsigned int osg::Uniform::getNumParents ( ) const
inline

Get the number of parents of this Uniform.

Returns
the number of parents of this Uniform.
StateSet* osg::Uniform::getParent ( unsigned int  i)
inline
const StateSet* osg::Uniform::getParent ( unsigned int  i) const
inline

Get a single const parent of this Uniform.

Parameters
iindex of the parent to get.
Returns
the parent i.
const ParentList& osg::Uniform::getParents ( ) const
inline

Get the parent list of this Uniform.

ParentList osg::Uniform::getParents ( )
inline

Get the a copy of parent list of node.

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

Type osg::Uniform::getType ( ) const
inline

Get the type of glUniform as enum.

static Uniform::Type osg::Uniform::getTypeId ( const std::string &  tname)
static

Return the Type enum of a Uniform typename string.

static const char* osg::Uniform::getTypename ( Type  t)
static

Return the name of a Type enum as string.

static int osg::Uniform::getTypeNumComponents ( Type  t)
static

Return the the number of components for a GLSL type.

UIntArray* osg::Uniform::getUIntArray ( )
inline

Get the internal data array for an unsigned int osg::Uniform.

const UIntArray* osg::Uniform::getUIntArray ( ) const
inline
Callback* osg::Uniform::getUpdateCallback ( )
inline

Get the non const UpdateCallback.

const Callback* osg::Uniform::getUpdateCallback ( ) const
inline

Get the const UpdateCallback.

bool osg::Uniform::isCompatibleType ( Type  t) const
protected
bool osg::Uniform::isScalar ( ) const
inlineprotected
osg::Uniform::META_Object ( osg  ,
Uniform   
)
bool osg::Uniform::operator!= ( const Uniform rhs) const
inline
bool osg::Uniform::operator< ( const Uniform rhs) const
inline
Uniform& osg::Uniform::operator= ( const Uniform )
inlineprotected
bool osg::Uniform::operator== ( const Uniform rhs) const
inline
void osg::Uniform::removeParent ( osg::StateSet object)
protected
bool osg::Uniform::set ( float  f)

convenient scalar (non-array) value assignment

bool osg::Uniform::set ( int  i)
bool osg::Uniform::set ( unsigned int  i)
bool osg::Uniform::set ( bool  b)
bool osg::Uniform::set ( const osg::Vec2 v2)
bool osg::Uniform::set ( const osg::Vec3 v3)
bool osg::Uniform::set ( const osg::Vec4 v4)
bool osg::Uniform::set ( const osg::Matrix2 m2)
bool osg::Uniform::set ( const osg::Matrix3 m3)
bool osg::Uniform::set ( const osg::Matrixf m4)
bool osg::Uniform::set ( const osg::Matrixd m4)
bool osg::Uniform::set ( int  i0,
int  i1 
)
bool osg::Uniform::set ( int  i0,
int  i1,
int  i2 
)
bool osg::Uniform::set ( int  i0,
int  i1,
int  i2,
int  i3 
)
bool osg::Uniform::set ( unsigned int  i0,
unsigned int  i1 
)
bool osg::Uniform::set ( unsigned int  i0,
unsigned int  i1,
unsigned int  i2 
)
bool osg::Uniform::set ( unsigned int  i0,
unsigned int  i1,
unsigned int  i2,
unsigned int  i3 
)
bool osg::Uniform::set ( bool  b0,
bool  b1 
)
bool osg::Uniform::set ( bool  b0,
bool  b1,
bool  b2 
)
bool osg::Uniform::set ( bool  b0,
bool  b1,
bool  b2,
bool  b3 
)
bool osg::Uniform::setArray ( FloatArray array)

Set the internal data array for a osg::Uniform.

bool osg::Uniform::setArray ( IntArray array)
bool osg::Uniform::setArray ( UIntArray array)
bool osg::Uniform::setElement ( unsigned int  index,
float  f 
)

value assignment for array uniforms

bool osg::Uniform::setElement ( unsigned int  index,
int  i 
)
bool osg::Uniform::setElement ( unsigned int  index,
unsigned int  i 
)
bool osg::Uniform::setElement ( unsigned int  index,
bool  b 
)
bool osg::Uniform::setElement ( unsigned int  index,
const osg::Vec2 v2 
)
bool osg::Uniform::setElement ( unsigned int  index,
const osg::Vec3 v3 
)
bool osg::Uniform::setElement ( unsigned int  index,
const osg::Vec4 v4 
)
bool osg::Uniform::setElement ( unsigned int  index,
const osg::Matrix2 m2 
)
bool osg::Uniform::setElement ( unsigned int  index,
const osg::Matrix3 m3 
)
bool osg::Uniform::setElement ( unsigned int  index,
const osg::Matrixf m4 
)
bool osg::Uniform::setElement ( unsigned int  index,
const osg::Matrixd m4 
)
bool osg::Uniform::setElement ( unsigned int  index,
int  i0,
int  i1 
)
bool osg::Uniform::setElement ( unsigned int  index,
int  i0,
int  i1,
int  i2 
)
bool osg::Uniform::setElement ( unsigned int  index,
int  i0,
int  i1,
int  i2,
int  i3 
)
bool osg::Uniform::setElement ( unsigned int  index,
unsigned int  i0,
unsigned int  i1 
)
bool osg::Uniform::setElement ( unsigned int  index,
unsigned int  i0,
unsigned int  i1,
unsigned int  i2 
)
bool osg::Uniform::setElement ( unsigned int  index,
unsigned int  i0,
unsigned int  i1,
unsigned int  i2,
unsigned int  i3 
)
bool osg::Uniform::setElement ( unsigned int  index,
bool  b0,
bool  b1 
)
bool osg::Uniform::setElement ( unsigned int  index,
bool  b0,
bool  b1,
bool  b2 
)
bool osg::Uniform::setElement ( unsigned int  index,
bool  b0,
bool  b1,
bool  b2,
bool  b3 
)
void osg::Uniform::setEventCallback ( Callback ec)

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

void osg::Uniform::setModifiedCount ( unsigned int  mc)
inline
virtual void osg::Uniform::setName ( const std::string &  name)
virtual

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

Reimplemented from osg::Object.

void osg::Uniform::setNumElements ( unsigned int  numElements)

Set the length of a uniform, ensuring it is only set once (1==scalar)

bool osg::Uniform::setType ( Type  t)

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

void osg::Uniform::setUpdateCallback ( Callback uc)

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

Friends And Related Function Documentation

friend class osg::StateSet
friend

Member Data Documentation

ref_ptr<Callback> osg::Uniform::_eventCallback
protected
ref_ptr<FloatArray> osg::Uniform::_floatArray
protected
ref_ptr<IntArray> osg::Uniform::_intArray
protected
unsigned int osg::Uniform::_modifiedCount
protected
unsigned int osg::Uniform::_nameID
protected
unsigned int osg::Uniform::_numElements
protected
ParentList osg::Uniform::_parents
protected
Type osg::Uniform::_type
protected
ref_ptr<UIntArray> osg::Uniform::_uintArray
protected
ref_ptr<Callback> osg::Uniform::_updateCallback
protected

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

osg logo
Generated at Tue Sep 4 2012 16:27:05 for the OpenSceneGraph by doxygen 1.8.1.2.