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

Represents a waypoint or mark within the navigation system. More...

#include <route_point.h>

Public Member Functions

 RoutePoint (double lat, double lon, const wxString &icon_ident, const wxString &name, const wxString &pGUID=wxEmptyString, bool bAddToList=true)
 
 RoutePoint (RoutePoint *orig)
 
void ReLoadIcon ()
 
void SetPosition (double lat, double lon)
 
double GetLatitude ()
 
double GetLongitude ()
 
LLBBox & GetBBox ()
 
bool IsSame (RoutePoint *pOtherRP)
 
bool IsVisible ()
 
bool IsListed ()
 
bool IsNameShown ()
 
bool IsNameDynamic ()
 
bool IsShared ()
 
void SetShared (bool bshared)
 
bool IsSharedInVisibleRoute (void)
 
bool IsVisibleSelectable (double scale_val, bool boverrideViz=false)
 
void SetVisible (bool viz=true)
 
void SetListed (bool viz=true)
 
void SetNameShown (bool viz=true)
 
bool GetNameShown ()
 
virtual wxString GetName (void)
 
wxString GetDescription (void)
 
wxDateTime GetCreateTime (void)
 
void SetCreateTime (wxDateTime dt)
 
wxString GetIconName (void)
 
void SetIconName (wxString name)
 
void * GetSelectNode (void)
 
void SetSelectNode (void *node)
 
void * GetManagerListNode (void)
 
void SetManagerListNode (void *node)
 
void SetName (const wxString &name)
 
void CalculateNameExtents (void)
 
void SetCourse (double course)
 
double GetCourse ()
 
void SetDistance (double distance)
 
double GetDistance ()
 
void SetWaypointArrivalRadius (double dArrivalDistance)
 
void SetWaypointArrivalRadius (wxString wxArrivalDistance)
 
double GetWaypointArrivalRadius ()
 
bool GetShowWaypointRangeRings (void)
 
int GetWaypointRangeRingsNumber (void)
 
float GetWaypointRangeRingsStep (void)
 
int GetWaypointRangeRingsStepUnits (void)
 
void SetShowWaypointRangeRings (bool b_showWaypointRangeRings)
 
void SetWaypointRangeRingsNumber (int i_WaypointRangeRingsNumber)
 
void SetWaypointRangeRingsStep (float f_WaypointRangeRingsStep)
 
void SetWaypointRangeRingsStepUnits (int i_WaypointRangeRingsStepUnits)
 
void SetWaypointRangeRingsColour (wxColour wxc_WaypointRangeRingsColour)
 
void SetScaMin (wxString str)
 
void SetScaMin (long val)
 
long GetScaMin ()
 
void SetScaMax (wxString str)
 
void SetScaMax (long val)
 
long GetScaMax ()
 
bool GetUseSca ()
 
void SetUseSca (bool value)
 
bool IsDragHandleEnabled ()
 
void SetPlannedSpeed (double spd)
 
double GetPlannedSpeed ()
 
wxDateTime GetETD ()
 
wxDateTime GetManualETD ()
 
void SetETD (const wxDateTime &etd)
 
bool SetETD (const wxString &ts)
 
wxDateTime GetETA ()
 
wxString GetETE ()
 
void SetETE (wxLongLong secs)
 

Public Attributes

double m_lat
 
double m_lon
 
double m_seg_len
 
double m_seg_vmg
 
wxDateTime m_seg_etd
 
wxDateTime m_seg_eta
 
wxLongLong m_seg_ete = 0
 
bool m_manual_etd {false}
 
bool m_bPtIsSelected
 
bool m_bRPIsBeingEdited
 
bool m_bIsInRoute
 
bool m_bIsolatedMark
 Flag indicating if the waypoint is a standalone mark.
 
bool m_bIsVisible
 
bool m_bIsListed
 
bool m_bIsActive
 
bool m_IconIsDirty
 
wxString m_MarkDescription
 
wxString m_GUID
 
wxString m_TideStation
 
wxFont * m_pMarkFont
 
wxColour m_FontColor
 
wxSize m_NameExtents
 
bool m_bBlink
 
bool m_bShowName
 
bool m_bShowNameData
 
wxRect CurrentRect_in_DC
 
int m_NameLocationOffsetX
 
int m_NameLocationOffsetY
 
bool m_bIsInLayer
 
int m_LayerID
 
double m_routeprop_course
 
double m_routeprop_distance
 
bool m_btemp
 
bool m_bShowWaypointRangeRings
 
int m_iWaypointRangeRingsNumber
 
float m_fWaypointRangeRingsStep
 
int m_iWaypointRangeRingsStepUnits
 
