nbody/dist/types/src/Universe.d.ts

Configure, simulate and visualize n-body interactions

import { type SimulateFunction } from './SimulateFunction';
import { type State } from './State';
import { type Transformation } from './Transformation';
/**
 * Container for a Universe's configuration.
 * @category Types
 */
export type UniverseConfig = {
    /**
     * Previous state of the Universe.
     */
    prevState: State;
    /**
     * Current state of the Universe.
     */
    currState: State;
    /**
     * Color of the bodies in the Universe. A single color applied to all bodies or an array of colors applied to each body respectively. Length of the array should match the number of bodies in the state.
     */
    color: string | string[];
    /**
     * Scale the radius of the bodies in the Universe. Default is 1.
     */
    radiusScale: number;
    /**
     * Label of the Universe.
     */
    label: string;
    /**
     * Simulation function used to simulate the Universe.
     */
    simFunc: SimulateFunction;
    /**
     * Array of transformations to be applied to the Universe's state after simulation and before visualization.
     */
    transformations: Transformation[];
};
/**
 * A Universe object that contains previous and current state of the universe, a simulation function, frame of reference transformations and other necessary data.
 * @category Building blocks
 */
export declare class Universe {
    prevState: State;
    currState: State;
    /**
     * Color of the bodies in the Universe. A single color applied to all bodies or an array of colors applied to each body respectively. Incase of array, length should match the number of bodies in the state.
     */
    color: string | string[];
    /**
     * Scale the radius of the bodies in the Universe. Default is 1.
     */
    radiusScale: number;
    /**
     * Label of the Universe.
     */
    label: string;
    /**
     * Simulation function used to simulate the Universe.
     */
    simFunc: SimulateFunction;
    /**
     * Array of transformations to be applied to the Universe's state after simulation and before visualization.
     */
    transformations: Transformation[];
    /**
     * Create a new Universe with the provided configuration.
     * @param config configuration object.
     */
    constructor(config: Partial<UniverseConfig>);
    /**
     * Simulate a step in the Universe using the SimulateFunction and Transformations.
     * @param deltaT time step to simulate.
     * @hidden
     */
    simulateStep(deltaT: number): void;
    /**
     * Deep copy the current Universe.
     * @returns a new Universe instance.
     */
    clone(): Universe;
}