InterpolateValueAction

This defines an action responsible to change the value of a property by interpolating between its current value and the newly set one once triggered.

see

http://doc.babylonjs.com/how_to/how_to_use_actions

Hierarchy

  • Action
    • InterpolateValueAction

Index

Constructors

constructor

Find examples in Playground
  • new InterpolateValueAction(triggerOptions: any, target: any, propertyPath: string, value: any, duration?: number, condition?: Condition, stopOtherAnimations?: boolean, onInterpolationDone?: function): InterpolateValueAction
  • Instantiate the action

    Parameters

    • triggerOptions: any

      defines the trigger options

    • target: any

      defines the object containing the value to interpolate

    • propertyPath: string

      defines the path to the property in the target object

    • value: any

      defines the target value at the end of the interpolation

    • Optional duration: number

      deines the time it will take for the property to interpolate to the value.

    • Optional condition: Condition

      defines the trigger related conditions

    • Optional stopOtherAnimations: boolean

      defines if the other scene animations should be stopped when the action has been triggered

    • Optional onInterpolationDone: function

      defines a callback raised once the interpolation animation has been done

        • (): void
        • Returns void

    Returns InterpolateValueAction

Properties

duration

Find examples in Playground
duration: number

Defines the time it will take for the property to interpolate to the value.

onBeforeExecuteObservable

Find examples in Playground
onBeforeExecuteObservable: Observable<Action>

An event triggered prior to action being executed.

Optional onInterpolationDone

Find examples in Playground
onInterpolationDone: function

Defines a callback raised once the interpolation animation has been done.

Type declaration

    • (): void
    • Returns void

onInterpolationDoneObservable

Find examples in Playground
onInterpolationDoneObservable: Observable<InterpolateValueAction>

Observable triggered once the interpolation animation has been done.

propertyPath

Find examples in Playground
propertyPath: string

Defines the path of the property where the value should be interpolated

Optional stopOtherAnimations

Find examples in Playground
stopOtherAnimations: boolean

Defines if the other scene animations should be stopped when the action has been triggered

trigger

Find examples in Playground
trigger: number

Trigger for the action

triggerOptions

Find examples in Playground
triggerOptions: any

the trigger, with or without parameters, for the action

value

Find examples in Playground
value: any

Defines the target value at the end of the interpolation.

Methods

execute

Find examples in Playground
  • execute(): void
  • Execute the action starts the value interpolation.

    Returns void

getTriggerParameter

Find examples in Playground
  • getTriggerParameter(): any

serialize

Find examples in Playground
  • serialize(parent: any): any
  • Serializes the actions and its related information.

    Parameters

    • parent: any

      defines the object to serialize in

    Returns any

    the serialized object

skipToNextActiveAction

Find examples in Playground
  • skipToNextActiveAction(): void

then

Find examples in Playground

Generated using TypeDoc