MRenderLine Class Reference
[OpenMayaFX - API module for effects]

#include <MRenderLine.h>

List of all members.


Detailed Description

Class for accessing paint effects output curve data.

A MRenderLine provides access to paint effects curve rendering info. This class contains arrays for per vertex attributes along an individual curve: line: the vertices in worldspace twist: a twist vector at each vertice width: the tube widths flatness: the tube flatness along the twist vector direction parameter: the u parameterization value for each vertice color: color rgb value for each vertice incandescence: incandescence rgb value for each vertice transpareancy: transparency rgb value for each vertice

Examples:

pfxInfoCmd.cpp.


Public Member Functions

  MRenderLine ()
  ~MRenderLine ()
MRenderLine operator= (const MRenderLine &other)
MVectorArray  getLine () const
MVectorArray  getTwist () const
MDoubleArray  getWidth () const
MDoubleArray  getFlatness () const
MDoubleArray  getParameter () const
MVectorArray  getColor () const
MVectorArray  getIncandescence () const
MVectorArray  getTransparency () const

Constructor & Destructor Documentation

MRenderLine::MRenderLine (  ) 

The class constructor.

MRenderLine::~MRenderLine (  ) 

The class destructor.


Member Function Documentation

MRenderLine & MRenderLine::operator= ( const MRenderLine other  ) 

Assignment operator. This simply copies the internal data pointer. Any arrays access from the copy will thus point to the same data. MRenderLine is basically a handle that points to the internal render line data on an MRenderLineArray.

Parameters:
[in]  other  the MRenderLine to be copied
Returns:
A reference to the copied MRenderLine

MVectorArray MRenderLine::getLine (  )  const

Return the array of vertices along the curve.

Returns:
The vertex array
Examples:

MVectorArray MRenderLine::getTwist (  )  const

Return the array of twist vectors along the curve.

Returns:
The twist vector array
Examples:

MDoubleArray MRenderLine::getWidth (  )  const

Return the array of tube widths along the curve.

Returns:
The width array
Examples:

MDoubleArray MRenderLine::getFlatness (  )  const

Return the array of flatness along the curve.

Returns:
The flatness array
Examples:

MDoubleArray MRenderLine::getParameter (  )  const

Return the array of parameter along the curve.

Returns:
The parameter array
Examples:

MVectorArray MRenderLine::getColor (  )  const

Return the array of colors along the curve.

Returns:
The color array
Examples:

MVectorArray MRenderLine::getIncandescence (  )  const

Return the array of incandescence along the curve.

Returns:
The incandescence array
Examples:

MVectorArray MRenderLine::getTransparency (  )  const

Return the array of transparency along the curve.

Returns:
The transparency array
Examples:

Autodesk® Maya® 2011 © 1997-2010 Autodesk, Inc. All rights reserved. Generated with doxygen 1.5.6