Class ActionManager

Action Manager manages all events to be triggered on a given mesh or the global scene. A single scene can have many Action Managers to handle predefined actions on specific meshes.

See

https://doc.babylonjs.com/features/featuresDeepDive/events/actions

Hierarchy (View Summary)

AbstractActionManager
- ActionManager

Constructors

constructor

new ActionManager(scene?: Nullable<Scene>): ActionManager
Creates a new action manager
Parameters
- Optionalscene: Nullable<Scene>
  defines the hosting scene
Returns ActionManager
Overrides AbstractActionManager.constructor
- Defined in packages/dev/core/src/Actions/actionManager.ts:133

Properties

actions

actions: IAction[] = []

Gets the list of actions

disposeWhenUnowned

disposeWhenUnowned: boolean = true

Gets or sets a boolean indicating if this ActionManager should be disposed once the last Mesh using it is disposed

hoverCursor

hoverCursor: string = ""

Gets the cursor to use when hovering items

isRecursive

isRecursive: boolean = false

Gets or sets a boolean indicating that the manager is recursive meaning that it can trigger action from children

`Static` `Readonly`NothingTrigger

NothingTrigger: 0 = Constants.ACTION_NothingTrigger

Nothing

See

https://doc.babylonjs.com/features/featuresDeepDive/events/actions#triggers

`Static` `Readonly`OnCenterPickTrigger

OnCenterPickTrigger: 4 = Constants.ACTION_OnCenterPickTrigger

On center pick

See

https://doc.babylonjs.com/features/featuresDeepDive/events/actions#triggers

`Static` `Readonly`OnDoublePickTrigger

OnDoublePickTrigger: 6 = Constants.ACTION_OnDoublePickTrigger

On double pick

See

https://doc.babylonjs.com/features/featuresDeepDive/events/actions#triggers

`Static` `Readonly`OnEveryFrameTrigger

OnEveryFrameTrigger: 11 = Constants.ACTION_OnEveryFrameTrigger

On every frame

See

https://doc.babylonjs.com/features/featuresDeepDive/events/actions#triggers

`Static` `Readonly`OnIntersectionEnterTrigger

OnIntersectionEnterTrigger: 12 = Constants.ACTION_OnIntersectionEnterTrigger

On intersection enter

See

https://doc.babylonjs.com/features/featuresDeepDive/events/actions#triggers

`Static` `Readonly`OnIntersectionExitTrigger

OnIntersectionExitTrigger: 13 = Constants.ACTION_OnIntersectionExitTrigger

On intersection exit

See

https://doc.babylonjs.com/features/featuresDeepDive/events/actions#triggers

`Static` `Readonly`OnKeyDownTrigger

OnKeyDownTrigger: 14 = Constants.ACTION_OnKeyDownTrigger

On key down

See

https://doc.babylonjs.com/features/featuresDeepDive/events/actions#triggers

`Static` `Readonly`OnKeyUpTrigger

OnKeyUpTrigger: 15 = Constants.ACTION_OnKeyUpTrigger

On key up

See

https://doc.babylonjs.com/features/featuresDeepDive/events/actions#triggers

`Static` `Readonly`OnLeftPickTrigger

OnLeftPickTrigger: 2 = Constants.ACTION_OnLeftPickTrigger

On left pick

See

https://doc.babylonjs.com/features/featuresDeepDive/events/actions#triggers

`Static` `Readonly`OnLongPressTrigger

OnLongPressTrigger: 8 = Constants.ACTION_OnLongPressTrigger

On long press

See

https://doc.babylonjs.com/features/featuresDeepDive/events/actions#triggers

`Static` `Readonly`OnPickDownTrigger

OnPickDownTrigger: 5 = Constants.ACTION_OnPickDownTrigger

On pick down

See

https://doc.babylonjs.com/features/featuresDeepDive/events/actions#triggers

`Static` `Readonly`OnPickOutTrigger

OnPickOutTrigger: 16 = Constants.ACTION_OnPickOutTrigger

On pick out. This trigger will only be raised if you also declared a OnPickDown

See

https://doc.babylonjs.com/features/featuresDeepDive/events/actions#triggers

`Static` `Readonly`OnPickTrigger

OnPickTrigger: 1 = Constants.ACTION_OnPickTrigger

On pick

See

https://doc.babylonjs.com/features/featuresDeepDive/events/actions#triggers

`Static` `Readonly`OnPickUpTrigger

OnPickUpTrigger: 7 = Constants.ACTION_OnPickUpTrigger

