MUniformParameterList Class Reference
[OpenMayaRender - API module for rendering]

#include <MUniformParameterList.h>

List of all members.


Detailed Description

Uniform Parameter.

MUniformParameterArray specify the list of uniform shader parameters 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:

hlslShader.h.


Public Member Functions

 MUniformParameterList ()
 ~MUniformParameterList ()
void append (const MUniformParameter &element)
int length () const
void setLength (int n)
MUniformParameter getElement (int n) const
void setElement (int n, const MUniformParameter &p)
const MUniformParameterListoperator= (const MUniformParameterList &other)

Friends

class MPxHardwareShader

Constructor & Destructor Documentation

MUniformParameterList::MUniformParameterList (  ) 

Create a new, empty list of uniform parameters.

MUniformParameterList::~MUniformParameterList (  ) 

Class destructor.


Member Function Documentation

void MUniformParameterList::append ( const MUniformParameter element  ) 

Append a new parameter to this end of this list.

Parameters:
[in] element The new parameter to append

int MUniformParameterList::length (  )  const

Get the number of parameters in this list.

Returns:
The number of parameters in this list.

void MUniformParameterList::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] n The number of parameters in this list.

MUniformParameter MUniformParameterList::getElement ( int  n  )  const

Get the nth parameter in this list.

Parameters:
[in] n the index of the element to return
Returns:
The nth parameter in the list

void MUniformParameterList::setElement ( int  n,
const MUniformParameter p 
)

Get the nth parameter in this list.

Parameters:
[in] n the index of the element to return
Returns:
The nth parameter in the list

const MUniformParameterList & MUniformParameterList::operator= ( const MUniformParameterList src  ) 

Assignment operator


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