The DistanceManip allows the user to manipulate a point that is constrained to move along a line. This manipulator generates a single floating point value. Scaling factors can be used to determine how the manipulator appears when it is drawn.
Method resolution order:
- MFnDistanceManip
- MFnManip3D
- OpenMaya.MFnTransform
- OpenMaya.MFnDagNode
- OpenMaya.MFnDependencyNode
- OpenMaya.MFnBase
- builtins.object
Constructor & Destructor Documentation
OpenMayaUI.MFnDistanceManip.__init__
(
)
Initialize self. See help(type(self)) for accurate signature.
Member Function Documentation
OpenMayaUI.MFnDistanceManip.__new__
(
)
static
Create and return a new object. See help(type) for accurate signature.
OpenMayaUI.MFnDistanceManip.connectToDistancePlug
(
)
connectToDistancePlug(directionPlug) -> self
Connect to the distance plug. The data type corresponding to the distancePlug is a double. (Note that MFnUnitAttribute.kDistance is used to specify a distance attribute.)
* distancePlug (MPlug) - the distance plug
OpenMayaUI.MFnDistanceManip.create
(
)
create(manipName=None, distanceName=None) -> MObject
Creates a new DistanceManip.
This function set's object is set to be the new manipulator.
This method should only be used to create a non-composite DistanceManip.
The name that appears in the feedback line is specified by the distanceName argument.
* manipName (string) - Name of the manip for UI purposes.
* distanceName (string) - Label for the distance value which appears in the feedback line.
OpenMayaUI.MFnDistanceManip.currentPointIndex
(
)
currentPointIndex() -> int
Returns the index of the current point of the DistanceManip. The data type corresponding to this index is MFnNumericData.k3Double.
OpenMayaUI.MFnDistanceManip.directionIndex
(
)
directionIndex() -> int
Returns the index of the direction. The data type corresponding to this index is MFnNumericData.k3Double.
OpenMayaUI.MFnDistanceManip.distanceIndex
(
)
distanceIndex() -> int
Returns the index of the distance. The data type corresponding to this index is a double.
OpenMayaUI.MFnDistanceManip.setDirection
(
)
setDirection(direction) -> self
Sets the direction of the DistanceManip.
* direction (MVector) - the direction of the DistanceManip
OpenMayaUI.MFnDistanceManip.setStartPoint
(
)
setStartPoint(startPoint) -> self
Sets the start point of the DistanceManip.
* startPoint (MPoint) - the start point of the DistanceManip
OpenMayaUI.MFnDistanceManip.startPointIndex
(
)
startPointIndex() -> int
Returns the index of the start point of the DistanceManip. The data type corresponding to this index is MFnNumericData.k3Double.
Property Documentation
OpenMayaUI.MFnDistanceManip.isDrawLineOn
static
Whether or not to draw a line from the start to the end of the DistanceManip.
By default the line is drawn.
OpenMayaUI.MFnDistanceManip.isDrawStartOn
static
Whether or not the start of the DistanceManip is being drawn.
By default the start is not drawn.
OpenMayaUI.MFnDistanceManip.scalingFactor
static
The scaling factor is used to determine how int the DistanceManip appears when it is drawn.
The default scaling factor is 1.0.