This reference page is linked to from the following overview topics: A hardware shading node plug-in example.

Detailed Description

Geometric data container.

This class allows storage of arbitrary data which is formated to be specifically suitable for usage using a 3D display interface such as OpenGL.

Format options include:

Currently, each element can be of a 1, 2, 3, 4 tuple.
Element type can be IEEE single float or double float, signed or unsigned byte (character), 16 or 32 bit signed unsigned integers.
There are specific "type" identifiers to provide a semantic on for the data. These include:
- position : vertex position vector
- normal : vertex normal vector
- texCoord : vertextexture coordinate vector
- color : vertex color vector
- weight : vertex skin weight vector
- tangent : vertex tangent vector
- binormal : vertex binormal vector
- velocity : vertex velocity vector
- primitiveCenter : center a primitive (e.g. a triangle)
- colorMask : colour existance mask. 1:1 correspondance with color
- useData : some user defined data. A semantic that Maya does not understand.

Currently Maya only interprets a fixed format subset for data with recongnized semantics, This does not mean that the user cannot create any arbitrary format for data storage. Support formats with semantics includes:

3 float position interpreted as (x,y,z).
3 float normal interpreted as (x,y,z).
2 float texture coordinate. Coorindate is interpreted as a (U,V) tuple.
4 float color. Color is interpreted as (Red, Green, Blue, Alpha) tuple.
3 float tangent interpreted as (x,y,z).
3 float binormal interpreted as (x,y,z).
3 float velocity interpreted as (x,y,z).
3 float primitive center position interpreted as (x,y,z).
1 float color mask interpreted as 1=mapped, and 0 = unmapped.

Memory allocation of the correct size is left up to the user of this class.

Memory can be marked as "owned" by this class or the user of this class. Ownership by this class is the default behaviour specified in the constructor. If the data is marked as being owned by the class, it is assumed that the data is created using a "new" operation, as the destructor of this class will use a "delete" operation to free memory.

Internal Maya data which is passed to the user via this class is always assumed to be non-modifiable. If modified, stability cannot be ensured.

Examples:: cgfxShaderNode.cpp, D3DGeometryItem.cpp, GLSLShaderNode.cpp, GLSLShaderNode.h, hlslShader.cpp, hwColorPerVertexShader.cpp, hwPhongShader.cpp, hwPhongShader.h, and OpenGLViewportRenderer.cpp.

#include <MGeometryData.h>

List of all members.

Public Types
enum	ElementSize { kInvalidElementSize = 0, kOne = 1, kTwo, kThree, kFour }
	Specifies the size or dimension of each data element of the storage. More...
enum	ElementType { kInvalidElementType = -1, kFloat = 0, kDouble, kChar, kUnsignedChar, kInt16, kUnsignedInt16, kInt32, kUnsignedInt32 }
	Specifies the data type of each data element of the storage. More...
enum	DataType { kInvalidDataType = 0, kPosition, kNormal, kTexCoord, kColor, kWeight, kAPISupported, kTangent, kBiNormal, kVelocity, kPrimitiveCenter, kColorMask, kUserData, kMaxDataTypeIndex }
	Specifies the data type of the storage array. More...
Public Member Functions
	MGeometryData (const char dataName, DataType dataType, ElementType elementType, ElementSize elementSize, unsigned int elementCount, void dataPtr=NULL, bool ownsData=true)
	Geometry data constructor.
	MGeometryData (const MGeometryData &)
	Copy constructor.
	~MGeometryData ()
	Class destructor.
const char *	objectName () const
	Return the logical name of the geometry.
int	uniqueID () const
	Return the per session unique identifier.
DataType	dataType () const
	Get the data type for the data.
ElementType	elementType () const
	Returns the data type.
unsigned int	elementTypeSize () const
	Return the element type size.
ElementSize	elementSize () const
	Return element size.
unsigned int	elementCount () const
	Return element count.
void *	data () const
	Retrieve a pointer to the internal data.
void	setCollectionNumber (int cn)
	Set the collection number for the object.
int	collectionNumber () const
	Get the collection number of the data.
void	setObjectOwnsData (bool val)
	Set ownship of the interal data.
bool	objectOwnsData () const
	Return if the MGeometryData object owns the internal data or not.
Friends
class	MGeometry Search for all occurrences
class	MHardwareRenderer Search for all occurrences
class	MD3D9Renderer Search for all occurrences

kInvalidElementSize	Invalid element size. Search for all occurrences
kOne	Single value. Search for all occurrences
kTwo	2-tuple Search for all occurrences
kThree	3-tuple Search for all occurrences
kFour	4-tuple Search for all occurrences

kInvalidElementType	Invalid element type (default value) Search for all occurrences
kFloat	IEEE single precision floating point. Search for all occurrences
kDouble	IEEE double precision floating point. Search for all occurrences
kChar	Signed char. Search for all occurrences
kUnsignedChar	Unsigned char. Search for all occurrences
kInt16	Signed 16-bit integer. Search for all occurrences
kUnsignedInt16	Unsigned 16-bit integer. Search for all occurrences
kInt32	Signed 32-bit integer. Search for all occurrences
kUnsignedInt32	Unsigned 32-bit integer. Search for all occurrences

kInvalidDataType	Invalid data type (default value) Search for all occurrences
kPosition	Position vector. Search for all occurrences
kNormal	Normal vector. Search for all occurrences
kTexCoord	Texture coordinate tuple. Search for all occurrences
kColor	Color tuple. Search for all occurrences
kWeight	Vertex weighting data. Search for all occurrences
kAPISupported	Separator to indicate native draw API supported types. Search for all occurrences
kTangent	Tangent vector. Search for all occurrences
kBiNormal	Bi-normal vector. Search for all occurrences
kVelocity	Velocity vector. Search for all occurrences
kPrimitiveCenter	Center of primitive. Search for all occurrences
kColorMask	Mapped, unmapped color mask. Search for all occurrences
kUserData	Arbitrary "user data". Search for all occurrences
kMaxDataTypeIndex	Valid entries are < kMaxDataTypeIndex. Search for all occurrences

MGeometryData	(	const char *	dataName,
		MGeometryData::DataType	dataType,
		MGeometryData::ElementType	elementType,
		MGeometryData::ElementSize	elementSize,
		unsigned int	elementCount,
		void *	dataPtr = `NULL`,
		bool	ownsData = `true`
	)

[in]	dataName	name of the data
[in]	dataType	type of data
[in]	elementType	element type
[in]	elementSize	size or dimension of an element. For example, a 3D position vector has three components per position (x, y, z) so it would have an elementSize of kThree.
[in]	elementCount	element count
[in]	dataPtr	pointer to contiguous block of data
[in]	ownsData	flag to tell if the instance owns the data or not.

MGeometryData Class Reference

OpenMayaRender - API module for rendering

Detailed Description

Public Types

Public Member Functions

Friends

Member Enumeration Documentation

Constructor & Destructor Documentation

Member Function Documentation