Nasal library/geo: Difference between revisions

{{Nasal doc

|mode = class

|text = The main class, used widely for storing and managing positional data. Coordinates may be stored in either {{wikipedia|ECEF|Earth-centered, Earth-fixed}} coordinates (x, y and z) or {{wikipedia|geodetic coordinates}} (latitude, longitude, and altitude). In addition, it will convert coordinates as necessary. However, note that for the conversion to work, set_latlon() and set_xyz() must be used.

}}

{{Nasal doc

|syntax = geo.Coord.new([coord]);

|text = Constructor function. Returns a <code>geo.Coord</code> instance.

|param1 = coord

{{Nasal doc

|syntax = geo.Coord.set(coord);

|text = Sets the coordinates. Returns the <code>geo.Coord</code> instance.

|param1 = coord

{{Nasal doc

|syntax = geo.Coord.set_lat(lat);

|text = Sets the {{wikipedia|latitude}} coordinate. Returns the <code>geo.Coord</code> instance.

|param1 = lat

{{Nasal doc

|syntax = geo.Coord.set_lon(lon);

|text = Sets the {{wikipedia|longitude}} coordinate. Returns the <code>geo.Coord</code> instance.

|param1 = lon

{{Nasal doc

|syntax = geo.Coord.set_alt(alt);

|text = Sets the {{wikipedia|altitude}} coordinate. Returns the <code>geo.Coord</code> instance.

|param1 = alt

{{Nasal doc

|syntax = geo.Coord.set_latlon(lat, lon[, alt]);

|text = Sets the latitude and longitude coordinates, and optionally the altitude coordinate. Returns the <code>geo.Coord</code> instance.

|param1 = lat

{{Nasal doc

|syntax = geo.Coord.set_x(x);

|text = Sets the x-axis coordinate coordinate. Returns the <code>geo.Coord</code> instance.

|param1 = x

{{Nasal doc

|syntax = geo.Coord.set_y(y);

|text = Sets the y-axis coordinate coordinate. Returns the <code>geo.Coord</code> instance.

|param1 = y

{{Nasal doc

|syntax = geo.Coord.set_z(z);

|text = Sets the y-axis coordinate coordinate. Returns the <code>geo.Coord</code> instance.

|param1 = z

{{Nasal doc

|syntax = geo.Coord.set_xyz(x, y, z);

|text = Sets all three Cartesian coordinates. Returns the <code>geo.Coord</code> instance. All arguments are mandatory.

|param1 = x

{{Nasal doc

|syntax = geo.Coord.lat();

|text = Returns the latitude coordinate.

|example1 = var coord = geo.Coord.new();

{{Nasal doc

|syntax = geo.Coord.lon();

|text = Returns the longitude coordinate.

|example1 = var coord = geo.Coord.new();

{{Nasal doc

|syntax = geo.Coord.alt();

|text = Returns the altitude coordinate.

|example1 = var coord = geo.Coord.new();

{{Nasal doc

|syntax = geo.Coord.latlon();

|text = Returns a vector containing the latitude, longitude, and altitude, in that order.

|example1 = var coord = geo.Coord.new();

{{Nasal doc

|syntax = geo.Coord.x();

|text = Returns the x-axis coordinate.

|example1 = var coord = geo.Coord.new();

{{Nasal doc

|syntax = geo.Coord.y();

|text = Returns the y-axis coordinate.

|example1 = var coord = geo.Coord.new();

{{Nasal doc

|syntax = geo.Coord.z();

|text = Returns the z-axis coordinate.

|example1 = var coord = geo.Coord.new();

{{Nasal doc

|syntax = geo.Coord.xyz();

|text = Returns a vector containing the x, y, and z coordinates, in that order.

|example1 = var coord = geo.Coord.new();

{{Nasal doc

|syntax = geo.Coord.is_defined();

|text = Returns 1 (true) if all three coordinates (either x/y/z or /lat/lon/alt) are defined. Note that set_latlon() or set_xyz() must be used for this function to work correctly.

|example1 = var coord = geo.Coord.new();

{{Nasal doc

|syntax = geo.Coord.dump();

|text = Dumps all six coordinates into the console. It requires all three coordinates (either x/y/z or /lat/lon/alt) to be defined. Note that set_latlon() or set_xyz() must be used for this function to work correctly.

|example1 = var coord = geo.Coord.new();

{{Nasal doc

|syntax = geo.Coord.course_to(coord);

|text = Returns the initial bearing (see [http://www.movable-type.co.uk/scripts/latlong.html#bearing here]) to another <code>geo.Coord</code> instance. The bearing will be an {{wikipedia|absolute bearing}} (in the range 0–360).

|param1 = coord

{{Nasal doc

|syntax = geo.Coord.distance_to(coord);

|text = Returns the great circle distance in metres to another <code>geo.Coord</code> instance. Note that this function ignores altitude.

|param1 = coord

{{Nasal doc

|syntax = geo.Coord.direct_distance_to(coord);

|text = Returns the direct distance (cutting through the earth) in metres to another <code>geo.Coord</code> instance.  

|param1 = coord

{{Nasal doc

|syntax = geo.Coord.apply_course_distance(course, dist);

|text = Calculates a new coordinate from a given course and distancce, and then updates the coordinates to the new set. Returns the <code>geo.Coord</code> instance.

|param1 = course

=== PositionedSearch ===

==== new() ====

==== condense() ====

{{Nasal doc

|syntax = geo.normdeg180(angle);

|text = Normalizes an angle to be in the range -180–180.

|param1 = angle