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

Public Types

enum  Type {
  PrimitiveType, DrawArraysPrimitiveType, DrawArrayLengthsPrimitiveType, DrawElementsUBytePrimitiveType,
  DrawElementsUShortPrimitiveType, DrawElementsUIntPrimitiveType, MultiDrawArraysPrimitiveType, DrawArraysIndirectPrimitiveType,
  DrawElementsUByteIndirectPrimitiveType, DrawElementsUShortIndirectPrimitiveType, DrawElementsUIntIndirectPrimitiveType, MultiDrawArraysIndirectPrimitiveType,
  MultiDrawElementsUByteIndirectPrimitiveType, MultiDrawElementsUShortIndirectPrimitiveType, MultiDrawElementsUIntIndirectPrimitiveType
}
 
enum  Mode {
  POINTS = GL_POINTS, LINES = GL_LINES, LINE_STRIP = GL_LINE_STRIP, LINE_LOOP = GL_LINE_LOOP,
  TRIANGLES = GL_TRIANGLES, TRIANGLE_STRIP = GL_TRIANGLE_STRIP, TRIANGLE_FAN = GL_TRIANGLE_FAN, QUADS = GL_QUADS,
  QUAD_STRIP = GL_QUAD_STRIP, POLYGON = GL_POLYGON, LINES_ADJACENCY = GL_LINES_ADJACENCY, LINE_STRIP_ADJACENCY = GL_LINE_STRIP_ADJACENCY,
  TRIANGLES_ADJACENCY = GL_TRIANGLES_ADJACENCY, TRIANGLE_STRIP_ADJACENCY = GL_TRIANGLE_STRIP_ADJACENCY, PATCHES = GL_PATCHES
}
 
- Public Types inherited from osg::Object
enum  DataVariance { DYNAMIC, STATIC, UNSPECIFIED }
 

