osg::Geometry Class Reference

Inheritance diagram for osg::Geometry:

Inheritance graph
[legend]
List of all members.

Public Types

typedef std::vector< ArrayDataArrayList
typedef std::vector< ref_ptr<
PrimitiveSet > > 
PrimitiveSetList
enum  AttributeBinding {
  BIND_OFF = 0, BIND_OVERALL, BIND_PER_PRIMITIVE_SET, BIND_PER_PRIMITIVE,
  BIND_PER_VERTEX
}

Public Member Functions

 Geometry ()
 Geometry (const Geometry &geometry, const CopyOp &copyop=CopyOp::SHALLOW_COPY)
 Copy constructor using CopyOp to manage deep vs shallow copy.
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 bool isSameKindAs (const Object *obj) const
virtual const char * libraryName () const
 return the name of the object's library.
virtual const char * className () const
 return the name of the object's class type.
virtual GeometryasGeometry ()
 convert 'this' into a Geometry pointer if Drawable is a Geometry, otherwise return 0.
virtual const GeometryasGeometry () const
 convert 'const this' into a const Geometry pointer if Drawable is a Geometry, otherwise return 0.
bool empty () const
void setVertexArray (Array *array)
ArraygetVertexArray ()
const ArraygetVertexArray () const
void setVertexIndices (IndexArray *array)
IndexArraygetVertexIndices ()
const IndexArraygetVertexIndices () const
void setVertexData (const ArrayData &arrayData)
ArrayDatagetVertexData ()
const ArrayDatagetVertexData () const
void setNormalBinding (AttributeBinding ab)
AttributeBinding getNormalBinding () const
void setNormalArray (Vec3Array *array)
Vec3ArraygetNormalArray ()
const Vec3ArraygetNormalArray () const
void setNormalIndices (IndexArray *array)
IndexArraygetNormalIndices ()
const IndexArraygetNormalIndices () const
void setNormalData (const Vec3ArrayData &arrayData)
Vec3ArrayDatagetNormalData ()
const Vec3ArrayDatagetNormalData () const
void setColorBinding (AttributeBinding ab)
AttributeBinding getColorBinding () const
void setColorArray (Array *array)
ArraygetColorArray ()
const ArraygetColorArray () const
void setColorIndices (IndexArray *array)
IndexArraygetColorIndices ()
const IndexArraygetColorIndices () const
void setColorData (const ArrayData &arrayData)
ArrayDatagetColorData ()
const ArrayDatagetColorData () const
void setSecondaryColorBinding (AttributeBinding ab)
AttributeBinding getSecondaryColorBinding () const
void setSecondaryColorArray (Array *array)
ArraygetSecondaryColorArray ()
const ArraygetSecondaryColorArray () const
void setSecondaryColorIndices (IndexArray *array)
IndexArraygetSecondaryColorIndices ()
const IndexArraygetSecondaryColorIndices () const
void setSecondaryColorData (const ArrayData &arrayData)
ArrayDatagetSecondaryColorData ()
const ArrayDatagetSecondaryColorData () const
void setFogCoordBinding (AttributeBinding ab)
AttributeBinding getFogCoordBinding () const
void setFogCoordArray (Array *array)
ArraygetFogCoordArray ()
const ArraygetFogCoordArray () const
void setFogCoordIndices (IndexArray *array)
IndexArraygetFogCoordIndices ()
const IndexArraygetFogCoordIndices () const
void setFogCoordData (const ArrayData &arrayData)
ArrayDatagetFogCoordData ()
const ArrayDatagetFogCoordData () const
void setTexCoordArray (unsigned int unit, Array *)
ArraygetTexCoordArray (unsigned int unit)
const ArraygetTexCoordArray (unsigned int unit) const
void setTexCoordIndices (unsigned int unit, IndexArray *)
IndexArraygetTexCoordIndices (unsigned int unit)
const IndexArraygetTexCoordIndices (unsigned int unit) const
void setTexCoordData (unsigned int index, const ArrayData &arrayData)
ArrayDatagetTexCoordData (unsigned int index)
const ArrayDatagetTexCoordData (unsigned int index) const
unsigned int getNumTexCoordArrays () const
ArrayListgetTexCoordArrayList ()
const ArrayListgetTexCoordArrayList () const
void setVertexAttribArray (unsigned int index, Array *array)
ArraygetVertexAttribArray (unsigned int index)
const ArraygetVertexAttribArray (unsigned int index) const
void setVertexAttribIndices (unsigned int index, IndexArray *array)
IndexArraygetVertexAttribIndices (unsigned int index)
const IndexArraygetVertexAttribIndices (unsigned int index) const
void setVertexAttribBinding (unsigned int index, AttributeBinding ab)
AttributeBinding getVertexAttribBinding (unsigned int index) const
void setVertexAttribNormalize (unsigned int index, GLboolean norm)
GLboolean getVertexAttribNormalize (unsigned int index) const
void setVertexAttribData (unsigned int index, const ArrayData &arrayData)
ArrayDatagetVertexAttribData (unsigned int index)
const ArrayDatagetVertexAttribData (unsigned int index) const
unsigned int getNumVertexAttribArrays () const
ArrayListgetVertexAttribArrayList ()
const ArrayListgetVertexAttribArrayList () const
void setPrimitiveSetList (const PrimitiveSetList &primitives)
PrimitiveSetListgetPrimitiveSetList ()
const PrimitiveSetListgetPrimitiveSetList () const
unsigned int getNumPrimitiveSets () const
PrimitiveSetgetPrimitiveSet (unsigned int pos)
const PrimitiveSetgetPrimitiveSet (unsigned int pos) const
bool addPrimitiveSet (PrimitiveSet *primitiveset)
 Add a primitive set to the geometry.
