Interface

Clutter-18 ▶ Clutter ▶ Animatable ▶ Interface

Interface for implementing Animatable. Contains only the virtual methods that need to be implemented.

interface Interface {
    vfunc_find_property(property_name: string): GObject.ParamSpec;
    vfunc_get_actor(): Clutter.Actor;
    vfunc_get_initial_state(property_name: string, value: unknown): void;
    vfunc_interpolate_value(
        property_name: string,
        interval: Clutter.Interval,
        progress: number,
    ): [boolean, any];
    vfunc_set_final_state(property_name: string, value: unknown): void;
}

Hierarchy (View Summary)

Index

Methods

vfunc_find_property vfunc_get_actor vfunc_get_initial_state vfunc_interpolate_value vfunc_set_final_state

Methods

  • Retrieves the current state of property_name and sets value with it

    Parameters

    • property_name: string

      the name of the animatable property to retrieve

    • value: unknown

      a GObject.Value initialized to the type of the property to retrieve

    Returns void

  • Asks a Clutter.Animatable implementation to interpolate a a named property between the initial and final values of a Clutter.Interval, using progress as the interpolation value, and store the result inside value.

    This function should be used for every property animation involving Clutter.Animatables.

    Parameters

    • property_name: string

      the name of the property to interpolate

    • interval: Clutter.Interval

      a Clutter.Interval with the animation range

    • progress: number

      the progress to use to interpolate between the initial and final values of the interval

    Returns [boolean, any]

  • Sets the current state of property_name to value

    Parameters

    • property_name: string

      the name of the animatable property to set

    • value: unknown

      the value of the animatable property to set

    Returns void