Selection¶
AddToCandidate¶
Add objects to ‘candidate set’.
Note
Candidate set will be reset after scene switch
Name | Required | Description |
---|---|---|
Object Reference | Yes | Object Reference |
Example
1 2 3 4 | {
"cmd": "AddToCandidate",
"uids": ["obj01", "obj02"]
}
|
ClearCandidate¶
Empty candidate set.
Note
Candidate set will be reset after scene switch.
Parameters
No parameters.
Example
1 2 3 | {
"cmd": "ClearCandidate"
}
|
RemoveFromCandidate¶
Remove objects from candidate set.
Note
Candidate set will be reset after scene switch
Name | Required | Description |
---|---|---|
Object Reference | Yes | Object Reference |
Example
1 2 3 4 | {
"cmd": "RemoveFromCandidate",
"uids":["obj01", "obj02"]
}
|
AddToSelection¶
Add objects to ‘selection set’ and marked as ‘selected’.
Name | Required | Description |
---|---|---|
Object Reference | Yes | Object Reference |
Example
1 2 3 4 | {
"cmd": "AddToSelection",
"uids":["obj01", "obj02"]
}
|
ClearSelection¶
Empty selection set and mark all objects as ‘unselected’.
Parameters
No parameters.
Example
1 2 3 | {
"cmd": "ClearSelection"
}
|
RemoveFromSelection¶
Remove objects from selection set and mark as ‘unselected’.
Name | Required | Description |
---|---|---|
Object Reference | Yes | Object Reference |
Example
1 2 3 4 | {
"cmd": "AddToSelection",
"uids":["obj01", "obj02"]
}
|
GetSelection¶
Save objects in selection set to buffer
Name | Required | Description |
---|---|---|
toBuffer | Yes | Buffer to save object |
Example
1 2 3 4 | {
"cmd": "GetSelection",
"toBuffer":{"ObjectManager":"RunBuffer/selection"}
}
|
LockSelection¶
Lock selection set, cannot remove or add new object if locked.
Parameters
No parameters.
Example
1 2 3 | {
"cmd": "LockSelection"
}
|
UnlockSelection¶
UnlockSelection selection set.
Parameters
No parameters.
Example
1 2 3 | {
"cmd": "UnlockSelection"
}
|
EnableRectangleSelect¶
Enable bulk selector in UI.
Name | Required | Description |
---|---|---|
enable | Yes | True or False |
Example
1 2 3 4 | {
"cmd": "EnableRectangleSelect",
"enable":true
}
|