OpenMayaRender.MAttributeParameterMapping Class Reference

OpenMayaRender.MAttributeParameterMapping Class Reference

Class Description

Class for defining relationship between Maya attributes and fragment parameters.
+ Inheritance diagram for OpenMayaRender.MAttributeParameterMapping:

Public Member Functions

__init__ ()
 
allowConnection ()
 
allowRename ()
 
attributeName ()
 
parameterName ()
 
resolvedParameterName ()
 

Constructor & Destructor Documentation

OpenMayaRender.MAttributeParameterMapping.__init__ ( )
x.__init__(...) initializes x; see help(type(x)) for signature

Member Function Documentation

OpenMayaRender.MAttributeParameterMapping.allowConnection ( )
allowConnection() -> bool

This method returns true if Maya is allowed to connect other shade fragments to the parameter named by this mapping.
OpenMayaRender.MAttributeParameterMapping.allowRename ( )
allowRename() -> bool

This method returns true if the parameter named by this mapping may be renamed in the final shading effect.
If false, name collisions of parameters will be unresolved and results will be unpredictable.
OpenMayaRender.MAttributeParameterMapping.attributeName ( )
attributeName() -> string

Get the attribute name for this mapping.
OpenMayaRender.MAttributeParameterMapping.parameterName ( )
parameterName() -> string

Get the parameter name for this mapping.
OpenMayaRender.MAttributeParameterMapping.resolvedParameterName ( )
resolvedParameterName() -> string

Get the resolved parameter name for this mapping. After the fragment has been joined with other
fragments to form the final shading effect its parameters are renamed to prevent name collisions.
This returns the name of the parameter on the final shading effect.
This name is useful in MPxShadingNodeOverride::updateShader() for setting parameter values manually.

If the fragment has not yet been joined with other fragments, this will return the same string as parameterName().

The documentation for this class was generated from the following file:
  • D:/Maya-MD-Merge/input/python/2.0/OpenMayaRender.py