polyPinUV

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

Synopsis

polyPinUV [-createHistory boolean] [-operation uint] [-unpinned boolean] [-uvSetName string] [-value float]

polyPinUV is undoable, queryable, and editable.

This command is used to pin and unpin UVs. A "pinned" UV is one which should not be modified.

Each UV has an associated pin weight, that defaults to 0.0 meaning that the UV is not pinned. If pin weight is set to 1.0 then it becomes fully pinned and UV tools should not modify that UV. If the pin weight is set to a value between 0.0 and 1.0 then UV tools should weight their changes to that UV accordingly.

UV pinning is not enforced by the shape node: it is up to each tool to decide whether it will obey the pin weights.

Return value

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

Keywords

Flags

Long name (short name)	Argument types	Properties
-createHistory(-ch)	boolean
For objects that have no construction history, this flag can be used to force the creation of construction history for pinning. By default, history is not created if the object has no history. Regardless of this flag, history is always created if the object already has history.
-operation(-op)	uint
Operation to perform. Valid values are: 0: Set pin weights on the selected UVs. 1: Set pin weights to zero for the selected UVs. 2: Remove pin weights from the entire mesh. 3: Invert pin weights of the entire mesh. Default is 0.
-unpinned(-unp)	boolean
List all selected UVs which are not pinned.
-uvSetName(-uvs)	string
Specifies the name of the UV set to edit UVs on. If not specified the current UV set will be used if it exists.
-value(-v)	float
Specifies the pin value for the selected UV components. When specified multiple times, the values are assigned respectively to the specified UVs.

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

// To set a pin value of 0.9 on the selected UVs
polyPinUV -value 0.9;

// List all selected UVs which are not pinned
polyPinUV -q -unpinned;