Interface OrientedImageCollectionOptions

Constructor options for the OrientedImageCollection entity.

interface OrientedImageCollectionOptions {
    frustums?: {
        color?: ColorRepresentation;
        visible?: boolean;
    };
    images?: {
        opacity?: number;
        visible?: boolean;
    };
    locationSpheres?: {
        color?: ColorRepresentation;
        radius?: number;
        visible?: boolean;
    };
    name?: string;
    object3d?: Object3D<Object3DEventMap>;
    source: OrientedImageCollectionSource;
}

Hierarchy (view full)

Properties

frustums? images? locationSpheres? name? object3d? source

Properties

Optionalfrustums

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

Frustums represent the field of view of each images as a view cone.

Type declaration

  • Optionalcolor?: ColorRepresentation

    The color of the camera frustums.

    Default Value

    green
  • Optionalvisible?: boolean

    Display the frustum of each image.

    Default Value

    true

Optionalimages

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

Type declaration

  • Optionalopacity?: number

    The opacity of the image object.

    Default Value

    1
  • Optionalvisible?: boolean

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

    Default Value

    false

OptionallocationSpheres

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.

    Default Value

    green
  • Optionalradius?: number

    The radius of the location spheres, in CRS units.

    Default Value

    0.5
  • Optionalvisible?: boolean

    Display the location spheres at the origin of each image.

    Default Value

    true

Optionalname

name?: string

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

Optionalobject3d

object3d?: Object3D<Object3DEventMap>

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

source

source: OrientedImageCollectionSource

The OrientedImageCollection source.

Settings

Member Visibility

On This Page

Properties