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

Synopsis

cpProperty([addVerts=boolean], [assign=propertyName], [help=boolean], [indexList=[string, string]], [list=boolean], [listMeshNodes=string], [listSets=boolean], [name=propertyName], [query=boolean], [reassign=propertySetName], [remove=boolean], [removeVerts=boolean])

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

cpProperty is undoable, queryable, and editable.

This command creates or assignes a property node.

Flags

addVerts, assign, help, indexList, list, listMeshNodes, listSets, name, query, reassign, remove, removeVerts
Long name (short name) [argument types] Properties
help(h) boolean create
Prints a quick help message.
assign(a) propertyName edit
This option assigns the property with the given name to the set of selected panels.
reassign(ra) propertySetName edit
This option assigns the selection to the existing property set node. This is useful for assigning an alterative set of vertices to an existing property set. The selected vertices must belong to the same mesh that the property was previously assigned.
addVerts(add) boolean edit
This flag can be used with the -reassign flag to specify that that the given selection list should be added to the property set versus the default action of replace.
removeVerts(rv) boolean edit
This flag can be used with the -reassign flag to specify that the selected vertices should be removed from the property set.
remove(r) boolean edit
Remove the property nodes from the selected items. This removes the controller node connection from the solver. It does not delete the node.
list(l) boolean query
This option returns the names of the property nodes that are in the scene.

In query mode, this flag needs a value.

listSets(ls) boolean query
List the property sets in the scene.

In query mode, this flag needs a value.

indexList(il) [string, string] query
Show the index list for the given property set and mesh. The property set is the first argument and the mesh is the second argment. If the mesh is not attached to the property set nothing is returned.

In query mode, this flag needs a value.

listMeshNodes(lmn) string query
Show the mesh nodes that belongs to the given property set.

In query mode, this flag needs a value.

name(n) propertyName create
This option uses the given name when creating a property.
query(q) boolean query
This option requires a property to be selected and specifies that the command is a query.

In query mode, this flag needs a value.


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


The new property node name.

Related

cpButton, cpCollision, cpConstraint, cpPanel, cpSeam, cpSolver, cpTool