cpProperty

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

Synopsis

cpProperty [-addVerts] [-assign propertyName] [-help] [-indexList string string] [-list] [-listMeshNodes string] [-listSets] [-name propertyName] [-reassign propertySetName] [-remove] [-removeVerts]

cpProperty is undoable, queryable, and editable.

Return value

string The new property node name.

In query mode, return type is based on queried flag.

Related

Flags

Long name (short name)	argument types	Properties
-help(-h)
Prints a quick help message.
-assign(-a)	propertyName
This option assigns the property with the given name to the set of selected panels.
-reassign(-ra)	propertySetName
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)
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)
This flag can be used with the -reassign flag to specify that the selected vertices should be removed from the property set.
-remove(-r)
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)
This option returns the names of the property nodes that are in the scene.
-listSets(-ls)
List the property sets in the scene.
-indexList(-il)	string string
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.
-listMeshNodes(-lmn)	string
Show the mesh nodes that belongs to the given property set.
-name(-n)	propertyName
This option uses the given name when creating a property.

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 be used more than once in a command

MEL examples

// Create a new property in the scene.
cpProperty;

// List all property nodes in the scene.
cpProperty -q -list;

// Assign named property to a set of one or more selected panels.
cpProperty -assign shirtProperty;