Interface CreateShapeOptions

Options for the DrawTool.createShape method.

interface CreateShapeOptions {
    afterInsertPoint?: PostHook<InsertPointHook>;
    afterRemovePoint?: PostHook<RemovePointHook>;
    afterUpdatePoint?: PostHook<UpdatePointHook>;
    beforeInsertPoint?: PreHook<InsertPointHook>;
    beforeRemovePoint?: PreHook<RemovePointHook>;
    beforeUpdatePoint?: PreHook<UpdatePointHook>;
    borderWidth?: number;
    closeRing?: boolean;
    color?: ColorRepresentation;
    constraints?: Permissions;
    endCondition?: MouseCallback;
    floorElevation?: number;
    fontSize?: number;
    fontWeight?: ShapeFontWeight;
    labelOpacity?: number;
    lineLabelFormatter?: LineLabelFormatter;
    lineWidth?: number;
    maxPoints?: number;
    minPoints?: number;
    name?: string;
    object3d?: Object3D<Object3DEventMap>;
    onPointCreated?: ((shape: entities.Shape<EntityUserData>, index: number, position: Vector3) => void);
    onTemporaryPointMoved?: ((shape: entities.Shape<EntityUserData>, position: Vector3) => void);
    pick?: PickCallback<PickResult<unknown>>;
    pickableLabels?: boolean;
    segmentLabelFormatter?: SegmentLabelFormatter;
    showFloorLine?: boolean;
    showFloorVertices?: boolean;
    showLine?: boolean;
    showLineLabel?: boolean;
    showSegmentLabels?: boolean;
    showSurface?: boolean;
    showSurfaceLabel?: boolean;
    showVertexLabels?: boolean;
    showVerticalLineLabels?: boolean;
    showVerticalLines?: boolean;
    showVertices?: boolean;
    signal?: AbortSignal;
    surfaceLabelFormatter?: SurfaceLabelFormatter;
    surfaceLabelPlacement?: SurfaceLabelPlacement;
    surfaceOpacity?: number;
    vertexLabelFormatter?: VertexLabelFormatter;
    vertexRadius?: number;
    verticalLineLabelFormatter?: VerticalLineLabelFormatter;
}

Hierarchy (view full)

Properties

afterInsertPoint? afterRemovePoint? afterUpdatePoint? beforeInsertPoint? beforeRemovePoint? beforeUpdatePoint? borderWidth? closeRing? color? constraints? endCondition? floorElevation? fontSize? fontWeight? labelOpacity? lineLabelFormatter? lineWidth? maxPoints? minPoints? name? object3d? onPointCreated? onTemporaryPointMoved? pick? pickableLabels? segmentLabelFormatter? showFloorLine? showFloorVertices? showLine? showLineLabel? showSegmentLabels? showSurface? showSurfaceLabel? showVertexLabels? showVerticalLineLabels? showVerticalLines? showVertices? signal? surfaceLabelFormatter? surfaceLabelPlacement? surfaceOpacity? vertexLabelFormatter? vertexRadius? verticalLineLabelFormatter?

Properties

OptionalafterInsertPoint

afterInsertPoint?: PostHook<InsertPointHook>

An optional hook to be called just after a point is inserted.

OptionalafterRemovePoint

afterRemovePoint?: PostHook<RemovePointHook>

An optional hook to be called just after a point is removed.

OptionalafterUpdatePoint

afterUpdatePoint?: PostHook<UpdatePointHook>

An optional hook to be called just after a point is updated.

OptionalbeforeInsertPoint

beforeInsertPoint?: PreHook<InsertPointHook>

An optional hook to be called just before a point is inserted. If the hook returns false, the point is not inserted.

OptionalbeforeRemovePoint

beforeRemovePoint?: PreHook<RemovePointHook>

An optional hook to be called just before a point is removed. If the hook returns false, the point is not removed.

OptionalbeforeUpdatePoint

beforeUpdatePoint?: PreHook<UpdatePointHook>

An optional hook to be called just before a point is updated. If the hook returns false, the point is not updated.

OptionalborderWidth

borderWidth?: number

The width, in pixels, of the border around vertices and lines.

Default Value

DEFAULT_BORDER_WIDTH

OptionalcloseRing

closeRing?: boolean

If true, the shape's line will be closed just before being returned to the caller.

Optionalcolor

color?: ColorRepresentation

The main color of the shape. Affects lines, vertices, surfaces and labels.

Default Value

DEFAULT_COLOR

Optionalconstraints

