Description

Sets labeling options that control how a label is applied to a trajectory, which character is being labeled, what label is being applied, etc.

This command is executed when options are changed in the Label Options section of the Labeling panel.

This command adds some functionality that is not in the Labeling panel and may be useful to hot key or add to a marking menu.

Functional area

Data editing

Command syntax

Syntax

labelOptions [-nextChar] [-prevChar] [-charParent] [-nextLabel] [-prevLabel] [-mode string] [-direction string] [-type string] [-advance boolean] [-curChar string] [-curLabel string] [-cliffTol float] [-cliffMaxGap integer] [-hide boolean] [-labelRadiusOffset float] [-unlabelRadiusOffset float] [-loadActors boolean] [-snapToSelection] [-nextUnlabeled] [-prevUnlabeled] [-autoVelocity boolean] [-advanceUnlabeled boolean] [-followSelection boolean] [-restoreDefaultSettings]

Arguments

None

Flags

Name	Flag arguments	Argument type	Exclusive to	Comments
`nextChar`	0	—	prevChar, charParent, curChar	Sets the character to be labeled to the next character.
`prevChar`	0	—	nextChar, charParent, curChar	Sets the character to be labeled to the previous character.
`charParent`	0	—	nextChar, prevChar, curChar	Sets the character parent of the first selected marker to be the character to be labeled.
`nextLabel`	0	—	prevLabel, curLabel, nextUnlabeled, prevUnlabeled	Sets the name the unlabeled marker is labeled as to the next label in the list.
`prevLabel`	0	—	nextLabel, curLabel, nextUnlabeled, prevUnlabeled	Sets the name the unlabeled marker is labeled as to the previous label in the list.
`mode`	1	string	—	Specifies how the current label advances through the labels list after applying a labeling.
`direction`	1	string	—	Specifies if a label made at the current frame is extended to the trajectory start and/or end frames.
`type`	1	string	—	Specifies how a label made at the current frame extends to the trajectory start and end. If the markers are packed, also specifies if the label applies to other trajectories on the marker being labeled.
`advance`	1	boolean	—	Specifies if the current label in the label list advances after performing a label.
`curChar`	1	string	nextChar, prevChar, charParent	Specifies the character to label by name. If you specify a subject other than the current one, the Use Current Subject in the Labeling panel is cleared.
`curLabel`	1	string	nextLabel, prevLabel	Specifies the current label to apply to the selected marker by name.
`cliffTol`	1	float	—	Specifies the allowable amount of acceleration between frames for a trajectory to be considered continuous when labeling using cliff mode.
`cliffMaxGap`	1	integer	—	Specifies the max number of frames without data between trajectories on the marker being labeled for the labeler to label both trajectories. Only applies when using cliff mode.
`hide`	1	boolean	—	Hides or shows the Labeling panel.
`labelRadiusOffset`	1	float	—	Point size offset applied to markers when labeled.
`unlabelRadiusOffset`	1	float	—	Point size offset applied to markers when unlabeled.
`loadActors`	1	boolean	—	Specifies if characters with names Actor_* are available for labeling.
`snapToSelection`	0	—	—	Sets the current character to the character parent of the selected marker and sets the current label to the name of the selected marker.
`nextUnlabeled`	0	—	nextLabel, prevLabel, curLabel, prevUnlabeled	Sets the current label to the next label that is not already labeled.
`prevUnlabeled`	0	—	nextLabel, prevLabel, curLabel, nextUnlabeled	Sets the current label to the previous label that is not already labeled.
`autoVelocity`	1	boolean	—	Specifies if a velocity label operation should be performed after a label is applied.
`advanceUnlabeled`	1	boolean	—	Specifies if the current label in the labels list should auto advance to the next unlabeled label after a label is applied.
`followSelection`	1	boolean	—	Specifies if the current label in the labels list should automatically match the current select as selection changes in the scene.

Return value

void

Examples

// Set up the labeler to label the character named Bob using the 
// cliff setting. 
labelOptions -curChar "Bob";
labelOptions -type "Cliff";

Additional information

Related commands

label