Public Member Functions

 PrimitiveSet (Type primType=PrimitiveType, GLenum mode=0, int numInstances=0)
 
 PrimitiveSet (const PrimitiveSet &prim, 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...
 
Type getType () const
 
virtual osg::PrimitiveSetasPrimitiveSet ()
 
virtual const osg::PrimitiveSetasPrimitiveSet () const
 
virtual const GLvoid * getDataPointer () const
 
virtual unsigned int getTotalDataSize () const
 
virtual bool supportsBufferObject () const
 
virtual DrawElementsgetDrawElements ()
 
virtual const DrawElementsgetDrawElements () const
 
void setNumInstances (int n)
 
int getNumInstances () const
 
void setMode (GLenum mode)
 
GLenum getMode () const
 
virtual void draw (State &state, bool useVertexBufferObjects) const =0
 
virtual void accept (PrimitiveFunctor &functor) const =0
 
virtual void accept (PrimitiveIndexFunctor &functor) const =0
 
virtual unsigned int index (unsigned int pos) const =0
 
virtual unsigned int getNumIndices () const =0
 
virtual void offsetIndices (int offset)=0
 
virtual unsigned int getNumPrimitives () const
 
virtual void computeRange () const
 
- 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::ArrayasArray ()
 
virtual const osg::ArrayasArray () const
 
virtual osg::ImageasImage ()
 Convert 'this' into a Image pointer if Object is a Image, otherwise return 0. More...
 
virtual const osg::ImageasImage () const
 Convert 'this' into a Image pointer if Object is a Image, otherwise return 0. More...
 
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 StateSetasStateSet ()
 Convert 'this' into a StateSet pointer if Object is a StateSet, otherwise return 0. More...
 
virtual const StateSetasStateSet () const
 convert 'const this' into a const StateSet pointer if Object is a StateSet, 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 Uniform * asUniform ()
 Convert 'this' into a Uniform pointer if Object is a Uniform, otherwise return 0. More...
 
virtual const UniformBaseasUniformBase () const
 convert 'const this' into a const Uniform pointer if Object is a Uniform, otherwise return 0. More...
 
virtual UniformBaseasUniformBase ()
 Convert 'this' into a Uniform pointer if Object is a Uniform, otherwise return 0. More...
 
virtual const Uniform * asUniform () const
 convert 'const this' into a const Uniform pointer if Object is a Uniform, otherwise return 0. More...
 
virtual CameraasCamera ()
 Convert 'this' into a Camera pointer if Node is a Camera, otherwise return 0. More...
 
virtual const CameraasCamera () const
 convert 'const this' into a const Camera pointer if Node is a Camera, otherwise return 0. More...
 
virtual DrawableasDrawable ()
 Convert 'this' into a Drawable pointer if Object is a Drawable, otherwise return 0. More...
 
virtual const DrawableasDrawable () const
 convert 'const this' into a const Drawable pointer if Object is a Drawable, otherwise return 0. More...
 
virtual CallbackasCallback ()
 Convert 'this' into a Callback pointer if Object is a Callback, otherwise return 0. More...
 
virtual const CallbackasCallback () const
 convert 'const this' into a const Callback pointer if Object is a Callback, otherwise return 0. More...
 
virtual CallbackObjectasCallbackObject ()
 Convert 'this' into a CallbackObject pointer if Object is a CallbackObject, otherwise return 0. More...
 
virtual const CallbackObjectasCallbackObject () const
 convert 'const this' into a const CallbackObject pointer if Object is a CallbackObject, otherwise return 0. More...
 
virtual UserDataContainerasUserDataContainer ()
 Convert 'this' into a UserDataContainer pointer if Object is a UserDataContainer, otherwise return 0. More...
 
virtual const UserDataContainerasUserDataContainer () const
 convert 'const this' into a const UserDataContainer pointer if Object is a UserDataContainer, otherwise return 0. More...
 
virtual ValueObjectasValueObject ()
 Convert 'this' into a ValueObject pointer if Object is a ValueObject, otherwise return 0. More...
 
virtual const ValueObjectasValueObject () const
 Convert 'this' into a ValueObject pointer if Object is a ValueObject, 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)
 Deprecated, Referenced is now always uses thread safe ref/unref, use default Referenced() constructor instead. More...
 
 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::MutexgetRefMutex () 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 ~PrimitiveSet ()
 
- 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 _primitiveType
 
int _numInstances
 
GLenum _mode
 
- 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 ()
 Get the optional global Referenced mutex, this can be shared between all osg::Referenced. 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

◆ Mode

Enumerator
POINTS 
LINES 
LINE_STRIP 
LINE_LOOP 
TRIANGLES 
TRIANGLE_STRIP 
TRIANGLE_FAN 
QUADS 
QUAD_STRIP 
POLYGON 
LINES_ADJACENCY 
LINE_STRIP_ADJACENCY 
TRIANGLES_ADJACENCY 
TRIANGLE_STRIP_ADJACENCY 
PATCHES 

◆ Type

Enumerator
PrimitiveType 
DrawArraysPrimitiveType 
DrawArrayLengthsPrimitiveType 
DrawElementsUBytePrimitiveType 
DrawElementsUShortPrimitiveType 
DrawElementsUIntPrimitiveType 
MultiDrawArraysPrimitiveType 
DrawArraysIndirectPrimitiveType 
DrawElementsUByteIndirectPrimitiveType 
DrawElementsUShortIndirectPrimitiveType 
DrawElementsUIntIndirectPrimitiveType 
MultiDrawArraysIndirectPrimitiveType 
MultiDrawElementsUByteIndirectPrimitiveType 
MultiDrawElementsUShortIndirectPrimitiveType 
MultiDrawElementsUIntIndirectPrimitiveType 

Constructor & Destructor Documentation

◆ PrimitiveSet() [1/2]

osg::PrimitiveSet::PrimitiveSet ( Type  primType = PrimitiveType,
GLenum  mode = 0,
int  numInstances = 0 
)
inline

