OSG  3.4.0
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Pages
Public Types | Public Member Functions | Protected Member Functions | Protected Attributes | List of all members
osg::Array Class Referenceabstract

#include <Array.h>

Inheritance diagram for osg::Array:
Inheritance graph
[legend]
Collaboration diagram for osg::Array:
Collaboration 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
 
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::Array * asArray ()
 
virtual const osg::Array * asArray () 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)
 
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::VertexBufferObject * getVertexBufferObject ()
 
const osg::VertexBufferObject * getVertexBufferObject () const
 
- Public Member Functions inherited from osg::BufferData
 BufferData ()
 
 BufferData (const BufferData &bd, const CopyOp &copyop=CopyOp::SHALLOW_COPY)
 
virtual osg::PrimitiveSet * asPrimitiveSet ()
 
virtual const osg::PrimitiveSet * asPrimitiveSet () const
 
virtual osg::Image * asImage ()
 
virtual const osg::Image * asImage () const
 
void setBufferObject (BufferObject *bufferObject)
 
BufferObject * getBufferObject ()
 
const BufferObject * getBufferObject () const
 
void setBufferIndex (unsigned int index)
 
unsigned int getBufferIndex () const
 
GLBufferObject * getGLBufferObject (unsigned int contextID) const
 
GLBufferObject * getOrCreateGLBufferObject (unsigned int contextID) const
 
void setModifiedCallback (ModifiedCallback *md)
 
ModifiedCallback * getModifiedCallback ()
 
const ModifiedCallback * getModifiedCallback () 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 Object * cloneType () const =0
 
virtual Object * clone (const CopyOp &) const =0
 
std::string getCompoundClassName () const
 
virtual Node * asNode ()
 
virtual const Node * asNode () const
 
virtual NodeVisitor * asNodeVisitor ()
 
virtual const NodeVisitor * asNodeVisitor () const
 
virtual StateAttribute * asStateAttribute ()
 
virtual const StateAttribute * asStateAttribute () const
 
virtual Uniform * asUniform ()
 
virtual const Uniform * asUniform () 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)
 
osg::UserDataContainer * getUserDataContainer ()
 
const osg::UserDataContainer * getUserDataContainer () const
 
osg::UserDataContainer * getOrCreateUserDataContainer ()
 
virtual void setUserData (Referenced *obj)
 
virtual Referenced * getUserData ()
 
virtual const Referenced * getUserData () 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 &)
 
Referenced & operator= (const Referenced &)
 
bool getThreadSafeRefUnref () const
 
OpenThreads::Mutex * getRefMutex () const
 
int ref () const
 
int unref () const
 
int unref_nodelete () const
 
int referenceCount () const
 
ObserverSet * getObserverSet () const
 
ObserverSet * getOrCreateObserverSet () 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::Mutex * getGlobalReferencedMutex ()
 
static void setThreadSafeReferenceCounting (bool enableThreadSafeReferenceCounting)
 
static bool getThreadSafeReferenceCounting ()
 
static void setDeleteHandler (DeleteHandler *handler)
 
static DeleteHandler * getDeleteHandler ()
 

Detailed Description

Definition at line 59 of file Array.h.

Member Enumeration Documentation

enum osg::Array::Binding
Enumerator
BIND_UNDEFINED 
BIND_OFF 
BIND_OVERALL 
BIND_PER_PRIMITIVE_SET 
BIND_PER_VERTEX 

Definition at line 115 of file Array.h.

enum osg::Array::Type
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 

Definition at line 64 of file Array.h.

Constructor & Destructor Documentation

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

Definition at line 124 of file Array.h.

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

Definition at line 132 of file Array.h.

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

Definition at line 205 of file Array.h.

Member Function Documentation

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

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

Here is the caller graph for this function:

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

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

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

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

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

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

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

Reimplemented from osg::BufferData.

Definition at line 159 of file Array.h.

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

Reimplemented from osg::BufferData.

Definition at line 160 of file Array.h.

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.

Definition at line 174 of file Array.h.

Here is the caller graph for this function:

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

Implements osg::BufferData.

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

Here is the caller graph for this function:

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

Definition at line 156 of file Array.h.

Here is the caller graph for this function:

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

Definition at line 157 of file Array.h.

Here is the caller graph for this function:

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

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

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

Get whether the array data should be normalized by OpenGL.

Definition at line 181 of file Array.h.

Here is the caller graph for this function:

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

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

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

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

Definition at line 188 of file Array.h.

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

Implements osg::BufferData.

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

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

Definition at line 155 of file Array.h.

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

Get the VertexBufferObject. If no VBO is assigned returns NULL

Definition at line 198 of file Array.h.

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

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

Definition at line 201 of file Array.h.

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

Reimplemented from osg::BufferData.

Reimplemented in osg::IndexArray.

Definition at line 141 of file Array.h.

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.

Definition at line 142 of file Array.h.

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

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

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

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

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

Specify how this array should be passed to OpenGL.

Definition at line 171 of file Array.h.

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

Specify whether the array data should be normalized by OpenGL.

Definition at line 178 of file Array.h.

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.

Definition at line 185 of file Array.h.

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

Set the VertexBufferObject.

Definition at line 195 of file Array.h.

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

Definition at line 192 of file Array.h.

Member Data Documentation

Type osg::Array::_arrayType
protected

Definition at line 207 of file Array.h.

Binding osg::Array::_binding
protected

Definition at line 210 of file Array.h.

GLint osg::Array::_dataSize
protected

Definition at line 208 of file Array.h.

GLenum osg::Array::_dataType
protected

Definition at line 209 of file Array.h.

bool osg::Array::_normalize
protected

Definition at line 211 of file Array.h.

bool osg::Array::_preserveDataType
protected

Definition at line 212 of file Array.h.

The documentation for this class was generated from the following file:
Generated on Tue Oct 4 2016 19:20:49 for OSG by   doxygen 1.8.8