osg::TemplatePrimitiveFunctor< T > Class Template Reference

Provides access to the primitives that compose an osg::Drawable. More...

Inheritance diagram for osg::TemplatePrimitiveFunctor< T >:

Inheritance graph
[legend]

List of all members.

Public Member Functions

 TemplatePrimitiveFunctor ()
virtual ~TemplatePrimitiveFunctor ()
void setTreatVertexDataAsTemporary (bool treatVertexDataAsTemporary)
bool getTreatVertexDataAsTemporary () const
virtual void setVertexArray (unsigned int, const Vec2 *)
 Sets the array of vertices used to describe the primitives.
virtual void setVertexArray (unsigned int count, const Vec3 *vertices)
 Sets the array of vertices used to describe the primitives.
virtual void setVertexArray (unsigned int, const Vec4 *)
 Sets the array of vertices used to describe the primitives.
virtual void drawArrays (GLenum mode, GLint first, GLsizei count)
 Mimics the OpenGL glDrawArrays() function.
template<class IndexType>
void drawElementsTemplate (GLenum mode, GLsizei count, const IndexType *indices)
virtual void drawElements (GLenum mode, GLsizei count, const GLubyte *indices)
 Mimics the OpenGL glDrawElements() function.
virtual void drawElements (GLenum mode, GLsizei count, const GLushort *indices)
 Mimics the OpenGL glDrawElements() function.
virtual void drawElements (GLenum mode, GLsizei count, const GLuint *indices)
 Mimics the OpenGL glDrawElements() function.
