MAttributeParameterMappingList Class Reference

#include <MPxShadingNodeOverride.h>

Class Description

Public Member Functions

 MAttributeParameterMappingList ()
 Constructor.
 
 ~MAttributeParameterMappingList ()
 Destructor.
 
unsigned int length () const
 Get the length of the list. More...
 
const MAttributeParameterMappinggetMapping (unsigned int index) const
 Get the mapping at the specified index. More...
 
const MAttributeParameterMappingfindByAttributeName (const MString &attributeName) const
 Find a mapping by attribute name. More...
 
const MAttributeParameterMappingfindByParameterName (const MString &parameterName) const
 Find a mapping by parameter name. More...
 
void append (const MAttributeParameterMapping &mapping)
 Add a mapping to the list. More...
 
void clear ()
 Clear all mappings from the list.
 

Static Public Member Functions

static const char * className ()
 Returns the name of this class. More...
 

Member Function Documentation

unsigned int length ( ) const

Get the length of the list.

Returns
The length of the list
const MAttributeParameterMapping * getMapping ( unsigned int  index) const

Get the mapping at the specified index.

Parameters
[in]indexThe index of the mapping to get
Returns
A pointer to the mapping or NULL if out of bounds
const MAttributeParameterMapping * findByAttributeName ( const MString attributeName) const

Find a mapping by attribute name.

This will return the first mapping found with a matching attribute name.

Parameters
[in]attributeNameThe name of the attribute to search for
Returns
A pointer to the mapping or NULL if not found
const MAttributeParameterMapping * findByParameterName ( const MString parameterName) const

Find a mapping by parameter name.

This will return the first mapping found with a matching parameter name.

Parameters
[in]parameterNameThe name of the parameter to search for
Returns
A pointer to the mapping or NULL if not found
+ Examples:
void append ( const MAttributeParameterMapping mapping)

Add a mapping to the list.

The list makes a copy; ownership of the original is left with the caller.

Parameters
[in]mappingThe mapping to add to the list
+ Examples:
const char * className ( )
static

Returns the name of this class.

Returns
Name of this class.

The documentation for this class was generated from the following files:
  • MPxShadingNodeOverride.h
  • MPxShadingNodeOverride.cpp