OpenMayaRender.MAttributeParameterMapping Class Reference

Inheritance diagram for OpenMayaRender.MAttributeParameterMapping:

Public Member Functions
def	__init__ ()
def	allowConnection ()
def	allowRename ()
def	attributeName ()
def	parameterName ()
def	resolvedParameterName ()

Static Public Member Functions
def	__new__ ()

Detailed Description

Class for defining relationship between Maya attributes and fragment parameters.

Constructor & Destructor Documentation

def OpenMayaRender.MAttributeParameterMapping.__init__

(

)

Initialize self.  See help(type(self)) for accurate signature.

Member Function Documentation

def OpenMayaRender.MAttributeParameterMapping.__new__ ( )

static

Create and return a new object.  See help(type) for accurate signature.

def 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.

def 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.

def OpenMayaRender.MAttributeParameterMapping.attributeName

(

)

attributeName() -> string

Get the attribute name for this mapping.

def OpenMayaRender.MAttributeParameterMapping.parameterName

(

)

parameterName() -> string

Get the parameter name for this mapping.

def 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().