bool setPrimitiveSet (unsigned int i, PrimitiveSet *primitiveset)
 Set a primitive set to the specified position in geometry's primitive set list.
bool insertPrimitiveSet (unsigned int i, PrimitiveSet *primitiveset)
 Insert a primitive set to the specified position in geometry's primitive set list.
bool removePrimitiveSet (unsigned int i, unsigned int numElementsToRemove=1)
 Remove primitive set(s) from the specified position in geometry's primitive set list.
unsigned int getPrimitiveSetIndex (const PrimitiveSet *primitiveset) const
 Get the index number of a primitive set, return a value between 0 and getNumPrimitiveSet()-1 if found, if not found then return getNumPrimitiveSet().
void setFastPathHint (bool on)
 Set whether fast paths should be used when supported.
bool getFastPathHint () const
 Get whether fast paths should be used when supported.
bool areFastPathsUsed () const
 Return true if OpenGL fast paths will be used with drawing this Geometry.
bool computeFastPathsUsed ()
bool verifyBindings () const
void computeCorrectBindingsAndArraySizes ()
bool suitableForOptimization () const
void copyToAndOptimize (Geometry &target)
void computeInternalOptimizedGeometry ()
void removeInternalOptimizedGeometry ()
void setInternalOptimizedGeometry (osg::Geometry *geometry)
osg::GeometrygetInternalOptimizedGeometry ()
const osg::GeometrygetInternalOptimizedGeometry () const
virtual unsigned int getGLObjectSizeHint () const
 Return the estimated size of GLObjects (display lists/vertex buffer objects) that are associated with this drawable.
virtual void drawImplementation (State &state) const
 Draw Geometry directly ignoring an OpenGL display list which could be attached.
virtual bool supports (AttributeFunctor &) const
 Return true, osg::Geometry does support accept(AttributeFunctor&).
virtual void accept (AttributeFunctor &af)
 Accept an AttributeFunctor and call its methods to tell it about the interal attributes that this Drawable has.
virtual bool supports (ConstAttributeFunctor &) const
 Return true, osg::Geometry does support accept(ConstAttributeFunctor&).
virtual void accept (ConstAttributeFunctor &af) const
 Accept a ConstAttributeFunctor and call its methods to tell it about the interal attributes that this Drawable has.
virtual bool supports (PrimitiveFunctor &) const
 Return true, osg::Geometry does support accept(PrimitiveFunctor&).
virtual void accept (PrimitiveFunctor &pf) const
 Accept a PrimitiveFunctor and call its methods to tell it about the interal primitives that this Drawable has.
virtual bool supports (PrimitiveIndexFunctor &) const
 Return true, osg::Geometry does support accept(PrimitiveIndexFunctor&).
