Selva Compute API Reference - v1.5.1
    Preparing search index...

    Type Alias EventConfig

    type EventConfig = {
        enableClickToFocus?: boolean;
        enableDoubleClickZoom?: boolean;
        enableEventHandlers?: boolean;
        enableKeyboardControls?: boolean;
        onBackgroundClicked?: (event: { x: number; y: number }) => void;
        onFrame?: (delta: number) => void;
        onMeshDoubleClicked?: (object: Object3D) => void;
        onMeshMetadataClicked?: (metadata: Record<string, string>) => void;
        onObjectSelected?: (object: Object3D) => void;
        onReady?: () => void;
        selectionColor?: Color | string;
    }
    Index

    Properties

    enableClickToFocus? enableDoubleClickZoom? enableEventHandlers? enableKeyboardControls? onBackgroundClicked? onFrame? onMeshDoubleClicked? onMeshMetadataClicked? onObjectSelected? onReady? selectionColor?

    Properties

    enableClickToFocus?: boolean
    enableDoubleClickZoom?: boolean

    Zoom into a mesh on double-click. Defaults to true.

    enableEventHandlers?: boolean

    Enable all event handlers (click/selection/metadata). Defaults to true.

    enableKeyboardControls?: boolean
    onBackgroundClicked?: (event: { x: number; y: number }) => void
    onFrame?: (delta: number) => void

    Called every animation frame, after controls update and before render. Use for custom per-frame logic.

    onMeshDoubleClicked?: (object: Object3D) => void

    Called when a mesh is double-clicked. Receives the mesh object.

    onMeshMetadataClicked?: (metadata: Record<string, string>) => void

    Called when a mesh with metadata is clicked. Receives the mesh's metadata object.

    onObjectSelected?: (object: Object3D) => void
    onReady?: () => void

    Called once the HDR environment map has finished loading and been applied to the scene.

    selectionColor?: Color | string

    Color to use for highlighting selected meshes. Defaults to red (#ff0000).

    Settings

    Member Visibility

    On This Page

    Properties