OpenSceneGraph 3.6.5
osg::TemplateArray< T, ARRAYTYPE, DataSize, DataType > Class Template Reference

A concrete array holding elements of type T. More...

#include <Array>

Inheritance diagram for osg::TemplateArray< T, ARRAYTYPE, DataSize, DataType >:

Public Types

typedef T ElementDataType
Public Types inherited from osg::Array
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 , QuatArrayType = 35 ,
  UInt64ArrayType = 36 , Int64ArrayType = 37 , LastArrayType = 37
}
 The type of data stored in this array. More...
enum  Binding {
  BIND_UNDEFINED =-1 , BIND_OFF =0 , BIND_OVERALL =1 , BIND_PER_PRIMITIVE_SET =2 ,
  BIND_PER_VERTEX =4
}
 The scope of applicability of the values in this array. More...
Public Types inherited from osg::Object
enum  DataVariance { DYNAMIC , STATIC , UNSPECIFIED }
Public Types inherited from osg::MixinVector< T >
typedef vector_type::allocator_type allocator_type
typedef vector_type::value_type value_type
typedef vector_type::const_pointer const_pointer
typedef vector_type::pointer pointer
typedef vector_type::const_reference const_reference
typedef vector_type::reference reference
typedef vector_type::const_iterator const_iterator
typedef vector_type::iterator iterator
typedef vector_type::const_reverse_iterator const_reverse_iterator
typedef vector_type::reverse_iterator reverse_iterator
typedef vector_type::size_type size_type
typedef vector_type::difference_type difference_type

Public Member Functions

 TemplateArray (Binding binding=BIND_UNDEFINED)
 TemplateArray (const TemplateArray &ta, const CopyOp &copyop=CopyOp::SHALLOW_COPY)
 TemplateArray (unsigned int no)
 TemplateArray (unsigned int no, const T *ptr)
 TemplateArray (Binding binding, unsigned int no)
 TemplateArray (Binding binding, unsigned int no, const T *ptr)
template<class InputIterator>
 TemplateArray (InputIterator first, InputIterator last)
TemplateArrayoperator= (const TemplateArray &array)
virtual ObjectcloneType () const
 Clone the type of an object, with Object* return type.
virtual Objectclone (const CopyOp &copyop) const
 Clone an object, with Object* return type.
virtual void accept (ArrayVisitor &av)
virtual void accept (ConstArrayVisitor &av) const
virtual void accept (unsigned int index, ValueVisitor &vv)
virtual void accept (unsigned int index, ConstValueVisitor &vv) const
virtual int compare (unsigned int lhs, unsigned int rhs) const
 Return -1 if lhs element is less than rhs element, 0 if equal, 1 if lhs element is greater than rhs element.
virtual void trim ()
 Frees unused space on this vector - i.e.
virtual unsigned int getElementSize () const
virtual const GLvoid * getDataPointer () const
virtual const GLvoid * getDataPointer (unsigned int index) const
virtual unsigned int getTotalDataSize () const
virtual unsigned int getNumElements () const
virtual void reserveArray (unsigned int num)
virtual void resizeArray (unsigned int num)
Public Member Functions inherited from osg::Array
 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.
virtual const char * className () const
 Get the class name of this array.
Type getType () const
GLint getDataSize () const
GLenum getDataType () const
virtual osg::ArrayasArray ()
virtual const osg::ArrayasArray () const
void setBinding (Binding binding)
 Specify how this array should be passed to OpenGL.
Binding getBinding () const
 Get how this array should be passed to OpenGL.
void setNormalize (bool normalize)
 Specify whether the array data should be normalized by OpenGL.
bool getNormalize () const
 Get whether the array data should be normalized by OpenGL.
void setPreserveDataType (bool preserve)
 Set hint to ask that the array data is passed via integer or double, or normal setVertexAttribPointer function.
bool getPreserveDataType () const
 Get hint to ask that the array data is passed via integer or double, or normal setVertexAttribPointer function.
void setVertexBufferObject (osg::VertexBufferObject *vbo)
 Set the VertexBufferObject.
osg::VertexBufferObjectgetVertexBufferObject ()
 Get the VertexBufferObject.
const osg::VertexBufferObjectgetVertexBufferObject () const
 Get the const VertexBufferObject.
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.
virtual osg::PrimitiveSetasPrimitiveSet ()
virtual const osg::PrimitiveSetasPrimitiveSet () const
virtual osg::ImageasImage ()
 Convert 'this' into a Image pointer if Object is a Image, otherwise return 0.
