The CircleSweepManip allows the user to manipulate a point constrained to move around a circle, in order to specify a sweep angle. This manipulator generates a single floating point value corresponding to the sweep angle.
Method resolution order:
- MFnCircleSweepManip
- MFnManip3D
- OpenMaya.MFnTransform
- OpenMaya.MFnDagNode
- OpenMaya.MFnDependencyNode
- OpenMaya.MFnBase
- builtins.object
Constructor & Destructor Documentation
OpenMayaUI.MFnCircleSweepManip.__init__
(
)
Initialize self. See help(type(self)) for accurate signature.
Member Function Documentation
OpenMayaUI.MFnCircleSweepManip.__new__
(
)
static
Create and return a new object. See help(type) for accurate signature.
OpenMayaUI.MFnCircleSweepManip.angleIndex
(
)
angleIndex() -> int
Returns the index for the angle of CircleSweepManip. The data type corresponding to this index is a double.
OpenMayaUI.MFnCircleSweepManip.axisIndex
(
)
axisIndex() -> int
Returns the index for the axis of CircleSweepManip. The data type corresponding to this index is MFnNumericData.k3Double.
OpenMayaUI.MFnCircleSweepManip.centerIndex
(
)
centerIndex() -> int
Returns the index for the center of the CircleSweepManip. The data type corresponding to this index is MFnNumericData.k3Double.
OpenMayaUI.MFnCircleSweepManip.connectToAnglePlug
(
)
connectToAnglePlug(anglePlug) -> self
Connect to the angle plug. The data type corresponding to the anglePlug is a double. (Note that MFnUnitAttribute.kAngle is used to specify an angle attribute.)
* anglePlug (MPlug) - the angle plug
OpenMayaUI.MFnCircleSweepManip.create
(
)
create(manipName=None, angleName=None) -> MObject
Creates a new CircleSweepManip.
This function set's object is set to be the new manipulator.
This method should only be used to create a non-composite CircleSweepManip.
The name that appears in the feedback line is specified by the angleName argument.
* manipName (string) - Name of the manip for UI purposes.
* angleName (string) - Label for the angle value which appears in the feedback line.
OpenMayaUI.MFnCircleSweepManip.endCircleIndex
(
)
endCircleIndex() -> int
Returns the index for the end of the circle of CircleSweepManip. The data type corresponding to this index is a double.
OpenMayaUI.MFnCircleSweepManip.setAngle
(
)
setAngle(angle) -> self
Sets the angle of the CircleSweepManip.
* angle (MAngle) - the angle of the CircleSweepManip
OpenMayaUI.MFnCircleSweepManip.setCenterPoint
(
)
setCenterPoint(centerPoint) -> self
Sets the center point of the CircleSweepManip.
* centerPoint (MPoint) - the center point of the CircleSweepManip
OpenMayaUI.MFnCircleSweepManip.setDrawAsArc
(
)
setDrawAsArc(state) -> self
Sets whether or not to draw as arc.
* state (bool) - whether or not to draw as arc
OpenMayaUI.MFnCircleSweepManip.setNormal
(
)
setNormal(normal) -> self
Sets the normal of the CircleSweepManip.
* normal (MVector) - the normal of the CircleSweepManip
OpenMayaUI.MFnCircleSweepManip.setRadius
(
)
setRadius(radius) -> self
Sets the radius of the CircleSweepManip.
* radius (float) - the radius of the CircleSweepManip
OpenMayaUI.MFnCircleSweepManip.startCircleIndex
(
)
startCircleIndex() -> int
Returns the index for the start of the circle of CircleSweepManip. The data type corresponding to this index is a double.