API (v2.0.0) - Giro3D
    Preparing search index...

    Interface ImageCollectionBaseOptions<TSource>

    Constructor options for the OrientedImageCollection entity.

    interface ImageCollectionBaseOptions<TSource extends ImageSource> {
        images?: { opacity?: number; visible?: boolean };
        locationSpheres?: {
            color?: ColorRepresentation;
            radius?: number;
            visible?: boolean;
        };
        name?: string;
        object3d?: Object3D<Object3DEventMap>;
        source: ImageCollectionBaseSource<TSource>;
        wireframes?: { color?: ColorRepresentation; visible?: boolean };
    }

    Type Parameters

    Hierarchy (View Summary)

    Index

    Properties

    images? locationSpheres? name? object3d? source wireframes?

    Properties

    images?: { opacity?: number; visible?: boolean }

    Type Declaration

    • Optionalopacity?: number

      The opacity of the image object.

      1
    • Optionalvisible?: boolean

      Display the actual images. Note, if the .imageUrl property is undefined, then a blank rectangle is displayed instead.

      false
    locationSpheres?: {
        color?: ColorRepresentation;
        radius?: number;
        visible?: boolean;
    }

    Location spheres show the location of the camera when an image was taken.

    Type Declaration

    • Optionalcolor?: ColorRepresentation

      The color of the location spheres.

      green
    • Optionalradius?: number

      The radius of the location spheres, in CRS units.

      0.5
    • Optionalvisible?: boolean

      Display the location spheres at the origin of each image.

      true
    name?: string

    The optional display name of this entity. Mostly used for debugging.

    object3d?: Object3D<Object3DEventMap>

    The root object of this entity. If none is provided, a new Group is created.

    source: ImageCollectionBaseSource<TSource>

    The OrientedImageCollection source.

    wireframes?: { color?: ColorRepresentation; visible?: boolean }

    Wireframes represent the field of view of each image.

    Type Declaration

    • Optionalcolor?: ColorRepresentation

      The color of the camera wireframes.

      green
    • Optionalvisible?: boolean

      Display the wireframe of each image.

      true

    Settings

    Member Visibility

    On This Page

    Properties