On pick up

See

https://doc.babylonjs.com/features/featuresDeepDive/events/actions#triggers

`Static` `Readonly`OnPointerOutTrigger

OnPointerOutTrigger: 10 = Constants.ACTION_OnPointerOutTrigger

On pointer out

See

https://doc.babylonjs.com/features/featuresDeepDive/events/actions#triggers

`Static` `Readonly`OnPointerOverTrigger

OnPointerOverTrigger: 9 = Constants.ACTION_OnPointerOverTrigger

On pointer over

See

https://doc.babylonjs.com/features/featuresDeepDive/events/actions#triggers

`Static` `Readonly`OnRightPickTrigger

OnRightPickTrigger: 3 = Constants.ACTION_OnRightPickTrigger

On right pick

See

https://doc.babylonjs.com/features/featuresDeepDive/events/actions#triggers

`Static`Triggers

Triggers: { [key: string]: number } = {}

Gets the list of active triggers

Accessors

hasPickTriggers

get hasPickTriggers(): boolean
Does this action manager has pick triggers

Returns boolean
Overrides AbstractActionManager.hasPickTriggers
- Defined in packages/dev/core/src/Actions/actionManager.ts:260

hasPointerTriggers

get hasPointerTriggers(): boolean
Does this action manager has pointer triggers

Returns boolean
Overrides AbstractActionManager.hasPointerTriggers
- Defined in packages/dev/core/src/Actions/actionManager.ts:243

`Static`HasPickTriggers

get HasPickTriggers(): boolean
Does exist one action manager with at least one pick trigger

Returns boolean
Inherited from AbstractActionManager.HasPickTriggers
- Defined in packages/dev/core/src/Actions/abstractActionManager.ts:114

`Static`HasTriggers

get HasTriggers(): boolean
Does exist one action manager with at least one trigger

Returns boolean
Inherited from AbstractActionManager.HasTriggers
- Defined in packages/dev/core/src/Actions/abstractActionManager.ts:102

Methods

dispose

dispose(): void
Releases all associated resources

Returns void
Overrides AbstractActionManager.dispose
- Defined in packages/dev/core/src/Actions/actionManager.ts:149

getScene

getScene(): Scene
Gets hosting scene

Returns Scene
the hosting scene
- Defined in packages/dev/core/src/Actions/actionManager.ts:176

hasSpecificTrigger

hasSpecificTrigger(
trigger: number,
parameterPredicate?: (parameter: any) => boolean,
): boolean
Does this action manager handles actions of a given trigger
Parameters
- trigger: number
  defines the trigger to be tested
- OptionalparameterPredicate: (parameter: any) => boolean
  defines an optional predicate to filter triggers by parameter
Returns boolean
whether the trigger is handled
Overrides AbstractActionManager.hasSpecificTrigger
- Defined in packages/dev/core/src/Actions/actionManager.ts:222

hasSpecificTriggers

hasSpecificTriggers(triggers: number[]): boolean
Does this action manager handles actions of any of the given triggers
Parameters
- triggers: number[]
  defines the triggers to be tested
Returns boolean
a boolean indicating whether one (or more) of the triggers is handled
Overrides AbstractActionManager.hasSpecificTriggers
- Defined in packages/dev/core/src/Actions/actionManager.ts:185

hasSpecificTriggers2

hasSpecificTriggers2(triggerA: number, triggerB: number): boolean
Does this action manager handles actions of any of the given triggers. This function takes two arguments for speed.
Parameters
- triggerA: number
  defines the trigger to be tested
- triggerB: number
  defines the trigger to be tested
Returns boolean
a boolean indicating whether one (or more) of the triggers is handled
Overrides AbstractActionManager.hasSpecificTriggers2
- Defined in packages/dev/core/src/Actions/actionManager.ts:204

processTrigger

processTrigger(trigger: number, evt?: IActionEvent): void
Process a specific trigger
Parameters
- trigger: number
  defines the trigger to process
- Optionalevt: IActionEvent
  defines the event details to be processed
Returns void
Overrides AbstractActionManager.processTrigger
- Defined in packages/dev/core/src/Actions/actionManager.ts:327

registerAction

registerAction(action: IAction): Nullable<IAction>
Registers an action to this action manager
Parameters
- action: IAction
  defines the action to be registered
Returns Nullable<IAction>
the action amended (prepared) after registration
Overrides AbstractActionManager.registerAction
- Defined in packages/dev/core/src/Actions/actionManager.ts:279

