Struct Omap

pub struct Omap { /* private fields */ }

Struct representing an Orienteering map

The map will be georeferenced if self.epsg_crs.is_some() or else it is written in Local space

Implementations

impl Omap

pub fn new( ref_point: Coord, scale: Scale, epsg_crs: Option<u16>, meters_above_sea_level: Option<f64>, ) -> OmapResult<Self>

Create a new map in the given scale centered at the ref_point (projected coordinates) with an optional CRS and optional meters_above_sea_level in elevation

All coordinates of objects added to the map must be relative the ref_point The ref_point can be retrieved with Self::get_ref_point

Examples found in repository

examples/mountain_top_triangle.rs (lines 30-35)

fn main() {
    let map_center = DUMHOE;

    let map_center_elevation_meters = 2_182.;
    let crs_epsg_code = 25832;

    let mut omap = Omap::new(
        map_center,
        Scale::S15_000,
        Some(crs_epsg_code),
        Some(map_center_elevation_meters),
    )
    .expect("Could not make map with the given CRS-code");

    let ghp_point = Point(GALDHOPIGGEN - map_center);
    let mut ghp_object = PointObject::from_point(ghp_point, PointSymbol::SpotHeight, 0.);
    ghp_object.add_elevation_tag(2469.);

    let dh_point = Point(DUMHOE - map_center);
    let mut dh_object = PointObject::from_point(dh_point, PointSymbol::SpotHeight, 0.);
    dh_object.add_elevation_tag(2182.);

    let bh_point = Point(BUKKEHOE - map_center);
    let mut bh_object = PointObject::from_point(bh_point, PointSymbol::SpotHeight, 0.);
    bh_object.add_elevation_tag(2314.);

    omap.add_object(ghp_object);
    omap.add_object(dh_object);
    omap.add_object(bh_object);

    omap.write_to_file(
        PathBuf::from_str("./mountain_top_triangle.omap").unwrap(),
        Default::default(),
    )
    .expect("Could not write to file");
}

examples/simple_example.rs (lines 17-22)

fn main() {
    let map_center = Coord {
        x: 323_877.,
        y: 6_399_005.,
    };
    let map_center_elevation_meters = 100.;
    let crs_epsg_code = 3006;

    let mut omap = Omap::new(
        map_center,
        Scale::S15_000,
        Some(crs_epsg_code),
        Some(map_center_elevation_meters),
    )
    .expect("Could not make map with the given CRS-code");

    // coordinates of geometry are in the same units as the map_center, but relative the map_center
    let polygon = Polygon::new(
        LineString::new(vec![
            Coord { x: -50., y: -50. },
            Coord { x: -50., y: 50. },
            Coord { x: 50., y: 50. },
            Coord { x: 50., y: -50. },
            Coord { x: -50., y: -50. },
        ]),
        vec![],
    );
    let mut area_object =
        AreaObject::from_polygon(polygon, AreaSymbol::RoughVineyard, 45.0_f64.to_radians());
    area_object.add_tag("tag_key", "tag_value");

    let line_string = LineString::new(vec![
        Coord { x: -60., y: 20. },
        Coord { x: -20., y: 25. },
        Coord { x: 0., y: 27.5 },
        Coord { x: 20., y: 26. },
        Coord { x: 40., y: 22.5 },
        Coord { x: 60., y: 20. },
        Coord { x: 60., y: -20. },
        Coord { x: -60., y: -20. },
    ]);
    let mut line_object = LineObject::from_line_string(line_string, LineSymbol::Contour);
    line_object.add_elevation_tag(20.);

    let point = Point::new(0.0_f64, 0.0_f64);
    let point_object = PointObject::from_point(
        point,
        PointSymbol::ElongatedDotKnoll,
        -45.0_f64.to_radians(),
    );

    let text_point = Point::new(0.0_f64, -30.0_f64);
    let text = "some text".to_string();
    let text_object = TextObject::from_point(text_point, TextSymbol::SpotHeight, text);

    omap.add_object(area_object);
    omap.add_object(line_object);
    omap.add_object(point_object);
    omap.add_object(text_object);

    let max_bezier_deviation_meters = 2.5;

    let bez_error = omap::BezierError::new(Some(max_bezier_deviation_meters), None);

    omap.write_to_file(
        PathBuf::from_str("./simple_example.omap").unwrap(),
        bez_error,
    )
    .expect("Could not write to file");
}

pub fn reserve_capacity(&mut self, symbol: impl Into<Symbol>, cap: usize)

Reserve capacity for cap elements for key symbol in the objects hashmap

pub fn add_object(&mut self, obj: impl Into<MapObject>)