wxColour m_wxcWaypointRangeRingsColour
 
unsigned int m_iTextTexture
 
int m_iTextTextureWidth
 
int m_iTextTextureHeight
 
LLBBox m_wpBBox
 
double m_wpBBox_view_scale_ppm
 
double m_wpBBox_rotation
 
bool m_pos_on_screen
 
wxPoint2DDouble m_screen_pos
 
double m_WaypointArrivalRadius
 
HyperlinkList * m_HyperlinkList
 
wxString m_timestring
 
wxDateTime m_CreateTimeX
 

Static Public Attributes

static std::function< void(unsigned, const unsigned *)> delete_gl_textures
 Horrible Hack (tm).
 

Friends

class RoutePointGui
 

Detailed Description

Represents a waypoint or mark within the navigation system.

RoutePoint represents both standalone marks and waypoints that are part of routes or tracks. A RoutePoint contains geographical coordinates, display properties, and various navigation-related attributes.

RoutePoints can exist in several states:

  • As standalone marks (isolated waypoints)
  • As part of one or more routes
  • As shared waypoints (used in multiple routes)

The class manages visual properties like icons, visibility, and range rings, as well as navigation data like arrival radius, planned speed, and ETAs.

Definition at line 68 of file route_point.h.

Constructor & Destructor Documentation

◆ RoutePoint() [1/3]

RoutePoint::RoutePoint ( double  lat,
double  lon,
const wxString &  icon_ident,
const wxString &  name,
const wxString &  pGUID = wxEmptyString,
bool  bAddToList = true 
)

Definition at line 175 of file route_point.cpp.

◆ RoutePoint() [2/3]

RoutePoint::RoutePoint ( RoutePoint *  orig)

Definition at line 119 of file route_point.cpp.

◆ RoutePoint() [3/3]

RoutePoint::RoutePoint ( )

Definition at line 53 of file route_point.cpp.

◆ ~RoutePoint()

RoutePoint::~RoutePoint ( void  )
virtual

Definition at line 261 of file route_point.cpp.

Member Function Documentation

◆ CalculateNameExtents()

void RoutePoint::CalculateNameExtents ( void  )

Definition at line 290 of file route_point.cpp.

◆ GetBBox()

LLBBox & RoutePoint::GetBBox ( )
inline

Definition at line 92 of file route_point.h.

◆ GetCourse()

double RoutePoint::GetCourse ( )
inline

Definition at line 129 of file route_point.h.

◆ GetCreateTime()

wxDateTime RoutePoint::GetCreateTime ( void  )

Definition at line 272 of file route_point.cpp.

◆ GetDescription()

wxString RoutePoint::GetDescription ( void  )
inline

Definition at line 111 of file route_point.h.

◆ GetDistance()

double RoutePoint::GetDistance ( )
inline

Definition at line 131 of file route_point.h.

◆ GetETA()

wxDateTime RoutePoint::GetETA ( )

Definition at line 511 of file route_point.cpp.

◆ GetETD()

wxDateTime RoutePoint::GetETD ( )

Definition at line 462 of file route_point.cpp.

◆ GetETE()

wxString RoutePoint::GetETE ( )

Definition at line 518 of file route_point.cpp.

◆ GetIconName()

wxString RoutePoint::GetIconName ( void  )
inline

Definition at line 116 of file route_point.h.

◆ GetLatitude()

double RoutePoint::GetLatitude ( )
inline

Definition at line 90 of file route_point.h.

◆ GetLongitude()

double RoutePoint::GetLongitude ( )
inline

Definition at line 91 of file route_point.h.

◆ GetManagerListNode()

void * RoutePoint::GetManagerListNode ( void  )
inline

Definition at line 122 of file route_point.h.

◆ GetManualETD()

wxDateTime RoutePoint::GetManualETD ( )

Definition at line 504 of file route_point.cpp.

◆ GetName()

virtual wxString RoutePoint::GetName ( void  )
inlinevirtual

Definition at line 110 of file route_point.h.

◆ GetNameShown()

bool RoutePoint::GetNameShown ( )
inline

Definition at line 109 of file route_point.h.

◆ GetPlannedSpeed()

double RoutePoint::GetPlannedSpeed ( )

Definition at line 445 of file route_point.cpp.

◆ GetScaMax()

long RoutePoint::GetScaMax ( )
inline

Definition at line 164 of file route_point.h.

◆ GetScaMin()

long RoutePoint::GetScaMin ( )
inline

Definition at line 161 of file route_point.h.

◆ GetSelectNode()

void * RoutePoint::GetSelectNode ( void  )
inline