serialize

serialize(name: string): any
Serialize this manager to a JSON object
Parameters
- name: string
  defines the property name to store this manager
Returns any
a JSON representation of this manager
Overrides AbstractActionManager.serialize
- Defined in packages/dev/core/src/Actions/actionManager.ts:389

unregisterAction

unregisterAction(action: IAction): boolean
Unregisters an action to this action manager
Parameters
- action: IAction
  defines the action to be unregistered
Returns boolean
a boolean indicating whether the action has been unregistered
Overrides AbstractActionManager.unregisterAction
- Defined in packages/dev/core/src/Actions/actionManager.ts:307

`Static`GetTriggerName

GetTriggerName(trigger: number): string
Get a trigger name by index
Parameters
- trigger: number
  defines the trigger index
Returns string
a trigger name
- Defined in packages/dev/core/src/Actions/actionManager.ts:661

`Static`HasSpecificTrigger

HasSpecificTrigger(trigger: number): boolean
Does exist one action manager that handles actions of a given trigger
Parameters
- trigger: number
  defines the trigger to be tested
Returns boolean
a boolean indicating whether the trigger is handled by at least one action manager
Inherited from AbstractActionManager.HasSpecificTrigger
- Defined in packages/dev/core/src/Actions/abstractActionManager.ts:131

`Static`Parse

Parse(parsedActions: any, object: Nullable<AbstractMesh>, scene: Scene): void
Creates a new ActionManager from a JSON data
Parameters
- parsedActions: any
  defines the JSON data to read from
- object: Nullable<AbstractMesh>
  defines the hosting mesh
- scene: Scene
  defines the hosting scene
Returns void
- Defined in packages/dev/core/src/Actions/actionManager.ts:448

Class ActionManager

See

Hierarchy (View Summary)

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Parameters

Returns ActionManager

Properties

actions

disposeWhenUnowned

hoverCursor

isRecursive

Static ReadonlyNothingTrigger

See

Static ReadonlyOnCenterPickTrigger

See

Static ReadonlyOnDoublePickTrigger

See

Static ReadonlyOnEveryFrameTrigger

See

Static ReadonlyOnIntersectionEnterTrigger

See

Static ReadonlyOnIntersectionExitTrigger

See

Static ReadonlyOnKeyDownTrigger

See

Static ReadonlyOnKeyUpTrigger

See

Static ReadonlyOnLeftPickTrigger

See

Static ReadonlyOnLongPressTrigger

See

Static ReadonlyOnPickDownTrigger

See

Static ReadonlyOnPickOutTrigger

See

Static ReadonlyOnPickTrigger

See

Static ReadonlyOnPickUpTrigger

See

Static ReadonlyOnPointerOutTrigger

See

Static ReadonlyOnPointerOverTrigger

See

Static ReadonlyOnRightPickTrigger

See

StaticTriggers

Accessors

hasPickTriggers

Returns boolean

hasPointerTriggers

Returns boolean

StaticHasPickTriggers

Returns boolean

StaticHasTriggers

Returns boolean

Methods

dispose

Returns void

getScene

Returns Scene

hasSpecificTrigger

Parameters

Returns boolean

hasSpecificTriggers

Parameters

Returns boolean

hasSpecificTriggers2

Parameters

Returns boolean

processTrigger

Parameters

Returns void

registerAction

Parameters

`Static` `Readonly`NothingTrigger

`Static` `Readonly`OnCenterPickTrigger

`Static` `Readonly`OnDoublePickTrigger

`Static` `Readonly`OnEveryFrameTrigger

`Static` `Readonly`OnIntersectionEnterTrigger

`Static` `Readonly`OnIntersectionExitTrigger

`Static` `Readonly`OnKeyDownTrigger

`Static` `Readonly`OnKeyUpTrigger

`Static` `Readonly`OnLeftPickTrigger

`Static` `Readonly`OnLongPressTrigger

`Static` `Readonly`OnPickDownTrigger

`Static` `Readonly`OnPickOutTrigger

`Static` `Readonly`OnPickTrigger

`Static` `Readonly`OnPickUpTrigger

`Static` `Readonly`OnPointerOutTrigger

`Static` `Readonly`OnPointerOverTrigger

`Static` `Readonly`OnRightPickTrigger

`Static`Triggers

`Static`HasPickTriggers

`Static`HasTriggers

`Static`GetTriggerName

`Static`HasSpecificTrigger

`Static`Parse