Insert an object in the objects hashmap
All coordinates of objects added to the map must be relative the map’s ref_point

Examples found in repository

examples/mountain_top_triangle.rs (line 50)

fn main() {
    let map_center = DUMHOE;

    let map_center_elevation_meters = 2_182.;
    let crs_epsg_code = 25832;

    let mut omap = Omap::new(
        map_center,
        Scale::S15_000,
        Some(crs_epsg_code),
        Some(map_center_elevation_meters),
    )
    .expect("Could not make map with the given CRS-code");

    let ghp_point = Point(GALDHOPIGGEN - map_center);
    let mut ghp_object = PointObject::from_point(ghp_point, PointSymbol::SpotHeight, 0.);
    ghp_object.add_elevation_tag(2469.);

    let dh_point = Point(DUMHOE - map_center);
    let mut dh_object = PointObject::from_point(dh_point, PointSymbol::SpotHeight, 0.);
    dh_object.add_elevation_tag(2182.);

    let bh_point = Point(BUKKEHOE - map_center);
    let mut bh_object = PointObject::from_point(bh_point, PointSymbol::SpotHeight, 0.);
    bh_object.add_elevation_tag(2314.);

    omap.add_object(ghp_object);
    omap.add_object(dh_object);
    omap.add_object(bh_object);

    omap.write_to_file(
        PathBuf::from_str("./mountain_top_triangle.omap").unwrap(),
        Default::default(),
    )
    .expect("Could not write to file");
}

examples/simple_example.rs (line 64)

fn main() {
    let map_center = Coord {
        x: 323_877.,
        y: 6_399_005.,
    };
    let map_center_elevation_meters = 100.;
    let crs_epsg_code = 3006;

    let mut omap = Omap::new(
        map_center,
        Scale::S15_000,
        Some(crs_epsg_code),
        Some(map_center_elevation_meters),
    )
    .expect("Could not make map with the given CRS-code");

    // coordinates of geometry are in the same units as the map_center, but relative the map_center
    let polygon = Polygon::new(
        LineString::new(vec![
            Coord { x: -50., y: -50. },
            Coord { x: -50., y: 50. },
            Coord { x: 50., y: 50. },
            Coord { x: 50., y: -50. },
            Coord { x: -50., y: -50. },
        ]),
        vec![],
    );
    let mut area_object =
        AreaObject::from_polygon(polygon, AreaSymbol::RoughVineyard, 45.0_f64.to_radians());
    area_object.add_tag("tag_key", "tag_value");

    let line_string = LineString::new(vec![
        Coord { x: -60., y: 20. },
        Coord { x: -20., y: 25. },
        Coord { x: 0., y: 27.5 },
        Coord { x: 20., y: 26. },
        Coord { x: 40., y: 22.5 },
        Coord { x: 60., y: 20. },
        Coord { x: 60., y: -20. },
        Coord { x: -60., y: -20. },
    ]);
    let mut line_object = LineObject::from_line_string(line_string, LineSymbol::Contour);
    line_object.add_elevation_tag(20.);

    let point = Point::new(0.0_f64, 0.0_f64);
    let point_object = PointObject::from_point(
        point,
        PointSymbol::ElongatedDotKnoll,
        -45.0_f64.to_radians(),
    );

    let text_point = Point::new(0.0_f64, -30.0_f64);
    let text = "some text".to_string();
    let text_object = TextObject::from_point(text_point, TextSymbol::SpotHeight, text);

    omap.add_object(area_object);
    omap.add_object(line_object);
    omap.add_object(point_object);
    omap.add_object(text_object);

    let max_bezier_deviation_meters = 2.5;

    let bez_error = omap::BezierError::new(Some(max_bezier_deviation_meters), None);

    omap.write_to_file(
        PathBuf::from_str("./simple_example.omap").unwrap(),
        bez_error,
    )
    .expect("Could not write to file");
}

pub fn get_crs(&self) -> Option<u16>

Get the CRS of the map represented by an EPSG code

pub fn get_ref_point(&self) -> Coord

Get the projected ref point of the map

pub fn get_geo_ref_point(&self) -> Option<Coord>

Get the geographical ref point of the map

pub fn merge_lines(&mut self, delta: f64)

Merge line objects that are tip to tail. This method is gated behind the merge_lines-feature
Line ends (directed) of the same symbol that are less than delta units (same units as the crs, most often meters) apart are merged.
Elevation tags are respected and only elements with equal Elevation tags can be merged

pub fn make_dotknolls_and_depressions( &mut self, min_area: f64, max_area: f64, elongated_aspect: f64, )