◆ PrimitiveSet() [2/2]

osg::PrimitiveSet::PrimitiveSet ( const PrimitiveSet prim,
const CopyOp copyop = CopyOp::SHALLOW_COPY 
)
inline

◆ ~PrimitiveSet()

virtual osg::PrimitiveSet::~PrimitiveSet ( )
inlineprotectedvirtual

Member Function Documentation

◆ accept() [1/2]

virtual void osg::PrimitiveSet::accept ( PrimitiveFunctor functor) const
pure virtual

◆ accept() [2/2]

virtual void osg::PrimitiveSet::accept ( PrimitiveIndexFunctor functor) const
pure virtual

◆ asPrimitiveSet() [1/2]

virtual osg::PrimitiveSet* osg::PrimitiveSet::asPrimitiveSet ( )
inlinevirtual

Reimplemented from osg::BufferData.

◆ asPrimitiveSet() [2/2]

virtual const osg::PrimitiveSet* osg::PrimitiveSet::asPrimitiveSet ( ) const
inlinevirtual

Reimplemented from osg::BufferData.

◆ className()

virtual const char* osg::PrimitiveSet::className ( ) const
inlinevirtual

◆ computeRange()

virtual void osg::PrimitiveSet::computeRange ( ) const
inlinevirtual

◆ draw()

virtual void osg::PrimitiveSet::draw ( State state,
bool  useVertexBufferObjects 
) const
pure virtual

◆ getDataPointer()

virtual const GLvoid* osg::PrimitiveSet::getDataPointer ( ) const
inlinevirtual

◆ getDrawElements() [1/2]

virtual DrawElements* osg::PrimitiveSet::getDrawElements ( )
inlinevirtual

Reimplemented in osg::DrawElements.

◆ getDrawElements() [2/2]

virtual const DrawElements* osg::PrimitiveSet::getDrawElements ( ) const
inlinevirtual

Reimplemented in osg::DrawElements.

◆ getMode()

GLenum osg::PrimitiveSet::getMode ( ) const
inline

◆ getNumIndices()

virtual unsigned int osg::PrimitiveSet::getNumIndices ( ) const
pure virtual

◆ getNumInstances()

int osg::PrimitiveSet::getNumInstances ( ) const
inline

◆ getNumPrimitives()

virtual unsigned int osg::PrimitiveSet::getNumPrimitives ( ) const
virtual

◆ getTotalDataSize()

virtual unsigned int osg::PrimitiveSet::getTotalDataSize ( ) const
inlinevirtual

◆ getType()

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

◆ index()

virtual unsigned int osg::PrimitiveSet::index ( unsigned int  pos) const
pure virtual

◆ isSameKindAs()

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

◆ libraryName()

virtual const char* osg::PrimitiveSet::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.

Reimplemented in osg::DrawArraysIndirect, osg::MultiDrawArrays, osg::DrawElementsUInt, osg::DrawElementsUShort, osg::DrawElementsUByte, osg::DrawElementsIndirectUInt, osg::DrawArrayLengths, osg::DrawElementsIndirectUShort, osg::DrawArrays, and osg::DrawElementsIndirectUByte.

◆ offsetIndices()

virtual void osg::PrimitiveSet::offsetIndices ( int  offset)
pure virtual

◆ setMode()

void osg::PrimitiveSet::setMode ( GLenum  mode)
inline

◆ setNumInstances()

void osg::PrimitiveSet::setNumInstances ( int  n)
inline

◆ supportsBufferObject()

virtual bool osg::PrimitiveSet::supportsBufferObject ( ) const
inlinevirtual

Member Data Documentation

◆ _mode

GLenum osg::PrimitiveSet::_mode
protected

◆ _numInstances

int osg::PrimitiveSet::_numInstances
protected

◆ _primitiveType

Type osg::PrimitiveSet::_primitiveType
protected

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