OpenSceneGraph  3.5.1
Public Types | Public Member Functions | Protected Member Functions | Protected Attributes | List of all members
osg::Array Class Referenceabstract
Inheritance diagram for osg::Array:
Inheritance graph
[legend]

Public Types

enum  Type {
  ArrayType = 0, ByteArrayType = 1, ShortArrayType = 2, IntArrayType = 3,
  UByteArrayType = 4, UShortArrayType = 5, UIntArrayType = 6, FloatArrayType = 7,
  DoubleArrayType = 8, Vec2bArrayType = 9, Vec3bArrayType = 10, Vec4bArrayType = 11,
  Vec2sArrayType = 12, Vec3sArrayType = 13, Vec4sArrayType = 14, Vec2iArrayType = 15,
  Vec3iArrayType = 16, Vec4iArrayType = 17, Vec2ubArrayType = 18, Vec3ubArrayType = 19,
  Vec4ubArrayType = 20, Vec2usArrayType = 21, Vec3usArrayType = 22, Vec4usArrayType = 23,
  Vec2uiArrayType = 24, Vec3uiArrayType = 25, Vec4uiArrayType = 26, Vec2ArrayType = 27,
  Vec3ArrayType = 28, Vec4ArrayType = 29, Vec2dArrayType = 30, Vec3dArrayType = 31,
  Vec4dArrayType = 32, MatrixArrayType = 33, MatrixdArrayType = 34
}
 
enum  Binding {
  BIND_UNDEFINED =-1, BIND_OFF =0, BIND_OVERALL =1, BIND_PER_PRIMITIVE_SET =2,
  BIND_PER_VERTEX =4
}
 
- Public Types inherited from osg::Object
enum  DataVariance { DYNAMIC, STATIC, UNSPECIFIED }
 

Public Member Functions

 Array (Type arrayType=ArrayType, GLint dataSize=0, GLenum dataType=0, Binding binding=BIND_UNDEFINED)
 
 Array (const Array &array, const CopyOp &copyop=CopyOp::SHALLOW_COPY)
 
virtual bool isSameKindAs (const Object *obj) const
 
virtual const char * libraryName () const
 return the name of the object's library. More...
 
virtual const char * className () const
 return the name of the object's class type. More...
 
virtual void accept (ArrayVisitor &)=0
 
virtual void accept (ConstArrayVisitor &) const =0
 
virtual void accept (unsigned int index, ValueVisitor &)=0
 
virtual void accept (unsigned int index, ConstValueVisitor &) const =0
 
virtual int compare (unsigned int lhs, unsigned int rhs) const =0
 Return -1 if lhs element is less than rhs element, 0 if equal, 1 if lhs element is greater than rhs element. More...
 
Type getType () const
 
GLint getDataSize () const
 
GLenum getDataType () const
 
virtual osg::ArrayasArray ()
 
virtual const osg::ArrayasArray () const
 
virtual unsigned int getElementSize () const =0
 
virtual const GLvoid * getDataPointer () const =0
 
virtual unsigned int getTotalDataSize () const =0
 
virtual unsigned int getNumElements () const =0
 
virtual void reserveArray (unsigned int num)=0
 
virtual void resizeArray (unsigned int num)=0
 
void setBinding (Binding binding)
 Specify how this array should be passed to OpenGL. More...
 
Binding getBinding () const
 Get how this array should be passed to OpenGL. More...
 
void setNormalize (bool normalize)
 Specify whether the array data should be normalized by OpenGL. More...
 
bool getNormalize () const
 Get whether the array data should be normalized by OpenGL. More...
 
void setPreserveDataType (bool preserve)
 Set hint to ask that the array data is passed via integer or double, or normal setVertexAttribPointer function. More...
 
bool getPreserveDataType () const
 Get hint to ask that the array data is passed via integer or double, or normal setVertexAttribPointer function. More...
 
virtual void trim ()
 Frees unused space on this vector - i.e. More...
 
void setVertexBufferObject (osg::VertexBufferObject *vbo)
 Set the VertexBufferObject. More...
 
osg::VertexBufferObjectgetVertexBufferObject ()
 Get the VertexBufferObject. More...
 
const osg::VertexBufferObjectgetVertexBufferObject () const
 Get the const VertexBufferObject. More...
 
- Public Member Functions inherited from osg::BufferData
 BufferData ()
 
 BufferData (const BufferData &bd, const CopyOp &copyop=CopyOp::SHALLOW_COPY)
 Copy constructor using CopyOp to manage deep vs shallow copy. More...
 
virtual osg::PrimitiveSetasPrimitiveSet ()
 
virtual const osg::PrimitiveSetasPrimitiveSet () const
 
virtual osg::ImageasImage ()
 
virtual const osg::ImageasImage () const
 
void setBufferObject (BufferObject *bufferObject)
 
BufferObjectgetBufferObject ()
 
const BufferObjectgetBufferObject () const
 
void setBufferIndex (unsigned int index)
 
