openscenegraph
Public Types | Public Member Functions | Protected Member Functions | Protected Attributes | List of all members
osg::Array Class Referenceabstract

#include <Array>

Inheritance diagram for osg::Array:
osg::BufferData osg::Object osg::Referenced osg::IndexArray osg::TemplateArray< T, ARRAYTYPE, DataSize, DataType > osg::TemplateIndexArray< T, ARRAYTYPE, DataSize, DataType >

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 , 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 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
 
virtual const char * className () const
 
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
 
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 const GLvoid * getDataPointer (unsigned int index) 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)
 
Binding getBinding () const
 
void setNormalize (bool normalize)
 
bool getNormalize () const
 
void setPreserveDataType (bool preserve)
 
bool getPreserveDataType () const
 
virtual void trim ()
 
void setVertexBufferObject (osg::VertexBufferObject *vbo)
 
osg::VertexBufferObjectgetVertexBufferObject ()
 
const osg::VertexBufferObjectgetVertexBufferObject () const
 
- Public Member Functions inherited from osg::BufferData
 BufferData ()
 
 BufferData (const BufferData &bd, const CopyOp &copyop=CopyOp::SHALLOW_COPY)
 
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 ()
 
void setModifiedCount (unsigned int value)
 
unsigned int getModifiedCount () const
 
virtual void resizeGLObjectBuffers (unsigned int maxSize)
 
void releaseGLObjects (State *state=0) const
 
unsigned int getNumClients () const
 
void addClient (osg::Object *)
 
void removeClient (osg::Object *)
 
- Public Member Functions inherited from osg::Object
 Object ()
 
 Object (bool threadSafeRefUnref)
 
 Object (const Object &, const CopyOp &copyop=CopyOp::SHALLOW_COPY)
 
virtual ObjectcloneType () const =0
 
virtual Objectclone (const CopyOp &) const =0
 
std::string getCompoundClassName () const
 
virtual NodeasNode ()
 
virtual const NodeasNode () const
 
virtual NodeVisitorasNodeVisitor ()
 
virtual const NodeVisitorasNodeVisitor () const
 
virtual StateSetasStateSet ()
 
virtual const StateSetasStateSet () const
 
virtual StateAttributeasStateAttribute ()
 
virtual const StateAttributeasStateAttribute () const
 
virtual UniformasUniform ()
 
virtual const UniformasUniform () const
 
virtual CameraasCamera ()
 
virtual const CameraasCamera () const
 
virtual DrawableasDrawable ()
 
virtual const DrawableasDrawable () const
 
virtual CallbackasCallback ()
 
virtual const CallbackasCallback () const
 
virtual CallbackObjectasCallbackObject ()
 
virtual const CallbackObjectasCallbackObject () const
 
virtual UserDataContainerasUserDataContainer ()
 
virtual const UserDataContainerasUserDataContainer () const
 
virtual ValueObjectasValueObject ()
 
virtual const ValueObjectasValueObject () const
 
virtual void setThreadSafeRefUnref (bool threadSafe)
 
virtual void setName (const std::string &name)
 
void setName (const char *name)
 
const std::string & getName () const
 
void setDataVariance (DataVariance dv)
 
DataVariance getDataVariance () const
 
virtual void computeDataVariance ()
 
void setUserDataContainer (osg::UserDataContainer *udc)
 
template<class T >
void setUserDataContainer (const ref_ptr< T > &udc)
 
osg::UserDataContainergetUserDataContainer ()
 
const osg::UserDataContainergetUserDataContainer () const
 
osg::UserDataContainergetOrCreateUserDataContainer ()
 
virtual void setUserData (Referenced *obj)
 
template<class T >
void setUserData (const ref_ptr< T > &ud)
 
virtual ReferencedgetUserData ()
 
virtual const ReferencedgetUserData () const
 
template<typename T >
bool getUserValue (const std::string &name, T &value) const
 
template<typename T >
void setUserValue (const std::string &name, const T &value)
 
template<typename T >
BoolValueObject UCharValueObject UShortValueObject UIntValueObject DoubleValueObject Vec3fValueObject Vec2dValueObject Vec4dValueObject PlaneValueObject MatrixdValueObject BoundingBoxdValueObject BoundingSpheredValueObject bool getUserValue (const std::string &name, T &value) const
 
- Public Member Functions inherited from osg::Referenced
 Referenced ()
 
 Referenced (bool threadSafeRefUnref)
 
 Referenced (const Referenced &)
 
Referencedoperator= (const Referenced &)
 
bool getThreadSafeRefUnref () const
 
OpenThreads::MutexgetRefMutex () const
 
int ref () const
 
int unref () const
 
int unref_nodelete () const
 
int referenceCount () const
 
ObserverSetgetObserverSet () const
 
ObserverSetgetOrCreateObserverSet () const
 
void addObserver (Observer *observer) const
 
void removeObserver (Observer *observer) const
 

Protected Member Functions

virtual ~Array ()
 
