Cortex  10.0.0-a4
Public Member Functions | Protected Attributes | List of all members
IECoreMaya::ParameterManipContainer Class Reference

#include <ParameterManipContainer.h>

+ Inheritance diagram for IECoreMaya::ParameterManipContainer:

Public Member Functions

void setPlug (MPlug &plug)
 
MPlug getPlug ()
 
void setLabel (MString &label)
 
MString getLabel ()
 

Protected Attributes

MPlug m_plug
 
MString m_label
 

Detailed Description

This class should be used as a base class for any custom manipulators designed to operate on IECore::Parameters. When used in conjunction with the ParameterisedHolderManipContext, it ensures that the manipulator knows which MPlug it is meant to target, and any Parameter defined labeling is also transferred.

Member Function Documentation

MString IECoreMaya::ParameterManipContainer::getLabel ( )
Returns
The custom label for the manipulator, if one has been set.
MPlug IECoreMaya::ParameterManipContainer::getPlug ( )
Returns
The MPlug that the manipulator is currently set to operate on.
void IECoreMaya::ParameterManipContainer::setLabel ( MString &  label)

Called by ParameterisedHolderManipContext right before connectToDependNode() if a custom manipulator label has been defined in the Parameters userData().

void IECoreMaya::ParameterManipContainer::setPlug ( MPlug &  plug)

Called by ParameterisedHolderManipContext right before connectToDependNode(), to set the MPlug that the user is wishing to manipulate.

Member Data Documentation

MString IECoreMaya::ParameterManipContainer::m_label
protected

This label may be set by certain parameters, it is up to the derived classes to display it, or not...

MPlug IECoreMaya::ParameterManipContainer::m_plug
protected

To be used in derived classes to determine which plug the user is interested in manipulating.


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