Definition at line 119 of file route_point.h.

◆ GetShowWaypointRangeRings()

bool RoutePoint::GetShowWaypointRangeRings ( void  )
inline

Definition at line 140 of file route_point.h.

◆ GetUseSca()

bool RoutePoint::GetUseSca ( )
inline

Definition at line 165 of file route_point.h.

◆ GetWaypointArrivalRadius()

double RoutePoint::GetWaypointArrivalRadius ( )

Definition at line 388 of file route_point.cpp.

◆ GetWaypointRangeRingsNumber()

int RoutePoint::GetWaypointRangeRingsNumber ( void  )

Definition at line 396 of file route_point.cpp.

◆ GetWaypointRangeRingsStep()

float RoutePoint::GetWaypointRangeRingsStep ( void  )

Definition at line 403 of file route_point.cpp.

◆ GetWaypointRangeRingsStepUnits()

int RoutePoint::GetWaypointRangeRingsStepUnits ( void  )

Definition at line 410 of file route_point.cpp.

◆ IsDragHandleEnabled()

bool RoutePoint::IsDragHandleEnabled ( )
inline

Definition at line 167 of file route_point.h.

◆ IsListed()

bool RoutePoint::IsListed ( )
inline

Definition at line 96 of file route_point.h.

◆ IsNameDynamic()

bool RoutePoint::IsNameDynamic ( )

Check if the name is dynamic for resequencing purposes. If the name is part of a route, and has 3 numeric characters, then it is dynamic and can be resequenced.

Definition at line 367 of file route_point.cpp.

◆ IsNameShown()

bool RoutePoint::IsNameShown ( )
inline

Definition at line 97 of file route_point.h.

◆ IsSame()

bool RoutePoint::IsSame ( RoutePoint *  pOtherRP)

Definition at line 351 of file route_point.cpp.

◆ IsShared()

bool RoutePoint::IsShared ( )
inline

Definition at line 100 of file route_point.h.

◆ IsSharedInVisibleRoute()

bool RoutePoint::IsSharedInVisibleRoute ( void  )

Definition at line 324 of file route_point.cpp.

◆ IsVisible()

bool RoutePoint::IsVisible ( )
inline

Definition at line 95 of file route_point.h.

◆ IsVisibleSelectable()

bool RoutePoint::IsVisibleSelectable ( double  scale_val,
bool  boverrideViz = false 
)

Definition at line 306 of file route_point.cpp.

◆ ReLoadIcon()

void RoutePoint::ReLoadIcon ( )
inline

Definition at line 87 of file route_point.h.

◆ SetCourse()

void RoutePoint::SetCourse ( double  course)
inline

Definition at line 128 of file route_point.h.

◆ SetCreateTime()

void RoutePoint::SetCreateTime ( wxDateTime  dt)

Definition at line 279 of file route_point.cpp.

◆ SetDistance()

void RoutePoint::SetDistance ( double  distance)
inline

Definition at line 130 of file route_point.h.

◆ SetETD() [1/2]

void RoutePoint::SetETD ( const wxDateTime &  etd)

Definition at line 527 of file route_point.cpp.

◆ SetETD() [2/2]

bool RoutePoint::SetETD ( const wxString &  ts)

Definition at line 532 of file route_point.cpp.

◆ SetETE()

void RoutePoint::SetETE ( wxLongLong  secs)

Definition at line 525 of file route_point.cpp.

◆ SetIconName()

void RoutePoint::SetIconName ( wxString  name)
inline

Definition at line 117 of file route_point.h.

◆ SetListed()

void RoutePoint::SetListed ( bool  viz = true)
inline

Definition at line 107 of file route_point.h.

◆ SetManagerListNode()

void RoutePoint::SetManagerListNode ( void *  node)
inline

Definition at line 123 of file route_point.h.

◆ SetName()

void RoutePoint::SetName ( const wxString &  name)

Definition at line 281 of file route_point.cpp.

◆ SetNameShown()

void RoutePoint::SetNameShown ( bool  viz = true)
inline

Definition at line 108 of file route_point.h.

◆ SetPlannedSpeed()

void RoutePoint::SetPlannedSpeed ( double  spd)

Definition at line 441 of file route_point.cpp.

◆ SetPosition()

void RoutePoint::SetPosition ( double  lat,
double  lon 
)

Definition at line 346 of file route_point.cpp.

◆ SetScaMax() [1/2]

void RoutePoint::SetScaMax ( long  val)

Definition at line 430 of file route_point.cpp.

◆ SetScaMax() [2/2]

void RoutePoint::SetScaMax ( wxString  str)

Definition at line 435 of file route_point.cpp.

