dragonbones-runtime/DragonBones/src/dragonBones/model/DragonBonesData.ts

the tools to build dragonbones file for diffrent framework

/**
 * The MIT License (MIT)
 *
 * Copyright (c) 2012-2017 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.
 */
namespace dragonBones {
    /**
     * - The DragonBones data.
     * A DragonBones data contains multiple armature data.
     * @see dragonBones.ArmatureData
     * @version DragonBones 3.0
     * @language en_US
     */
    /**
     * - 龙骨数据。
     * 一个龙骨数据包含多个骨架数据。
     * @see dragonBones.ArmatureData
     * @version DragonBones 3.0
     * @language zh_CN
     */
    export class DragonBonesData extends BaseObject {
        public static toString(): string {
            return "[class dragonBones.DragonBonesData]";
        }
        /**
         * @private
         */
        public autoSearch: boolean;
        /**
         * - The animation frame rate.
         * @version DragonBones 3.0
         * @language en_US
         */
        /**
         * - 动画帧频。
         * @version DragonBones 3.0
         * @language zh_CN
         */
        public frameRate: number;
        /**
         * - The data version.
         * @version DragonBones 3.0
         * @language en_US
         */
        /**
         * - 数据版本。
         * @version DragonBones 3.0
         * @language zh_CN
         */
        public version: string;
        /**
         * - The DragonBones data name.
         * The name is consistent with the DragonBones project name.
         * @version DragonBones 3.0
         * @language en_US
         */
        /**
         * - 龙骨数据名称。
         * 该名称与龙骨项目名保持一致。
         * @version DragonBones 3.0
         * @language zh_CN
         */
        public name: string;
        /**
         * @private
         */
        public stage: ArmatureData | null;
        /**
         * @internal
         * @private
         */
        public readonly frameIndices: Array<number> = [];
        /**
         * @internal
         * @private
         */
        public readonly cachedFrames: Array<number> = [];
        /**
         * - All armature data names.
         * @version DragonBones 3.0
         * @language en_US
         */
        /**
         * - 所有的骨架数据名称。
         * @version DragonBones 3.0
         * @language zh_CN
         */
        public readonly armatureNames: Array<string> = [];
        /**
         * @private
         */
        public readonly armatures: Map<ArmatureData> = {};
        /**
         * @internal
         * @private
         */
        public binary: ArrayBuffer;
        /**
         * @internal
         * @private
         */
        public intArray: Int16Array;
        /**
         * @internal
         * @private
         */
        public floatArray: Float32Array;
        /**
         * @internal
         * @private
         */
        public frameIntArray: Int16Array;
        /**
         * @internal
         * @private
         */
        public frameFloatArray: Float32Array;
        /**
         * @internal
         * @private
         */
        public frameArray: Int16Array;
        /**
         * @internal
         * @private
         */
        public timelineArray: Uint16Array;
        /**
         * @private
         */
        public userData: UserData | null = null; // Initial value.
        /**
         * @inheritDoc
         */
        protected _onClear(): void {
            for (let k in this.armatures) {
                this.armatures[k].returnToPool();
                delete this.armatures[k];
            }

            if (this.userData !== null) {
                this.userData.returnToPool();
            }

            this.autoSearch = false;
            this.frameRate = 0;
            this.version = "";
            this.name = "";
            this.stage = null;
            this.frameIndices.length = 0;
            this.cachedFrames.length = 0;
            this.armatureNames.length = 0;
            //this.armatures.clear();
            this.binary = null as any; //
            this.intArray = null as any; //
            this.floatArray = null as any; //
            this.frameIntArray = null as any; //
            this.frameFloatArray = null as any; //
            this.frameArray = null as any; //
            this.timelineArray = null as any; //
            this.userData = null;
        }
        /**
         * @internal
         * @private
         */
        public addArmature(value: ArmatureData): void {
            if (value.name in this.armatures) {
                console.warn("Same armature: " + value.name);
                return;
            }

            value.parent = this;
            this.armatures[value.name] = value;
            this.armatureNames.push(value.name);
        }
        /**
         * - Get a specific armature data.
         * @param name - The armature data name.
         * @version DragonBones 3.0
         * @language en_US
         */
        /**
         * - 获取特定的骨架数据。
         * @param name - 骨架数据名称。
         * @version DragonBones 3.0
         * @language zh_CN
         */
        public getArmature(name: string): ArmatureData | null {
            return name in this.armatures ? this.armatures[name] : null;
        }

        /**
         * - Deprecated, please refer to {@link #dragonBones.BaseFactory#removeDragonBonesData()}.
         * @deprecated
         * @language en_US
         */
        /**
         * - 已废弃，请参考 {@link #dragonBones.BaseFactory#removeDragonBonesData()}。
         * @deprecated
         * @language zh_CN
         */
        public dispose(): void {
            console.warn("已废弃");
            this.returnToPool();
        }
    }
}