virtual void accept (PrimitiveIndexFunctor &pf) const
 Accept a PrimitiveFunctor and call its methods to tell it about the interal primitives that this Drawable has.

Static Public Attributes

static const ArrayData s_InvalidArrayData
 Static ArrayData which is returned from getTexCoordData(i) const and getVertexAttribData(i) const when i is out of range.

Protected Member Functions

Geometryoperator= (const Geometry &)
virtual ~Geometry ()
bool verifyBindings (const ArrayData &arrayData) const
bool verifyBindings (const Vec3ArrayData &arrayData) const
void computeCorrectBindingsAndArraySizes (ArrayData &arrayData, const char *arrayName)
void computeCorrectBindingsAndArraySizes (Vec3ArrayData &arrayData, const char *arrayName)

Protected Attributes

PrimitiveSetList _primitives
ArrayData _vertexData
Vec3ArrayData _normalData
ArrayData _colorData
ArrayData _secondaryColorData
ArrayData _fogCoordData
ArrayList _texCoordList
ArrayList _vertexAttribList
bool _fastPath
bool _fastPathHint
ref_ptr< Geometry_internalOptimizedGeometry

Classes

struct  ArrayData
struct  Vec3ArrayData

Member Typedef Documentation

typedef std::vector< ArrayData > osg::Geometry::ArrayList
 

typedef std::vector< ref_ptr<PrimitiveSet> > osg::Geometry::PrimitiveSetList
 


Member Enumeration Documentation

enum osg::Geometry::AttributeBinding
 

Enumerator:
BIND_OFF 
BIND_OVERALL 
BIND_PER_PRIMITIVE_SET 
BIND_PER_PRIMITIVE 
BIND_PER_VERTEX 


Constructor & Destructor Documentation

Geometry::Geometry  ) 
 

Geometry::Geometry const Geometry geometry,
const CopyOp copyop = CopyOp::SHALLOW_COPY
 

Copy constructor using CopyOp to manage deep vs shallow copy.

Geometry::~Geometry  )  [protected, virtual]
 


Member Function Documentation

void Geometry::accept PrimitiveIndexFunctor &  pf  )  const [virtual]
 

Accept a PrimitiveFunctor and call its methods to tell it about the interal primitives that this Drawable has.

void Geometry::accept PrimitiveFunctor &  pf  )  const [virtual]
 

Accept a PrimitiveFunctor and call its methods to tell it about the interal primitives that this Drawable has.

void Geometry::accept ConstAttributeFunctor &  af  )  const [virtual]
 

Accept a ConstAttributeFunctor and call its methods to tell it about the interal attributes that this Drawable has.

void Geometry::accept AttributeFunctor &  af  )  [virtual]
 

Accept an AttributeFunctor and call its methods to tell it about the interal attributes that this Drawable has.

bool Geometry::addPrimitiveSet PrimitiveSet primitiveset  ) 
 

Add a primitive set to the geometry.

bool osg::Geometry::areFastPathsUsed  )  const [inline]
 

Return true if OpenGL fast paths will be used with drawing this Geometry.

Fast paths use vertex arrays, and glDrawArrays/glDrawElements. Slow paths use glBegin()/glVertex.../glEnd(). Use of per primitive bindings or per vertex indexed arrays will drop the rendering path off the fast path.

virtual const Geometry* osg::Geometry::asGeometry  )  const [inline, virtual]
 

convert 'const this' into a const Geometry pointer if Drawable is a Geometry, otherwise return 0.

Equivalent to dynamic_cast<const Geometry*>(this).

Reimplemented from osg::Drawable.

virtual Geometry* osg::Geometry::asGeometry  )  [inline, virtual]
 

convert 'this' into a Geometry pointer if Drawable is a Geometry, otherwise return 0.

Equivalent to dynamic_cast<Geometry*>(this).

Reimplemented from osg::Drawable.

virtual const char* osg::Geometry::className  )  const [inline, virtual]
 

return the name of the object's class type.

Must be defined by derived classes.

Reimplemented from osg::Drawable.

virtual Object* osg::Geometry::clone const CopyOp copyop  )  const [inline, virtual]
 

Clone an object, with Object* return type.

Must be defined by derived classes.

Implements osg::Object.

