⬅️ Back to Table of Contents

📄 Animation.js

📊 Analysis Summary

Metric	Count
🔧 Functions	8
🧱 Classes	1

📚 Table of Contents

• Functions
• Classes

🛠️ File Location:

📂 src/renderers/common/Animation.js

Functions

Animation.start(): void

JSDoc:

/**
     * Starts the internal animation loop.
     */

Returns: void

Calls:

• this._context.requestAnimationFrame
• this.info.reset
• this.nodes.nodeFrame.update
• this._animationLoop
• update

Code

start() {

        const update = ( time, xrFrame ) => {

            this._requestId = this._context.requestAnimationFrame( update );

            if ( this.info.autoReset === true ) this.info.reset();

            this.nodes.nodeFrame.update();

            this.info.frame = this.nodes.nodeFrame.frameId;

            if ( this._animationLoop !== null ) this._animationLoop( time, xrFrame );

        };

        update();

    }

Animation.stop(): void

JSDoc:

/**
     * Stops the internal animation loop.
     */

Returns: void

Calls:

• this._context.cancelAnimationFrame

Code

stop() {

        this._context.cancelAnimationFrame( this._requestId );

        this._requestId = null;

    }

Animation.getAnimationLoop(): Function

JSDoc:

/**
     * Returns the user-level animation loop.
     *
     * @return {?Function} The animation loop.
     */

Returns: Function

Code

getAnimationLoop() {

        return this._animationLoop;

    }

Animation.setAnimationLoop(callback: Function): void

JSDoc:

/**
     * Defines the user-level animation loop.
     *
     * @param {?Function} callback - The animation loop.
     */

Parameters:

• callback Function

Returns: void

Code

setAnimationLoop( callback ) {

        this._animationLoop = callback;

    }

Animation.getContext(): any

JSDoc:

/**
     * Returns the animation context.
     *
     * @return {Window|XRSession} The animation context.
     */

Returns: any

Code

getContext() {

        return this._context;

    }

Animation.setContext(context: any): void

JSDoc:

/**
     * Defines the context in which `requestAnimationFrame()` is executed.
     *
     * @param {Window|XRSession} context - The context to set.
     */

Parameters:

• context any

Returns: void

Code

setContext( context ) {

        this._context = context;

    }

Animation.dispose(): void

JSDoc:

/**
     * Frees all internal resources and stops the animation loop.
     */

Returns: void

Calls:

• this.stop

Code

dispose() {

        this.stop();

    }

update(time: any, xrFrame: any): void

Parameters:

• time any
• xrFrame any

Returns: void

Calls:

• this._context.requestAnimationFrame
• this.info.reset
• this.nodes.nodeFrame.update
• this._animationLoop

Code

( time, xrFrame ) => {

            this._requestId = this._context.requestAnimationFrame( update );

            if ( this.info.autoReset === true ) this.info.reset();

            this.nodes.nodeFrame.update();

            this.info.frame = this.nodes.nodeFrame.frameId;

            if ( this._animationLoop !== null ) this._animationLoop( time, xrFrame );

        }

---

Classes

Animation

Class Code

class Animation {

    /**
     * Constructs a new animation loop management component.
     *
     * @param {Nodes} nodes - Renderer component for managing nodes related logic.
     * @param {Info} info - Renderer component for managing metrics and monitoring data.
     */
    constructor( nodes, info ) {

        /**
         * Renderer component for managing nodes related logic.
         *
         * @type {Nodes}
         */
        this.nodes = nodes;

        /**
         * Renderer component for managing metrics and monitoring data.
         *
         * @type {Info}
         */
        this.info = info;

        /**
         * A reference to the context from `requestAnimationFrame()` can
         * be called (usually `window`).
         *
         * @type {?(Window|XRSession)}
         */
        this._context = typeof self !== 'undefined' ? self : null;

        /**
         * The user-defined animation loop.
         *
         * @type {?Function}
         * @default null
         */
        this._animationLoop = null;

        /**
         * The requestId which is returned from the `requestAnimationFrame()` call.
         * Can be used to cancel the stop the animation loop.
         *
         * @type {?number}
         * @default null
         */
        this._requestId = null;

    }

    /**
     * Starts the internal animation loop.
     */
    start() {

        const update = ( time, xrFrame ) => {

            this._requestId = this._context.requestAnimationFrame( update );

            if ( this.info.autoReset === true ) this.info.reset();

            this.nodes.nodeFrame.update();

            this.info.frame = this.nodes.nodeFrame.frameId;

            if ( this._animationLoop !== null ) this._animationLoop( time, xrFrame );

        };

        update();

    }

    /**
     * Stops the internal animation loop.
     */
    stop() {

        this._context.cancelAnimationFrame( this._requestId );

        this._requestId = null;

    }

    /**
     * Returns the user-level animation loop.
     *
     * @return {?Function} The animation loop.
     */
    getAnimationLoop() {

        return this._animationLoop;

    }

    /**
     * Defines the user-level animation loop.
     *
     * @param {?Function} callback - The animation loop.
     */
    setAnimationLoop( callback ) {

        this._animationLoop = callback;

    }

    /**
     * Returns the animation context.
     *
     * @return {Window|XRSession} The animation context.
     */
    getContext() {

        return this._context;

    }

    /**
     * Defines the context in which `requestAnimationFrame()` is executed.
     *
     * @param {Window|XRSession} context - The context to set.
     */
    setContext( context ) {

        this._context = context;

    }

    /**
     * Frees all internal resources and stops the animation loop.
     */
    dispose() {

        this.stop();

    }

}

Methods

start(): void

Code

start() {

        const update = ( time, xrFrame ) => {

            this._requestId = this._context.requestAnimationFrame( update );

            if ( this.info.autoReset === true ) this.info.reset();

            this.nodes.nodeFrame.update();

            this.info.frame = this.nodes.nodeFrame.frameId;

            if ( this._animationLoop !== null ) this._animationLoop( time, xrFrame );

        };

        update();

    }

stop(): void

Code

stop() {

        this._context.cancelAnimationFrame( this._requestId );

        this._requestId = null;

    }

getAnimationLoop(): Function

Code

getAnimationLoop() {

        return this._animationLoop;

    }

setAnimationLoop(callback: Function): void

Code

setAnimationLoop( callback ) {

        this._animationLoop = callback;

    }

getContext(): any

Code

getContext() {

        return this._context;

    }

setContext(context: any): void

Code

setContext( context ) {

        this._context = context;

    }

dispose(): void

Code

dispose() {

        this.stop();

    }

---