x.__init__(...) initializes x; see help(type(x)) for signature
Member Function Documentation
OpenMayaUI.MFnScaleManip.connectToScaleCenterPlug
(
)
connectToScaleCenterPlug(scaleCenterPlug) -> self
Create a 1-1 association of the scale center on the manipulator and the scaleCenterPlug parameter. When both the scale center is attached to a plug and the displayWithNode() method has been called, the manipulator will display with the node regardless of the connection made to the scale center.
The plug must have a data type of MFnNumericData.k3Double.
* scaleCenterPlug (MPlug) - The plug to connect the scale center to
OpenMayaUI.MFnScaleManip.connectToScalePlug
(
)
connectToScalePlug(scalePlug) -> self
Create a 1-1 connection from the scale manipVal to the scalePlug parameter. Any changes to the scale manipVal will be immediately reflected in the connected plug. Connecting to the "scale" plug on a transform node will produce similar behavior to the built-in scale manipulator.
The plug must have a data type of MFnNumericData.k3Double.
* scalePlug (MPlug) - The plug to connect the scale value to
OpenMayaUI.MFnScaleManip.create
(
)
create(manipName=None, scaleName=None) -> MObject
Creates a new ScaleManip, and attaches this function set to the new manipulator.
This method should only be used to create a non-composite manipulator, meaning that the manipulator is standalone and not part of a container.
When the manipulator is being used, the feedback line will display a string including scaleName, indicating that this manipulator is in use.
* manipName (string) - Name of the manip for UI purposes.
* scaleName (string) - Label for the scale value displayed in the feedback line.
OpenMayaUI.MFnScaleManip.displayWithNode
(
)
displayWithNode(node) -> self
Configures the manipulator to display with the node, causing the position of the manipulator to follow the position of the node whenever the node is moved. The node must be a DAG object.
* node (MObject) - The node the manipulator should display with
OpenMayaUI.MFnScaleManip.scaleCenterIndex
(
)
scaleCenterIndex() -> int
Returns the index of the scale center manipVal for this manipulator.
Note that the scale center is only used for display of the manipulator and has no effect on scale values produced by the manipulator.
OpenMayaUI.MFnScaleManip.scaleIndex
(
)
scaleIndex() -> int
Returns the index of the scale manipVal for this manipulator.
OpenMayaUI.MFnScaleManip.setInitialScale
(
)
setInitialScale(scale) -> self
Sets the initial scale for the scale manipulator. Setting the initial scale will prevent the manipulator from jumping back to the default scale when there is already an existing scale on the target plug.
* scale (MVector) - The initial scale
Property Documentation
OpenMayaUI.MFnScaleManip.isSnapModeOn
static
Whether or not the snap mode is on.
OpenMayaUI.MFnScaleManip.orientation
static
The arbitrary orientation of the MFnScaleManip. This only has any effect when the orientation mode is set to kArbitraryOrientation.
OpenMayaUI.MFnScaleManip.orientationMode
static
When the manipulator's orientationMode is set to kArbitraryOrientation the manipulator will be oriented according to oritentation value. When the orientationMode is set to kDefaultOrientation the manipulator will be aligned with the world-space axes.
OpenMayaUI.MFnScaleManip.snapIncrement
static
The snap increment is specified in the working unit, and is the distance between snap points when dragging the scale handles.