virtual Object* osg::Geometry::cloneType  )  const [inline, virtual]
 

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

Must be defined by derived classes.

Implements osg::Object.

void Geometry::computeCorrectBindingsAndArraySizes Vec3ArrayData arrayData,
const char *  arrayName
[protected]
 

void Geometry::computeCorrectBindingsAndArraySizes ArrayData arrayData,
const char *  arrayName
[protected]
 

void Geometry::computeCorrectBindingsAndArraySizes  ) 
 

bool Geometry::computeFastPathsUsed  ) 
 

void Geometry::computeInternalOptimizedGeometry  ) 
 

void Geometry::copyToAndOptimize Geometry target  ) 
 

void Geometry::drawImplementation State state  )  const [virtual]
 

Draw Geometry directly ignoring an OpenGL display list which could be attached.

This is the internal draw method which does the drawing itself, and is the method to override when deriving from Geometry for user-drawn objects.

Implements osg::Drawable.

bool Geometry::empty  )  const
 

const Array* osg::Geometry::getColorArray  )  const [inline]
 

Array* osg::Geometry::getColorArray  )  [inline]
 

AttributeBinding osg::Geometry::getColorBinding  )  const [inline]
 

const ArrayData& osg::Geometry::getColorData  )  const [inline]
 

ArrayData& osg::Geometry::getColorData  )  [inline]
 

const IndexArray* osg::Geometry::getColorIndices  )  const [inline]
 

IndexArray* osg::Geometry::getColorIndices  )  [inline]
 

bool osg::Geometry::getFastPathHint  )  const [inline]
 

Get whether fast paths should be used when supported.

const Array* osg::Geometry::getFogCoordArray  )  const [inline]
 

Array* osg::Geometry::getFogCoordArray  )  [inline]
 

AttributeBinding osg::Geometry::getFogCoordBinding  )  const [inline]
 

const ArrayData& osg::Geometry::getFogCoordData  )  const [inline]
 

ArrayData& osg::Geometry::getFogCoordData  )  [inline]
 

const IndexArray* osg::Geometry::getFogCoordIndices  )  const [inline]
 

IndexArray* osg::Geometry::getFogCoordIndices  )  [inline]
 

unsigned int Geometry::getGLObjectSizeHint  )  const [virtual]
 

Return the estimated size of GLObjects (display lists/vertex buffer objects) that are associated with this drawable.

This size is used a hint for reuse of deleteed display lists/vertex buffer objects.

Reimplemented from osg::Drawable.

const osg::Geometry* osg::Geometry::getInternalOptimizedGeometry  )  const [inline]
 

osg::Geometry* osg::Geometry::getInternalOptimizedGeometry  )  [inline]
 

const Vec3Array* osg::Geometry::getNormalArray  )  const [inline]
 

Vec3Array* osg::Geometry::getNormalArray  )  [inline]
 

AttributeBinding osg::Geometry::getNormalBinding  )  const [inline]
 

const Vec3ArrayData& osg::Geometry::getNormalData  )  const [inline]
 

Vec3ArrayData& osg::Geometry::getNormalData  )  [inline]
 

const IndexArray* osg::Geometry::getNormalIndices  )  const [inline]
 

IndexArray* osg::Geometry::getNormalIndices  )  [inline]
 

unsigned int osg::Geometry::getNumPrimitiveSets  )  const [inline]
 

unsigned int osg::Geometry::getNumTexCoordArrays  )  const [inline]
 

unsigned int osg::Geometry::getNumVertexAttribArrays  )  const [inline]
 

const PrimitiveSet* osg::Geometry::getPrimitiveSet unsigned int  pos  )  const [inline]
 

PrimitiveSet* osg::Geometry::getPrimitiveSet unsigned int  pos  )  [inline]
 

unsigned int Geometry::getPrimitiveSetIndex const PrimitiveSet primitiveset  )  const
 

Get the index number of a primitive set, return a value between 0 and getNumPrimitiveSet()-1 if found, if not found then return getNumPrimitiveSet().

When checking for a valid find value use if ((value=geometry->getPrimitiveSetIndex(primitive))!=geometry.getNumPrimitiveSet())

const PrimitiveSetList& osg::Geometry::getPrimitiveSetList  )  const [inline]
 

