splineIK.create module

class splineIK.create.SplineIK

Bases: splineIK.settings.Settings

The Spline IK module works on a curve and generates an joint chain that sticks to it’s position on the curve. This means that stretch and squash will only occur in the areas that manipulates as opposed to it scaling as a whole.

The other benefit of using this module over a regular spline IK is the fact that the twist is divided over the controls that are generated and not just limited to the beginning and end.

Once the class is initialized the user can change attributes that are defined in the rjSplineIK.settings.Settings class that gets inherited.

Once the user parameters are set the SplineIK.create() can be ran.

controls
Returns:list of all tweak controls
Return type:list
create(name, curve_, numJoints, upDirection='y', worldUpDirection='y', forwardDirection='x')

Create the spline IK, besides changing attributes from the Settings class, the create function itself can also be parsed with various variables to customise the result.

Parameters:
  • name – name that is used to prefix all nodes
  • curve – curve to attach the Spline IK to.
  • numJoints – number of joints to be distributed on the curve
  • upDirection – “x”, “y” or “z”, default “y”
  • worldUpDirection – “x”, “y” or “z”, default “y”
  • forwardDirection – “x”, “y” or “z”, default “x”
curve
Returns:name of the curve to attach the ik to
Return type:str
curveShape
Returns:first shape of the curve
Return type:str
joints
Returns:list of joints that are attached to the curve
Return type:list
name
Returns:name to use while creating the spline ik
Return type:str
rootControl
Returns:name of root control
Return type:str
rootJoint
Returns:name of root joint
Return type:str
slideControl
Returns:name of slide control
Return type:str
slideMaxControl
Returns:name of slide control ( max )
Return type:str
slideMinControl
Returns:name of slide control ( min )
Return type:str
tangentControls
Returns:list of all tangent controls
Return type:list