ThreePipe
    Preparing search index...

    Interface ISceneEventMap

    interface ISceneEventMap {
        __register: {};
        __unregister: {};
        activateMain: {
            bubbleToParent: boolean;
            camera?: ICamera<ICameraEventMap> | null;
            ui?: boolean;
        };
        activeCameraChange: { camera: ICamera; lastCamera: ICamera };
        activeCameraUpdate: {
            bubbleToParent: boolean;
            camera?: ICamera<ICameraEventMap>;
            ui?: boolean;
        } & Omit<ICameraSetDirtyOptions, "bubbleToParent">;
        added: {};
        addSceneObject: {
            geometryChanged?: boolean;
            object: IObject3D;
            options?: AddObjectOptions;
            updateGround?: boolean;
        };
        backgroundChanged: {
            background: Color
            | "environment"
            | Texture<TextureEventMap>
            | null;
            backgroundColor: Color | null;
            oldTexture: ITexture<TextureEventMap> | null;
            texture: ITexture<TextureEventMap> | null;
        };
        beforeDeserialize: { material: IMaterial } & {
            bubbleToObject: boolean;
            bubbleToParent: boolean;
            data: unknown;
            meta?: SerializationMetaType;
        };
        cameraUpdate: {
            bubbleToParent: boolean;
            camera?: ICamera<ICameraEventMap>;
            ui?: boolean;
        } & Omit<ICameraSetDirtyOptions, "bubbleToParent">;
        dispose: { bubbleToParent: false };
        environmentChanged: {
            environment: ITexture<TextureEventMap> | null;
            oldTexture: ITexture<TextureEventMap> | null;
            texture: ITexture<TextureEventMap> | null;
        };
        geometryChanged: {
            bubbleToParent: boolean;
            geometry: IGeometry<NormalBufferAttributes, BufferGeometryEventMap>
            | null;
            object: IObject3D;
            oldGeometry:
                | IGeometry<NormalBufferAttributes, BufferGeometryEventMap>
                | null;
        };
        geometryUpdate: {
            bubbleToParent: boolean;
            geometry: IGeometry;
            object: IObject3D;
        } & AnyOptions & { bubbleToObject?: boolean };
        mainCameraChange: { camera: ICamera; lastCamera: ICamera };
        mainCameraUpdate: {
            bubbleToParent: boolean;
            camera?: ICamera<ICameraEventMap>;
            ui?: boolean;
        } & Omit<ICameraSetDirtyOptions, "bubbleToParent">;
        materialChanged: {
            bubbleToParent: boolean;
            material:
                | IMaterial<IMaterialEventMap>
                | IMaterial<IMaterialEventMap>[]
                | null;
            object: IObject3D;
            oldMaterial:
                | IMaterial<IMaterialEventMap>
                | IMaterial<IMaterialEventMap>[]
                | null;
        };
        materialUpdate: {
            material: IMaterial<IMaterialEventMap>
            | IMaterial<IMaterialEventMap>[];
        } & IMaterialSetDirtyOptions;
        objectUpdate: { args?: any[]; bubbleToParent: boolean; object: IObject3D } & Omit<
            IObjectSetDirtyOptions,
            "bubbleToParent",
        >;
        parentRootChanged: {
            bubbleToParent: boolean;
            object: IObject3D;
            oldParentRoot: | IObject3D<
                IObject3DEventMap,
                IGeometry<NormalBufferAttributes, BufferGeometryEventMap>
                | undefined,
                IMaterial<IMaterialEventMap> | IMaterial<IMaterialEventMap>[] | undefined,
            >
            | undefined;
        };
        removed: {};
        renderCameraChange: {
            camera: ICamera;
            lastCamera: ICamera<ICameraEventMap>
            | undefined;
        };
        sceneMaterialUpdate: {
            material: IMaterial<IMaterialEventMap>
            | IMaterial<IMaterialEventMap>[];
        } & IMaterialSetDirtyOptions;
        sceneUpdate: {
            bubbleToParent?: boolean;
            change?: string;
            geometry?: | IGeometry<NormalBufferAttributes, BufferGeometryEventMap>
            | null;
            hierarchyChanged?: boolean;
            object?: IObject3D<
                IObject3DEventMap,
                IGeometry<NormalBufferAttributes, BufferGeometryEventMap>
                | undefined,
                IMaterial<IMaterialEventMap> | IMaterial<IMaterialEventMap>[] | undefined,
            >;
            oldGeometry?:
                | IGeometry<NormalBufferAttributes, BufferGeometryEventMap>
                | null;
            refreshScene?: boolean;
            sceneUpdate?: boolean;
        } & ISceneSetDirtyOptions;
        select: {
            bubbleToParent?: boolean;
            focusCamera?: boolean;
            object: IObject3D;
            source?: string;
            trackUndo?: boolean;
            ui?: boolean;
            value?: | IObject3D<
                IObject3DEventMap,
                IGeometry<NormalBufferAttributes, BufferGeometryEventMap>
                | undefined,
                IMaterial<IMaterialEventMap> | IMaterial<IMaterialEventMap>[] | undefined,
            >
            | null;
        };
        setView: { bubbleToParent: boolean; camera: ICamera; ui?: boolean };
        texturesChanged: Omit<
            {
                addedTextures: Set<ITexture<TextureEventMap>>;
                bubbleToObject?: boolean;
                bubbleToParent?: boolean;
                material: IMaterial;
                oldTextures: Set<ITexture<TextureEventMap>>;
                removedTextures: Set<ITexture<TextureEventMap>>;
                textures: Set<ITexture<TextureEventMap>>;
            },
            "material",
        > & { bubbleToParent: boolean; object: IObject3D };
        textureUpdate: {
            bubbleToObject?: boolean;
            bubbleToParent?: boolean;
            texture: ITexture;
            uiChangeEvent?: ChangeEvent;
        };
        update: { args?: any[]; bubbleToParent: boolean; object: IObject3D } & Omit<
            IObjectSetDirtyOptions,
            "bubbleToParent",
        >;
    }

    Hierarchy (View Summary)

    Index

    Properties

    __register: {}
    __unregister: {}
    activateMain: {
        bubbleToParent: boolean;
        camera?: ICamera<ICameraEventMap> | null;
        ui?: boolean;
    }

    Type Declaration

    • bubbleToParent: boolean
    • Optionalcamera?: ICamera<ICameraEventMap> | null

      Set to the camera being activated as main camera. If null, the default camera will be set If undefined, the last activated camera will be set, or the default camera if no camera was activated before.

    • Optionalui?: boolean
    activeCameraChange: { camera: ICamera; lastCamera: ICamera }

    use mainCameraChange instead

    activeCameraUpdate: {
        bubbleToParent: boolean;
        camera?: ICamera<ICameraEventMap>;
        ui?: boolean;
    } & Omit<ICameraSetDirtyOptions, "bubbleToParent">

    use mainCameraUpdate instead

    added: {}

    Fires when the object has been added to its parent object.

    addSceneObject: {
        geometryChanged?: boolean;
        object: IObject3D;
        options?: AddObjectOptions;
        updateGround?: boolean;
    }
    backgroundChanged: {
        background: Color | "environment" | Texture<TextureEventMap> | null;
        backgroundColor: Color | null;
        oldTexture: ITexture<TextureEventMap> | null;
        texture: ITexture<TextureEventMap> | null;
    }
    beforeDeserialize: { material: IMaterial } & {
        bubbleToObject: boolean;
        bubbleToParent: boolean;
        data: unknown;
        meta?: SerializationMetaType;
    }
    cameraUpdate: {
        bubbleToParent: boolean;
        camera?: ICamera<ICameraEventMap>;
        ui?: boolean;
    } & Omit<ICameraSetDirtyOptions, "bubbleToParent">
    dispose: { bubbleToParent: false }
    environmentChanged: {
        environment: ITexture<TextureEventMap> | null;
        oldTexture: ITexture<TextureEventMap> | null;
        texture: ITexture<TextureEventMap> | null;
    }
    geometryChanged: {
        bubbleToParent: boolean;
        geometry: IGeometry<NormalBufferAttributes, BufferGeometryEventMap> | null;
        object: IObject3D;
        oldGeometry:
            | IGeometry<NormalBufferAttributes, BufferGeometryEventMap>
            | null;
    }
    geometryUpdate: {
        bubbleToParent: boolean;
        geometry: IGeometry;
        object: IObject3D;
    } & AnyOptions & { bubbleToObject?: boolean }
    mainCameraChange: { camera: ICamera; lastCamera: ICamera }
    mainCameraUpdate: {
        bubbleToParent: boolean;
        camera?: ICamera<ICameraEventMap>;
        ui?: boolean;
    } & Omit<ICameraSetDirtyOptions, "bubbleToParent">
    materialChanged: {
        bubbleToParent: boolean;
        material:
            | IMaterial<IMaterialEventMap>
            | IMaterial<IMaterialEventMap>[]
            | null;
        object: IObject3D;
        oldMaterial:
            | IMaterial<IMaterialEventMap>
            | IMaterial<IMaterialEventMap>[]
            | null;
    }
    objectUpdate: { args?: any[]; bubbleToParent: boolean; object: IObject3D } & Omit<
        IObjectSetDirtyOptions,
        "bubbleToParent",
    >
    parentRootChanged: {
        bubbleToParent: boolean;
        object: IObject3D;
        oldParentRoot:
            | IObject3D<
                IObject3DEventMap,
                IGeometry<NormalBufferAttributes, BufferGeometryEventMap>
                | undefined,
                IMaterial<IMaterialEventMap> | IMaterial<IMaterialEventMap>[] | undefined,
            >
            | undefined;
    }
    removed: {}

    Fires when the object has been removed from its parent object.

    renderCameraChange: {
        camera: ICamera;
        lastCamera: ICamera<ICameraEventMap> | undefined;
    }
    sceneMaterialUpdate: {
        material: IMaterial<IMaterialEventMap> | IMaterial<IMaterialEventMap>[];
    } & IMaterialSetDirtyOptions

    use materialUpdate instead

    sceneUpdate: {
        bubbleToParent?: boolean;
        change?: string;
        geometry?: IGeometry<NormalBufferAttributes, BufferGeometryEventMap> | null;
        hierarchyChanged?: boolean;
        object?: IObject3D<
            IObject3DEventMap,
            IGeometry<NormalBufferAttributes, BufferGeometryEventMap>
            | undefined,
            IMaterial<IMaterialEventMap> | IMaterial<IMaterialEventMap>[] | undefined,
        >;
        oldGeometry?:
            | IGeometry<NormalBufferAttributes, BufferGeometryEventMap>
            | null;
        refreshScene?: boolean;
        sceneUpdate?: boolean;
    } & ISceneSetDirtyOptions

    Type Declaration

    select: {
        bubbleToParent?: boolean;
        focusCamera?: boolean;
        object: IObject3D;
        source?: string;
        trackUndo?: boolean;
        ui?: boolean;
        value?:
            | IObject3D<
                IObject3DEventMap,
                IGeometry<NormalBufferAttributes, BufferGeometryEventMap>
                | undefined,
                IMaterial<IMaterialEventMap> | IMaterial<IMaterialEventMap>[] | undefined,
            >
            | null;
    }
    setView: { bubbleToParent: boolean; camera: ICamera; ui?: boolean }
    texturesChanged: Omit<
        {
            addedTextures: Set<ITexture<TextureEventMap>>;
            bubbleToObject?: boolean;
            bubbleToParent?: boolean;
            material: IMaterial;
            oldTextures: Set<ITexture<TextureEventMap>>;
            removedTextures: Set<ITexture<TextureEventMap>>;
            textures: Set<ITexture<TextureEventMap>>;
        },
        "material",
    > & { bubbleToParent: boolean; object: IObject3D }
    textureUpdate: {
        bubbleToObject?: boolean;
        bubbleToParent?: boolean;
        texture: ITexture;
        uiChangeEvent?: ChangeEvent;
    }
    update: { args?: any[]; bubbleToParent: boolean; object: IObject3D } & Omit<
        IObjectSetDirtyOptions,
        "bubbleToParent",
    >

    use objectUpdate or sceneUpdate instead