API (v2.0.0) - Giro3D
    Preparing search index...

    Class Coordinates

    Represents coordinates associated with a coordinate reference system (CRS). The exact semantics of the values in the coordinates depend on the kind of CRS used:

    • for projected systems, X is the easting, Y is the northing and Z is the elevation above/below the map plane.
    • for geocentric systems (such as ECEF), XYZ are cartesian coordinates in the 3D frame.
    • for geographic systems (such as EPSG:4326), X is the longitude, Y is the latitude and Z is the elevation above/below the reference ellipsoid.
    Index

    Constructors

    constructor

    Properties

    crs isCoordinates

    Accessors

    altitude latitude longitude values x y z

    Methods

    as clone copy isGeographic set setAltitude toVector2 toVector3 withAltitude withCRS withLatitude withLongitude WGS84

    Constructors

    • Create coordinates from a pair of XY coordinates.

      Parameters

      • crs: CoordinateSystem

        The coordinate system to use.

      • x: number

        The X coordinate.

      • y: number

        The Y coordinate.

      Returns Coordinates

      const x = 124225;
      const y = 10244.2;
      const mercator = new Coordinates(CoordinateSystem.epsg3857, x, y);

      // If using geographic coordinates, X is the longitude and Y is the latitude.
      const lon = 4.2123;
      const lat = 43.256;
      const geo = new Coordinates(CoordinateSystem.epsg4326, lon, lat);

    • Create coordinates from a XYZ triplet.

      Parameters

      • crs: CoordinateSystem

        The coordinate system to use.

      • x: number

        The X coordinate.

      • y: number

        The Y coordinate.

      • z: number

        The Z coordinate.

      Returns Coordinates

      const x = 124225;
      const y = 10244.2;
      const z = 1000;
      const mercator = new Coordinates(CoordinateSystem.epsg3857, x, y, z);

      // If using geographic coordinates, X is the longitude and Y is the latitude.
      // Z is still the elevation in meters.
      const lon = 4.2123;
      const lat = 43.256;
      const geo = new Coordinates(CoordinateSystem.epsg4326, lon, lat, z);

    • Create coordinates from a Vector2Like

      Parameters

      • crs: CoordinateSystem

        The coordinate system to use.

      • xy: Vector2Like

        The vector to initialize coordinates.

      Returns Coordinates

      const coord = new Coordinates(CoordinateSystem.epsg3857, new THREE.Vector2(1020, 20924));
      // Alternatively, you don't have to use an actual Vector2 instance.
      // Any object that matches the Vector2Like interface will do.
      const coord = new Coordinates(CoordinateSystem.epsg3857, { x: 1020, y: 20924 });

    • Create coordinates from a Vector3Like

      Parameters

      • crs: CoordinateSystem

        The coordinate system to use.

      • xyz: Vector3Like

        The vector to initialize coordinates.

      Returns Coordinates

      const coord = new Coordinates(CoordinateSystem.epsg3857, new THREE.Vector3(1020, 20924, 1000));
      // Alternatively, you don't have to use an actual Vector3 instance.
      // Any object that matches the Vector3Like interface will do.
      const coord = new Coordinates(CoordinateSystem.epsg3857, { x: 1020, y: 20924, z: 1000 });

    Properties

    crs: CoordinateSystem
    isCoordinates: true = ...

    Accessors

    • get altitude(): number

      Returns the altitude in geographic coordinates. Coordinates must be in geographic system (can be converted by using as).

      const position = { longitude: 2.33, latitude: 48.24, altitude: 24999549 };
      // Geographic system
      const coordinates =
           new Coordinates(CoordinateSystem.epsg4326, position.longitude, position.latitude, position.altitude);
      coordinates.altitude; // Altitude in geographic system
      // returns : 24999549

      // or

      const position = { x: 20885167, y: 849862, z: 23385912 };
      // Geocentric system
      const coords = new Coordinates(CoordinateSystem.epsg4978, position.x, position.y, position.z);
      const coordinates = coords.as(CoordinateSystem.epsg4326);  // Geographic system
      coordinates.altitude; // Altitude in geographic system
      // returns : 24999548.046711832

      Returns number

      The altitude of the position.

    • get latitude(): number

      Returns the latitude in geographic coordinates. Coordinates must be in geographic system (can be converted by using as).

      const position = { longitude: 2.33, latitude: 48.24, altitude: 24999549 };
      const coordinates = new Coordinates(
          'EPSG:4326', position.longitude, position.latitude, position.altitude); // Geographic
      coordinates.latitude; // Latitude in geographic system
      // returns : 48.24

      // or

      const position = { x: 20885167, y: 849862, z: 23385912 };
      // Geocentric system
      const coords = new Coordinates(CoordinateSystem.epsg4978, position.x, position.y, position.z);
      const coordinates = coords.as(CoordinateSystem.epsg4326);  // Geographic system
      coordinates.latitude; // Latitude in geographic system
      // returns : 48.24830764643365

      Returns number

      The latitude of the position.

    • get longitude(): number

      Returns the longitude in geographic coordinates. Coordinates must be in geographic system (can be converted by using as ).

      const position = { longitude: 2.33, latitude: 48.24, altitude: 24999549 };
      const coordinates = new Coordinates(
        'EPSG:4326', position.longitude, position.latitude, position.altitude); // Geographic
      coordinates.longitude; // Longitude in geographic system
      // returns 2.33

      // or

      const position = { x: 20885167, y: 849862, z: 23385912 };
      // Geocentric system
      const coords = new Coordinates(CoordinateSystem.epsg4978, position.x, position.y, position.z);
      const coordinates = coords.as(CoordinateSystem.epsg4326);  // Geographic system
      coordinates.longitude; // Longitude in geographic system
      // returns 2.330201911389028

      Returns number

      The longitude of the position.

    • get x(): number

      Returns the x component of this coordinate in geocentric coordinates. Coordinates must be in geocentric system (can be converted by using as).

      const position = { x: 20885167, y: 849862, z: 23385912 };
      const coordinates = new Coordinates(CoordinateSystem.epsg4978, position.x, position.y, position.z);
      coordinates.x;  // Geocentric system
      // returns : 20885167

      // or

      const position = { longitude: 2.33, latitude: 48.24, altitude: 24999549 };
      // Geographic system
      const coords =
          new Coordinates(CoordinateSystem.epsg4326, position.longitude, position.latitude, position.altitude);
      const coordinates = coords.as(CoordinateSystem.epsg4978); // Geocentric system
      coordinates.x; // Geocentric system
      // returns : 20888561.0301258

      Returns number

      The x component of the position.

    • get y(): number

      Returns the y component of this coordinate in geocentric coordinates. Coordinates must be in geocentric system (can be converted by using as).

      const position = { x: 20885167, y: 849862, z: 23385912 };
      const coordinates = new Coordinates(CoordinateSystem.epsg4978, position.x, position.y, position.z);
      coordinates.y;  // Geocentric system
      // returns :  849862

      Returns number

      The y component of the position.

    • get z(): number

      Returns the z component of this coordinate in geocentric coordinates. Coordinates must be in geocentric system (can be converted by using as).

      const position = { x: 20885167, y: 849862, z: 23385912 };
      const coordinates = new Coordinates(CoordinateSystem.epsg4978, position.x, position.y, position.z);
      coordinates.z;  // Geocentric system
      // returns :  23385912

      Returns number

      The z component of the position.

    Methods

    • Converts coordinates in another CRS.

      If target is not specified, creates a new instance. The original instance is never modified (except if you passed it as target).

      const position = { longitude: 2.33, latitude: 48.24, altitude: 24999549 };
      // Geographic system
      const coords =
          new Coordinates(CoordinateSystem.epsg4326, position.longitude, position.latitude, position.altitude);
      const coordinates = coords.as(CoordinateSystem.epsg4978); // Geocentric system

      Parameters

      Returns Coordinates

      the converted coordinate

    • Returns the boolean result of the check if this coordinate is geographic (true) or geocentric (false).

      const position = { x: 20885167, y: 849862, z: 23385912 };
      const coordinates = new Coordinates(CoordinateSystem.epsg4978, position.x, position.y, position.z);
      coordinates.isGeographic();  // Geocentric system
      // returns :  false

      Returns boolean

      true if the coordinate is geographic.

    • Set the altitude.

      Parameters

      • altitude: number

        the new altitude.

        coordinates.setAltitude(10000)

      Returns void

    • Returns the equivalent Vector2 of this coordinate. Note that the Z component (elevation) is lost.

      const position = { x: 20885167, y: 849862, z: 23385912 };
      // Metric system
      const coordinates = new Coordinates(CoordinateSystem.epsg3857, position.x, position.y, position.z);
      coordinates.toVector2();
      // returns : Vector2
      // x: 20885167
      // y: 849862

      // or

      const position = { longitude: 2.33, latitude: 48.24, altitude: 24999549 };
      // Geographic system
      const coordinates =
           new Coordinates(CoordinateSystem.epsg4326, position.longitude, position.latitude, position.altitude);
      coordinates.toVector2();
      // returns : Vector2
      // x: 2.33
      // y: 48.24

      Parameters

      • Optionaltarget: Vector2

        the geocentric coordinate

      Returns Vector2

      target position

    • Returns the equivalent Vector3 of this coordinate.

      const position = { x: 20885167, y: 849862, z: 23385912 };
      // Geocentric system
      const coordinates = new Coordinates(CoordinateSystem.epsg4978, position.x, position.y, position.z);
      coordinates.toVector3();
      // returns : Vector3
      // x: 20885167
      // y: 849862
      // z: 23385912

      // or

      const position = { longitude: 2.33, latitude: 48.24, altitude: 24999549 };
      // Geographic system
      const coordinates =
           new Coordinates(CoordinateSystem.epsg4326, position.longitude, position.latitude, position.altitude);
      coordinates.toVector3();
      // returns : Vector3
      // x: 2.33
      // y: 48.24
      // z: 24999549

      Parameters

      • Optionaltarget: Vector3

        the geocentric coordinate

      Returns Vector3

      target position

    Settings

    Member Visibility

    On This Page

    Constructors
    Properties
    Accessors
    Methods