unsigned int getBufferIndex () const
 
GLBufferObjectgetGLBufferObject (unsigned int contextID) const
 
GLBufferObjectgetOrCreateGLBufferObject (unsigned int contextID) const
 
void setModifiedCallback (ModifiedCallback *md)
 
ModifiedCallbackgetModifiedCallback ()
 
const ModifiedCallbackgetModifiedCallback () const
 
void dirty ()
 Dirty the primitive, which increments the modified count, to force buffer objects to update. More...
 
void setModifiedCount (unsigned int value)
 Set the modified count value. More...
 
unsigned int getModifiedCount () const
 Get modified count value. More...
 
virtual void resizeGLObjectBuffers (unsigned int maxSize)
 Resize any per context GLObject buffers to specified size. More...
 
void releaseGLObjects (State *state=0) const
 If State is non-zero, this function releases OpenGL objects for the specified graphics context. More...
 
unsigned int getNumClients () const
 
void addClient (osg::Object *)
 
void removeClient (osg::Object *)
 
- 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 ObjectcloneType () const =0
 Clone the type of an object, with Object* return type. More...
 
virtual Objectclone (const CopyOp &) const =0
 Clone an object, with Object* return type. More...
 
std::string getCompoundClassName () const
 return the compound class name that combines the library name and class name. More...
 
virtual NodeasNode ()
 Convert 'this' into a Node pointer if Object is a Node, otherwise return 0. More...
 
virtual const NodeasNode () const
 convert 'const this' into a const Node pointer if Object is a Node, otherwise return 0. More...
 
virtual NodeVisitorasNodeVisitor ()
 Convert 'this' into a NodeVisitor pointer if Object is a NodeVisitor, otherwise return 0. More...
 
virtual const NodeVisitorasNodeVisitor () const
 convert 'const this' into a const NodeVisitor pointer if Object is a NodeVisitor, otherwise return 0. More...
 
virtual StateAttributeasStateAttribute ()
 Convert 'this' into a StateAttribute pointer if Object is a StateAttribute, otherwise return 0. More...
 
virtual const StateAttributeasStateAttribute () const
 convert 'const this' into a const StateAttribute pointer if Object is a StateAttribute, otherwise return 0. More...
 
virtual UniformasUniform ()
 Convert 'this' into a Uniform pointer if Object is a Uniform, otherwise return 0. More...
 
virtual const UniformasUniform () const
 convert 'const this' into a const Uniform pointer if Object is a Uniform, 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::UserDataContainergetUserDataContainer ()
 get the UserDataContainer attached to this object. More...
 
const osg::UserDataContainergetUserDataContainer () const
 get the const UserDataContainer attached to this object. More...
 
osg::UserDataContainergetOrCreateUserDataContainer ()
 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 ReferencedgetUserData ()
 Get user data. More...
 
virtual const ReferencedgetUserData () 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...
 
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)
 
 Referenced (const Referenced &)
 
