API Reference › core-common› IModels › EcefLocationProps

EcefLocationProps Interface

Properties that position an iModel on the earth via ECEF (Earth Centered Earth Fixed) coordinates The origin is specified as an ECEF coordinate. The cartographicOrigin property contains the latitude, longitude and elevation above the WGS84 ellipsoid of the origin property. This cartographicOrigin is offered as a convenient pre-calculated value representing the location of the ECEF origin. The 3D coordinate system this class represents is positioned at specified origin and the axis positioned according to the other properties. If transform property is defined then it will not be computed from other properties. If the xVector and yVector properties are defined (and transform is not defined) then they take precedence over the YawPitchRoll orientation property. The xVector and yVector represent the direction and scale of the X and Y axes. The Z axis is always perpendicular (according to the right hand rule) to these X-Y axes. The scaling in the Z direction is always unity. The scale of the X and Y axes is represented by the size of the vector length. If the xVector and yVector are not present then the YawPitchRoll properties indicates the angles for all tree axes. Scaling in that case is unity in all three directions. Note that the present class is intended to represent geolocated 3D coordinate systems that are normally tangent to the WGS84 ellipsoid possibly offset in altitude by the terrain elevation above the ellipsoid but other general 3D coordinate systems can be defined.

Implemented by

Properties

Name Type Description
cartographicOrigin Readonly CartographicProps | undefined Optional position on the earth used to establish the ECEF coordinates.  
orientation Readonly YawPitchRollProps The orientation of an iModel on the earth.  
origin Readonly XYZProps The Origin of an iModel on the earth in ECEF coordinates  
transform Readonly TransformProps | undefined Optional potentially non-rigid transform defining the ECEF location.  
xVector Readonly XYZProps | undefined Optional X column vector used with yVector to calculate potentially non-rigid transform if a projection is present.  
yVector Readonly XYZProps | undefined Optional Y column vector used with xVector to calculate potentially non-rigid transform if a projection is present.  

Defined in

Last Updated: 28 October, 2024