virtual const osg::ImageasImage () const
 Convert 'this' into a Image pointer if Object is a Image, otherwise return 0.
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.
void setModifiedCount (unsigned int value)
 Set the modified count value.
unsigned int getModifiedCount () const
 Get modified count value.
virtual void resizeGLObjectBuffers (unsigned int maxSize)
 Resize any per context GLObject buffers to specified size.
void releaseGLObjects (State *state=0) const
 If State is non-zero, this function releases OpenGL objects for the specified graphics context.
unsigned int getNumClients () const
void addClient (osg::Object *)
void removeClient (osg::Object *)
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.
std::string getCompoundClassName () const
 return the compound class name that combines the library name and class name.
virtual NodeasNode ()
 Convert 'this' into a Node pointer if Object is a Node, otherwise return 0.
virtual const NodeasNode () const
 convert 'const this' into a const Node pointer if Object is a Node, otherwise return 0.
virtual NodeVisitorasNodeVisitor ()
 Convert 'this' into a NodeVisitor pointer if Object is a NodeVisitor, otherwise return 0.
virtual const NodeVisitorasNodeVisitor () const
 convert 'const this' into a const NodeVisitor pointer if Object is a NodeVisitor, otherwise return 0.
virtual StateSetasStateSet ()
 Convert 'this' into a StateSet pointer if Object is a StateSet, otherwise return 0.
virtual const StateSetasStateSet () const
 convert 'const this' into a const StateSet pointer if Object is a StateSet, otherwise return 0.
virtual StateAttributeasStateAttribute ()
 Convert 'this' into a StateAttribute pointer if Object is a StateAttribute, otherwise return 0.
virtual const StateAttributeasStateAttribute () const
 convert 'const this' into a const StateAttribute pointer if Object is a StateAttribute, otherwise return 0.
virtual UniformasUniform ()
 Convert 'this' into a Uniform pointer if Object is a Uniform, otherwise return 0.
virtual const UniformasUniform () const
 convert 'const this' into a const Uniform pointer if Object is a Uniform, otherwise return 0.
virtual CameraasCamera ()
 Convert 'this' into a Camera pointer if Node is a Camera, otherwise return 0.
virtual const CameraasCamera () const
 convert 'const this' into a const Camera pointer if Node is a Camera, otherwise return 0.
virtual DrawableasDrawable ()
 Convert 'this' into a Drawable pointer if Object is a Drawable, otherwise return 0.
virtual const DrawableasDrawable () const
 convert 'const this' into a const Drawable pointer if Object is a Drawable, otherwise return 0.
virtual CallbackasCallback ()
 Convert 'this' into a Callback pointer if Object is a Callback, otherwise return 0.
virtual const CallbackasCallback () const
 convert 'const this' into a const Callback pointer if Object is a Callback, otherwise return 0.
virtual CallbackObjectasCallbackObject ()
 Convert 'this' into a CallbackObject pointer if Object is a CallbackObject, otherwise return 0.
virtual const CallbackObjectasCallbackObject () const
 convert 'const this' into a const CallbackObject pointer if Object is a CallbackObject, otherwise return 0.
virtual UserDataContainerasUserDataContainer ()
 Convert 'this' into a UserDataContainer pointer if Object is a UserDataContainer, otherwise return 0.
virtual const UserDataContainerasUserDataContainer () const
 convert 'const this' into a const UserDataContainer pointer if Object is a UserDataContainer, otherwise return 0.
virtual ValueObjectasValueObject ()
 Convert 'this' into a ValueObject pointer if Object is a ValueObject, otherwise return 0.
virtual const ValueObjectasValueObject () const
 Convert 'this' into a ValueObject pointer if Object is a ValueObject, otherwise return 0.
virtual void setThreadSafeRefUnref (bool threadSafe)
 Set whether to use a mutex to ensure ref() and unref() are thread safe.
virtual void setName (const std::string &name)
 Set the name of object using C++ style string.
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.
template<class T>
void setUserDataContainer (const ref_ptr< T > &udc)
osg::UserDataContainergetUserDataContainer ()
 get the UserDataContainer attached to this object.
const osg::UserDataContainergetUserDataContainer () const
 get the const UserDataContainer attached to this object.
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.
virtual void setUserData (Referenced *obj)
 Set user data, data must be subclassed from Referenced to allow automatic memory handling.
template<class T>
void setUserData (const ref_ptr< T > &ud)
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
 Convenience 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)
 Convenience method that creates the osg::TemplateValueObject<T> to store the specified value and adds it as a named UserObject.
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
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.
 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 no longer referencing it.
int unref_nodelete () const
 Decrement the reference count by one, indicating that a pointer to this object is no longer 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.
