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

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.
 

Detailed Description

Examples
/home/runner/work/main/main/opencpn/include/ocpn_plugin.h.

Definition at line 5307 of file ocpn_plugin.h.

Constructor & Destructor Documentation

◆ PlugIn_Waypoint_ExV2() [1/2]

PlugIn_Waypoint_ExV2::PlugIn_Waypoint_ExV2 ( )

Definition at line 1882 of file ocpn_plugin_gui.cpp.

◆ PlugIn_Waypoint_ExV2() [2/2]

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 1884 of file ocpn_plugin_gui.cpp.

◆ ~PlugIn_Waypoint_ExV2()

PlugIn_Waypoint_ExV2::~PlugIn_Waypoint_ExV2 ( )
virtual

Definition at line 1936 of file ocpn_plugin_gui.cpp.

Member Function Documentation

◆ GetFSStatus()

bool PlugIn_Waypoint_ExV2::GetFSStatus ( )

Gets "free-standing" status of waypoint.

A waypoint is considered "free-standing" if it was:

  • Created by dropping a point in the GUI
  • Imported from a GPX file
  • Added via AddSingleWaypoint API (vs being part of a route)
Returns
True if waypoint is free-standing, false if part of route

Definition at line 1938 of file ocpn_plugin_gui.cpp.

◆ GetRouteMembershipCount()

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.

Returns
Number of routes waypoint belongs to (0 if free-standing)

Definition at line 1945 of file ocpn_plugin_gui.cpp.

◆ InitDefaults()

void PlugIn_Waypoint_ExV2::InitDefaults ( )
protected

Initializes waypoint properties to default values.

Sets standard default values for waypoint fields:

  • Zero latitude/longitude
  • Empty name and description
  • Current timestamp
  • Visible but inactive state
  • Default icon and settings

Definition at line 1914 of file ocpn_plugin_gui.cpp.

Member Data Documentation

◆ b_useScamin

bool PlugIn_Waypoint_ExV2::b_useScamin

True to enable scale-dependent visibility.

Definition at line 5358 of file ocpn_plugin.h.

◆ IconDescription

wxString PlugIn_Waypoint_ExV2::IconDescription

User-friendly description of icon.

Definition at line 5367 of file ocpn_plugin.h.

◆ IconName

wxString PlugIn_Waypoint_ExV2::IconName

Name of icon to use for waypoint symbol.

Definition at line 5366 of file ocpn_plugin.h.

◆ IsActive

bool PlugIn_Waypoint_ExV2::IsActive

Active state (e.g. destination)

Definition at line 5355 of file ocpn_plugin.h.

◆ IsNameVisible

bool PlugIn_Waypoint_ExV2::IsNameVisible

True to show waypoint name on chart.

Definition at line 5359 of file ocpn_plugin.h.

◆ IsVisible

bool PlugIn_Waypoint_ExV2::IsVisible

Visibility state on chart.

Definition at line 5354 of file ocpn_plugin.h.

◆ m_bShowWaypointRangeRings

bool PlugIn_Waypoint_ExV2::m_bShowWaypointRangeRings

True to show range rings on chart.

Definition at line 5379 of file ocpn_plugin.h.

◆ m_CreateTime

wxDateTime PlugIn_Waypoint_ExV2::m_CreateTime

Creation timestamp in UTC.

Definition at line 5353 of file ocpn_plugin.h.

◆ m_ETD

wxDateTime PlugIn_Waypoint_ExV2::m_ETD

Estimated departure time in UTC, or wxInvalidDateTime if not set.

Definition at line 5382 of file ocpn_plugin.h.

◆ m_GUID

wxString PlugIn_Waypoint_ExV2::m_GUID

Globally unique identifier.

Definition at line 5350 of file ocpn_plugin.h.

◆ m_HyperlinkList

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 5374 of file ocpn_plugin.h.

◆ m_lat

double PlugIn_Waypoint_ExV2::m_lat

Latitude in decimal degrees.

Definition at line 5348 of file ocpn_plugin.h.

◆ m_lon

double PlugIn_Waypoint_ExV2::m_lon

Longitude in decimal degrees.

Definition at line 5349 of file ocpn_plugin.h.

◆ m_MarkDescription

wxString PlugIn_Waypoint_ExV2::m_MarkDescription

Optional description text.

Definition at line 5352 of file ocpn_plugin.h.

◆ m_MarkName

wxString PlugIn_Waypoint_ExV2::m_MarkName

Display name of waypoint.

Definition at line 5351 of file ocpn_plugin.h.

◆ m_PlannedSpeed

double PlugIn_Waypoint_ExV2::m_PlannedSpeed

Planned speed for next leg (knots)

Definition at line 5378 of file ocpn_plugin.h.

◆ m_TideStation

wxString PlugIn_Waypoint_ExV2::m_TideStation

Tide Station Identifier.

Definition at line 5384 of file ocpn_plugin.h.

◆ m_WaypointArrivalRadius

double PlugIn_Waypoint_ExV2::m_WaypointArrivalRadius

Arrival radius in nautical miles.

Definition at line 5380 of file ocpn_plugin.h.

◆ nrange_rings

int PlugIn_Waypoint_ExV2::nrange_rings

Number of range rings to display around waypoint.

Definition at line 5361 of file ocpn_plugin.h.

◆ RangeRingColor

wxColour PlugIn_Waypoint_ExV2::RangeRingColor

Color to draw range rings.

Definition at line 5364 of file ocpn_plugin.h.

◆ RangeRingSpace

double PlugIn_Waypoint_ExV2::RangeRingSpace

Distance between range rings in preferred units.

Definition at line 5362 of file ocpn_plugin.h.

◆ RangeRingSpaceUnits

int PlugIn_Waypoint_ExV2::RangeRingSpaceUnits

Units for range ring spacing - 0:nm, 1:km.

Definition at line 5363 of file ocpn_plugin.h.

◆ scamax

double PlugIn_Waypoint_ExV2::scamax

Maximum display scale (1:X) for waypoint visibility.

Definition at line 5377 of file ocpn_plugin.h.

◆ scamin

double PlugIn_Waypoint_ExV2::scamin

Minimum display scale (1:X) for waypoint visibility.

Definition at line 5357 of file ocpn_plugin.h.

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