PrimitiveSetList& osg::Geometry::getPrimitiveSetList  )  [inline]
 

const Array* osg::Geometry::getSecondaryColorArray  )  const [inline]
 

Array* osg::Geometry::getSecondaryColorArray  )  [inline]
 

AttributeBinding osg::Geometry::getSecondaryColorBinding  )  const [inline]
 

const ArrayData& osg::Geometry::getSecondaryColorData  )  const [inline]
 

ArrayData& osg::Geometry::getSecondaryColorData  )  [inline]
 

const IndexArray* osg::Geometry::getSecondaryColorIndices  )  const [inline]
 

IndexArray* osg::Geometry::getSecondaryColorIndices  )  [inline]
 

const Array * Geometry::getTexCoordArray unsigned int  unit  )  const
 

Array * Geometry::getTexCoordArray unsigned int  unit  ) 
 

const ArrayList& osg::Geometry::getTexCoordArrayList  )  const [inline]
 

ArrayList& osg::Geometry::getTexCoordArrayList  )  [inline]
 

const Geometry::ArrayData & Geometry::getTexCoordData unsigned int  index  )  const
 

Geometry::ArrayData & Geometry::getTexCoordData unsigned int  index  ) 
 

const IndexArray * Geometry::getTexCoordIndices unsigned int  unit  )  const
 

IndexArray * Geometry::getTexCoordIndices unsigned int  unit  ) 
 

const Array* osg::Geometry::getVertexArray  )  const [inline]
 

Array* osg::Geometry::getVertexArray  )  [inline]
 

const Array * Geometry::getVertexAttribArray unsigned int  index  )  const
 

Array * Geometry::getVertexAttribArray unsigned int  index  ) 
 

const ArrayList& osg::Geometry::getVertexAttribArrayList  )  const [inline]
 

ArrayList& osg::Geometry::getVertexAttribArrayList  )  [inline]
 

Geometry::AttributeBinding Geometry::getVertexAttribBinding unsigned int  index  )  const
 

const Geometry::ArrayData & Geometry::getVertexAttribData unsigned int  index  )  const
 

Geometry::ArrayData & Geometry::getVertexAttribData unsigned int  index  ) 
 

const IndexArray * Geometry::getVertexAttribIndices unsigned int  index  )  const
 

IndexArray * Geometry::getVertexAttribIndices unsigned int  index  ) 
 

GLboolean Geometry::getVertexAttribNormalize unsigned int  index  )  const
 

const ArrayData& osg::Geometry::getVertexData  )  const [inline]
 

ArrayData& osg::Geometry::getVertexData  )  [inline]
 

const IndexArray* osg::Geometry::getVertexIndices  )  const [inline]
 

IndexArray* osg::Geometry::getVertexIndices  )  [inline]
 

bool Geometry::insertPrimitiveSet unsigned int  i,
PrimitiveSet primitiveset
 

Insert a primitive set to the specified position in geometry's primitive set list.

virtual bool osg::Geometry::isSameKindAs const Object obj  )  const [inline, virtual]
 

Reimplemented from osg::Drawable.

virtual const char* osg::Geometry::libraryName  )  const [inline, virtual]
 

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

Geometry& osg::Geometry::operator= const Geometry  )  [inline, protected]
 

void osg::Geometry::removeInternalOptimizedGeometry  )  [inline]
 

bool Geometry::removePrimitiveSet unsigned int  i,
unsigned int  numElementsToRemove = 1
 

Remove primitive set(s) from the specified position in geometry's primitive set list.

void osg::Geometry::setColorArray Array array  )  [inline]
 

void osg::Geometry::setColorBinding AttributeBinding  ab  )  [inline]
 

void osg::Geometry::setColorData const ArrayData arrayData  )  [inline]
 

void osg::Geometry::setColorIndices IndexArray array  )  [inline]
 

void osg::Geometry::setFastPathHint bool  on  )  [inline]
 

Set whether fast paths should be used when supported.

void osg::Geometry::setFogCoordArray Array array  )  [inline]
 

void osg::Geometry::setFogCoordBinding AttributeBinding  ab  )  [inline]
 

void osg::Geometry::setFogCoordData const ArrayData arrayData  )  [inline]
 

