Skip to content

controlShapes

=== Author: Assaf Ben Zur ===

Core control shapes creation function assembly.

A main CtrlCreate function calls a veriaty of pre-defined shape creation, then handles them

Defenitions

arrowDodecagonShapeCreate

Constructor: arrowDodecagonShapeCreate(**kwargs)
Return: None
Arguments:
  • **kwargs
Keyword Arguments:

arrowShapeCreate

Constructor: arrowShapeCreate(**kwargs)
Return: None
Arguments:
  • **kwargs
Keyword Arguments:

arrowSquareShapeCreate

Constructor: arrowSquareShapeCreate(**kwargs)
Return: None
Arguments:
  • **kwargs
Keyword Arguments:

batchCreateAllControlShapes

Constructor: batchCreateAllControlShapes(**kwargs)
Return: list (MnsNameStd, created shapes)
Arguments:
  • **kwargs
Keyword Arguments:
  • side(str) ; [default: c]
  • color(tuple) ; [default: (0.0, 1.0, 0.0)]

batchCreateAllControlShapesIcons

Constructor: batchCreateAllControlShapesIcons()
Return: None
Arguments:
Keyword Arguments:

bubblePinShapeCreate

Constructor: bubblePinShapeCreate(**kwargs)
Return: None
Arguments:
  • **kwargs
Keyword Arguments:

circleShapeCreate

Constructor: circleShapeCreate(**kwargs)
Return: None
Arguments:
  • **kwargs
Keyword Arguments:
  • sections(int) ; [default: 8]

coneShapeCreate

Constructor: coneShapeCreate(**kwargs)
Return: None
Arguments:
  • **kwargs
Keyword Arguments:

createMirrorGroup

Constructor: createMirrorGroup(nameStd, symmetryType = 0)
Return: None
Arguments:
  • nameStd
  • symmetryType(int) ; [default: 0]
Keyword Arguments:

createOffsetRigMasterAttrForTransform

Constructor: createOffsetRigMasterAttrForTransform(ctrl = None, **kwargs)
Return: None
Arguments:
  • ctrl(str) ; [default: None]
  • **kwargs
Keyword Arguments:
  • offsetRigMaster(str) ; [default: None] - If passed in, an attribute connecting the master joint to the control will be created.

createRemoteControlStyleCtrl

creates a frames ui remote-control style ctrl based on the input params.


Constructor: createRemoteControlStyleCtrl(**kwargs)
Return: MnsNameStd (ctrl), MnsNameStd (uiOffsetGrp), MnsNameStd (Frame)
Arguments:
  • **kwargs
Keyword Arguments:
  • horizontalMin(float) ; [default: -1.0]
  • horizontalMax(float) ; [default: 1.0]
  • verticalMin(float) ; [default: -1.0]
  • verticalMax(float) ; [default: 1.0]
  • bodySuffix(str)
  • uiScale(float) ; [default: 1.0]

crossShapeCreate

Constructor: crossShapeCreate(**kwargs)
Return: None
Arguments:
  • **kwargs
Keyword Arguments:

ctrlCreate

Main creation function.

This function takes user defined parameters and creates a ctrl transform node following the mns naming convention.

Based on the choice passed in, a shape node will be created with the shape selected, and will be parented under the transform ceated.

Then a color selected will be assigned to it.

The ctrl can be set to be created along all axes and in every color.

The default color is white when used as standalone, and based on the rig's global color coding defined- based on the side flag.


Constructor: ctrlCreate(**kwargs)
Return: MnsNameStd (MnsNameStd class instance containing all info for the new node created)
Arguments:
  • **kwargs
Keyword Arguments:
  • side(str) ; [default: side] - side flag
  • body(str) ; [default: body] - Node's name body
  • alpha(str) ; [default: alpha] - Node's Alpha id
  • id(str) ; [default: id] - Node's id
  • isFacial(bool)
  • bodySuffix(str)
  • incrementAlpha(bool) - In case of a 'free' creation, if True will name the node to the first possible name- searching for new Alpha instead of the ID
  • ctrlType(str) ; [default: ctrl]
  • createBlkClassID(bool) ; [default: True]
  • createBlkCtrlTypeID(bool) ; [default: True]
  • blkCtrlTypeID(int)
  • customParentTransform(str)
  • skipColor(bool)
  • createOffsetGrp(bool)
  • createSpaceSwitchGroup(bool)
  • symmetryType(int)
  • doMirror(bool)
  • forceMirrorGrp(bool)
  • parentNode(str) ; [default: None]
  • chennelControl(str) ; [default: None]
  • controlShape(str) ; [default: circle] - Control's NURBS shape
  • scale(float) ; [default: 1.0] - Ctrl scale. Relative to global settings.
  • color(tuple) ; [default: (1.0, 1.0, 1.0)] - Shape's color
  • alongAxis(int) ; [default: 1] - Along which axis to create the shape
  • matchTransform(str) - if not empty, look for a node within the scene matching the string specefied. If found, match it's transforms.
  • freezeScale(bool)
  • matchScale(bool)
  • matchPosition(str) - if not empty, look for a node within the scene matching the string specefied. If found, match it's position.
  • matchOrientation(str) - if not empty, look for a node within the scene matching the string specefied. If found, match it's Orientation.
  • sections(int) ; [default: 1] - Aplicable only for circle creation
  • offsetRigMaster(str) ; [default: None] - If passed in, an attribute connecting the master joint to the control will be created.

cubeShapeCreate

