Selection


AddToCandidate

Add objects to ‘candidate set’.

注解

Candidate set will be reset after scene switch

Parameters
Name Required Description
Object Reference Yes Object Reference

Example

1
2
3
4
{
    "cmd": "AddToCandidate",
    "uids": ["obj01", "obj02"]
}

ClearCandidate

Empty candidate set.

注解

Candidate set will be reset after scene switch.

Parameters

No parameters.

Example

1
2
3
{
    "cmd": "ClearCandidate"
}

RemoveFromCandidate

Remove objects from candidate set.

注解

Candidate set will be reset after scene switch

Parameters
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’.

Parameters
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’.

Parameters
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

Parameters
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.

Parameters
Name Required Description
enable Yes True or False

Example

1
2
3
4
{
    "cmd": "EnableRectangleSelect",
    "enable":true
}

EnalbeCheckRectangleUpdate

Update bulk selection in real-time, recommended value: false

Parameters
Name Required Description
enable Yes True or False

Example

1
2
3
4
{
    "cmd": "EnalbeCheckRectangleUpdate",
    "enable":true
}

LimitRectangleSelectNum

Limit number of selected objects by bulk selector.

Parameters
Name Required Description
num Yes maxim number of selected objects by bulk selector

Example

1
2
3
4
{
    "cmd": "LimitRectangleSelectNum",
    "num": 4
}