Public Member Functions inherited from osg::MixinVector< T >
 MixinVector ()
MixinVectoroperator= (const vector_type &other)
virtual ~MixinVector ()
void clear ()
void resize (size_type new_size, const value_type &fill_value=value_type())
void reserve (size_type new_capacity)
void swap (vector_type &other)
bool empty () const
size_type size () const
size_type capacity () const
size_type max_size () const
allocator_type get_allocator () const
const_iterator begin () const
const_iterator end () const
const_reverse_iterator rbegin () const
const_reverse_iterator rend () const
const_reference operator[] (size_type index) const
const_reference at (size_type index) const
void assign (size_type count, const value_type &value)
void push_back (const value_type &value)
void pop_back ()
iterator erase (iterator where)
iterator insert (iterator where, const value_type &value)
const_reference back () const
const_reference front () const
vector_type & asVector ()

Protected Member Functions

virtual ~TemplateArray ()
Protected Member Functions inherited from osg::Array
virtual ~Array ()
Protected Member Functions inherited from osg::BufferData
virtual ~BufferData ()
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

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.
static void setDeleteHandler (DeleteHandler *handler)
 Set a DeleteHandler to which deletion of all referenced counted objects will be delegated.
static DeleteHandlergetDeleteHandler ()
 Get a DeleteHandler.
Protected Attributes inherited from osg::Array
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

Detailed Description

template<typename T, Array::Type ARRAYTYPE, int DataSize, int DataType>
class osg::TemplateArray< T, ARRAYTYPE, DataSize, DataType >

A concrete array holding elements of type T.

Member Typedef Documentation

◆ ElementDataType

template<typename T, Array::Type ARRAYTYPE, int DataSize, int DataType>
typedef T osg::TemplateArray< T, ARRAYTYPE, DataSize, DataType >::ElementDataType

Constructor & Destructor Documentation

◆ TemplateArray() [1/7]

template<typename T, Array::Type ARRAYTYPE, int DataSize, int DataType>
osg::TemplateArray< T, ARRAYTYPE, DataSize, DataType >::TemplateArray ( Binding binding = BIND_UNDEFINED)
inline

◆ TemplateArray() [2/7]

template<typename T, Array::Type ARRAYTYPE, int DataSize, int DataType>
osg::TemplateArray< T, ARRAYTYPE, DataSize, DataType >::TemplateArray ( const TemplateArray< T, ARRAYTYPE, DataSize, DataType > & ta,
const CopyOp & copyop = CopyOp::SHALLOW_COPY )
inline

◆ TemplateArray() [3/7]

template<typename T, Array::Type ARRAYTYPE, int DataSize, int DataType>
osg::TemplateArray< T, ARRAYTYPE, DataSize, DataType >::TemplateArray ( unsigned int no)
inline

◆ TemplateArray() [4/7]

template<typename T, Array::Type ARRAYTYPE, int DataSize, int DataType>
osg::TemplateArray< T, ARRAYTYPE, DataSize, DataType >::TemplateArray ( unsigned int no,
const T * ptr )
inline

◆ TemplateArray() [5/7]

template<typename T, Array::Type ARRAYTYPE, int DataSize, int DataType>
osg::TemplateArray< T, ARRAYTYPE, DataSize, DataType >::TemplateArray ( Binding binding,
unsigned int no )
inline

◆ TemplateArray() [6/7]

template<typename T, Array::Type ARRAYTYPE, int DataSize, int DataType>
osg::TemplateArray< T, ARRAYTYPE, DataSize, DataType >::TemplateArray ( Binding binding,
unsigned int no,
const T * ptr )
inline

◆ TemplateArray() [7/7]

template<typename T, Array::Type ARRAYTYPE, int DataSize, int DataType>
template<class InputIterator>
osg::TemplateArray< T, ARRAYTYPE, DataSize, DataType >::TemplateArray ( InputIterator first,
InputIterator last )
inline

◆ ~TemplateArray()

template<typename T, Array::Type ARRAYTYPE, int DataSize, int DataType>
virtual osg::TemplateArray< T, ARRAYTYPE, DataSize, DataType >::~TemplateArray ( )
inlineprotectedvirtual

Member Function Documentation

◆ accept() [1/4]

template<typename T, Array::Type ARRAYTYPE, int DataSize, int DataType>
void osg::TemplateArray< T, ARRAYTYPE, DataSize, DataType >::accept ( ArrayVisitor & av)
inlinevirtual

Implements osg::Array.

References osg::ArrayVisitor::apply().

◆ accept() [2/4]

