PixiThree - v0.0.16
    Preparing search index...

    Interface ThreeViewParentThreeContextValue

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

    interface ThreeViewParentThreeContextValue {
        mapThreeToParentThree: (vec3: Vector3, out?: Vector3) => Vector3;
        mapThreeToParentThreeLocal: (vec3: Vector3, out?: Vector3) => Vector3;
        mapThreeToParentUv: (vec3: Vector3, out?: Vector2) => Vector2;
    }
    Index

    Properties

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

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

    Type Declaration

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

        • vec3: Vector3

          Three.js Vector3 in world coordinates

        • Optionalout: Vector3

          Optional Vector3 to store the result in parent world coords

        Returns Vector3

        The world Vector3

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

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

    Type Declaration

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

        • vec3: Vector3

          Three.js Vector3 in world coordinates

        • Optionalout: Vector3

          Optional Vector3 to store the result in local mesh coords

        Returns Vector3

        The local Vector3

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

    Maps a Three.js world position to UV coordinates.

    Type Declaration

      • (vec3: Vector3, out?: Vector2): Vector2
      • Parameters

        • vec3: Vector3

          Three.js Vector3 in world coordinates

        • Optionalout: Vector2

          Optional Vector2 to store the UV result

        Returns Vector2

        The UV Vector2