OpenCPN Partial API docs
Loading...
Searching...
No Matches
WayPointman Class Reference

Public Member Functions

 WayPointman (GlobalColourFunc colour_func)
wxBitmap * GetIconBitmap (const wxString &icon_key) const
bool GetIconPrescaled (const wxString &icon_key) const
int GetIconIndex (const wxBitmap *pbm) const
int GetIconImageListIndex (const wxBitmap *pbm) const
int GetXIconImageListIndex (const wxBitmap *pbm) const
 index of "X-ed out" icon in the image list
int GetFIconImageListIndex (const wxBitmap *pbm) const
 index of "fixed viz" icon in the image list
int GetNumIcons (void)
wxString CreateGUID (RoutePoint *pRP)
RoutePoint * FindWaypointByGuid (const std::string &guid)
RoutePoint * GetNearbyWaypoint (double lat, double lon, double radius_meters)
RoutePoint * GetOtherNearbyWaypoint (double lat, double lon, double radius_meters, const wxString &guid)
bool IsReallyVisible (RoutePoint *pWP)
bool SharedWptsExist ()
void DeleteAllWaypoints (bool b_delete_used)
RoutePoint * FindRoutePointByGUID (const wxString &guid)
void DestroyWaypoint (RoutePoint *pRp, bool b_update_changeset=true)
void ClearRoutePointFonts (void)
bool DoesIconExist (const wxString &icon_key) const
wxBitmap GetIconBitmapForList (int index, int height) const
wxString * GetIconDescription (int index) const
wxString * GetIconKey (int index) const
wxString GetIconDescription (wxString icon_key) const
wxImageList * Getpmarkicon_image_list (int nominal_height)
bool AddRoutePoint (RoutePoint *prp)
 Add a point to list which owns it.
bool RemoveRoutePoint (RoutePoint *prp)
 Remove a routepoint from list if present, deallocate it all cases.
const RoutePointList * GetWaypointList (void)

Friends

class WayPointmanGui

Detailed Description

Definition at line 313 of file routeman.h.

Constructor & Destructor Documentation

◆ WayPointman()

WayPointman::WayPointman ( GlobalColourFunc colour_func)

Definition at line 968 of file routeman.cpp.

◆ ~WayPointman()

WayPointman::~WayPointman ( )

Definition at line 986 of file routeman.cpp.

Member Function Documentation

◆ AddRoutePoint()

bool WayPointman::AddRoutePoint ( RoutePoint * prp)

Add a point to list which owns it.

Parameters
prpRoutePoint allocated by caller.
Returns
true if successfully added.

Definition at line 1025 of file routeman.cpp.

◆ ClearRoutePointFonts()

void WayPointman::ClearRoutePointFonts ( void )

Definition at line 1442 of file routeman.cpp.

◆ CreateGUID()

wxString WayPointman::CreateGUID ( RoutePoint * pRP)

Definition at line 1383 of file routeman.cpp.

◆ DeleteAllWaypoints()

void WayPointman::DeleteAllWaypoints ( bool b_delete_used)

Definition at line 1459 of file routeman.cpp.

◆ DestroyWaypoint()

void WayPointman::DestroyWaypoint ( RoutePoint * pRp,
bool b_update_changeset = true )

Definition at line 1484 of file routeman.cpp.

◆ DoesIconExist()

bool WayPointman::DoesIconExist ( const wxString & icon_key) const

Definition at line 1113 of file routeman.cpp.

◆ FindRoutePointByGUID()

RoutePoint * WayPointman::FindRoutePointByGUID ( const wxString & guid)

Definition at line 1387 of file routeman.cpp.

◆ FindWaypointByGuid()

RoutePoint * WayPointman::FindWaypointByGuid ( const std::string & guid)

Definition at line 1478 of file routeman.cpp.

◆ GetFIconImageListIndex()

int WayPointman::GetFIconImageListIndex ( const wxBitmap * pbm) const

index of "fixed viz" icon in the image list

Definition at line 1378 of file routeman.cpp.

◆ GetIconBitmap()

wxBitmap * WayPointman::GetIconBitmap ( const wxString & icon_key) const

Definition at line 1125 of file routeman.cpp.

◆ GetIconBitmapForList()

wxBitmap WayPointman::GetIconBitmapForList ( int index,
int height ) const

Definition at line 1189 of file routeman.cpp.

◆ GetIconDescription() [1/2]

wxString * WayPointman::GetIconDescription ( int index) const

Definition at line 1231 of file routeman.cpp.

◆ GetIconDescription() [2/2]

wxString WayPointman::GetIconDescription ( wxString icon_key) const

Definition at line 1241 of file routeman.cpp.

◆ GetIconImageListIndex()

int WayPointman::GetIconImageListIndex ( const wxBitmap * pbm) const

Definition at line 1280 of file routeman.cpp.

◆ GetIconIndex()

int WayPointman::GetIconIndex ( const wxBitmap * pbm) const

Definition at line 1264 of file routeman.cpp.

◆ GetIconKey()

wxString * WayPointman::GetIconKey ( int index) const

Definition at line 1254 of file routeman.cpp.

◆ GetIconPrescaled()

bool WayPointman::GetIconPrescaled ( const wxString & icon_key) const

Definition at line 1161 of file routeman.cpp.

◆ GetNearbyWaypoint()

RoutePoint * WayPointman::GetNearbyWaypoint ( double lat,
double lon,
double radius_meters )

Definition at line 1394 of file routeman.cpp.

◆ GetNumIcons()

int WayPointman::GetNumIcons ( void )
inline

Definition at line 330 of file routeman.h.

◆ GetOtherNearbyWaypoint()

RoutePoint * WayPointman::GetOtherNearbyWaypoint ( double lat,
double lon,
double radius_meters,
const wxString & guid )

Definition at line 1408 of file routeman.cpp.

◆ Getpmarkicon_image_list()

wxImageList * WayPointman::Getpmarkicon_image_list ( int nominal_height)

Definition at line 1053 of file routeman.cpp.

◆ GetWaypointList()

const RoutePointList * WayPointman::GetWaypointList ( void )
inline

Definition at line 366 of file routeman.h.

◆ GetXIconImageListIndex()

int WayPointman::GetXIconImageListIndex ( const wxBitmap * pbm) const

index of "X-ed out" icon in the image list

Definition at line 1374 of file routeman.cpp.

◆ IsReallyVisible()

bool WayPointman::IsReallyVisible ( RoutePoint * pWP)

Definition at line 1424 of file routeman.cpp.

◆ RemoveRoutePoint()

bool WayPointman::RemoveRoutePoint ( RoutePoint * prp)

Remove a routepoint from list if present, deallocate it all cases.

Parameters
prpRoutePoint possibly part of list.
Returns
true if prp != nullptr.

Definition at line 1034 of file routeman.cpp.

◆ SharedWptsExist()

bool WayPointman::SharedWptsExist ( )

Definition at line 1450 of file routeman.cpp.

◆ WayPointmanGui

friend class WayPointmanGui
friend

Definition at line 314 of file routeman.h.


The documentation for this class was generated from the following files:
  • /home/runner/work/main/main/opencpn/model/include/model/routeman.h
  • /home/runner/work/main/main/opencpn/model/src/routeman.cpp