OptionaldomElement?: HTMLElementThe DOM element to listen to. If unspecified, this will use Instance.domElement.
The Giro3D instance.
Creates an extent-like Shape.
Optionaloptions: CreationOptionsThe options.
A promise that eventually returns the Shape or null if creation was cancelled.
Creates a LineString Shape.
OptionalcreationOptions: CreationOptionsThe options.
A promise that eventually returns the Shape or null if creation was cancelled.
Creates multiple point Shapes.
Optionaloptions: CreationOptionsThe options.
A promise that eventually returns the Shape or null if creation was cancelled.
Interactively draws a segment, calling the provided callback every time the second point of the segment is moved. This method returns when the user clicks to confirm the position of the last point.
Note: the segment itself is not visible, it is the responsibility of the caller to create the appropriate visual representation depending on the desired effect.
Creates a single point Shape.
Optionaloptions: CreationOptionsThe options.
A promise that eventually returns the Shape or null if creation was cancelled.
Creates a polygon Shape.
Optionaloptions: CreationOptionsThe options.
A promise that eventually returns the Shape or null if creation was cancelled.
Create a closed ring Shape.
Optionaloptions: CreationOptionsThe options.
A promise that eventually returns the Shape or null if creation was cancelled.
Create a sector Shape.
Optionaloptions: CreationOptionsThe options.
A promise that eventually returns the Shape or null if creation was cancelled.
Create a segment (straight line between two points).
Optionaloptions: CreationOptionsThe options.
A promise that eventually returns the Shape or null if creation was cancelled.
Starts creating a Shape with the given parameters.
The shape creation options.
A promise that eventually resolves with the created shape, or null if the creation
was cancelled.
Creates a vertical measure Shape that displays the vertical distance between the start and end point, as well as the angle between the segment formed by those points and the horizontal plane. The shape looks like a right triangle.
Optionaloptions: CreationOptionsThe options.
A promise that eventually returns the Shape or null if creation was cancelled.
Disposes unmanaged resources created by this instance.
Enter edition mode. In this mode, existing Shapes can be modified (add/remove points, move points).
Optionaloptions: {The options.
OptionalonBeforePointMoved?: MouseCallbackThe optional callback called just before a point is clicked, to determine if it can be moved. By default, points are moved with a left click.
OptionalonBeforePointRemoved?: MouseCallbackThe optional callback called just before a point is clicked, to determine if it can be deleted. By default, points are removed with a click on the middle mouse button or Alt + Left click.
OptionalonPointInserted?: PointInsertedCallbackAn optional callback called when a point has been inserted.
OptionalonPointRemoved?: PointRemovedCallbackAn optional callback called when a point has been removed.
OptionalonPointUpdated?: PointUpdatedCallbackAn optional callback called when a point has been updated (i.e moved).
OptionalonSegmentClicked?: MouseCallbackThe optional callback to test for mouse or key combination when a segment is clicked. By default, points are inserted with a left click.
Optionalpick?: PickCallback<PickResult<unknown>>The custom picking function. If unspecified, the default one will be used.
OptionalpickShapes?: PickCallback<ShapePickResult>A picking function to pick shapes only. If unspecified, the default one will be used.
OptionalshapesToEdit?: Shape<EntityUserData>[]The shapes to edit. If undefined or empty, all shapes become editable.
Exits edition mode.
A tool that allows interactive creation and edition of Shapes.
Creation
To create shapes, you can either use one of the preset methods (createSegment, createPolygon...), or start creating a free shape with createShape.
This method allows fine control over the constraints to apply to the shape (how many vertices, styling options, what component to display...).
Edition
The enterEditMode method allows the user to edit any shape that the mouse interacts with. Depending on the constraints put on the shape during the creation (assuming of course that the shape was created with this tool), some operations might not be permitted.
To exit edition mode, call exitEditMode.
Examples of constraints
If a shape was created with the createSegment method, it is not possible to insert or remove points, because the constraint forces the shape to have exactly 2 points.
If a shape was created with the createPolygon method, then any time the user moves the first or last vertex, the other one is automatically moved at the same position, to ensure the shape remains closed.