◆ SetScaMin() [1/2]

void RoutePoint::SetScaMin ( long  val)

Definition at line 417 of file route_point.cpp.

◆ SetScaMin() [2/2]

void RoutePoint::SetScaMin ( wxString  str)

Definition at line 424 of file route_point.cpp.

◆ SetSelectNode()

void RoutePoint::SetSelectNode ( void *  node)
inline

Definition at line 120 of file route_point.h.

◆ SetShared()

void RoutePoint::SetShared ( bool  bshared)
inline

Definition at line 101 of file route_point.h.

◆ SetShowWaypointRangeRings()

void RoutePoint::SetShowWaypointRangeRings ( bool  b_showWaypointRangeRings)
inline

Definition at line 144 of file route_point.h.

◆ SetUseSca()

void RoutePoint::SetUseSca ( bool  value)
inline

Definition at line 166 of file route_point.h.

◆ SetVisible()

void RoutePoint::SetVisible ( bool  viz = true)
inline

Definition at line 106 of file route_point.h.

◆ SetWaypointArrivalRadius() [1/2]

void RoutePoint::SetWaypointArrivalRadius ( double  dArrivalDistance)
inline

Definition at line 133 of file route_point.h.

◆ SetWaypointArrivalRadius() [2/2]

void RoutePoint::SetWaypointArrivalRadius ( wxString  wxArrivalDistance)
inline

Definition at line 136 of file route_point.h.

◆ SetWaypointRangeRingsColour()

void RoutePoint::SetWaypointRangeRingsColour ( wxColour  wxc_WaypointRangeRingsColour)
inline

Definition at line 156 of file route_point.h.

◆ SetWaypointRangeRingsNumber()

void RoutePoint::SetWaypointRangeRingsNumber ( int  i_WaypointRangeRingsNumber)
inline

Definition at line 147 of file route_point.h.

◆ SetWaypointRangeRingsStep()

void RoutePoint::SetWaypointRangeRingsStep ( float  f_WaypointRangeRingsStep)
inline

Definition at line 150 of file route_point.h.

◆ SetWaypointRangeRingsStepUnits()

void RoutePoint::SetWaypointRangeRingsStepUnits ( int  i_WaypointRangeRingsStepUnits)
inline

Definition at line 153 of file route_point.h.

Friends And Related Symbol Documentation

◆ RoutePointGui

friend class RoutePointGui
friend

Definition at line 69 of file route_point.h.

Member Data Documentation

◆ CurrentRect_in_DC

wxRect RoutePoint::CurrentRect_in_DC

Definition at line 210 of file route_point.h.

◆ delete_gl_textures

std::function< void(unsigned, const unsigned *)> RoutePoint::delete_gl_textures
static
Initial value:
=
[](unsigned, const unsigned *) { assert(true); }

Horrible Hack (tm).

The destructor needs to call glDeleteTextures, but this is not visible for RoutePoint. This is basically a global, initially doing nothing but at an "early stage" initiated do do the actual glDeleteTextures call.

Definition at line 50 of file route_point.h.

◆ m_bBlink

bool RoutePoint::m_bBlink

Definition at line 208 of file route_point.h.

◆ m_bIsActive

bool RoutePoint::m_bIsActive

Definition at line 196 of file route_point.h.

◆ m_bIsInLayer

bool RoutePoint::m_bIsInLayer

Definition at line 213 of file route_point.h.

◆ m_bIsInRoute

bool RoutePoint::m_bIsInRoute

Definition at line 190 of file route_point.h.

◆ m_bIsListed

bool RoutePoint::m_bIsListed

Definition at line 195 of file route_point.h.

◆ m_bIsolatedMark

bool RoutePoint::m_bIsolatedMark

Flag indicating if the waypoint is a standalone mark.

Definition at line 192 of file route_point.h.

◆ m_bIsVisible

bool RoutePoint::m_bIsVisible

Definition at line 194 of file route_point.h.

◆ m_bPtIsSelected

bool RoutePoint::m_bPtIsSelected

Definition at line 187 of file route_point.h.

◆ m_bRPIsBeingEdited

bool RoutePoint::m_bRPIsBeingEdited

Definition at line 188 of file route_point.h.

◆ m_bShowName

bool RoutePoint::m_bShowName

Definition at line 209 of file route_point.h.

◆ m_bShowNameData

bool RoutePoint::m_bShowNameData

Definition at line 209 of file route_point.h.

◆ m_bShowWaypointRangeRings

bool RoutePoint::m_bShowWaypointRangeRings

Definition at line 223 of file route_point.h.

◆ m_btemp

bool RoutePoint::m_btemp

