RayDrillSelectionOperator

class Communicator.Operator.RayDrillSelectionOperator()

Methods

addMapping()
clearMapping()
clearSelection()
getForceEffectiveSceneVisibilityMask()
getIgnoreTransparency()
hasActiveSelection()
setForceEffectiveSceneVisibilityMask()
setIgnoreTransparency()
setMapping()
waitForIdle()

Methods

addMapping

RayDrillSelectionOperator.addMapping(button[, modifier])

Adds a button and key modifier mapping for the operator. If no mapping is provided, all combinations are considered valid. All mappings require a mouse button, but a key modifier is optional.

Arguments

button (Button) –
modifier (KeyModifiers) – optional

Return type

void

clearMapping

RayDrillSelectionOperator.clearMapping()

Clears any button and key modifier mappings for the operator.

Return type: void

clearSelection

RayDrillSelectionOperator.clearSelection()

Return type: Promise <void>

getForceEffectiveSceneVisibilityMask

RayDrillSelectionOperator.getForceEffectiveSceneVisibilityMask()

Gets the mask used for forcing effective scene visibility during selection.

Return type: SelectionMask

getIgnoreTransparency

RayDrillSelectionOperator.getIgnoreTransparency()

Return type: boolean

hasActiveSelection

RayDrillSelectionOperator.hasActiveSelection()

Return type: boolean

setForceEffectiveSceneVisibilityMask

RayDrillSelectionOperator.setForceEffectiveSceneVisibilityMask(mask)

Sets the mask used for forcing effective scene visibility during selection.

Arguments

mask (SelectionMask) –

Return type

void

setIgnoreTransparency

RayDrillSelectionOperator.setIgnoreTransparency(value)

Arguments

value (boolean()) –

Return type

void

setMapping

RayDrillSelectionOperator.setMapping(button[, modifier])

Sets the button and key modifier mapping for the operator.

Arguments

button (Button) –
modifier (KeyModifiers) – optional

Return type

void

waitForIdle

RayDrillSelectionOperator.waitForIdle()

Return type: Promise <void>