PixiThree - v0.0.16
    Preparing search index...

    Interface ThreeSceneContextValue

    Context value for Three view coordinate mapping. Works in ThreeScene (inside CanvasView) and ThreeRenderTexture.

    interface ThreeSceneContextValue {
        mapClientToNdc: (
            client: Point | { clientX: number; clientY: number },
            out?: Vector2,
        ) => Vector2 | null;
        mapNdcToPixi: (ndc: Vector2, out?: Point) => Point;
        mapPixiToNdc: (point: Point, out?: Vector2) => Vector2;
        mapThreeToClient: (vec3: Vector3, out?: Point) => Point[];
        mapThreeToParentPixi: (vec3: Vector3, out?: Point) => Point;
        mapThreeToParentPixiLocal: (vec3: Vector3, out?: Point) => Point;
        mapThreeToViewport: (vec3: Vector3, out?: Point) => Point[];
        mapViewportToNdc: (viewport: Point, out?: Vector2) => Vector2 | null;
        parentThree?: ThreeViewParentThreeContextValue;
        raycastClient: <
            T extends
                Object3D<Object3DEventMap>
                | Plane
                | Object3D<Object3DEventMap>[] = Object3D<Object3DEventMap>,
        >(
            client: Point | { clientX: number; clientY: number },
            target?: T,
            recursive?: boolean,
        ) => RaycastResult<T>[];
        raycastNdc: <
            T extends
                Object3D<Object3DEventMap>
                | Plane
                | Object3D<Object3DEventMap>[] = Object3D<Object3DEventMap>,
        >(
            ndc: Vector2,
            target?: T,
            recursive?: boolean,
        ) => RaycastResult<T>[];
        raycastViewport: <
            T extends
                Object3D<Object3DEventMap>
                | Plane
                | Object3D<Object3DEventMap>[] = Object3D<Object3DEventMap>,
        >(
            viewport: Point,
            target?: T,
            recursive?: boolean,
        ) => RaycastResult<T>[];
    }
    Index

    Properties

    mapClientToNdc mapNdcToPixi mapPixiToNdc mapThreeToClient mapThreeToParentPixi mapThreeToParentPixiLocal mapThreeToViewport mapViewportToNdc parentThree? raycastClient raycastNdc raycastViewport

    Properties

    mapClientToNdc: (
        client: Point | { clientX: number; clientY: number },
        out?: Vector2,
    ) => Vector2 | null

    Maps DOM client coordinates to NDC coordinates.

    Type Declaration

      • (
            client: Point | { clientX: number; clientY: number },
            out?: Vector2,
        ): Vector2 | null

      • Parameters

        • client: Point | { clientX: number; clientY: number }

          DOM client coordinates

        • Optionalout: Vector2

          Optional Vector2 to store the NDC result

        Returns Vector2 | null

        The NDC Vector2, or null if no hit (in PixiTexture context)

    mapNdcToPixi: (ndc: Vector2, out?: Point) => Point

    Maps Three.js NDC coordinates (-1 to 1) to a Pixi Point (in local sprite coordinates).

    Type Declaration

      • (ndc: Vector2, out?: Point): Point

      • Parameters

        • ndc: Vector2

          Vector2 with NDC coordinates

        • Optionalout: Point

          Optional Pixi Point to store the result

        Returns Point

        The Pixi Point

    mapPixiToNdc: (point: Point, out?: Vector2) => Vector2

    Maps a Pixi Point (in local sprite coordinates) to Three.js NDC coordinates (-1 to 1).

    Type Declaration

      • (point: Point, out?: Vector2): Vector2

      • Parameters

        • point: Point

          Pixi Point in local coordinates

        • Optionalout: Vector2

          Optional Vector2 to store the NDC result

        Returns Vector2

        The NDC Vector2

    mapThreeToClient: (vec3: Vector3, out?: Point) => Point[]

    Maps a Three.js world position to DOM client coordinates.

    Type Declaration

      • (vec3: Vector3, out?: Point): Point[]

      • Parameters

        • vec3: Vector3

          Three.js Vector3 in world coordinates

        • Optionalout: Point

          Optional Pixi Point to store the first result

        Returns Point[]

        Array of Points in client coords

    mapThreeToParentPixi: (vec3: Vector3, out?: Point) => Point

    Maps a Three.js world position to global Pixi parent coordinates.

    Type Declaration

      • (vec3: Vector3, out?: Point): Point

      • Parameters

        • vec3: Vector3

          Three.js Vector3 in world coordinates

        • Optionalout: Point

          Optional Pixi Point to store the result in global Pixi coords

        Returns Point

        The Pixi Point

    mapThreeToParentPixiLocal: (vec3: Vector3, out?: Point) => Point

    Maps a Three.js world position to local Pixi sprite coordinates.

    Type Declaration

      • (vec3: Vector3, out?: Point): Point

      • Parameters

        • vec3: Vector3

          Three.js Vector3 in world coordinates

        • Optionalout: Point

          Optional Pixi Point to store the result in local sprite coords

        Returns Point

        The Pixi Point

    mapThreeToViewport: (vec3: Vector3, out?: Point) => Point[]

    Maps a Three.js world position to CanvasView viewport coordinates.

    Type Declaration

      • (vec3: Vector3, out?: Point): Point[]

      • Parameters

        • vec3: Vector3

          Three.js Vector3 in world coordinates

        • Optionalout: Point

          Optional Pixi Point to store the first result

        Returns Point[]

        Array of Points in viewport coords

    mapViewportToNdc: (viewport: Point, out?: Vector2) => Vector2 | null

    Maps viewport coordinates to NDC coordinates.

    Type Declaration

      • (viewport: Point, out?: Vector2): Vector2 | null

      • Parameters

        • viewport: Point

          Viewport Point coordinates

        • Optionalout: Vector2

          Optional Vector2 to store the NDC result

        Returns Vector2 | null

        The NDC Vector2, or null if no hit (in PixiTexture context)

    parentThree?: ThreeViewParentThreeContextValue

    Parent Three coordinate mapping functions. Only available inside a ThreeRenderTexture context.

    Type Declaration

    Parent Three context for coordinate mapping from ThreeScene to parent Three scene. Only available inside a ThreeRenderTexture context.

    • mapThreeToParentThree: (vec3: Vector3, out?: Vector3) => Vector3

      Maps a Three.js world position to world coordinates in the parent Three scene.

    • mapThreeToParentThreeLocal: (vec3: Vector3, out?: Vector3) => Vector3

      Maps a Three.js world position to local coordinates on the parent Three mesh surface.

    • mapThreeToParentUv: (vec3: Vector3, out?: Vector2) => Vector2

      Maps a Three.js world position to UV coordinates.

    raycastClient: <
        T extends
            Object3D<Object3DEventMap>
            | Plane
            | Object3D<Object3DEventMap>[] = Object3D<Object3DEventMap>,
    >(
        client: Point | { clientX: number; clientY: number },
        target?: T,
        recursive?: boolean,
    ) => RaycastResult<T>[]

    Raycasts from DOM client coordinates through the camera.

    Type Declaration

      • <
            T extends
                Object3D<Object3DEventMap>
                | Plane
                | Object3D<Object3DEventMap>[] = Object3D<Object3DEventMap>,
        >(
            client: Point | { clientX: number; clientY: number },
            target?: T,
            recursive?: boolean,
        ): RaycastResult<T>[]

      • Type Parameters

        • T extends Object3D<Object3DEventMap> | Plane | Object3D<Object3DEventMap>[] = Object3D<Object3DEventMap>

        Parameters

        • client: Point | { clientX: number; clientY: number }

          DOM client coordinates (Point with x/y or clientX/clientY)

        • Optionaltarget: T

          Optional target object(s) or plane to intersect. Default, scene children.

        • Optionalrecursive: boolean

          Whether to recursively traverse children. Default true.

        Returns RaycastResult<T>[]

        Array of intersections

    raycastNdc: <
        T extends
            Object3D<Object3DEventMap>
            | Plane
            | Object3D<Object3DEventMap>[] = Object3D<Object3DEventMap>,
    >(
        ndc: Vector2,
        target?: T,
        recursive?: boolean,
    ) => RaycastResult<T>[]

    Raycasts from NDC coordinates through the camera.

    Type Declaration

      • <
            T extends
                Object3D<Object3DEventMap>
                | Plane
                | Object3D<Object3DEventMap>[] = Object3D<Object3DEventMap>,
        >(
            ndc: Vector2,
            target?: T,
            recursive?: boolean,
        ): RaycastResult<T>[]

      • Type Parameters

        • T extends Object3D<Object3DEventMap> | Plane | Object3D<Object3DEventMap>[] = Object3D<Object3DEventMap>

        Parameters

        • ndc: Vector2

          NDC coordinates (-1 to 1)

        • Optionaltarget: T

          Optional target object(s) or plane to intersect. Default, scene children.

        • Optionalrecursive: boolean

          Whether to recursively traverse children. Default true.

        Returns RaycastResult<T>[]

        Array of intersections

    raycastViewport: <
        T extends
            Object3D<Object3DEventMap>
            | Plane
            | Object3D<Object3DEventMap>[] = Object3D<Object3DEventMap>,
    >(
        viewport: Point,
        target?: T,
        recursive?: boolean,
    ) => RaycastResult<T>[]

    Raycasts from viewport coordinates through the camera.

    Type Declaration

      • <
            T extends
                Object3D<Object3DEventMap>
                | Plane
                | Object3D<Object3DEventMap>[] = Object3D<Object3DEventMap>,
        >(
            viewport: Point,
            target?: T,
            recursive?: boolean,
        ): RaycastResult<T>[]

      • Type Parameters

        • T extends Object3D<Object3DEventMap> | Plane | Object3D<Object3DEventMap>[] = Object3D<Object3DEventMap>

        Parameters

        • viewport: Point

          Viewport Point coordinates

        • Optionaltarget: T

          Optional target object(s) or plane to intersect. Default, scene children.

        • Optionalrecursive: boolean

          Whether to recursively traverse children. Default true.

        Returns RaycastResult<T>[]

        Array of intersections

    Settings

    Member Visibility

    On This Page

    Properties