constraints?: Permissions

An optional list of permitted operations.

OptionalendCondition

endCondition?: MouseCallback

The input required to finish drawing the shape. Does not apply to shapes that require a fixed number of points (i.e point, segment, etc).

Default Value

right click

OptionalfloorElevation

floorElevation?: number

The floor elevation, in meters.

Default Value

0

OptionalfontSize

fontSize?: number

The label font size.

Default Value

DEFAULT_FONT_SIZE

OptionalfontWeight

fontWeight?: ShapeFontWeight

The label font weight.

Default Value

'bold'

OptionallabelOpacity

labelOpacity?: number

The specific opacity of the labels.

Default Value

1

OptionallineLabelFormatter

lineLabelFormatter?: LineLabelFormatter

A custom formatter for the line label.

OptionallineWidth

lineWidth?: number

The width, in pixels, of lines.

Default Value

DEFAULT_LINE_WIDTH

OptionalmaxPoints

maxPoints?: number

The maximum number of points to create before the shape is automatically completed.

OptionalminPoints

minPoints?: number

The minimum number of points to create before the shape can be completed.

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.

OptionalonPointCreated

onPointCreated?: ((shape: entities.Shape<EntityUserData>, index: number, position: Vector3) => void)

An optional callback to be called when a point has been added to the shape.

Type declaration

    • (shape, index, position): void

    • Parameters

      Returns void

OptionalonTemporaryPointMoved

onTemporaryPointMoved?: ((shape: entities.Shape<EntityUserData>, position: Vector3) => void)

An optional callback to be called when a point has been moved.

Type declaration

Optionalpick

pick?: PickCallback<PickResult<unknown>>

The optional custom picking function.

OptionalpickableLabels

pickableLabels?: boolean

Make labels pickable.

Default Value

false

OptionalsegmentLabelFormatter

segmentLabelFormatter?: SegmentLabelFormatter

A custom formatter for segment labels.

OptionalshowFloorLine

showFloorLine?: boolean

Shows the line that is the vertical projection of the line on the plane at the floorElevation.

Default Value

DEFAULT_SHOW_FLOOR_LINE

OptionalshowFloorVertices

showFloorVertices?: boolean

Shows floor vertices.

Default Value

DEFAULT_SHOW_FLOOR_VERTICES

OptionalshowLine

showLine?: boolean

Shows the line that connects each vertex.

Default Value

DEFAULT_SHOW_LINE

OptionalshowLineLabel

showLineLabel?: boolean

Display a label for the entire line.

Default Value

false

OptionalshowSegmentLabels

showSegmentLabels?: boolean

Display labels for each segment of the line.

Default Value

false

OptionalshowSurface

showSurface?: boolean

Show the surface polygon.

Default Value

DEFAULT_SHOW_SURFACE

OptionalshowSurfaceLabel

showSurfaceLabel?: boolean

Display a label for the surface.

Default Value

false

OptionalshowVertexLabels

showVertexLabels?: boolean

Display a label for each vertex.

Default Value

false

OptionalshowVerticalLineLabels

showVerticalLineLabels?: boolean

Display labels for vertical lines.

Default Value

false

OptionalshowVerticalLines

showVerticalLines?: boolean

Show vertical lines that connect each vertex to each floor vertex.

Default Value

DEFAULT_SHOW_VERTICAL_LINES

OptionalshowVertices

showVertices?: boolean

Show vertices.

Default Value

DEFAULT_SHOW_VERTICES

Optionalsignal

signal?: AbortSignal

The optional signal to listen to cancel the creation of a shape.

OptionalsurfaceLabelFormatter

surfaceLabelFormatter?: SurfaceLabelFormatter

A custom formatter for the surface label.

OptionalsurfaceLabelPlacement

surfaceLabelPlacement?: SurfaceLabelPlacement

An optional function to compute the location of the surface label.

OptionalsurfaceOpacity

surfaceOpacity?: number

The opacity of the surface.

Default Value

DEFAULT_SURFACE_OPACITY

OptionalvertexLabelFormatter

vertexLabelFormatter?: VertexLabelFormatter

A custom formatter for the vertex labels.

OptionalvertexRadius

vertexRadius?: number

The radius, in pixels, of vertices.

Default Value

DEFAULT_VERTEX_RADIUS

OptionalverticalLineLabelFormatter

verticalLineLabelFormatter?: VerticalLineLabelFormatter

A custom formatter for vertical line labels.

Settings

Member Visibility

On This Page

Properties