@rive-app/canvas 2.26.4 → 2.26.5

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@rive-app/canvas",
-  "version": "2.26.4",
+  "version": "2.26.5",
   "description": "Rive's canvas based web api.",
   "main": "rive.js",
   "homepage": "https://rive.app",

package/rive.d.ts

@@ -233,6 +233,10 @@ export interface RiveParameters {
      * EventType.RiveEvent
      */
     automaticallyHandleEvents?: boolean;
+    /**
+     * Rive will look for a default view model and view model instance to bind to the artboard
+     */
+    autoBind?: boolean;
     onLoad?: EventCallback;
     onLoadError?: EventCallback;
     onPlay?: EventCallback;
@@ -276,6 +280,7 @@ export interface RiveLoadParameters {
     buffer?: ArrayBuffer;
     riveFile?: RiveFile;
     autoplay?: boolean;
+    autoBind?: boolean;
     artboard?: string;
     animations?: string | string[];
     stateMachines?: string | string[];
@@ -287,6 +292,7 @@ export interface RiveResetParameters {
     animations?: string | string[];
     stateMachines?: string | string[];
     autoplay?: boolean;
+    autoBind?: boolean;
 }
 export interface RiveFileParameters {
     src?: string;
@@ -371,6 +377,8 @@ export declare class Rive {
     private _hasZeroSize;
     private _audioEventListener;
     private _boundDraw;
+    private _viewModelInstance;
+    private _dataEnums;
     durations: number[];
     frameTimes: number[];
     frameCount: number;
@@ -705,6 +713,153 @@ export declare class Rive {
      */
     get devicePixelRatioUsed(): number;
     set devicePixelRatioUsed(value: number);
+    /**
+     * Initialize the data context with the view model instance.
+     */
+    bindViewModelInstance(viewModelInstance: ViewModelInstance | null): void;
+    get viewModelInstance(): ViewModelInstance | null;
+    viewModelByIndex(index: number): ViewModel | null;
+    viewModelByName(name: string): ViewModel | null;
+    enums(): DataEnum[];
+    defaultViewModel(): ViewModel | null;
+}
+export declare class ViewModel {
+    private _viewModel;
+    constructor(viewModel: rc.ViewModel);
+    get instanceCount(): number;
+    get name(): string;
+    instanceByIndex(index: number): ViewModelInstance | null;
+    instanceByName(name: string): ViewModelInstance | null;
+    defaultInstance(): ViewModelInstance | null;
+    instance(): ViewModelInstance | null;
+    get properties(): rc.ViewModelProperty[];
+    get instanceNames(): string[];
+}
+export declare class DataEnum {
+    private _dataEnum;
+    constructor(dataEnum: rc.DataEnum);
+    get name(): string;
+    get values(): string[];
+}
+export declare class ViewModelInstance {
+    private _runtimeInstance;
+    private _root;
+    private _propertiesWithCallbacks;
+    private _referenceCount;
+    constructor(runtimeInstance: rc.ViewModelInstance, root: ViewModelInstance | null);
+    get runtimeInstance(): rc.ViewModelInstance | null;
+    handleCallbacks(): void;
+    private clearCallbacks;
+    /**
+     * method to access a property instance of type number belonging
+     * to the view model instance or to a nested view model instance
+     * @param path - path to the number property
+     */
+    number(path: string): ViewModelInstanceNumber | null;
+    /**
+     * method to access a property instance of type string belonging
+     * to the view model instance or to a nested view model instance
+     * @param path - path to the number property
+     */
+    string(path: string): ViewModelInstanceString | null;
+    /**
+     * method to access a property instance of type boolean belonging
+     * to the view model instance or to a nested view model instance
+     * @param path - path to the number property
+     */
+    boolean(path: string): ViewModelInstanceBoolean | null;
+    /**
+     * method to access a property instance of type color belonging
+     * to the view model instance or to a nested view model instance
+     * @param path - path to the number property
+     */
+    color(path: string): ViewModelInstanceColor | null;
+    /**
+     * method to access a property instance of type trigger belonging
+     * to the view model instance or to a nested view model instance
+     * @param path - path to the number property
+     */
+    trigger(path: string): ViewModelInstanceTrigger | null;
+    /**
+     * method to access a property instance of type enum belonging
+     * to the view model instance or to a nested view model instance
+     * @param path - path to the number property
+     */
+    enum(path: string): ViewModelInstanceEnum | null;
+    /**
+     * method to access a view model property instance belonging
+     * to the view model instance or to a nested view model instance
+     * @param path - path to the number property
+     */
+    viewModel(path: string): ViewModelInstance | null;
+    /**
+     * method to replace a view model property with another view model value
+     * @param path - path to the view model property
+     * @param value - view model that will replace the original
+     */
+    replaceViewModel(path: string, value: ViewModelInstance): boolean;
+    addToCallbacks(property: ViewModelInstanceValue): void;
+    removeFromCallbacks(property: ViewModelInstanceValue): void;
+    incrementReferenceCount(): void;
+    decrementReferenceCount(): void;
+    get properties(): rc.ViewModelProperty[];
+    internalIncrementReferenceCount(): void;
+    cleanup(): void;
+}
+export declare class ViewModelInstanceValue {
+    protected _rootViewModel: ViewModelInstance;
+    protected callbacks: EventCallback[];
+    protected _viewModelInstanceValue: rc.ViewModelInstanceValue;
+    constructor(instance: rc.ViewModelInstanceValue, root: ViewModelInstance);
+    on(callback: EventCallback): void;
+    off(callback?: EventCallback): void;
+    internalHandleCallback(callback: Function): void;
+    handleCallbacks(): void;
+    clearCallbacks(): void;
+    get name(): string;
+}
+export declare class ViewModelInstanceString extends ViewModelInstanceValue {
+    constructor(instance: rc.ViewModelInstanceString, root: ViewModelInstance);
+    get value(): string;
+    set value(val: string);
+    internalHandleCallback(callback: Function): void;
+}
+export declare class ViewModelInstanceNumber extends ViewModelInstanceValue {
+    constructor(instance: rc.ViewModelInstanceNumber, root: ViewModelInstance);
+    get value(): number;
+    set value(val: number);
+    internalHandleCallback(callback: Function): void;
+}
+export declare class ViewModelInstanceBoolean extends ViewModelInstanceValue {
+    constructor(instance: rc.ViewModelInstanceBoolean, root: ViewModelInstance);
+    get value(): boolean;
+    set value(val: boolean);
+    internalHandleCallback(callback: Function): void;
+}
+export declare class ViewModelInstanceTrigger extends ViewModelInstanceValue {
+    constructor(instance: rc.ViewModelInstanceTrigger, root: ViewModelInstance);
+    trigger(): void;
+    internalHandleCallback(callback: Function): void;
+}
+export declare class ViewModelInstanceEnum extends ViewModelInstanceValue {
+    constructor(instance: rc.ViewModelInstanceEnum, root: ViewModelInstance);
+    get value(): string;
+    set value(val: string);
+    set valueIndex(val: number);
+    get valueIndex(): number;
+    get values(): string[];
+    internalHandleCallback(callback: Function): void;
+}
+export declare class ViewModelInstanceColor extends ViewModelInstanceValue {
+    constructor(instance: rc.ViewModelInstanceColor, root: ViewModelInstance);
+    get value(): number;
+    set value(val: number);
+    rgb(r: number, g: number, b: number): void;
+    rgba(r: number, g: number, b: number, a: number): void;
+    argb(a: number, r: number, g: number, b: number): void;
+    alpha(a: number): void;
+    opacity(o: number): void;
+    internalHandleCallback(callback: Function): void;
 }
 /**
  * Contents of a state machine input