Turn small contour loops to dotknolls and depressions and remove the smallest ones dot_knolls smaller than (min+max)/2 + min will never be drawn as elongated

pub fn mark_basemap_depressions(&mut self)

Mark closed basemap contour loops wound clockwise as depressions

pub fn remove_empty_keys(&mut self)

Remove all keys without any objects in it

pub fn num_entries(&self, key: impl Into<Symbol>) -> Option<usize>

Get the number of map objects for a given symbol in the map

pub fn write_to_file( self, path: PathBuf, bezier_error: BezierError, ) -> OmapResult<()>

Write the map to an omap file,
if path is an invalid path then “auto_generated_map.omap” is the new path

Examples found in repository

examples/mountain_top_triangle.rs (lines 54-57)

fn main() {
    let map_center = DUMHOE;

    let map_center_elevation_meters = 2_182.;
    let crs_epsg_code = 25832;

    let mut omap = Omap::new(
        map_center,
        Scale::S15_000,
        Some(crs_epsg_code),
        Some(map_center_elevation_meters),
    )
    .expect("Could not make map with the given CRS-code");

    let ghp_point = Point(GALDHOPIGGEN - map_center);
    let mut ghp_object = PointObject::from_point(ghp_point, PointSymbol::SpotHeight, 0.);
    ghp_object.add_elevation_tag(2469.);

    let dh_point = Point(DUMHOE - map_center);
    let mut dh_object = PointObject::from_point(dh_point, PointSymbol::SpotHeight, 0.);
    dh_object.add_elevation_tag(2182.);

    let bh_point = Point(BUKKEHOE - map_center);
    let mut bh_object = PointObject::from_point(bh_point, PointSymbol::SpotHeight, 0.);
    bh_object.add_elevation_tag(2314.);

    omap.add_object(ghp_object);
    omap.add_object(dh_object);
    omap.add_object(bh_object);

    omap.write_to_file(
        PathBuf::from_str("./mountain_top_triangle.omap").unwrap(),
        Default::default(),
    )
    .expect("Could not write to file");
}

examples/simple_example.rs (lines 73-76)

fn main() {
    let map_center = Coord {
        x: 323_877.,
        y: 6_399_005.,
    };
    let map_center_elevation_meters = 100.;
    let crs_epsg_code = 3006;

    let mut omap = Omap::new(
        map_center,
        Scale::S15_000,
        Some(crs_epsg_code),
        Some(map_center_elevation_meters),
    )
    .expect("Could not make map with the given CRS-code");

    // coordinates of geometry are in the same units as the map_center, but relative the map_center
    let polygon = Polygon::new(
        LineString::new(vec![
            Coord { x: -50., y: -50. },
            Coord { x: -50., y: 50. },
            Coord { x: 50., y: 50. },
            Coord { x: 50., y: -50. },
            Coord { x: -50., y: -50. },
        ]),
        vec![],
    );
    let mut area_object =
        AreaObject::from_polygon(polygon, AreaSymbol::RoughVineyard, 45.0_f64.to_radians());
    area_object.add_tag("tag_key", "tag_value");

    let line_string = LineString::new(vec![
        Coord { x: -60., y: 20. },
        Coord { x: -20., y: 25. },
        Coord { x: 0., y: 27.5 },
        Coord { x: 20., y: 26. },
        Coord { x: 40., y: 22.5 },
        Coord { x: 60., y: 20. },
        Coord { x: 60., y: -20. },
        Coord { x: -60., y: -20. },
    ]);
    let mut line_object = LineObject::from_line_string(line_string, LineSymbol::Contour);
    line_object.add_elevation_tag(20.);

    let point = Point::new(0.0_f64, 0.0_f64);
    let point_object = PointObject::from_point(
        point,
        PointSymbol::ElongatedDotKnoll,
        -45.0_f64.to_radians(),
    );

    let text_point = Point::new(0.0_f64, -30.0_f64);
    let text = "some text".to_string();
    let text_object = TextObject::from_point(text_point, TextSymbol::SpotHeight, text);

    omap.add_object(area_object);
    omap.add_object(line_object);
    omap.add_object(point_object);
    omap.add_object(text_object);

    let max_bezier_deviation_meters = 2.5;

    let bez_error = omap::BezierError::new(Some(max_bezier_deviation_meters), None);

    omap.write_to_file(
        PathBuf::from_str("./simple_example.omap").unwrap(),
        bez_error,
    )
    .expect("Could not write to file");
}

pub fn into_objects(self) -> HashMap<Symbol, Vec<MapObject>>

Consume the omap object and get the object hashmap

Trait Implementations

impl Clone for Omap

fn clone(&self) -> Omap

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for Omap

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.