- Protected Member Functions inherited from osg::BufferData
virtual ~BufferData ()
 
- Protected Member Functions inherited from osg::Object
virtual ~Object ()
 
- 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::MutexgetGlobalReferencedMutex ()
 
static void setDeleteHandler (DeleteHandler *handler)
 
static DeleteHandlergetDeleteHandler ()
 

Member Enumeration Documentation

◆ Binding

The scope of applicability of the values in this array.

Enumerator
BIND_UNDEFINED 
BIND_OFF 
BIND_OVERALL 
BIND_PER_PRIMITIVE_SET 
BIND_PER_VERTEX 

◆ Type

The type of data stored in this array.

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 
QuatArrayType 
UInt64ArrayType 
Int64ArrayType 
LastArrayType 

Constructor & Destructor Documentation

◆ Array() [1/2]

osg::Array::Array ( Type  arrayType = ArrayType,
GLint  dataSize = 0,
GLenum  dataType = 0,
Binding  binding = BIND_UNDEFINED 
)
inline

◆ Array() [2/2]

osg::Array::Array ( const Array array,
const CopyOp copyop = CopyOp::SHALLOW_COPY 
)
inline

◆ ~Array()

virtual osg::Array::~Array ( )
inlineprotectedvirtual

Member Function Documentation

◆ accept() [1/4]

virtual void osg::Array::accept ( ArrayVisitor )
pure virtual

◆ accept() [2/4]

virtual void osg::Array::accept ( ConstArrayVisitor ) const
pure virtual

◆ accept() [3/4]

virtual void osg::Array::accept ( unsigned int  index,
ConstValueVisitor  
) const
pure virtual

◆ accept() [4/4]

virtual void osg::Array::accept ( unsigned int  index,
ValueVisitor  
)
pure virtual

◆ asArray() [1/2]

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

Reimplemented from osg::BufferData.

◆ asArray() [2/2]

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

Reimplemented from osg::BufferData.

◆ className()

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

Get the class name of this array. Defined in src/osg/Array.cpp for all concrete array types listed below — doesn't use traits.

Reimplemented from osg::BufferData.

◆ compare()

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::TemplateArray< T, ARRAYTYPE, DataSize, DataType >, and osg::TemplateIndexArray< T, ARRAYTYPE, DataSize, DataType >.

◆ getBinding()

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

Get how this array should be passed to OpenGL.

◆ getDataPointer() [1/2]

virtual const GLvoid * osg::Array::getDataPointer ( ) const
pure virtual

◆ getDataPointer() [2/2]

virtual const GLvoid * osg::Array::getDataPointer ( unsigned int  index) const
pure virtual

◆ getDataSize()

GLint osg::Array::getDataSize ( ) const
inline

◆ getDataType()

GLenum osg::Array::getDataType ( ) const
inline

◆ getElementSize()

virtual unsigned int osg::Array::getElementSize ( ) const
pure virtual

◆ getNormalize()

bool osg::Array::getNormalize ( ) const
inline

Get whether the array data should be normalized by OpenGL.

◆ getNumElements()

virtual unsigned int osg::Array::getNumElements ( ) const
pure virtual

◆ getPreserveDataType()

bool osg::Array::getPreserveDataType ( ) const
inline

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

◆ getTotalDataSize()

virtual unsigned int osg::Array::getTotalDataSize ( ) const
pure virtual

◆ getType()

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

◆ getVertexBufferObject() [1/2]

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

Get the VertexBufferObject. If no VBO is assigned returns NULL

◆ getVertexBufferObject() [2/2]

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

Get the const VertexBufferObject. If no VBO is assigned returns NULL

◆ isSameKindAs()

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

Reimplemented from osg::BufferData.

Reimplemented in osg::IndexArray.

◆ libraryName()

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.

◆ reserveArray()

virtual void osg::Array::reserveArray ( unsigned int  num)
pure virtual

◆ resizeArray()

virtual void osg::Array::resizeArray ( unsigned int  num)
pure virtual

◆ setBinding()

void osg::Array::setBinding ( Binding  binding)
inline

Specify how this array should be passed to OpenGL.

◆ setNormalize()

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

Specify whether the array data should be normalized by OpenGL.

◆ setPreserveDataType()

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.

◆ setVertexBufferObject()

void osg::Array::setVertexBufferObject ( osg::VertexBufferObject vbo)
inline

◆ trim()

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::TemplateArray< T, ARRAYTYPE, DataSize, DataType >, and osg::TemplateIndexArray< T, ARRAYTYPE, DataSize, DataType >.

Member Data Documentation

◆ _arrayType

Type osg::Array::_arrayType
protected

◆ _binding

Binding osg::Array::_binding
protected

◆ _dataSize

GLint osg::Array::_dataSize
protected

◆ _dataType

GLenum osg::Array::_dataType
protected

◆ _normalize

bool osg::Array::_normalize
protected

◆ _preserveDataType

bool osg::Array::_preserveDataType
protected

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