OpenCPN Partial API docs
Loading...
Searching...
No Matches
Public Member Functions | Static Public Member Functions | Public Attributes | List of all members
ShapeBaseChart Class Reference

Represents a basemap chart based on shapefile data. More...

#include <shapefile_basemap.h>

Public Member Functions

 ShapeBaseChart (const std::string &filename, const size_t &min_scale, const wxColor &color= *wxBLACK)
 
 ShapeBaseChart (const ShapeBaseChart &t)
 
void SetColor (wxColor color)
 
bool LoadSHP ()
 Loads the shapefile data into memory.
 
bool IsUsable ()
 Determines if the chart is ready to be used for rendering or spatial queries.
 
size_t MinScale ()
 
void RenderViewOnDC (ocpnDC &dc, ViewPort &vp)
 
bool CrossesLand (double &lat1, double &lon1, double &lat2, double &lon2)
 Determines if a line segment between two geographical points intersects any land mass represented in the chart.
 
void CancelLoading ()
 Cancel the chart loading operation.
 

Static Public Member Functions

static const std::string ConstructPath (const std::string &dir, const std::string &quality_suffix)
 

Public Attributes

int _dmod
 Tile size in degrees.
 

Detailed Description

Represents a basemap chart based on shapefile data.

This class loads, manages, and renders geographical polygon data from a shapefile for a particular resolution level. It supports tiled organization where data is divided into 1-degree cells for efficient access. It provides methods for drawing filled polygons.

Definition at line 128 of file shapefile_basemap.h.

Constructor & Destructor Documentation

◆ ShapeBaseChart() [1/2]

ShapeBaseChart::ShapeBaseChart ( const std::string &  filename,
const size_t &  min_scale,
const wxColor &  color = *wxBLACK 
)
inline

Definition at line 131 of file shapefile_basemap.h.

◆ ShapeBaseChart() [2/2]

ShapeBaseChart::ShapeBaseChart ( const ShapeBaseChart &  t)
inline

Definition at line 144 of file shapefile_basemap.h.

◆ ~ShapeBaseChart()

ShapeBaseChart::~ShapeBaseChart ( )
inline

Definition at line 154 of file shapefile_basemap.h.

Member Function Documentation

◆ CancelLoading()

void ShapeBaseChart::CancelLoading ( )

Cancel the chart loading operation.

Definition at line 623 of file shapefile_basemap.cpp.

◆ ConstructPath()

static const std::string ShapeBaseChart::ConstructPath ( const std::string &  dir,
const std::string &  quality_suffix 
)
inlinestatic

Definition at line 189 of file shapefile_basemap.h.

◆ CrossesLand()

bool ShapeBaseChart::CrossesLand ( double &  lat1,
double &  lon1,
double &  lat2,
double &  lon2 
)

Determines if a line segment between two geographical points intersects any land mass represented in the chart.

Parameters
lat1Latitude of the first point of the line segment.
lon1Longitude of the first point of the line segment.
lat2Latitude of the second point of the line segment.
lon2Longitude of the second point of the line segment.
Returns
true if the line segment crosses any polygon in the shapefile, false if the chart is not loaded yet, the line segment is entirely over water, or the line segment is entirely over land.
Note
The longitude of the line segment coordinates are normalized to the -180 to 180 range before performing the intersection test. This ensures that the line segment and polygon edges use the same longitude convention, which is necessary for accurate intersection detection.

Definition at line 543 of file shapefile_basemap.cpp.

◆ IsUsable()

bool ShapeBaseChart::IsUsable ( )
inline

Determines if the chart is ready to be used for rendering or spatial queries.

Returns
true if the chart exists, has been loaded, and is not currently loading data.

Definition at line 186 of file shapefile_basemap.h.

◆ LoadSHP()

bool ShapeBaseChart::LoadSHP ( )

Loads the shapefile data into memory.

Validates the file for geographical bounds (-180 to 180 longitude, -90 to 90 latitude) and ensures it contains polygon geometry. If the shapefile is tiled (contains 'x' and 'y' attributes), it organizes features by their tile location using the LatLonKey indexing system.

Returns
true if the shapefile was successfully loaded and is valid, false otherwise.

Definition at line 265 of file shapefile_basemap.cpp.

◆ MinScale()

size_t ShapeBaseChart::MinScale ( )
inline

Definition at line 187 of file shapefile_basemap.h.

◆ RenderViewOnDC()

void ShapeBaseChart::RenderViewOnDC ( ocpnDC &  dc,
ViewPort &  vp 
)
inline

Definition at line 188 of file shapefile_basemap.h.

◆ SetColor()

void ShapeBaseChart::SetColor ( wxColor  color)
inline

Definition at line 159 of file shapefile_basemap.h.

Member Data Documentation

◆ _dmod

int ShapeBaseChart::_dmod

Tile size in degrees.

Most map charts use 1-degree tiles (default), but the crude resolution chart uses 10-degree tiles to optimize performance for global views. The tiling system divides map data into grid cells of _dmod x _dmod degrees for efficient spatial indexing and rendering.

Definition at line 167 of file shapefile_basemap.h.

The documentation for this class was generated from the following files: