OpenMayaUI.MFnCircleSweepManip Class Reference

OpenMayaUI.MFnCircleSweepManip Class Reference
+ Related help topics:

Class Description

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
-   __builtin__.object
+ Inheritance diagram for OpenMayaUI.MFnCircleSweepManip:

Public Member Functions

__init__ ()
 
angleIndex ()
 
axisIndex ()
 
centerIndex ()
 
connectToAnglePlug ()
 
create ()
 
endCircleIndex ()
 
setAngle ()
 
setCenterPoint ()
 
setDrawAsArc ()
 
setNormal ()
 
setRadius ()
 
startCircleIndex ()
 
- 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 ()
 
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 ()
 
setAlias ()
 
setDoNotWrite ()
 
setExternalContent ()
 
setExternalContentForFileAttr ()
 
setFlag ()
 
setName ()
 
setUuid ()
 
userNode ()
 
uuid ()
 
- Public Member Functions inherited from OpenMaya.MFnBase
__init__ ()
 
hasObj ()
 
object ()
 
setObject ()
 
type ()
 

Properties

 endPoint
 
 startPoint
 
- 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 ()
 
- 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
 

Constructor & Destructor Documentation

OpenMayaUI.MFnCircleSweepManip.__init__ ( )
x.__init__(...) initializes x; see help(type(x)) for signature

Member Function Documentation

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.

Property Documentation

OpenMayaUI.MFnCircleSweepManip.endPoint
static
 The end point of the CircleSweepManip.
OpenMayaUI.MFnCircleSweepManip.startPoint
static
 The start point of the CircleSweepManip.