OpenCPN Plugin API Documentation / Routes

[dachancellor]

Is there anywhere with detailed documentation regarding the functions made available to OpenCPN plugins ?

I'm interested in being able to live plot a route.
A proof of concept that I would like to achieve would be having the plugin "listen" for messages containing GPS coordinates, and then creating a route on the fly for display.
I know some plugins support the creation of a gpx file which can then be loaded back in for display.
Are there any open source plugins that create routes without the use of a gpx file ?
I know the plugin header has some functions for Plugin_Waypoint, Plugin_Route, etc. (hence my question about detailed documentation).

Does this seem like a plausible idea ? Or is the gpx method a better way, having the plugin handle this automatically ?
The only issue I see is if I want a live plot, if the coordinates are coming in periodically...do I then have to remove the route, add the newly updated route, etc. ?

V/r,
Chandler

[bcn]

Originally Posted by dachancellor

I'm interested in being able to live plot a route.
A proof of concept that I would like to achieve would be having the plugin "listen" for messages containing GPS coordinates, and then creating a route on the fly for display.
V/r,
Chandler

Live is usually related to a Track.
Own ship? This does OCPN.
Others??

[nohal]

Chandler...
The header (https://github.com/OpenCPN/OpenCPN/b..._plugin.h#L708) is the best place to look at, there is no other documentation. Pull requests actually documenting it are of course more than welcome, I will gladly run doxygen on it when it makes sense
FWIW the weather routing and squidd.io plugins use this part of the API.
From your brief description it kind of seems that what you are trying to implement is the same as what recording a track already does.

Pavel

[dachancellor]

Originally Posted by bcn

Live is usually related to a Track.
Own ship? This does OCPN.
Others??

Good point.
I forgot that I'm using OCPN for the navigation of objects OTHER THAN ownship...
I guess this functionality doesn't really make sense to exist.

I could say it is for route planning, but at that point, a gpx file makes sense.

[dachancellor]

Originally Posted by nohal

Chandler...
The header (https://github.com/OpenCPN/OpenCPN/b..._plugin.h#L708) is the best place to look at, there is no other documentation. Pull requests actually documenting it are of course more than welcome, I will gladly run doxygen on it when it makes sense
FWIW the weather routing and squidd.io plugins use this part of the API.
From your brief description it kind of seems that what you are trying to implement is the same as what recording a track already does.

Pavel

Thanks Pavel, I figured that might be the case.

In the past hour I've played around with it and been able to add some waypoints, and add a route (though waypoint names are by default not visible when adding a route...anyway to change this ? )

[nohal]

Originally Posted by dachancellor

(though waypoint names are by default not visible when adding a route...anyway to change this ? )

Setting https://github.com/OpenCPN/OpenCPN/b..._plugin.h#L552 to true, I would say. If it doesn't work, it's probably broken.

Pavel

[dachancellor]

Originally Posted by nohal

Setting https://github.com/OpenCPN/OpenCPN/b..._plugin.h#L552 to true, I would say. If it doesn't work, it's probably broken.
Pavel

Pavel,
I tried setting this value (m_IsVisible) to both true and false.
For a route, neither waypoint name showed.
For a single waypoint, the waypoint name always showed.
It doesn't appear to have any affect, though I figured it may have hid the icon (same effect as unchecking Show on Chart).

I did however find the issue.
https://github.com/OpenCPN/OpenCPN/b...ager.cpp#L2925

When the plugin manager converts the Plugin WPs to RoutePoint, it sets show name to false.
I modified to true and recompiled, and the names showed as expected.

Thanks