void osg::Geometry::setFogCoordIndices IndexArray array  )  [inline]
 

void osg::Geometry::setInternalOptimizedGeometry osg::Geometry geometry  )  [inline]
 

void osg::Geometry::setNormalArray Vec3Array array  )  [inline]
 

void osg::Geometry::setNormalBinding AttributeBinding  ab  )  [inline]
 

void osg::Geometry::setNormalData const Vec3ArrayData arrayData  )  [inline]
 

void osg::Geometry::setNormalIndices IndexArray array  )  [inline]
 

bool Geometry::setPrimitiveSet unsigned int  i,
PrimitiveSet primitiveset
 

Set a primitive set to the specified position in geometry's primitive set list.

void osg::Geometry::setPrimitiveSetList const PrimitiveSetList primitives  )  [inline]
 

void osg::Geometry::setSecondaryColorArray Array array  )  [inline]
 

void osg::Geometry::setSecondaryColorBinding AttributeBinding  ab  )  [inline]
 

void osg::Geometry::setSecondaryColorData const ArrayData arrayData  )  [inline]
 

void osg::Geometry::setSecondaryColorIndices IndexArray array  )  [inline]
 

void Geometry::setTexCoordArray unsigned int  unit,
Array
 

void Geometry::setTexCoordData unsigned int  index,
const ArrayData arrayData
 

void Geometry::setTexCoordIndices unsigned int  unit,
IndexArray
 

void osg::Geometry::setVertexArray Array array  )  [inline]
 

void Geometry::setVertexAttribArray unsigned int  index,
Array array
 

void Geometry::setVertexAttribBinding unsigned int  index,
AttributeBinding  ab
 

void Geometry::setVertexAttribData unsigned int  index,
const ArrayData arrayData
 

void Geometry::setVertexAttribIndices unsigned int  index,
IndexArray array
 

void Geometry::setVertexAttribNormalize unsigned int  index,
GLboolean  norm
 

void osg::Geometry::setVertexData const ArrayData arrayData  )  [inline]
 

void osg::Geometry::setVertexIndices IndexArray array  )  [inline]
 

bool Geometry::suitableForOptimization  )  const
 

virtual bool osg::Geometry::supports PrimitiveIndexFunctor &   )  const [inline, virtual]
 

Return true, osg::Geometry does support accept(PrimitiveIndexFunctor&).

virtual bool osg::Geometry::supports PrimitiveFunctor &   )  const [inline, virtual]
 

Return true, osg::Geometry does support accept(PrimitiveFunctor&).

virtual bool osg::Geometry::supports ConstAttributeFunctor &   )  const [inline, virtual]
 

Return true, osg::Geometry does support accept(ConstAttributeFunctor&).

virtual bool osg::Geometry::supports AttributeFunctor &   )  const [inline, virtual]
 

Return true, osg::Geometry does support accept(AttributeFunctor&).

bool Geometry::verifyBindings const Vec3ArrayData arrayData  )  const [protected]
 

bool Geometry::verifyBindings const ArrayData arrayData  )  const [protected]
 

bool Geometry::verifyBindings  )  const
 


Member Data Documentation

ArrayData osg::Geometry::_colorData [protected]
 

bool osg::Geometry::_fastPath [mutable, protected]
 

bool osg::Geometry::_fastPathHint [protected]
 

ArrayData osg::Geometry::_fogCoordData [protected]
 

ref_ptr<Geometry> osg::Geometry::_internalOptimizedGeometry [protected]
 

Vec3ArrayData osg::Geometry::_normalData [protected]
 

PrimitiveSetList osg::Geometry::_primitives [protected]
 

ArrayData osg::Geometry::_secondaryColorData [protected]
 

ArrayList osg::Geometry::_texCoordList [protected]
 

ArrayList osg::Geometry::_vertexAttribList [protected]
 

ArrayData osg::Geometry::_vertexData [protected]
 

const Geometry::ArrayData Geometry::s_InvalidArrayData [static]
 

Static ArrayData which is returned from getTexCoordData(i) const and getVertexAttribData(i) const when i is out of range.


The documentation for this class was generated from the following files:
Generated at Sat Mar 18 08:53:03 2006 for the OpenSceneGraph by doxygen 1.4.6.