C++ API Reference
MVaryingParameterList Class Reference

Geometric data cache. More...

#include <MVaryingParameterList.h>

Public Member Functions

 MVaryingParameterList ()
 Create a new, empty list of varying parameters.
 
 ~MVaryingParameterList ()
 Class destructor.
 
 MVaryingParameterList (const MVaryingParameterList &src)
 Copy constructor.
 
void append (const MVaryingParameter &element)
 Append a new parameter to this end of this list. More...
 
int length () const
 Get the number of parameters in this list. More...
 
void setLength (int n)
 Set the number of parameters in this list. More...
 
MVaryingParameter getElement (int n) const
 Get the nth parameter in this list. More...
 
void setElement (int n, const MVaryingParameter &p)
 Set the nth parameter in this list. More...
 
const MVaryingParameterListoperator= (const MVaryingParameterList &other)
 Assignment operator. More...
 

Detailed Description

Geometric data cache.

MVaryingParameterList specify the surface component level data used by a hardware shader, allowing Maya to handle setting up the node and user interfaces to the data, the population and access of cached data, etc.

Examples:
dx11Shader/dx11Shader.cpp, dx11Shader/dx11Shader.h, glslShader/GLSLShader.h, and hlslShader/hlslShader.cpp.

Member Function Documentation

void append ( const MVaryingParameter element)

Append a new parameter to this end of this list.

Parameters
[in]elementThe new parameter to append
Examples:
dx11Shader/dx11Shader.cpp, and hlslShader/hlslShader.cpp.
int length ( ) const

Get the number of parameters in this list.

Returns
The number of parameters in this list.
Examples:
dx11Shader/dx11Shader.cpp.
void setLength ( int  n)

Set the number of parameters in this list.

If this is greater than the current number of parameters in the list, the caller is responsible for setting the new parameters to valid values using setElement.

Parameters
[in]nThe number of parameters in this list.
MVaryingParameter getElement ( int  n) const

Get the nth parameter in this list.

Parameters
[in]nThe index of the element to return
Returns
The nth parameter in the list
Examples:
dx11Shader/dx11Shader.cpp.
void setElement ( int  n,
const MVaryingParameter p 
)

Set the nth parameter in this list.

Parameters
[in]nThe index of the element to set
[in]pThe value to set
Returns
The nth parameter in the list
const MVaryingParameterList & operator= ( const MVaryingParameterList src)

Assignment operator.

Parameters
[in]srcMVaryingParameterList object to copy from.

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