Referencedoperator= (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...
 
ObserverSetgetObserverSet () const
 Get the ObserverSet if one is attached, otherwise return NULL. More...
 
ObserverSetgetOrCreateObserverSet () 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 ~Array ()
 
- Protected Member Functions inherited from osg::BufferData
virtual ~BufferData ()
 
- 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

Type _arrayType
 
GLint _dataSize
 
GLenum _dataType
 
Binding _binding
 
bool _normalize
 
bool _preserveDataType
 
- Protected Attributes inherited from osg::BufferData
unsigned int _modifiedCount
 
unsigned int _bufferIndex
 
osg::ref_ptr< BufferObject_bufferObject
 
osg::ref_ptr< ModifiedCallback_modifiedCallback
 
unsigned int _numClients
 
- 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

- 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 setThreadSafeReferenceCounting (bool enableThreadSafeReferenceCounting)
 Set whether reference counting should use a mutex for thread safe reference counting. More...
 
static bool getThreadSafeReferenceCounting ()
 Get whether reference counting is active. More...
 
static void setDeleteHandler (DeleteHandler *handler)
 Set a DeleteHandler to which deletion of all referenced counted objects will be delegated. More...
 
static DeleteHandlergetDeleteHandler ()
 Get a DeleteHandler. More...
 

Member Enumeration Documentation

Enumerator
BIND_UNDEFINED 
BIND_OFF 
BIND_OVERALL 
BIND_PER_PRIMITIVE_SET 
BIND_PER_VERTEX 
Enumerator
ArrayType 
ByteArrayType 
ShortArrayType 
IntArrayType 
UByteArrayType 
UShortArrayType 
UIntArrayType 
FloatArrayType 
DoubleArrayType 
Vec2bArrayType 
Vec3bArrayType 
Vec4bArrayType 
Vec2sArrayType 
Vec3sArrayType 
Vec4sArrayType 
Vec2iArrayType 
Vec3iArrayType 
Vec4iArrayType 
Vec2ubArrayType 
Vec3ubArrayType 
Vec4ubArrayType 
Vec2usArrayType 
Vec3usArrayType 
Vec4usArrayType 
Vec2uiArrayType 
Vec3uiArrayType 
Vec4uiArrayType 
Vec2ArrayType 
Vec3ArrayType 
Vec4ArrayType 
Vec2dArrayType 
Vec3dArrayType 
Vec4dArrayType 
MatrixArrayType 
MatrixdArrayType 

Constructor & Destructor Documentation

osg::Array::Array ( Type  arrayType = ArrayType,
GLint  dataSize = 0,
GLenum  dataType = 0,
Binding  binding = BIND_UNDEFINED 
)
inline
osg::Array::Array ( const Array array,
const CopyOp copyop = CopyOp::SHALLOW_COPY 
)
inline
virtual osg::Array::~Array ( )
inlineprotectedvirtual

Member Function Documentation

virtual void osg::Array::accept ( ArrayVisitor )
pure virtual
virtual void osg::Array::accept ( ConstArrayVisitor ) const
pure virtual
virtual void osg::Array::accept ( unsigned int  index,
ValueVisitor  
)
pure virtual
virtual void osg::Array::accept ( unsigned int  index,
ConstValueVisitor  
) const
pure virtual
virtual osg::Array* osg::Array::asArray ( )
inlinevirtual

Reimplemented from osg::BufferData.

virtual const osg::Array* osg::Array::asArray ( ) const
inlinevirtual

Reimplemented from osg::BufferData.

virtual const char* osg::Array::className ( ) const
virtual

return the name of the object's class type.

Must be defined by derived classes.

Reimplemented from osg::BufferData.

virtual int osg::Array::compare ( unsigned int  lhs,
unsigned int  rhs 
) const
pure virtual

Return -1 if lhs element is less than rhs element, 0 if equal, 1 if lhs element is greater than rhs element.

Implemented in osg::TemplateIndexArray< T, ARRAYTYPE, DataSize, DataType >, and osg::TemplateArray< T, ARRAYTYPE, DataSize, DataType >.

Binding osg::Array::getBinding ( ) const
inline

Get how this array should be passed to OpenGL.

virtual const GLvoid* osg::Array::getDataPointer ( ) const
pure virtual
GLint osg::Array::getDataSize ( ) const
inline
GLenum osg::Array::getDataType ( ) const
inline
virtual unsigned int osg::Array::getElementSize ( ) const
pure virtual
bool osg::Array::getNormalize ( ) const
inline

Get whether the array data should be normalized by OpenGL.

virtual unsigned int osg::Array::getNumElements ( ) const
pure virtual
bool osg::Array::getPreserveDataType ( ) const
inline

Get hint to ask that the array data is passed via integer or double, or normal setVertexAttribPointer function.

virtual unsigned int osg::Array::getTotalDataSize ( ) const
pure virtual
Type osg::Array::getType ( ) const
inline
osg::VertexBufferObject* osg::Array::getVertexBufferObject ( )
inline

Get the VertexBufferObject.

If no VBO is assigned returns NULL

const osg::VertexBufferObject* osg::Array::getVertexBufferObject ( ) const
inline

Get the const VertexBufferObject.

If no VBO is assigned returns NULL

virtual bool osg::Array::isSameKindAs ( const Object obj) const
inlinevirtual

Reimplemented from osg::BufferData.

Reimplemented in osg::IndexArray.

virtual const char* osg::Array::libraryName ( ) const
inlinevirtual

return the name of the object's library.

Must be defined by derived classes. The OpenSceneGraph convention is that the namespace of a library is the same as the library name.

Reimplemented from osg::BufferData.

virtual void osg::Array::reserveArray ( unsigned int  num)
pure virtual
virtual void osg::Array::resizeArray ( unsigned int  num)
pure virtual
void osg::Array::setBinding ( Binding  binding)
inline

Specify how this array should be passed to OpenGL.

void osg::Array::setNormalize ( bool  normalize)
inline

Specify whether the array data should be normalized by OpenGL.

void osg::Array::setPreserveDataType ( bool  preserve)
inline

Set hint to ask that the array data is passed via integer or double, or normal setVertexAttribPointer function.

void osg::Array::setVertexBufferObject ( osg::VertexBufferObject vbo)
inline
virtual void osg::Array::trim ( )
inlinevirtual

Frees unused space on this vector - i.e.

the difference between size() and max_size() of the underlying vector.

Reimplemented in osg::TemplateIndexArray< T, ARRAYTYPE, DataSize, DataType >, and osg::TemplateArray< T, ARRAYTYPE, DataSize, DataType >.

Member Data Documentation

Type osg::Array::_arrayType
protected
Binding osg::Array::_binding
protected
GLint osg::Array::_dataSize
protected
GLenum osg::Array::_dataType
protected
bool osg::Array::_normalize
protected
bool osg::Array::_preserveDataType
protected

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

osg logo
Generated at Wed Nov 11 2015 22:14:27 for the OpenSceneGraph by doxygen 1.8.10.