OpenCPN Partial API docs
|
Public Member Functions | |
PlugIn_Waypoint_ExV2 (double lat, double lon, const wxString &icon_ident, const wxString &wp_name, const wxString &GUID="", const double ScaMin=1e9, const double ScaMax=1e6, const bool bNameVisible=false, const int nRangeRings=0, const double RangeDistance=1.0, const int RangeRingSpaceUnits=0, const wxColor RangeColor=wxColor(255, 0, 0), const double WaypointArrivalRadius=0.0, const bool ShowWaypointRangeRings=false, const double PlannedSpeed=0.0, const wxString TideStation=wxEmptyString) | |
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. | |
int | RangeRingSpaceUnits |
Units for range ring spacing - 0:nm, 1:km. | |
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. | |
double | scamax |
Maximum display scale (1:X) for waypoint visibility. | |
double | m_PlannedSpeed |
Planned speed for next leg (knots) | |
bool | m_bShowWaypointRangeRings |
True to show range rings on chart. | |
double | m_WaypointArrivalRadius |
Arrival radius in nautical miles. | |
wxDateTime | m_ETD |
Estimated departure time in UTC, or wxInvalidDateTime if not set. | |
wxString | m_TideStation |
Tide Station Identifier. | |
Protected Member Functions | |
void | InitDefaults () |
Initializes waypoint properties to default values. | |
Definition at line 5596 of file ocpn_plugin.h.
PlugIn_Waypoint_ExV2::PlugIn_Waypoint_ExV2 | ( | ) |
Definition at line 1874 of file ocpn_plugin_gui.cpp.
PlugIn_Waypoint_ExV2::PlugIn_Waypoint_ExV2 | ( | double | lat, |
double | lon, | ||
const wxString & | icon_ident, | ||
const wxString & | wp_name, | ||
const wxString & | GUID = "" , |
||
const double | ScaMin = 1e9 , |
||
const double | ScaMax = 1e6 , |
||
const bool | bNameVisible = false , |
||
const int | nRangeRings = 0 , |
||
const double | RangeDistance = 1.0 , |
||
const int | RangeRingSpaceUnits = 0 , |
||
const wxColor | RangeColor = wxColor(255, 0, 0) , |
||
const double | WaypointArrivalRadius = 0.0 , |
||
const bool | ShowWaypointRangeRings = false , |
||
const double | PlannedSpeed = 0.0 , |
||
const wxString | TideStation = wxEmptyString |
||
) |
Definition at line 1876 of file ocpn_plugin_gui.cpp.
|
virtual |
Definition at line 1928 of file ocpn_plugin_gui.cpp.
bool PlugIn_Waypoint_ExV2::GetFSStatus | ( | ) |
Gets "free-standing" status of waypoint.
A waypoint is considered "free-standing" if it was:
Definition at line 1930 of file ocpn_plugin_gui.cpp.
int PlugIn_Waypoint_ExV2::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 1937 of file ocpn_plugin_gui.cpp.
|
protected |
Initializes waypoint properties to default values.
Sets standard default values for waypoint fields:
Definition at line 1906 of file ocpn_plugin_gui.cpp.
bool PlugIn_Waypoint_ExV2::b_useScamin |
True to enable scale-dependent visibility.
Definition at line 5647 of file ocpn_plugin.h.
wxString PlugIn_Waypoint_ExV2::IconDescription |
User-friendly description of icon.
Definition at line 5656 of file ocpn_plugin.h.
wxString PlugIn_Waypoint_ExV2::IconName |
Name of icon to use for waypoint symbol.
Definition at line 5655 of file ocpn_plugin.h.
bool PlugIn_Waypoint_ExV2::IsActive |
Active state (e.g. destination)
Definition at line 5644 of file ocpn_plugin.h.
bool PlugIn_Waypoint_ExV2::IsNameVisible |
True to show waypoint name on chart.
Definition at line 5648 of file ocpn_plugin.h.
bool PlugIn_Waypoint_ExV2::IsVisible |
Visibility state on chart.
Definition at line 5643 of file ocpn_plugin.h.
bool PlugIn_Waypoint_ExV2::m_bShowWaypointRangeRings |
True to show range rings on chart.
Definition at line 5668 of file ocpn_plugin.h.
wxDateTime PlugIn_Waypoint_ExV2::m_CreateTime |
Creation timestamp in UTC.
Definition at line 5642 of file ocpn_plugin.h.
wxDateTime PlugIn_Waypoint_ExV2::m_ETD |
Estimated departure time in UTC, or wxInvalidDateTime if not set.
Definition at line 5671 of file ocpn_plugin.h.
wxString PlugIn_Waypoint_ExV2::m_GUID |
Globally unique identifier.
Definition at line 5639 of file ocpn_plugin.h.
Plugin_HyperlinkList* PlugIn_Waypoint_ExV2::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 5663 of file ocpn_plugin.h.
double PlugIn_Waypoint_ExV2::m_lat |
Latitude in decimal degrees.
Definition at line 5637 of file ocpn_plugin.h.
double PlugIn_Waypoint_ExV2::m_lon |
Longitude in decimal degrees.
Definition at line 5638 of file ocpn_plugin.h.
wxString PlugIn_Waypoint_ExV2::m_MarkDescription |
Optional description text.
Definition at line 5641 of file ocpn_plugin.h.
wxString PlugIn_Waypoint_ExV2::m_MarkName |
Display name of waypoint.
Definition at line 5640 of file ocpn_plugin.h.
double PlugIn_Waypoint_ExV2::m_PlannedSpeed |
Planned speed for next leg (knots)
Definition at line 5667 of file ocpn_plugin.h.
wxString PlugIn_Waypoint_ExV2::m_TideStation |
Tide Station Identifier.
Definition at line 5673 of file ocpn_plugin.h.
double PlugIn_Waypoint_ExV2::m_WaypointArrivalRadius |
Arrival radius in nautical miles.
Definition at line 5669 of file ocpn_plugin.h.
int PlugIn_Waypoint_ExV2::nrange_rings |
Number of range rings to display around waypoint.
Definition at line 5650 of file ocpn_plugin.h.
wxColour PlugIn_Waypoint_ExV2::RangeRingColor |
Color to draw range rings.
Definition at line 5653 of file ocpn_plugin.h.
double PlugIn_Waypoint_ExV2::RangeRingSpace |
Distance between range rings in preferred units.
Definition at line 5651 of file ocpn_plugin.h.
int PlugIn_Waypoint_ExV2::RangeRingSpaceUnits |
Units for range ring spacing - 0:nm, 1:km.
Definition at line 5652 of file ocpn_plugin.h.
double PlugIn_Waypoint_ExV2::scamax |
Maximum display scale (1:X) for waypoint visibility.
Definition at line 5666 of file ocpn_plugin.h.
double PlugIn_Waypoint_ExV2::scamin |
Minimum display scale (1:X) for waypoint visibility.
Definition at line 5646 of file ocpn_plugin.h.