template<typename T, Array::Type ARRAYTYPE, int DataSize, int DataType>
void osg::TemplateArray< T, ARRAYTYPE, DataSize, DataType >::accept ( ConstArrayVisitor & av) const
inlinevirtual

◆ accept() [3/4]

template<typename T, Array::Type ARRAYTYPE, int DataSize, int DataType>
void osg::TemplateArray< T, ARRAYTYPE, DataSize, DataType >::accept ( unsigned int index,
ConstValueVisitor & vv ) const
inlinevirtual

◆ accept() [4/4]

template<typename T, Array::Type ARRAYTYPE, int DataSize, int DataType>
void osg::TemplateArray< T, ARRAYTYPE, DataSize, DataType >::accept ( unsigned int index,
ValueVisitor & vv )
inlinevirtual

Implements osg::Array.

References osg::ValueVisitor::apply().

◆ clone()

template<typename T, Array::Type ARRAYTYPE, int DataSize, int DataType>
virtual Object * osg::TemplateArray< T, ARRAYTYPE, DataSize, DataType >::clone ( const CopyOp & ) const
inlinevirtual

Clone an object, with Object* return type.

Must be defined by derived classes.

Implements osg::Object.

◆ cloneType()

template<typename T, Array::Type ARRAYTYPE, int DataSize, int DataType>
virtual Object * osg::TemplateArray< T, ARRAYTYPE, DataSize, DataType >::cloneType ( ) const
inlinevirtual

Clone the type of an object, with Object* return type.

Must be defined by derived classes.

Implements osg::Object.

◆ compare()

template<typename T, Array::Type ARRAYTYPE, int DataSize, int DataType>
virtual int osg::TemplateArray< T, ARRAYTYPE, DataSize, DataType >::compare ( unsigned int lhs,
unsigned int rhs ) const
inlinevirtual

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

Implements osg::Array.

◆ getDataPointer() [1/2]

template<typename T, Array::Type ARRAYTYPE, int DataSize, int DataType>
virtual const GLvoid * osg::TemplateArray< T, ARRAYTYPE, DataSize, DataType >::getDataPointer ( ) const
inlinevirtual

Implements osg::Array.

◆ getDataPointer() [2/2]

template<typename T, Array::Type ARRAYTYPE, int DataSize, int DataType>
virtual const GLvoid * osg::TemplateArray< T, ARRAYTYPE, DataSize, DataType >::getDataPointer ( unsigned int index) const
inlinevirtual

Implements osg::Array.

◆ getElementSize()

template<typename T, Array::Type ARRAYTYPE, int DataSize, int DataType>
virtual unsigned int osg::TemplateArray< T, ARRAYTYPE, DataSize, DataType >::getElementSize ( ) const
inlinevirtual

Implements osg::Array.

◆ getNumElements()

template<typename T, Array::Type ARRAYTYPE, int DataSize, int DataType>
virtual unsigned int osg::TemplateArray< T, ARRAYTYPE, DataSize, DataType >::getNumElements ( ) const
inlinevirtual

Implements osg::Array.

◆ getTotalDataSize()

template<typename T, Array::Type ARRAYTYPE, int DataSize, int DataType>
virtual unsigned int osg::TemplateArray< T, ARRAYTYPE, DataSize, DataType >::getTotalDataSize ( ) const
inlinevirtual

Implements osg::Array.

◆ operator=()

template<typename T, Array::Type ARRAYTYPE, int DataSize, int DataType>
TemplateArray & osg::TemplateArray< T, ARRAYTYPE, DataSize, DataType >::operator= ( const TemplateArray< T, ARRAYTYPE, DataSize, DataType > & array)
inline

◆ reserveArray()

template<typename T, Array::Type ARRAYTYPE, int DataSize, int DataType>
virtual void osg::TemplateArray< T, ARRAYTYPE, DataSize, DataType >::reserveArray ( unsigned int num)
inlinevirtual

Implements osg::Array.

◆ resizeArray()

template<typename T, Array::Type ARRAYTYPE, int DataSize, int DataType>
virtual void osg::TemplateArray< T, ARRAYTYPE, DataSize, DataType >::resizeArray ( unsigned int num)
inlinevirtual

Implements osg::Array.

◆ trim()

template<typename T, Array::Type ARRAYTYPE, int DataSize, int DataType>
virtual void osg::TemplateArray< T, ARRAYTYPE, DataSize, DataType >::trim ( )
inlinevirtual

Frees unused space on this vector - i.e.

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

Reimplemented from osg::Array.


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

osg logo
Generated at Sun Jul 20 2025 00:00:00 for the OpenSceneGraph by doxygen 1.14.0.