Small World Engine API Reference - v0.78.00
    Preparing search index...

    Interface CameraInterfaceData

    Interface representing the core data and API of a camera.

    interface CameraInterfaceData {
        activeStrategyType: string;
        aspect: number;
        behaviors: Behavior[];
        flashColor: Color;
        flashIntensity: number;
        pendingDx: number;
        pendingDy: number;
        phi: number;
        position: Vector3D;
        projection: AbstractProjection;
        strategy: CameraStrategy;
        target: Vector3D;
        theta: number;
        up: Vector3D;
        viewMatrix: Float32Array;
        viewMatrix4: Matrix4;
        viewProjectionMatrix: Float32Array;
        viewProjectionMatrix4: Matrix4;
        addBehavior(behavior: Behavior): this;
        addEffect(effect: CameraEffect): CameraEffect;
        applyEffect(
            type: CameraEffectType,
            intensity?: number,
            duration?: number,
            color?: Color,
        ): CameraEffect;
        clearEffects(type?: CameraEffectType): void;
        project(worldPos: Vector3D, result?: Vector3D): Vector3D;
        removeBehavior(behavior: Behavior): this;
        removeEffect(effect: CameraEffect): void;
        screenToWorld(screenX: number, screenY: number): Vector3D;
        setConstraints(constraints?: CameraConstraints): void;
        setStrategy(type: CameraStrategyType): void;
        update(
            targetPos: Vector3D,
            dx: number,
            dy: number,
            deltaTime?: number,
        ): void;
        updateProjectionMatrix(): void;
        updateViewMatrix(): void;
        zoom(delta: number): void;
    }

    Implemented by

    Index
    activeStrategyType aspect behaviors flashColor flashIntensity pendingDx pendingDy phi position projection strategy target theta up viewMatrix viewMatrix4 viewProjectionMatrix viewProjectionMatrix4
    addBehavior addEffect applyEffect clearEffects project removeBehavior removeEffect screenToWorld setConstraints setStrategy update updateProjectionMatrix updateViewMatrix zoom
    activeStrategyType: string

    The unique type identifier of the active strategy.

    aspect: number

    The aspect ratio (width / height).

    behaviors: Behavior[]

    The behaviors attached to this camera.

    flashColor: Color

    The tint color of the currently strongest active flash contribution.

    flashIntensity: number

    The combined post-processing flash intensity of all active camera effects, in [0, 1].

    pendingDx: number

    Horizontal rotation delta accumulated by behaviors.

    pendingDy: number

    Vertical rotation delta accumulated by behaviors.

    phi: number

    The rotation angle around the X-axis (pitch).

    position: Vector3D

    The position of the camera in world space.

    projection: AbstractProjection

    The active projection (e.g., Perspective, Orthographic).

    strategy: CameraStrategy

    The currently active camera control strategy.

    target: Vector3D

    The target point the camera is looking at.

    theta: number

    The rotation angle around the Y-axis (yaw).

    up: Vector3D

    The up vector of the camera (usually 0, 1, 0).

    viewMatrix: Float32Array

    The view matrix as a Float32Array.

    viewMatrix4: Matrix4

    The view matrix as a Matrix4 instance.

    viewProjectionMatrix: Float32Array

    The combined view-projection matrix as a Float32Array.

    viewProjectionMatrix4: Matrix4

    The combined view-projection matrix as a Matrix4 instance.

    • Adds a new effect to the camera. If an existing effect of the same type accepts a merge (see CameraEffect.merge), effect is absorbed into it instead of being added separately.

      Parameters

      Returns CameraEffect

      The effect that now represents this addition: either effect itself, or the existing effect effect was merged into.

    • Creates and adds a new effect by its type.

      Parameters

      • type: CameraEffectType

        The type of effect.

      • Optionalintensity: number

        The intensity factor.

      • Optionalduration: number

        The duration in seconds.

      • Optionalcolor: Color

        The tint color, only used by effects that support one (e.g. Flash).

      Returns CameraEffect

      The effect that was added (or the existing effect it was merged into).

    • Projects a 3D world position into Normalized Device Coordinates (NDC: [-1, 1] on X, Y, Z). After projection, Z >= -1 means the point is in front of the camera (true NDC depth; with OpenGL-style depth, in-front points closer than ~2x the near plane legitimately have negative NDC Z, so callers MUST NOT gate on Z > 0). The sentinel Z = -2 marks a point behind the camera.

      Parameters

      • worldPos: Vector3D

        The 3D world coordinates.

      • Optionalresult: Vector3D

        Optional Vector3D to receive the result.

      Returns Vector3D

      The projected NDC vector.

    • Maps screen coordinates (NDC -1 to 1) to world coordinates on the Y=0 plane.

      Parameters

      • screenX: number

        Normalized X coordinate (-1 to 1).

      • screenY: number

        Normalized Y coordinate (-1 to 1).

      Returns Vector3D

      The world position on the Y=0 plane.

    • Performs the movement and logic of the active strategy.

      Parameters

      • targetPos: Vector3D

        The target position to follow.

      • dx: number

        The horizontal rotation delta.

      • dy: number

        The vertical rotation delta.

      • OptionaldeltaTime: number

        Elapsed time since the last frame.

      Returns void

    • Adjusts the zoom level (radius, FOV, or orthographic bounds).

      Parameters

      • delta: number

        The zoom delta.

      Returns void

    Settings
    Member Visibility

    On This Page
    Properties
    Methods