pixi-dragonbones-runtime/lib/model/DragonBonesData.d.ts

DragonBones Runtime for Pixi.js

/**
 * The MIT License (MIT)
 *
 * Copyright (c) 2012-2018 DragonBones team and other contributors
 *
 * Permission is hereby granted, free of charge, to any person obtaining a copy of
 * this software and associated documentation files (the "Software"), to deal in
 * the Software without restriction, including without limitation the rights to
 * use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of
 * the Software, and to permit persons to whom the Software is furnished to do so,
 * subject to the following conditions:
 *
 * The above copyright notice and this permission notice shall be included in all
 * copies or substantial portions of the Software.
 *
 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS
 * FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR
 * COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER
 * IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN
 * CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
 */
import { BaseObject } from "../core/index.js";
import { ArmatureData } from "./ArmatureData.js";
import { UserData } from "./UserData.js";
/**
 * [en] The DragonBones data.
 * A DragonBones data contains multiple armature data.
 *
 * [zh] 龙骨数据。
 * 一个龙骨数据包含多个骨架数据。
 *
 * @see ArmatureData
 * @version DragonBones 3.0
 */
export declare class DragonBonesData extends BaseObject {
    static toString(): string;
    /**
     * @private
     */
    autoSearch: boolean;
    /**
     * [en] The animation frame rate.
     *
     * [zh] 动画帧频。
     *
     * @version DragonBones 3.0
     */
    frameRate: number;
    /**
     * [en] The data version.
     *
     * [zh] 数据版本。
     *
     * @version DragonBones 3.0
     */
    version: string;
    /**
     * [en] The DragonBones data name.
     * The name is consistent with the DragonBones project name.
     *
     * [zh] 龙骨数据名称。
     * 该名称与龙骨项目名保持一致。
     *
     * @version DragonBones 3.0
     */
    name: string;
    /**
     * @private
     */
    stage: ArmatureData | null;
    /**
     * @internal
     */
    readonly frameIndices: Array<number>;
    /**
     * @internal
     */
    readonly cachedFrames: Array<number>;
    /**
     * [en] All armature data names.
     *
     * [zh] 所有的骨架数据名称。
     *
     * @version DragonBones 3.0
     */
    readonly armatureNames: Array<string>;
    /**
     * @private
     */
    readonly armatures: Record<string, ArmatureData>;
    /**
     * @internal
     */
    binary: ArrayBuffer;
    /**
     * @internal
     */
    intArray: Int16Array;
    /**
     * @internal
     */
    floatArray: Float32Array;
    /**
     * @internal
     */
    frameIntArray: Int16Array;
    /**
     * @internal
     */
    frameFloatArray: Float32Array;
    /**
     * @internal
     */
    frameArray: Int16Array;
    /**
     * @internal
     */
    timelineArray: Uint16Array;
    /**
     * @internal
     */
    colorArray: Int16Array | Uint16Array;
    /**
     * @private
     */
    userData: UserData | null;
    protected _onClear(): void;
    /**
     * @internal
     */
    addArmature(value: ArmatureData): void;
    /**
     * [en] Get a specific armature data.
     *
     * [zh] 获取特定的骨架数据。
     *
     * @param armatureName - The armature data name.
     * @param armatureName - 骨架数据名称。
     *
     * @version DragonBones 3.0
     */
    getArmature(armatureName: string): ArmatureData | null;
}