Definition at line 221 of file route_point.h.

◆ m_CreateTimeX

wxDateTime RoutePoint::m_CreateTimeX

Definition at line 244 of file route_point.h.

◆ m_FontColor

wxColour RoutePoint::m_FontColor

Definition at line 204 of file route_point.h.

◆ m_fWaypointRangeRingsStep

float RoutePoint::m_fWaypointRangeRingsStep

Definition at line 226 of file route_point.h.

◆ m_GUID

wxString RoutePoint::m_GUID

Definition at line 199 of file route_point.h.

◆ m_HyperlinkList

HyperlinkList* RoutePoint::m_HyperlinkList

Definition at line 240 of file route_point.h.

◆ m_IconIsDirty

bool RoutePoint::m_IconIsDirty

Definition at line 197 of file route_point.h.

◆ m_iTextTexture

unsigned int RoutePoint::m_iTextTexture

Definition at line 230 of file route_point.h.

◆ m_iTextTextureHeight

int RoutePoint::m_iTextTextureHeight

Definition at line 231 of file route_point.h.

◆ m_iTextTextureWidth

int RoutePoint::m_iTextTextureWidth

Definition at line 231 of file route_point.h.

◆ m_iWaypointRangeRingsNumber

int RoutePoint::m_iWaypointRangeRingsNumber

Definition at line 224 of file route_point.h.

◆ m_iWaypointRangeRingsStepUnits

int RoutePoint::m_iWaypointRangeRingsStepUnits

Definition at line 227 of file route_point.h.

◆ m_lat

double RoutePoint::m_lat

Definition at line 178 of file route_point.h.

◆ m_LayerID

int RoutePoint::m_LayerID

Definition at line 214 of file route_point.h.

◆ m_lon

double RoutePoint::m_lon

Definition at line 178 of file route_point.h.

◆ m_manual_etd

bool RoutePoint::m_manual_etd {false}

Definition at line 185 of file route_point.h.

◆ m_MarkDescription

wxString RoutePoint::m_MarkDescription

Definition at line 198 of file route_point.h.

◆ m_NameExtents

wxSize RoutePoint::m_NameExtents

Definition at line 206 of file route_point.h.

◆ m_NameLocationOffsetX

int RoutePoint::m_NameLocationOffsetX

Definition at line 211 of file route_point.h.

◆ m_NameLocationOffsetY

int RoutePoint::m_NameLocationOffsetY

Definition at line 212 of file route_point.h.

◆ m_pMarkFont

wxFont* RoutePoint::m_pMarkFont

Definition at line 203 of file route_point.h.

◆ m_pos_on_screen

bool RoutePoint::m_pos_on_screen

Definition at line 236 of file route_point.h.

◆ m_routeprop_course

double RoutePoint::m_routeprop_course

Definition at line 216 of file route_point.h.

◆ m_routeprop_distance

double RoutePoint::m_routeprop_distance

Definition at line 218 of file route_point.h.

◆ m_screen_pos

wxPoint2DDouble RoutePoint::m_screen_pos

Definition at line 237 of file route_point.h.

◆ m_seg_eta

wxDateTime RoutePoint::m_seg_eta

Definition at line 183 of file route_point.h.

◆ m_seg_etd

wxDateTime RoutePoint::m_seg_etd

Definition at line 182 of file route_point.h.

◆ m_seg_ete

wxLongLong RoutePoint::m_seg_ete = 0

Definition at line 184 of file route_point.h.

◆ m_seg_len

double RoutePoint::m_seg_len

Definition at line 179 of file route_point.h.

◆ m_seg_vmg

double RoutePoint::m_seg_vmg

Definition at line 181 of file route_point.h.

◆ m_TideStation

wxString RoutePoint::m_TideStation

Definition at line 201 of file route_point.h.

◆ m_timestring

wxString RoutePoint::m_timestring

Definition at line 242 of file route_point.h.

◆ m_WaypointArrivalRadius

double RoutePoint::m_WaypointArrivalRadius

Definition at line 239 of file route_point.h.

◆ m_wpBBox

LLBBox RoutePoint::m_wpBBox

Definition at line 233 of file route_point.h.

◆ m_wpBBox_rotation

double RoutePoint::m_wpBBox_rotation

Definition at line 234 of file route_point.h.

◆ m_wpBBox_view_scale_ppm

double RoutePoint::m_wpBBox_view_scale_ppm

Definition at line 234 of file route_point.h.

◆ m_wxcWaypointRangeRingsColour

wxColour RoutePoint::m_wxcWaypointRangeRingsColour

Definition at line 228 of file route_point.h.

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