Documentation - v19.16.0-dev
    Preparing search index...

    One sprite to add to the SpriteController: an image facing the camera, of a size in world units, at a world position. The controller copies what it needs: an InputSprite can be reused once added.

    interface InputSprite {
        height: number;
        ignoreCuttingPlanes?: boolean;
        image: TextureImage;
        layer?: MeshLayer;
        opacity?: number;
        position: Vector3;
        width: number;
    }
    Index

    Properties

    height: number

    Height, in world units.

    ignoreCuttingPlanes?: boolean

    Whether it is left whole by the scene's cutting planes (see CuttingPlanesController); default false: cut as the meshes, its part behind a plane neither drawn nor picked.

    Its image, filling its rectangle: of the image's aspect, it shows it undistorted.

    layer?: MeshLayer

    The layer it is drawn in (see MeshLayer); default MeshLayer.Layer4, over every other.

    opacity?: number

    Opacity in 0..1, its image still alpha-tested; default 1.

    position: Vector3

    World position of its centre.

    width: number

    Width, in world units.