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

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.
 

Detailed Description

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:

  • Free-standing vs route waypoint status tracking
  • Route membership counting
  • Scale-dependent visibility control
  • Range ring visualization
  • Hyperlink attachments
  • Enhanced name/description fields
  • Activity status tracking

Used when more control is needed over waypoint behavior than provided by the basic PlugIn_Waypoint class.

Note
Requires OpenCPN API version 1.17 or later
Provides better support for complex navigation features
Use basic PlugIn_Waypoint for simple waypoint needs
Examples
/home/runner/work/main/main/opencpn/include/ocpn_plugin.h.

Definition at line 5300 of file ocpn_plugin.h.

Constructor & Destructor Documentation

◆ PlugIn_Waypoint_Ex() [1/2]

PlugIn_Waypoint_Ex::PlugIn_Waypoint_Ex ( )

Definition at line 1835 of file ocpn_plugin_gui.cpp.

◆ PlugIn_Waypoint_Ex() [2/2]

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

◆ ~PlugIn_Waypoint_Ex()

PlugIn_Waypoint_Ex::~PlugIn_Waypoint_Ex ( )

Definition at line 1902 of file ocpn_plugin_gui.cpp.

Member Function Documentation

◆ GetFSStatus()

bool PlugIn_Waypoint_Ex::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 1871 of file ocpn_plugin_gui.cpp.

◆ GetRouteMembershipCount()

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.

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

Definition at line 1880 of file ocpn_plugin_gui.cpp.

◆ InitDefaults()

void PlugIn_Waypoint_Ex::InitDefaults ( )

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

Member Data Documentation

◆ b_useScamin

bool PlugIn_Waypoint_Ex::b_useScamin

True to enable scale-dependent visibility.

Definition at line 5354 of file ocpn_plugin.h.

◆ IconDescription

wxString PlugIn_Waypoint_Ex::IconDescription

User-friendly description of icon.

Definition at line 5362 of file ocpn_plugin.h.

◆ IconName

wxString PlugIn_Waypoint_Ex::IconName

Name of icon to use for waypoint symbol.

Definition at line 5361 of file ocpn_plugin.h.

◆ IsActive

bool PlugIn_Waypoint_Ex::IsActive

Active state (e.g. destination)

Definition at line 5351 of file ocpn_plugin.h.

◆ IsNameVisible

bool PlugIn_Waypoint_Ex::IsNameVisible

True to show waypoint name on chart.

Definition at line 5355 of file ocpn_plugin.h.

◆ IsVisible

bool PlugIn_Waypoint_Ex::IsVisible

Visibility state on chart.

Definition at line 5350 of file ocpn_plugin.h.

◆ m_CreateTime

wxDateTime PlugIn_Waypoint_Ex::m_CreateTime

Creation timestamp in UTC.

Definition at line 5349 of file ocpn_plugin.h.

◆ m_GUID

wxString PlugIn_Waypoint_Ex::m_GUID

Globally unique identifier.

Definition at line 5346 of file ocpn_plugin.h.

◆ m_HyperlinkList

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

◆ m_lat

double PlugIn_Waypoint_Ex::m_lat

Latitude in decimal degrees.

Definition at line 5344 of file ocpn_plugin.h.

◆ m_lon

double PlugIn_Waypoint_Ex::m_lon

Longitude in decimal degrees.

Definition at line 5345 of file ocpn_plugin.h.

◆ m_MarkDescription

wxString PlugIn_Waypoint_Ex::m_MarkDescription

Optional description text.

Definition at line 5348 of file ocpn_plugin.h.

◆ m_MarkName

wxString PlugIn_Waypoint_Ex::m_MarkName

Display name of waypoint.

Definition at line 5347 of file ocpn_plugin.h.

◆ nrange_rings

int PlugIn_Waypoint_Ex::nrange_rings

Number of range rings to display around waypoint.

Definition at line 5357 of file ocpn_plugin.h.

◆ RangeRingColor

wxColour PlugIn_Waypoint_Ex::RangeRingColor

Color to draw range rings.

Definition at line 5359 of file ocpn_plugin.h.

◆ RangeRingSpace

double PlugIn_Waypoint_Ex::RangeRingSpace

Distance between range rings in preferred units.

Definition at line 5358 of file ocpn_plugin.h.

◆ scamin

double PlugIn_Waypoint_Ex::scamin

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

Definition at line 5353 of file ocpn_plugin.h.

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