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

Unstable development API. More...

#include <ocpn_plugin.h>

Inheritance diagram for HostApi122:
HostApi121 HostApi

Additional Inherited Members

- Public Types inherited from HostApi121
enum class  PiContextObjectType {
  kObjectChart = 0 , kObjectRoutepoint , kObjectRoutesegment , kObjectTracksegment ,
  kObjectAisTarget , kObjectUnknown
}
 
- Public Member Functions inherited from HostApi121
virtual wxString DropMarkPI (double lat, double lon)
 
virtual wxString RouteCreatePI (int canvas_index, bool start)
 
virtual wxString NavToHerePI (double lat, double lon)
 
virtual bool ActivateRoutePI (wxString route_guid, bool activate)
 
virtual void EnableDefaultConsole (bool enable)
 
virtual void EnableDefaultContextMenus (bool enable)
 
virtual void SetMinZoomScale (double min_scale)
 
virtual void SetMaxZoomScale (double max_scale)
 
virtual wxBitmap GetObjectIcon_PlugIn (const wxString &name)
 
virtual void SetDepthUnitVisible (bool bviz)
 
virtual void SetOverzoomFlagVisible (bool bviz)
 
virtual bool IsRouteActive (wxString route_guid)
 
virtual void SetBoatPosition (double zlat, double zlon)
 
virtual void RouteInsertWaypoint (int canvas_index, wxString route_guid, double zlat, double zlon)
 
virtual void RouteAppendWaypoint (int canvas_index, wxString route_guid)
 
virtual void FinishRoute (int canvas_index)
 
virtual bool IsRouteBeingCreated (int canvas_index)
 
virtual bool AreRouteWaypointNamesVisible (wxString route_guid)
 
virtual void ShowRouteWaypointNames (wxString route_guid, bool show)
 
virtual void NavigateToWaypoint (wxString waypoint_guid)
 
virtual bool DoMeasurePI (int canvas_index, bool start)
 
virtual bool IsMeasureActive (int canvas_index)
 
virtual void CancelMeasure (int canvas_index)
 
virtual bool IsAISTrackVisible (const wxString &ais_mmsi) const
 
virtual void AISToggleShowTrack (const wxString &ais_mmsi)
 
virtual bool IsAIS_CPAVisible (const wxString &ais_mmsi) const
 
virtual void AISToggleShowCPA (const wxString &ais_mmsi)
 
virtual void ShowAISTargetQueryDialog (int canvas_index, const wxString &ais_mmsi)
 
virtual void ShowAISTargetList (int canvas_index)
 
virtual std::shared_ptr< PiPointContextGetContextAtPoint (int x, int y, int canvas_index)
 
virtual void AddNoShowDirectory (std::string chart_dir)
 
virtual void RemoveNoShowDirectory (std::string chart_dir)
 
virtual void ClearNoShowVector ()
 
virtual const std::vector< std::string > & GetNoShowVector ()
 
virtual bool SelectChartFamily (int CanvasIndex, ChartFamilyEnumPI Family)
 
virtual void CenterToAisTarget (wxString ais_mmsi)
 
virtual void AisTargetCreateWpt (wxString ais_mmsi)
 
virtual void AisShowAllTracks (bool show)
 
virtual void AisToggleTrack (wxString ais_mmsi)
 
virtual int GetContextMenuMask ()
 
virtual void SetContextMenuMask (int mask)
 
virtual void SetTrackVisibiiity (const wxString &track_GUID, bool viz)
 
virtual bool AddRoute (Route *route, bool permanent=true)
 Add route to database, updated version of AddPlugInRouteExV2.
 
virtual bool UpdateRoute (Route *route)
 Update database route, updated version of UpdatePlugInRouteExV2.
 
virtual std::unique_ptr< HostApi121::RouteGetRoute (const wxString &guid)
 Retrieve route from database.
 
virtual bool GetNearestTideStation (double lat, double lon, PlugIn_TideStation *station)
 
virtual bool GetTideHeight (int stationIndex, time_t time, float *height)
 
- Public Attributes inherited from HostApi121
const int kContextMenuDisableWaypoint
 
const int kContextMenuDisableRoute
 
const int kContextMenuDisableTrack
 
const int kContextMenuDisableAistarget
 

Detailed Description

Unstable development API.

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

Definition at line 7386 of file ocpn_plugin.h.


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