Constructor: cubeShapeCreate(**kwargs)
Return: None
Arguments:
  • **kwargs
Keyword Arguments:

curvedFourArrowShapeCreate

Constructor: curvedFourArrowShapeCreate(**kwargs)
Return: None
Arguments:
  • **kwargs
Keyword Arguments:

cylinderShapeCreate

Constructor: cylinderShapeCreate(**kwargs)
Return: None
Arguments:
  • **kwargs
Keyword Arguments:

dialRoundShapeCreate

Constructor: dialRoundShapeCreate(**kwargs)
Return: None
Arguments:
  • **kwargs
Keyword Arguments:

dialShapeCreate

Constructor: dialShapeCreate(**kwargs)
Return: None
Arguments:
  • **kwargs
Keyword Arguments:

dialSquareShapeCreate

Constructor: dialSquareShapeCreate(**kwargs)
Return: None
Arguments:
  • **kwargs
Keyword Arguments:

diamondShapeCreate

Constructor: diamondShapeCreate(**kwargs)
Return: None
Arguments:
  • **kwargs
Keyword Arguments:

directionCircle

Constructor: directionCircle(**kwargs)
Return: None
Arguments:
  • **kwargs
Keyword Arguments:

directionCubeShape

Constructor: directionCubeShape(**kwargs)
Return: None
Arguments:
  • **kwargs
Keyword Arguments:

directionDiamond

Constructor: directionDiamond(**kwargs)
Return: None
Arguments:
  • **kwargs
Keyword Arguments:

directionSphereShape

Constructor: directionSphereShape(**kwargs)
Return: None
Arguments:
  • **kwargs
Keyword Arguments:

dodecagonShapeCreate

Constructor: dodecagonShapeCreate(**kwargs)
Return: None
Arguments:
  • **kwargs
Keyword Arguments:

doubleArrowShapeCreate

Constructor: doubleArrowShapeCreate(**kwargs)
Return: None
Arguments:
  • **kwargs
Keyword Arguments:

flatDiamondRootShapeCreate

Constructor: flatDiamondRootShapeCreate(**kwargs)
Return: None
Arguments:
  • **kwargs
Keyword Arguments:

flatDiamondShapeCreate

Constructor: flatDiamondShapeCreate(**kwargs)
Return: None
Arguments:
  • **kwargs
Keyword Arguments:

fourArrowShapeCreate

Constructor: fourArrowShapeCreate(**kwargs)
Return: None
Arguments:
  • **kwargs
Keyword Arguments:

guidesRootShape

Constructor: guidesRootShape(**kwargs)
Return: None
Arguments:
  • **kwargs
Keyword Arguments:

hexagonShapeCreate

Constructor: hexagonShapeCreate(**kwargs)
Return: None
Arguments:
  • **kwargs
Keyword Arguments:

lightSphereShapeCreate

Constructor: lightSphereShapeCreate(**kwargs)
Return: None
Arguments:
  • **kwargs
Keyword Arguments:

octagonShapeCreate

Constructor: octagonShapeCreate(**kwargs)
Return: None
Arguments:
  • **kwargs
Keyword Arguments:

pickShapeCreate

Constructor: pickShapeCreate(**kwargs)
Return: None
Arguments:
  • **kwargs
Keyword Arguments:

pinShapeCreate

Constructor: pinShapeCreate(**kwargs)
Return: None
Arguments:
  • **kwargs
Keyword Arguments:
  • light(bool) ; [default: True]

pinchedCircleShapeCreate

Constructor: pinchedCircleShapeCreate(**kwargs)
Return: None
Arguments:
  • **kwargs
Keyword Arguments:

plusShapeCreate

Constructor: plusShapeCreate(**kwargs)
Return: None
Arguments:
  • **kwargs
Keyword Arguments:

pointArrowShapeCreate

Constructor: pointArrowShapeCreate(**kwargs)
Return: None
Arguments:
  • **kwargs
Keyword Arguments:

puppetRootShapeCreate

Constructor: puppetRootShapeCreate(**kwargs)
Return: None
Arguments:
  • **kwargs
Keyword Arguments:

pyramidShapeCreate

Constructor: pyramidShapeCreate(**kwargs)
Return: None
Arguments:
  • **kwargs
Keyword Arguments:

sphereShapeCreate

Constructor: sphereShapeCreate(**kwargs)
Return: None
Arguments:
  • **kwargs
Keyword Arguments:

squareRoundShapeCreate

Constructor: squareRoundShapeCreate(**kwargs)
Return: None
Arguments:
  • **kwargs
Keyword Arguments:

squareShapeCreate

Constructor: squareShapeCreate(**kwargs)
Return: None
Arguments:
  • **kwargs
Keyword Arguments:

squareWithMidDividersShapeCreate

Constructor: squareWithMidDividersShapeCreate(**kwargs)
Return: None
Arguments:
  • **kwargs
Keyword Arguments:

teardropShapeCreate

Constructor: teardropShapeCreate(**kwargs)
Return: None
Arguments:
  • **kwargs
Keyword Arguments:

textShapeCreate

Constructor: textShapeCreate(text = "")
Return: None
Arguments:
  • text(str) ; [default: ""]
Keyword Arguments:

triangleShapeCreate

Constructor: triangleShapeCreate(**kwargs)
Return: None
Arguments:
  • **kwargs
Keyword Arguments:

tripleArrowShapeCreate

Constructor: tripleArrowShapeCreate(**kwargs)
Return: None
Arguments:
  • **kwargs
Keyword Arguments: