Skip to content
Last updated

API / geotoolkit3d / transformation / XYCoordinates / XYCoordinates

Class: XYCoordinates

transformation.XYCoordinates.XYCoordinates

A XYCoordinates coordinates object.<br> <br> This object holds the information about the XY coordinates of a seismic volume.<br> It is used to compute the Index-to-XY transformation and provides some utility function to retrieve the XY coordinates.<br>

Hierarchy

Table of contents

Constructors
  • [new XYCoordinates()](/solutions/geotoolkit/GeoToolkit_JS/apis/classes/geotoolkit3d.transformation.xycoordinates.xycoordinates.md#new xycoordinates())
Methods

Contents

Constructors

new XYCoordinates()

• new XYCoordinates()

Methods

asBox3

▸ asBox3(): Box3

Returns the bounding box

Returns

Box3

The xyz coordinates as a box 3d


asElevationBox3

▸ asElevationBox3(): Box3

Returns the bounding box with z being elevation

Returns

Box3

The xyz coordinates as a box 3d


fromJSONPoints

▸ fromJSONPoints(xy): XYCoordinates

Initialize XYCoordinates using given json.<br> <br> Only 3 corners out of 4 are required.<br>

Parameters

Name Type Description
xyPointsXYjson with points

Returns

XYCoordinates

this


fromJSONXY

▸ fromJSONXY(xy): XYCoordinates

Create a Seismic XYCoordinates system using the given corners.<br> <br> Only 3 corners out of 4 are required. Coordinates do not need to be in a specific order.<br>

Parameters

Name Type Description
xyXYThe xy json

Returns

XYCoordinates

this


getClassName

▸ getClassName(): string

Returns

string


isPointInside

▸ isPointInside(point): boolean

Returns if the given point is inside the XY limits defined by the given 4 corners.

Parameters

Name Type Description
pointVector3the point to check if it is inside the box

Returns

boolean

true if the point is inside the box


getClassName

▸ Static getClassName(): string

Returns

string