CivilPlanNavigator

This component is responsible for navigating and visualizing plan data of infra/civil models (horizontal alignments). 📕 Tutorial. 📘 API.

Extends

• CivilNavigator

Properties

enabled

enabled: boolean = true

OBC.Component.enabled

Inherited from

CivilNavigator . enabled

---

mouseMarkers?

optional mouseMarkers: object

Mouse markers for hover and select actions. They are of type Mark and are optional.

hover

hover: Mark

select

select: Mark

Inherited from

CivilNavigator . mouseMarkers

---

onDisposed

readonly onDisposed: Event<unknown>

OBC.Disposable.onDisposed

Inherited from

CivilNavigator . onDisposed

---

onHighlight

readonly onHighlight: Event<object>

Event triggered when a curve is highlighted. Provides the point of intersection and the corresponding curve mesh.

Type declaration

mesh

mesh: CurveMesh<BufferGeometry<NormalBufferAttributes>, Material | Material[]>

point

point: Vector3

Inherited from

CivilNavigator . onHighlight

---

onMarkerChange

readonly onMarkerChange: Event<object>

Event triggered when a marker (hover or select) is placed on a curve. Provides the alignment, percentage, type of marker, and the corresponding curve.

Type declaration

alignment

alignment: Alignment

curve

curve: CivilCurve

percentage

percentage: number

type

type: CivilMarkerType

Inherited from

CivilNavigator . onMarkerChange

---

onMarkerHidden

readonly onMarkerHidden: Event<object>

Event triggered when a marker (hover or select) is hidden. Provides the type of marker.

Type declaration

type

type: CivilMarkerType

Inherited from

CivilNavigator . onMarkerHidden

---

view

readonly view: "horizontal" = "horizontal"

The view mode of the component. In this case, the view mode is set to "horizontal".

Overrides

CivilNavigator . view

---

uuid

static readonly uuid: "3096dea0-5bc2-41c7-abce-9089b6c9431b"

A unique identifier for the component. This UUID is used to register the component within the Components system.

Accessors

highlighter

get highlighter(): CurveHighlighter

Getter for the highlighter instance. Throws an error if the highlighter is not initialized.

Returns

CurveHighlighter

The initialized highlighter instance.

---

world

get world(): null | World

Getter for the world property. Returns the world associated with the CivilPlanNavigator instance.

set world(world): void

Setter for the world property. Sets the world associated with the CivilPlanNavigator instance. If a new world is provided, the existing PlanHighlighter instance is disposed and a new one is created.

Parameters

Parameter	Type	Description
world	null | World	The new world to be associated with the CivilPlanNavigator instance.

Returns

null | World

Methods

clear()

clear(): void

Clears the civil curves from the scene. Removes all the curve meshes from the scene and clears the internal array of curve meshes. Also unselects and unhovers the highlighter.

Returns

void

Inherited from

CivilNavigator . clear

---

dispose()

dispose(): Promise<void>

OBC.Disposable.dispose

Returns

Promise<void>

Inherited from

CivilNavigator . dispose

---

draw()

draw(model, filter?): Promise<void>

Draws the civil curves from the provided model onto the scene.

Parameters

Parameter	Type	Description
model	FragmentsGroup	The FragmentsGroup containing the civil data to be drawn.
filter?	Iterable<Alignment>	An optional Iterable of alignments to filter the curves to be drawn.

Returns

Promise<void>

• A promise that resolves when the curves have been drawn onto the scene.

Inherited from

CivilNavigator . draw

Throws

Will throw an error if the provided model doesn't have civil data or if no world was given for this navigator.

---

hideMarker()

hideMarker(type): void

Hides the marker of the specified type.

Parameters

Parameter	Type	Description
type	CivilMarkerType	The type of marker to hide. It can be either "hover" or "select".

Returns

void

Inherited from

CivilNavigator . hideMarker

Throws

Will throw an error if the mouse markers are not initialized.

---

setDefSegments()

setDefSegments(segmentsArray): object

Sets the definition segments and slope from the provided segments array.

Parameters

Parameter	Type	Description
segmentsArray	any[]	An array of segments, where each segment is an array of numbers representing points.

Returns

object

An object containing the definition segments and slope.

defSegments

defSegments: any

slope

slope: any

Inherited from

CivilNavigator . setDefSegments

Throws

Will throw an error if the segments array is empty or if the points in the segments array are not in the expected format.

---

setMarker()

setMarker(alignment, percentage, type): void

Sets a marker on a specific curve at a given percentage.

Parameters

Parameter	Type	Description
alignment	Alignment	The alignment where the marker should be placed.
percentage	number	The percentage along the alignment where the marker should be placed.
type	CivilMarkerType	The type of marker to be placed (hover or select).

Returns

void

Inherited from

CivilNavigator . setMarker

Throws

Will throw an error if there are no curves to place the marker on.