Last updated

API / geotoolkit3d / geodata / Trajectory3d / Trajectory3d

Namespace: Trajectory3d

geodata.Trajectory3d.Trajectory3d

Table of contents

Type Aliases

Contents

Type Aliases

CoordinatesForDepths

Ƭ CoordinatesForDepths: Object

Type declaration

NameType
heightsnull | number[]
originVector3
widthsnull | number[]
xnumber[]
ynumber[]
znumber[]

GetPointByPositionOptions

Ƭ GetPointByPositionOptions: Object

The options when retrieving a trajectory point by position.

Type declaration

NameTypeDescription
interpolate?booleanIf true, the result will contain the interpolated position between the two closest points/stations found.
If false, only the closest point/station will be returned.
Default is true.
maxdistance?numberIf the resulting point is further than this distance, the selection will be canceled and null will be return instead.
Can save time if the well is at an unknown distance from the given point.
By default is Number.POSITIVE_INFINITY
positionVector3The XYZ position to search for. Z is the elevation, meaning it increase going upward.
When used alongside 3D picking, the picking position can directly be used without transformation.
selectionmode?TrajectorySelectionModeDefine the point selection mode, either closest by distance or by depth.
Default mode is ClosestByDepth.

GetPointResult

Ƭ GetPointResult: Object

The point/station result from retrieving a point by coordinates in the trajectory.

Type declaration

NameTypeDescription
interpolatedpoint?Point | nullWhen the interpolation option is enabled, this field will contain the point interpolated from the two closest trajectory points/stations.
Will be undefined if interpolation is disabled.
point1StationThe closest point/station to the provided coordinates.
point2?Station | nullThe second closest point/station to the provided coordinates (if interpolation option is enabled, and if the provided coordinate is between point1 and point2).
Will be undefined if interpolation is disabled or if the provided coordinate is not between two trajectory points/stations.

Point

Ƭ Point: Object

Define a point or station along the Trajectory. (Can be an interpolated point).

Type declaration

NameTypeDescription
mdnumberThe trajectory point's measured depth (md).
positionVector3The trajectory point's position (XYZ).
Note that the Trajectory origin offset is applied (added) to this result.

Station

Ƭ Station: Point & { index: number }

Define a point/station of the Trajectory. This point/station is identified by it's index in the trajectory.