Go to: Synopsis. Flags. Return value. Related.

Synopsis

cpConstraint( [objects ...] , [assigner=[assigner, type]], [help=boolean], [name=objectName], [type=[type, name]])

Note: Strings representing object names and arguments must be separated by commas. This is not depicted in the synopsis.

cpConstraint is undoable, queryable, and editable.

This command creates a constraint on a cloth mesh. The use of this command requires multiple selection. One selection is an object which will act as the constraint. The other selection is either a group of cloth vertices to be constrained, or a curve on the cloth panel. There are currently 5 types of constraints: 1. Transform constraint, which constrains a set of cloth vertices to follow another object's transform. 2. Mesh constraint, which constrains a set of cloth vertices to follow a set of triangles of a rigid body. 3. Field constraint, which affects a set of cloth vertices by a dynamics field. 4. Cloth constraint, which constrains points on one cloth to the triangles of another cloth (or the same cloth).

Flags

assigner, help, name, type
Long name (short name) [argument types] Properties
help(h) boolean create
Prints a quick help message.
type(t) [type, name] create
Specifies the type of constraint target. Currently, the type name must be cloth, transform, mesh, or field. The default value is transform. Type names: [cloth|field|mesh|transform|resimulation]
assigner(a) [assigner, type] create
Specifies the type of assigner: points or curve. A curve assigner allows you to pick a construction curve that was used to make a cloth panel, and a target object. The point assigner allows you to pick a set of points on cloth and a target. Assigner types: [point|curve]. If you have 2 objects selected, then the default is curve. If you have 1 non-component object selected, then the default is point.
name(n) objectName create
Specifies the name of the constraint object transform. The actual shape name will be objectNameShape.

Flag can appear in Create mode of command Flag can appear in Edit mode of command
Flag can appear in Query mode of command Flag can have multiple arguments, passed either as a tuple or a list.

Return value


Name of constraint. (string)

Related

cpButton, cpCollision, cpPanel, cpProperty, cpSeam, cpSolver, cpTool