OpenCPN Partial API docs
|
Extended waypoint class with additional navigation features. More...
#include <ocpn_plugin.h>
Public Member Functions | |
PlugIn_Waypoint_Ex (double lat, double lon, const wxString &icon_ident, const wxString &wp_name, const wxString &GUID="", const double ScaMin=1e9, const bool bNameVisible=false, const int nRanges=0, const double RangeDistance=1.0, const wxColor RangeColor=wxColor(255, 0, 0)) | |
void | InitDefaults () |
Initializes waypoint properties to default values. | |
bool | GetFSStatus () |
Gets "free-standing" status of waypoint. | |
int | GetRouteMembershipCount () |
Gets number of routes containing this waypoint. | |
Public Attributes | |
double | m_lat |
Latitude in decimal degrees. | |
double | m_lon |
Longitude in decimal degrees. | |
wxString | m_GUID |
Globally unique identifier. | |
wxString | m_MarkName |
Display name of waypoint. | |
wxString | m_MarkDescription |
Optional description text. | |
wxDateTime | m_CreateTime |
Creation timestamp in UTC. | |
bool | IsVisible |
Visibility state on chart. | |
bool | IsActive |
Active state (e.g. destination) | |
double | scamin |
Minimum display scale (1:X) for waypoint visibility. | |
bool | b_useScamin |
True to enable scale-dependent visibility. | |
bool | IsNameVisible |
True to show waypoint name on chart. | |
int | nrange_rings |
Number of range rings to display around waypoint. | |
double | RangeRingSpace |
Distance between range rings in preferred units. | |
wxColour | RangeRingColor |
Color to draw range rings. | |
wxString | IconName |
Name of icon to use for waypoint symbol. | |
wxString | IconDescription |
User-friendly description of icon. | |
Plugin_HyperlinkList * | m_HyperlinkList |
List of hyperlinks associated with this waypoint. | |
Extended waypoint class with additional navigation features.
This class extends the basic PlugIn_Waypoint with additional capabilities for managing waypoint display, range rings, routes, and more complex navigation features.
Key features include:
Used when more control is needed over waypoint behavior than provided by the basic PlugIn_Waypoint class.
Definition at line 5295 of file ocpn_plugin.h.
PlugIn_Waypoint_Ex::PlugIn_Waypoint_Ex | ( | ) |
Definition at line 1831 of file ocpn_plugin_gui.cpp.
PlugIn_Waypoint_Ex::PlugIn_Waypoint_Ex | ( | double | lat, |
double | lon, | ||
const wxString & | icon_ident, | ||
const wxString & | wp_name, | ||
const wxString & | GUID = "" , |
||
const double | ScaMin = 1e9 , |
||
const bool | bNameVisible = false , |
||
const int | nRanges = 0 , |
||
const double | RangeDistance = 1.0 , |
||
const wxColor | RangeColor = wxColor(255, 0, 0) |
||
) |
Definition at line 1833 of file ocpn_plugin_gui.cpp.
PlugIn_Waypoint_Ex::~PlugIn_Waypoint_Ex | ( | ) |
Definition at line 1898 of file ocpn_plugin_gui.cpp.
bool PlugIn_Waypoint_Ex::GetFSStatus | ( | ) |
Gets "free-standing" status of waypoint.
A waypoint is considered "free-standing" if it was:
Definition at line 1867 of file ocpn_plugin_gui.cpp.
int PlugIn_Waypoint_Ex::GetRouteMembershipCount | ( | ) |
Gets number of routes containing this waypoint.
Returns count of how many routes include this waypoint. Used to manage waypoint deletion and route integrity.
Definition at line 1876 of file ocpn_plugin_gui.cpp.
void PlugIn_Waypoint_Ex::InitDefaults | ( | ) |
Initializes waypoint properties to default values.
Sets standard default values for waypoint fields:
Definition at line 1852 of file ocpn_plugin_gui.cpp.
bool PlugIn_Waypoint_Ex::b_useScamin |
True to enable scale-dependent visibility.
Definition at line 5349 of file ocpn_plugin.h.
wxString PlugIn_Waypoint_Ex::IconDescription |
User-friendly description of icon.
Definition at line 5357 of file ocpn_plugin.h.
wxString PlugIn_Waypoint_Ex::IconName |
Name of icon to use for waypoint symbol.
Definition at line 5356 of file ocpn_plugin.h.
bool PlugIn_Waypoint_Ex::IsActive |
Active state (e.g. destination)
Definition at line 5346 of file ocpn_plugin.h.
bool PlugIn_Waypoint_Ex::IsNameVisible |
True to show waypoint name on chart.
Definition at line 5350 of file ocpn_plugin.h.
bool PlugIn_Waypoint_Ex::IsVisible |
Visibility state on chart.
Definition at line 5345 of file ocpn_plugin.h.
wxDateTime PlugIn_Waypoint_Ex::m_CreateTime |
Creation timestamp in UTC.
Definition at line 5344 of file ocpn_plugin.h.
wxString PlugIn_Waypoint_Ex::m_GUID |
Globally unique identifier.
Definition at line 5341 of file ocpn_plugin.h.
Plugin_HyperlinkList* PlugIn_Waypoint_Ex::m_HyperlinkList |
List of hyperlinks associated with this waypoint.
Can link to web pages, local files, charts, etc. Ownership is transferred to waypoint.
Definition at line 5364 of file ocpn_plugin.h.
double PlugIn_Waypoint_Ex::m_lat |
Latitude in decimal degrees.
Definition at line 5339 of file ocpn_plugin.h.
double PlugIn_Waypoint_Ex::m_lon |
Longitude in decimal degrees.
Definition at line 5340 of file ocpn_plugin.h.
wxString PlugIn_Waypoint_Ex::m_MarkDescription |
Optional description text.
Definition at line 5343 of file ocpn_plugin.h.
wxString PlugIn_Waypoint_Ex::m_MarkName |
Display name of waypoint.
Definition at line 5342 of file ocpn_plugin.h.
int PlugIn_Waypoint_Ex::nrange_rings |
Number of range rings to display around waypoint.
Definition at line 5352 of file ocpn_plugin.h.
wxColour PlugIn_Waypoint_Ex::RangeRingColor |
Color to draw range rings.
Definition at line 5354 of file ocpn_plugin.h.
double PlugIn_Waypoint_Ex::RangeRingSpace |
Distance between range rings in preferred units.
Definition at line 5353 of file ocpn_plugin.h.
double PlugIn_Waypoint_Ex::scamin |
Minimum display scale (1:X) for waypoint visibility.
Definition at line 5348 of file ocpn_plugin.h.