Python API 2.0 Reference: OpenMayaUI.MFnScaleManip Class Reference

+ Inheritance diagram for OpenMayaUI.MFnScaleManip:

Public Member Functions

__init__ ()
 
connectToScaleCenterPlug ()
 
connectToScalePlug ()
 
create ()
 
displayWithNode ()
 
scaleCenterIndex ()
 
scaleIndex ()
 
setInitialScale ()
 
- Public Member Functions inherited from OpenMayaUI.MFnManip3D
__init__ ()
 
rotateXYZValue ()
 
- Public Member Functions inherited from OpenMaya.MFnTransform
__init__ ()
 
clearRestPosition ()
 
create ()
 
enableLimit ()
 
isLimited ()
 
limitValue ()
 
resetFromRestPosition ()
 
restPosition ()
 
rotateBy ()
 
rotateByComponents ()
 
rotateOrientation ()
 
rotatePivot ()
 
rotatePivotTranslation ()
 
rotation ()
 
rotationComponents ()
 
rotationOrder ()
 
scale ()
 
scaleBy ()
 
scalePivot ()
 
scalePivotTranslation ()
 
setLimit ()
 
setRestPosition ()
 
setRotateOrientation ()
 
setRotatePivot ()
 
setRotatePivotTranslation ()
 
setRotation ()
 
setRotationComponents ()
 
setRotationOrder ()
 
setScale ()
 
setScalePivot ()
 
setScalePivotTranslation ()
 
setShear ()
 
setTransformation ()
 
setTranslation ()
 
shear ()
 
shearBy ()
 
transformation ()
 
translateBy ()
 
translation ()
 
- Public Member Functions inherited from OpenMaya.MFnDagNode
__init__ ()
 
addChild ()
 
child ()
 
childCount ()
 
create ()
 
dagPath ()
 
dagRoot ()
 
duplicate ()
 
fullPathName ()
 
getAllPaths ()
 
getConnectedSetsAndMembers ()
 
getPath ()
 
hasChild ()
 
hasParent ()
 
instanceCount ()
 
isChildOf ()
 
isInstanced ()
 
isInstancedAttribute ()
 
isParentOf ()
 
parent ()
 
parentCount ()
 
partialPathName ()
 
removeChild ()
 
removeChildAt ()
 
setObject ()
 
transformationMatrix ()
 
- Public Member Functions inherited from OpenMaya.MFnDependencyNode
__init__ ()
 
absoluteName ()
 
addAttribute ()
 
addExternalContentForFileAttr ()
 
affectsAnimation ()
 
attribute ()
 
attributeClass ()
 
attributeCount ()
 
canBeWritten ()
 
create ()
 
dgCallbackIds ()
 
dgCallbacks ()
 
dgTimer ()
 
dgTimerOff ()
 
dgTimerOn ()
 
dgTimerQueryState ()
 
dgTimerReset ()
 
findAlias ()
 
findPlug ()
 
getAffectedAttributes ()
 
getAffectingAttributes ()
 
getAliasAttr ()
 
getAliasList ()
 
getConnections ()
 
getExternalContent ()
 
hasAttribute ()
 
hasUniqueName ()
 
isFlagSet ()
 
isNewAttribute ()
 
isTrackingEdits ()
 
name ()
 
plugsAlias ()
 
removeAttribute ()
 
reorderedAttribute ()
 
setAffectsAnimation ()
 
setAlias ()
 
setDoNotWrite ()
 
setExternalContent ()
 
setExternalContentForFileAttr ()
 
setFlag ()
 
setName ()
 
setUuid ()
 
userNode ()
 
uuid ()
 
- Public Member Functions inherited from OpenMaya.MFnBase
__init__ ()
 
hasObj ()
 
object ()
 
setObject ()
 
type ()
 

Static Public Attributes

int kArbitraryOrientation = 1
 
int kDefaultOrientation = 0
 
- Static Public Attributes inherited from OpenMaya.MFnTransform
int kRotateMaxX = 13
 
int kRotateMaxY = 15
 
int kRotateMaxZ = 17
 
int kRotateMinX = 12
 
int kRotateMinY = 14
 
int kRotateMinZ = 16
 
int kScaleMaxX = 1
 
int kScaleMaxY = 3
 
int kScaleMaxZ = 5
 
int kScaleMinX = 0
 
int kScaleMinY = 2
 
int kScaleMinZ = 4
 
int kShearMaxXY = 7
 
int kShearMaxXZ = 9
 
int kShearMaxYZ = 11
 
int kShearMinXY = 6
 
int kShearMinXZ = 8
 
int kShearMinYZ = 10
 
int kTranslateMaxX = 19
 
int kTranslateMaxY = 21
 
int kTranslateMaxZ = 23
 
int kTranslateMinX = 18
 
int kTranslateMinY = 20
 
int kTranslateMinZ = 22
 
- Static Public Attributes inherited from OpenMaya.MFnDagNode
int kNextPos = 255
 
- Static Public Attributes inherited from OpenMaya.MFnDependencyNode
int kTimerMetrics = 9
 
int kTimerTypes = 3
 
int kExtensionAttr = 3
 
int kInvalidAttr = 4
 
int kLocalDynamicAttr = 1
 
int kNormalAttr = 2
 
int kTimerInvalidState = 3
 
int kTimerOff = 0
 
int kTimerOn = 1
 
int kTimerUninitialized = 2
 
int kTimerMetric_callback = 0
 
int kTimerMetric_callbackNotViaAPI = 6
 
int kTimerMetric_callbackViaAPI = 5
 
int kTimerMetric_compute = 1
 
int kTimerMetric_computeDuringCallback = 7
 
int kTimerMetric_computeNotDuringCallback = 8
 
int kTimerMetric_dirty = 2
 
int kTimerMetric_draw = 3
 
int kTimerMetric_fetch = 4
 
int kTimerType_count = 2
 
int kTimerType_inclusive = 1
 
int kTimerType_self = 0
 

Properties

 isSnapModeOn
 
 orientation
 
 orientationMode
 
 snapIncrement
 
- Properties inherited from OpenMayaUI.MFnManip3D
 isOptimizePlaybackOn
 
 isVisible
 
 manipScale
 
- Properties inherited from OpenMaya.MFnDagNode
 boundingBox
 
 inModel
 
 inUnderWorld
 
 isInstanceable
 
 isIntermediateObject
 
 objectColor
 
 objectColorRGB
 
 objectColorType
 
 useObjectColor
 
- Properties inherited from OpenMaya.MFnDependencyNode
 isDefaultNode
 
 isFromReferencedFile
 
 isLocked
 
 isShared
 
 namespace
 
 pluginName
 
 typeId
 
 typeName
 

Additional Inherited Members

- Static Public Member Functions inherited from OpenMayaUI.MFnManip3D
deleteManipulator ()
 
drawPlaneHandles ()
 
globalSize ()
 
handleSize ()
 
lineSize ()
 
setDrawPlaneHandles ()
 
setGlobalSize ()
 
setHandleSize ()
 
setLineSize ()
 
- Static Public Member Functions inherited from OpenMaya.MFnDependencyNode
allocateFlag ()
 
classification ()
 
deallocateAllFlags ()
 
deallocateFlag ()
 

Detailed Description

This class provides access to the built-in Maya scale manipulator.

Method resolution order:
-   MFnScaleManip
-   MFnManip3D
-   OpenMaya.MFnTransform
-   OpenMaya.MFnDagNode
-   OpenMaya.MFnDependencyNode
-   OpenMaya.MFnBase
-   __builtin__.object

Constructor & Destructor Documentation

OpenMayaUI.MFnScaleManip.__init__ ( )
x.__init__(...) initializes x; see x.__class__.__doc__ 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.