@babylonjs/serializers 5.0.0-rc.7 → 5.0.1

package/glTF/2.0/glTFAnimation.d.ts

@@ -1,205 +1,206 @@
-import { AnimationSamplerInterpolation, AnimationChannelTargetPath, AccessorType, IAnimation, INode, IBufferView, IAccessor } from "babylonjs-gltf2interface";
-import { Node } from "@babylonjs/core/node.js";
-import { Nullable } from "@babylonjs/core/types.js";
-import { Animation } from "@babylonjs/core/Animations/animation.js";
-import { TransformNode } from "@babylonjs/core/Meshes/transformNode.js";
-import { Scene } from "@babylonjs/core/scene.js";
-import { _BinaryWriter } from "./glTFExporter";
-/**
- * @hidden
- * Interface to store animation data.
- */
-export interface _IAnimationData {
-    /**
-     * Keyframe data.
-     */
-    inputs: number[];
-    /**
-     * Value data.
-     */
-    outputs: number[][];
-    /**
-     * Animation interpolation data.
-     */
-    samplerInterpolation: AnimationSamplerInterpolation;
-    /**
-     * Minimum keyframe value.
-     */
-    inputsMin: number;
-    /**
-     * Maximum keyframe value.
-     */
-    inputsMax: number;
-}
-/**
- * @hidden
- */
-export interface _IAnimationInfo {
-    /**
-     * The target channel for the animation
-     */
-    animationChannelTargetPath: AnimationChannelTargetPath;
-    /**
-     * The glTF accessor type for the data.
-     */
-    dataAccessorType: AccessorType.VEC3 | AccessorType.VEC4 | AccessorType.SCALAR;
-    /**
-     * Specifies if quaternions should be used.
-     */
-    useQuaternion: boolean;
-}
-/**
- * @hidden
- * Utility class for generating glTF animation data from BabylonJS.
- */
-export declare class _GLTFAnimation {
-    /**
-     * @ignore
-     *
-     * Creates glTF channel animation from BabylonJS animation.
-     * @param babylonTransformNode - BabylonJS mesh.
-     * @param animation - animation.
-     * @param animationChannelTargetPath - The target animation channel.
-     * @param convertToRightHandedSystem - Specifies if the values should be converted to right-handed.
-     * @param useQuaternion - Specifies if quaternions are used.
-     * @returns nullable IAnimationData
-     */
-    static _CreateNodeAnimation(babylonTransformNode: TransformNode, animation: Animation, animationChannelTargetPath: AnimationChannelTargetPath, convertToRightHandedSystem: boolean, useQuaternion: boolean, animationSampleRate: number): Nullable<_IAnimationData>;
-    private static _DeduceAnimationInfo;
-    /**
-     * @ignore
-     * Create node animations from the transform node animations
-     * @param babylonNode
-     * @param runtimeGLTFAnimation
-     * @param idleGLTFAnimations
-     * @param nodeMap
-     * @param nodes
-     * @param binaryWriter
-     * @param bufferViews
-     * @param accessors
-     * @param convertToRightHandedSystem
-     * @param animationSampleRate
-     */
-    static _CreateNodeAnimationFromNodeAnimations(babylonNode: Node, runtimeGLTFAnimation: IAnimation, idleGLTFAnimations: IAnimation[], nodeMap: {
-        [key: number]: number;
-    }, nodes: INode[], binaryWriter: _BinaryWriter, bufferViews: IBufferView[], accessors: IAccessor[], convertToRightHandedSystem: boolean, animationSampleRate: number): void;
-    /**
-     * @ignore
-     * Create individual morph animations from the mesh's morph target animation tracks
-     * @param babylonNode
-     * @param runtimeGLTFAnimation
-     * @param idleGLTFAnimations
-     * @param nodeMap
-     * @param nodes
-     * @param binaryWriter
-     * @param bufferViews
-     * @param accessors
-     * @param convertToRightHandedSystem
-     * @param animationSampleRate
-     */
-    static _CreateMorphTargetAnimationFromMorphTargetAnimations(babylonNode: Node, runtimeGLTFAnimation: IAnimation, idleGLTFAnimations: IAnimation[], nodeMap: {
-        [key: number]: number;
-    }, nodes: INode[], binaryWriter: _BinaryWriter, bufferViews: IBufferView[], accessors: IAccessor[], convertToRightHandedSystem: boolean, animationSampleRate: number): void;
-    /**
-     * @ignore
-     * Create node and morph animations from the animation groups
-     * @param babylonScene
-     * @param glTFAnimations
-     * @param nodeMap
-     * @param nodes
-     * @param binaryWriter
-     * @param bufferViews
-     * @param accessors
-     * @param convertToRightHandedSystemMap
-     * @param animationSampleRate
-     */
-    static _CreateNodeAndMorphAnimationFromAnimationGroups(babylonScene: Scene, glTFAnimations: IAnimation[], nodeMap: {
-        [key: number]: number;
-    }, nodes: INode[], binaryWriter: _BinaryWriter, bufferViews: IBufferView[], accessors: IAccessor[], convertToRightHandedSystemMap: {
-        [nodeId: number]: boolean;
-    }, animationSampleRate: number): void;
-    private static _AddAnimation;
-    /**
-     * Create a baked animation
-     * @param babylonTransformNode BabylonJS mesh
-     * @param animation BabylonJS animation corresponding to the BabylonJS mesh
-     * @param animationChannelTargetPath animation target channel
-     * @param minFrame minimum animation frame
-     * @param maxFrame maximum animation frame
-     * @param fps frames per second of the animation
-     * @param sampleRate
-     * @param inputs input key frames of the animation
-     * @param outputs output key frame data of the animation
-     * @param minMaxFrames
-     * @param minMaxFrames.min
-     * @param minMaxFrames.max
-     * @param convertToRightHandedSystem converts the values to right-handed
-     * @param useQuaternion specifies if quaternions should be used
-     */
-    private static _CreateBakedAnimation;
-    private static _ConvertFactorToVector3OrQuaternion;
-    private static _SetInterpolatedValue;
-    /**
-     * Creates linear animation from the animation key frames
-     * @param babylonTransformNode BabylonJS mesh
-     * @param animation BabylonJS animation
-     * @param animationChannelTargetPath The target animation channel
-     * @param frameDelta The difference between the last and first frame of the animation
-     * @param inputs Array to store the key frame times
-     * @param outputs Array to store the key frame data
-     * @param convertToRightHandedSystem Specifies if the position data should be converted to right handed
-     * @param useQuaternion Specifies if quaternions are used in the animation
-     */
-    private static _CreateLinearOrStepAnimation;
-    /**
-     * Creates cubic spline animation from the animation key frames
-     * @param babylonTransformNode BabylonJS mesh
-     * @param animation BabylonJS animation
-     * @param animationChannelTargetPath The target animation channel
-     * @param frameDelta The difference between the last and first frame of the animation
-     * @param inputs Array to store the key frame times
-     * @param outputs Array to store the key frame data
-     * @param convertToRightHandedSystem Specifies if the position data should be converted to right handed
-     * @param useQuaternion Specifies if quaternions are used in the animation
-     */
-    private static _CreateCubicSplineAnimation;
-    private static _GetBasePositionRotationOrScale;
-    /**
-     * Adds a key frame value
-     * @param keyFrame
-     * @param animation
-     * @param outputs
-     * @param animationChannelTargetPath
-     * @param babylonTransformNode
-     * @param convertToRightHandedSystem
-     * @param useQuaternion
-     */
-    private static _AddKeyframeValue;
-    /**
-     * Determine the interpolation based on the key frames
-     * @param keyFrames
-     * @param animationChannelTargetPath
-     * @param useQuaternion
-     */
-    private static _DeduceInterpolation;
-    /**
-     * Adds an input tangent or output tangent to the output data
-     * If an input tangent or output tangent is missing, it uses the zero vector or zero quaternion
-     * @param babylonTransformNode
-     * @param tangentType Specifies which type of tangent to handle (inTangent or outTangent)
-     * @param outputs The animation data by keyframe
-     * @param animationChannelTargetPath The target animation channel
-     * @param interpolation The interpolation type
-     * @param keyFrame The key frame with the animation data
-     * @param frameDelta Time difference between two frames used to scale the tangent by the frame delta
-     * @param useQuaternion Specifies if quaternions are used
-     * @param convertToRightHandedSystem Specifies if the values should be converted to right-handed
-     */
-    private static _AddSplineTangent;
-    /**
-     * Get the minimum and maximum key frames' frame values
-     * @param keyFrames animation key frames
-     * @returns the minimum and maximum key frame value
-     */
-    private static _CalculateMinMaxKeyFrames;
-}
+import type { IAnimation, INode, IBufferView, IAccessor } from "babylonjs-gltf2interface/.js";
+import { AnimationSamplerInterpolation, AnimationChannelTargetPath, AccessorType } from "babylonjs-gltf2interface/.js";
+import type { Node } from "@babylonjs/core/node.js";
+import type { Nullable } from "@babylonjs/core/types.js";
+import { Animation } from "@babylonjs/core/Animations/animation.js";
+import { TransformNode } from "@babylonjs/core/Meshes/transformNode.js";
+import type { Scene } from "@babylonjs/core/scene.js";
+import type { _BinaryWriter } from "./glTFExporter";
+/**
+ * @hidden
+ * Interface to store animation data.
+ */
+export interface _IAnimationData {
+    /**
+     * Keyframe data.
+     */
+    inputs: number[];
+    /**
+     * Value data.
+     */
+    outputs: number[][];
+    /**
+     * Animation interpolation data.
+     */
+    samplerInterpolation: AnimationSamplerInterpolation;
+    /**
+     * Minimum keyframe value.
+     */
+    inputsMin: number;
+    /**
+     * Maximum keyframe value.
+     */
+    inputsMax: number;
+}
+/**
+ * @hidden
+ */
+export interface _IAnimationInfo {
+    /**
+     * The target channel for the animation
+     */
+    animationChannelTargetPath: AnimationChannelTargetPath;
+    /**
+     * The glTF accessor type for the data.
+     */
+    dataAccessorType: AccessorType.VEC3 | AccessorType.VEC4 | AccessorType.SCALAR;
+    /**
+     * Specifies if quaternions should be used.
+     */
+    useQuaternion: boolean;
+}
+/**
+ * @hidden
+ * Utility class for generating glTF animation data from BabylonJS.
+ */
+export declare class _GLTFAnimation {
+    /**
+     * @ignore
+     *
+     * Creates glTF channel animation from BabylonJS animation.
+     * @param babylonTransformNode - BabylonJS mesh.
+     * @param animation - animation.
+     * @param animationChannelTargetPath - The target animation channel.
+     * @param convertToRightHandedSystem - Specifies if the values should be converted to right-handed.
+     * @param useQuaternion - Specifies if quaternions are used.
+     * @returns nullable IAnimationData
+     */
+    static _CreateNodeAnimation(babylonTransformNode: TransformNode, animation: Animation, animationChannelTargetPath: AnimationChannelTargetPath, convertToRightHandedSystem: boolean, useQuaternion: boolean, animationSampleRate: number): Nullable<_IAnimationData>;
+    private static _DeduceAnimationInfo;
+    /**
+     * @ignore
+     * Create node animations from the transform node animations
+     * @param babylonNode
+     * @param runtimeGLTFAnimation
+     * @param idleGLTFAnimations
+     * @param nodeMap
+     * @param nodes
+     * @param binaryWriter
+     * @param bufferViews
+     * @param accessors
+     * @param convertToRightHandedSystem
+     * @param animationSampleRate
+     */
+    static _CreateNodeAnimationFromNodeAnimations(babylonNode: Node, runtimeGLTFAnimation: IAnimation, idleGLTFAnimations: IAnimation[], nodeMap: {
+        [key: number]: number;
+    }, nodes: INode[], binaryWriter: _BinaryWriter, bufferViews: IBufferView[], accessors: IAccessor[], convertToRightHandedSystem: boolean, animationSampleRate: number): void;
+    /**
+     * @ignore
+     * Create individual morph animations from the mesh's morph target animation tracks
+     * @param babylonNode
+     * @param runtimeGLTFAnimation
+     * @param idleGLTFAnimations
+     * @param nodeMap
+     * @param nodes
+     * @param binaryWriter
+     * @param bufferViews
+     * @param accessors
+     * @param convertToRightHandedSystem
+     * @param animationSampleRate
+     */
+    static _CreateMorphTargetAnimationFromMorphTargetAnimations(babylonNode: Node, runtimeGLTFAnimation: IAnimation, idleGLTFAnimations: IAnimation[], nodeMap: {
+        [key: number]: number;
+    }, nodes: INode[], binaryWriter: _BinaryWriter, bufferViews: IBufferView[], accessors: IAccessor[], convertToRightHandedSystem: boolean, animationSampleRate: number): void;
+    /**
+     * @ignore
+     * Create node and morph animations from the animation groups
+     * @param babylonScene
+     * @param glTFAnimations
+     * @param nodeMap
+     * @param nodes
+     * @param binaryWriter
+     * @param bufferViews
+     * @param accessors
+     * @param convertToRightHandedSystemMap
+     * @param animationSampleRate
+     */
+    static _CreateNodeAndMorphAnimationFromAnimationGroups(babylonScene: Scene, glTFAnimations: IAnimation[], nodeMap: {
+        [key: number]: number;
+    }, nodes: INode[], binaryWriter: _BinaryWriter, bufferViews: IBufferView[], accessors: IAccessor[], convertToRightHandedSystemMap: {
+        [nodeId: number]: boolean;
+    }, animationSampleRate: number): void;
+    private static _AddAnimation;
+    /**
+     * Create a baked animation
+     * @param babylonTransformNode BabylonJS mesh
+     * @param animation BabylonJS animation corresponding to the BabylonJS mesh
+     * @param animationChannelTargetPath animation target channel
+     * @param minFrame minimum animation frame
+     * @param maxFrame maximum animation frame
+     * @param fps frames per second of the animation
+     * @param sampleRate
+     * @param inputs input key frames of the animation
+     * @param outputs output key frame data of the animation
+     * @param minMaxFrames
+     * @param minMaxFrames.min
+     * @param minMaxFrames.max
+     * @param convertToRightHandedSystem converts the values to right-handed
+     * @param useQuaternion specifies if quaternions should be used
+     */
+    private static _CreateBakedAnimation;
+    private static _ConvertFactorToVector3OrQuaternion;
+    private static _SetInterpolatedValue;
+    /**
+     * Creates linear animation from the animation key frames
+     * @param babylonTransformNode BabylonJS mesh
+     * @param animation BabylonJS animation
+     * @param animationChannelTargetPath The target animation channel
+     * @param frameDelta The difference between the last and first frame of the animation
+     * @param inputs Array to store the key frame times
+     * @param outputs Array to store the key frame data
+     * @param convertToRightHandedSystem Specifies if the position data should be converted to right handed
+     * @param useQuaternion Specifies if quaternions are used in the animation
+     */
+    private static _CreateLinearOrStepAnimation;
+    /**
+     * Creates cubic spline animation from the animation key frames
+     * @param babylonTransformNode BabylonJS mesh
+     * @param animation BabylonJS animation
+     * @param animationChannelTargetPath The target animation channel
+     * @param frameDelta The difference between the last and first frame of the animation
+     * @param inputs Array to store the key frame times
+     * @param outputs Array to store the key frame data
+     * @param convertToRightHandedSystem Specifies if the position data should be converted to right handed
+     * @param useQuaternion Specifies if quaternions are used in the animation
+     */
+    private static _CreateCubicSplineAnimation;
+    private static _GetBasePositionRotationOrScale;
+    /**
+     * Adds a key frame value
+     * @param keyFrame
+     * @param animation
+     * @param outputs
+     * @param animationChannelTargetPath
+     * @param babylonTransformNode
+     * @param convertToRightHandedSystem
+     * @param useQuaternion
+     */
+    private static _AddKeyframeValue;
+    /**
+     * Determine the interpolation based on the key frames
+     * @param keyFrames
+     * @param animationChannelTargetPath
+     * @param useQuaternion
+     */
+    private static _DeduceInterpolation;
+    /**
+     * Adds an input tangent or output tangent to the output data
+     * If an input tangent or output tangent is missing, it uses the zero vector or zero quaternion
+     * @param babylonTransformNode
+     * @param tangentType Specifies which type of tangent to handle (inTangent or outTangent)
+     * @param outputs The animation data by keyframe
+     * @param animationChannelTargetPath The target animation channel
+     * @param interpolation The interpolation type
+     * @param keyFrame The key frame with the animation data
+     * @param frameDelta Time difference between two frames used to scale the tangent by the frame delta
+     * @param useQuaternion Specifies if quaternions are used
+     * @param convertToRightHandedSystem Specifies if the values should be converted to right-handed
+     */
+    private static _AddSplineTangent;
+    /**
+     * Get the minimum and maximum key frames' frame values
+     * @param keyFrames animation key frames
+     * @returns the minimum and maximum key frame value
+     */
+    private static _CalculateMinMaxKeyFrames;
+}