OpenMayaRender.MPxVertexBufferGenerator Class Reference

Inheritance diagram for OpenMayaRender.MPxVertexBufferGenerator:

Public Member Functions
def	__init__ ()
def	createVertexStream ()
def	getSourceIndexing ()
def	getSourceStreams ()

Static Public Member Functions
def	__new__ ()

Detailed Description

Base class for user defined vertex buffer generators.

Constructor & Destructor Documentation

def OpenMayaRender.MPxVertexBufferGenerator.__init__

(

)

Initialize self.  See help(type(self)) for accurate signature.

Member Function Documentation

def OpenMayaRender.MPxVertexBufferGenerator.__new__ ( )

static

Create and return a new object.  See help(type) for accurate signature.

def OpenMayaRender.MPxVertexBufferGenerator.createVertexStream

(

)

createVertexStream(object, vertexBuffer, targetIndexing, sharedIndexing, sourceStreams) -> self

This method gets called to allow the generator to fill in the data for a custom vertex stream. Use the requirements in the vertexBuffer to get the description of the stream. Use vertexBuffer.acquire() and vertexBuffer.commit() to fill the buffer. 

* object (MObject) - The dag object being evaluated.
* vertexBuffer [IN/OUT] (MVertexBuffer) - The vertex buffer to fill.
* targetIndexing (MComponentDataIndexing) - Vertex index mapping from targetIndexing.getComponentType() space to vertex buffer space.
* sharedIndexing (MComponentDataIndexing) - Vertex index mapping in the declared MComponentDataIndexing::MComponentType space.
* sourceStreams (MVertexBufferArray) - Array of Vertex Buffers that can be used to create the new stream.

def OpenMayaRender.MPxVertexBufferGenerator.getSourceIndexing

(

)

getSourceIndexing(object, sourceIndexing) -> self

This function is called to allow the vertex buffer generator to provide its vertex indexing information as well as the space the vertices are in.  The indexing and the component type are stored in the  sourceIndexing argument.  This indexing information is to allow the system to identify any potential  vertex sharing that is common across all vertex requirements. 

* object (MObject) - The object being evaluated.
* sourceIndexing [OUT] (MComponentDataIndexing) - Vertex index mapping in the declared MComponentDataIndexing::MComponentType space.

def OpenMayaRender.MPxVertexBufferGenerator.getSourceStreams

(

)

getSourceStreams(object, sourceStreams) -> self

This function is called to allow the vertex buffer generator to provide the list of stream names that it requires. The names will be used to fill the array of vertex buffers that will be passed to createVertexStream. 

* object (MObject) - The dag object being evaluated.
* sourceStreams [OUT] (list of strings) - Array of strings.