virtual void begin (GLenum mode)
 Note: begin(.
virtual void vertex (const Vec2 &vert)
 Mimics the OpenGL glVertex() "family of functions".
virtual void vertex (const Vec3 &vert)
 Mimics the OpenGL glVertex() "family of functions".
virtual void vertex (const Vec4 &vert)
 Mimics the OpenGL glVertex() "family of functions".
virtual void vertex (float x, float y)
 Mimics the OpenGL glVertex() "family of functions".
virtual void vertex (float x, float y, float z)
 Mimics the OpenGL glVertex() "family of functions".
virtual void vertex (float x, float y, float z, float w)
 Mimics the OpenGL glVertex() "family of functions".
virtual void end ()
 Mimics the OpenGL glEnd() function.

Protected Attributes

unsigned int _vertexArraySize
const Vec3_vertexArrayPtr
GLenum _modeCache
std::vector< Vec3_vertexCache
bool _treatVertexDataAsTemporary


Detailed Description

template<class T>
class osg::TemplatePrimitiveFunctor< T >

Provides access to the primitives that compose an osg::Drawable.

Notice that TemplatePrimitiveFunctor is a class template, and that it inherits from its template parameter T. This template parameter must implement operator()(const osg::Vec3 v1, const osg::Vec3 v2, const osg::Vec3 v3, bool treatVertexDataAsTemporary), operator()(const osg::Vec3 v1, const osg::Vec3 v2, bool treatVertexDataAsTemporary), operator()(const osg::Vec3 v1, const osg::Vec3 v2, const osg::Vec3 v3, bool treatVertexDataAsTemporary), and operator()(const osg::Vec3 v1, const osg::Vec3 v2, const osg::Vec3 v3, const osg::Vec3 v4, bool treatVertexDataAsTemporary) which will be called for the matching primitive when the functor is applied to a Drawable. Parameters v1, v2, v3, and v4 are the vertices of the primitive. The last parameter, treatVertexDataAsTemporary, indicates whether these vertices are coming from a "real" vertex array, or from a temporary vertex array, created by the TemplatePrimitiveFunctor from some other geometry representation.

See also:
PrimitiveFunctor for general usage hints.

Constructor & Destructor Documentation

template<class T>
osg::TemplatePrimitiveFunctor< T >::TemplatePrimitiveFunctor (  )  [inline]

template<class T>
virtual osg::TemplatePrimitiveFunctor< T >::~TemplatePrimitiveFunctor (  )  [inline, virtual]


Member Function Documentation

template<class T>
void osg::TemplatePrimitiveFunctor< T >::setTreatVertexDataAsTemporary ( bool  treatVertexDataAsTemporary  )  [inline]

template<class T>
bool osg::TemplatePrimitiveFunctor< T >::getTreatVertexDataAsTemporary (  )  const [inline]

template<class T>
virtual void osg::TemplatePrimitiveFunctor< T >::setVertexArray ( unsigned  count,
const Vec2 vertices 
) [inline, virtual]

Sets the array of vertices used to describe the primitives.

Somehow mimics the OpenGL glVertexPointer() function.

Implements osg::PrimitiveFunctor.

template<class T>
virtual void osg::TemplatePrimitiveFunctor< T >::setVertexArray ( unsigned int  count,
const Vec3 vertices 
) [inline, virtual]

Sets the array of vertices used to describe the primitives.

Somehow mimics the OpenGL glVertexPointer() function.

Implements osg::PrimitiveFunctor.

template<class T>
virtual void osg::TemplatePrimitiveFunctor< T >::setVertexArray ( unsigned  count,
const Vec4 vertices 
) [inline, virtual]

Sets the array of vertices used to describe the primitives.

Somehow mimics the OpenGL glVertexPointer() function.

Implements osg::PrimitiveFunctor.

template<class T>
virtual void osg::TemplatePrimitiveFunctor< T >::drawArrays ( GLenum  mode,
GLint  first,
GLsizei  count 
) [inline, virtual]

Mimics the OpenGL glDrawArrays() function.

Implements osg::PrimitiveFunctor.

template<class T>
template<class IndexType>
void osg::TemplatePrimitiveFunctor< T >::drawElementsTemplate ( GLenum  mode,
GLsizei  count,
const IndexType *  indices 
) [inline]

template<class T>
virtual void osg::TemplatePrimitiveFunctor< T >::drawElements ( GLenum  mode,
GLsizei  count,
const GLubyte *  indices 
) [inline, virtual]

Mimics the OpenGL glDrawElements() function.

Implements osg::PrimitiveFunctor.

template<class T>
virtual void osg::TemplatePrimitiveFunctor< T >::drawElements ( GLenum  mode,
GLsizei  count,
const GLushort *  indices 
) [inline, virtual]

Mimics the OpenGL glDrawElements() function.

Implements osg::PrimitiveFunctor.

template<class T>
virtual void osg::TemplatePrimitiveFunctor< T >::drawElements ( GLenum  mode,
GLsizei  count,
const GLuint *  indices 
) [inline, virtual]

Mimics the OpenGL glDrawElements() function.

Implements osg::PrimitiveFunctor.

template<class T>
virtual void osg::TemplatePrimitiveFunctor< T >::begin ( GLenum  mode  )  [inline, virtual]

Note: begin(.

.),vertex(..) & end() are convenience methods for adapting non vertex array primitives to vertex array based primitives. This is done to simplify the implementation of primtive functor subclasses - users only need override drawArray and drawElements.

Implements osg::PrimitiveFunctor.

template<class T>
virtual void osg::TemplatePrimitiveFunctor< T >::vertex ( const Vec2 vert  )  [inline, virtual]

Mimics the OpenGL glVertex() "family of functions".

Implements osg::PrimitiveFunctor.

template<class T>
virtual void osg::TemplatePrimitiveFunctor< T >::vertex ( const Vec3 vert  )  [inline, virtual]

Mimics the OpenGL glVertex() "family of functions".

Implements osg::PrimitiveFunctor.

template<class T>
virtual void osg::TemplatePrimitiveFunctor< T >::vertex ( const Vec4 vert  )  [inline, virtual]

Mimics the OpenGL glVertex() "family of functions".

Implements osg::PrimitiveFunctor.

template<class T>
virtual void osg::TemplatePrimitiveFunctor< T >::vertex ( float  x,
float  y 
) [inline, virtual]

Mimics the OpenGL glVertex() "family of functions".

Implements osg::PrimitiveFunctor.

template<class T>
virtual void osg::TemplatePrimitiveFunctor< T >::vertex ( float  x,
float  y,
float  z 
) [inline, virtual]

Mimics the OpenGL glVertex() "family of functions".

Implements osg::PrimitiveFunctor.

template<class T>
virtual void osg::TemplatePrimitiveFunctor< T >::vertex ( float  x,
float  y,
float  z,
float  w 
) [inline, virtual]

Mimics the OpenGL glVertex() "family of functions".

Implements osg::PrimitiveFunctor.

template<class T>
virtual void osg::TemplatePrimitiveFunctor< T >::end (  )  [inline, virtual]

Mimics the OpenGL glEnd() function.

Implements osg::PrimitiveFunctor.


Member Data Documentation

template<class T>
unsigned int osg::TemplatePrimitiveFunctor< T >::_vertexArraySize [protected]

template<class T>
const Vec3* osg::TemplatePrimitiveFunctor< T >::_vertexArrayPtr [protected]

template<class T>
GLenum osg::TemplatePrimitiveFunctor< T >::_modeCache [protected]

template<class T>
std::vector<Vec3> osg::TemplatePrimitiveFunctor< T >::_vertexCache [protected]

template<class T>
bool osg::TemplatePrimitiveFunctor< T >::_treatVertexDataAsTemporary [protected]


The documentation for this class was generated from the following file:
Generated at Sun Oct 14 02:12:17 2007 for the OpenSceneGraph by doxygen 1.5.3.