pavi  0.0
Map Path Viewer
track_layer.bi File Reference

Header for advanced tracks layer. More...

#include "track_loader.bi"
Include dependency graph for track_layer.bi:
This graph shows which files directly or indirectly include this file:

Go to the source code of this file.

Classes

class  TrackLayerDefault
 
class  _TrackLayer
 
class  _TrackLayerClass
 

Macros

#define TRACK_TYPE_LAYER   /* (track_layer_get_type()) */
 
#define TRACK_LAYER(obj)   /* (G_TYPE_CHECK_INSTANCE_CAST((obj), TRACK_TYPE_LAYER, TrackLayer)) */
 
#define TRACK_LAYER_CLASS(obj)   /* (G_TYPE_CHECK_CLASS_CAST((obj), TRACK_TYPE_LAYER, TrackLayerClass)) */
 
#define TRACK_IS_LAYER(obj)   /* (G_TYPE_CHECK_INSTANCE_TYPE((obj), TRACK_TYPE_LAYER)) */
 
#define TRACK_IS_CLASS_LAYER(obj)   /* (G_TYPE_CHECK_CLASS_TYPE((obj), TRACK_TYPE_LAYER)) */
 
#define TRACK_LAYER_GET_CLASS(obj)   /* (G_TYPE_INSTANCE_GET_CLASS((obj), TRACK_TYPE_LAYER, TrackLayerClass)) */
 

Typedefs

typedef _TrackLayer TrackLayer
 
typedef _TrackLayerClass TrackLayerClass
 
typedef _TrackLayerPrivate TrackLayerPrivate
 

Functions

FUNCTION_AS_TrackLayer_PTR track_layer_new (BYVAL_AS_GObject_PTR)
 Creates a new instance of TrackLayer. More...
 
FUNCTION_AS_GType track_layer_get_type ()
 
FUNCTION_CDECL_AS_TrackLayerDefault_PTR track_layer_get_default (BYVAL_AS_TrackLayer_PTR)
 Provide the next default setting. More...
 
FUNCTION_CDECL_AS_TrackLoader_PTR track_layer_get_loader (BYVAL_AS_TrackLayer_PTR)
 Provide pointer to the active track. More...
 
SUB_CDECL track_layer_set_loader (BYVAL_AS_TrackLayer_PTR, BYVAL_AS_TrackLoader_PTR)
 Set active track. More...
 
SUB_CDECL track_layer_redraw (BYVAL_AS_TrackLayer_PTR)
 Redraw surface. More...
 
SUB_CDECL track_layer_center_track (BYVAL_AS_TrackLayer_PTR)
 Show complete track. More...
 
FUNCTION_CDECL_AS_gint track_layer_get_point (BYVAL_AS_TrackLayer_PTR)
 Get current point in active track. More...
 
SUB_CDECL track_layer_set_point (BYVAL_AS_TrackLayer_PTR, BYVAL_AS_gint)
 Set current point in active track. More...
 
SUB_CDECL track_layer_point_move (BYVAL_AS_TrackLayer_PTR, BYVAL_AS_gchar_PTR)
 Move current point. More...
 
SUB_CDECL track_layer_set_bbox (BYVAL_AS_TrackLayer_PTR, BYVAL_AS_float, BYVAL_AS_float, BYVAL_AS_float, BYVAL_AS_float)
 Set map segment to the given bounding box. More...
 

Detailed Description

Header for advanced tracks layer.

FIXME

Since
0.0

Definition in file track_layer.bi.


Class Documentation

◆ TrackLayerDefault

class TrackLayerDefault

Definition at line 20 of file track_layer.bi.

Collaboration diagram for TrackLayerDefault:
Class Members
gchar_PTR P point default
gchar_PTR L line default

◆ _TrackLayer

class _TrackLayer

Definition at line 30 of file track_layer.bi.

Collaboration diagram for _TrackLayer:
Class Members
GObject Parent
TrackLayerPrivate_PTR Priv

◆ _TrackLayerClass

class _TrackLayerClass

Definition at line 35 of file track_layer.bi.

Collaboration diagram for _TrackLayerClass:
Class Members
GObjectClass Parent_Class

Macro Definition Documentation

◆ TRACK_TYPE_LAYER

#define TRACK_TYPE_LAYER   /* (track_layer_get_type()) */

Definition at line 13 of file track_layer.bi.

◆ TRACK_LAYER

#define TRACK_LAYER (   obj)    /* (G_TYPE_CHECK_INSTANCE_CAST((obj), TRACK_TYPE_LAYER, TrackLayer)) */

Definition at line 14 of file track_layer.bi.

◆ TRACK_LAYER_CLASS

#define TRACK_LAYER_CLASS (   obj)    /* (G_TYPE_CHECK_CLASS_CAST((obj), TRACK_TYPE_LAYER, TrackLayerClass)) */

Definition at line 15 of file track_layer.bi.

◆ TRACK_IS_LAYER

#define TRACK_IS_LAYER (   obj)    /* (G_TYPE_CHECK_INSTANCE_TYPE((obj), TRACK_TYPE_LAYER)) */

Definition at line 16 of file track_layer.bi.

◆ TRACK_IS_CLASS_LAYER

#define TRACK_IS_CLASS_LAYER (   obj)    /* (G_TYPE_CHECK_CLASS_TYPE((obj), TRACK_TYPE_LAYER)) */

Definition at line 17 of file track_layer.bi.

◆ TRACK_LAYER_GET_CLASS

#define TRACK_LAYER_GET_CLASS (   obj)    /* (G_TYPE_INSTANCE_GET_CLASS((obj), TRACK_TYPE_LAYER, TrackLayerClass)) */

Definition at line 18 of file track_layer.bi.

Typedef Documentation

◆ TrackLayer

Definition at line 26 of file track_layer.bi.

◆ TrackLayerClass

Definition at line 27 of file track_layer.bi.

◆ TrackLayerPrivate

Definition at line 28 of file track_layer.bi.

Function Documentation

◆ track_layer_new()

FUNCTION_AS_TrackLayer_PTR track_layer_new ( BYVAL_AS_GObject_PTR  Map)

Creates a new instance of TrackLayer.

Parameters
MapMap object to connect to
Returns
The newly created TrackLayer instance (transfer full)

A new TrackLayer instance gets created and added to the osm_gps_map given as parameter. Also a callback gets connected in order to track any configure changes of the map window.

Note
Use g_object_unref() to finalize the instance.
Since
0.0

Definition at line 497 of file track_layer.bas.

Here is the call graph for this function:
Here is the caller graph for this function:

◆ track_layer_get_type()

FUNCTION_AS_GType track_layer_get_type ( )

◆ track_layer_get_default()

FUNCTION_CDECL_AS_TrackLayerDefault_PTR track_layer_get_default ( BYVAL_AS_TrackLayer_PTR  Lay)

Provide the next default setting.

Parameters
LayLayer instance
Returns
Pointer to default setting for the next track

The TrackLayer instance holds a number of default settings for line and point color and width, used as start values when loading a new track. This function returns a pointer to the next setting, reseting to the first when all defaults were used.

Since
0.0

Definition at line 815 of file track_layer.bas.

Here is the caller graph for this function:

◆ track_layer_get_loader()

FUNCTION_CDECL_AS_TrackLoader_PTR track_layer_get_loader ( BYVAL_AS_TrackLayer_PTR  Lay)

Provide pointer to the active track.

Parameters
LayLayer instance
Returns
Pointer to currently active track

In the TrackLayer instance one of the loaded tracks is the active track. This function returns the pointer to that track.

Since
0.0

Definition at line 836 of file track_layer.bas.

◆ track_layer_set_loader()

SUB_CDECL track_layer_set_loader ( BYVAL_AS_TrackLayer_PTR  Lay,
BYVAL_AS_TrackLoader_PTR  Loa 
)

Set active track.

Parameters
LayLayer instance
LoaTrack to activate (or NULL)

Procedure receiving a track to make it the active one. When Loa is NULL, no track is active.

Since
0.0

Definition at line 875 of file track_layer.bas.

Here is the caller graph for this function:

◆ track_layer_redraw()

SUB_CDECL track_layer_redraw ( BYVAL_AS_TrackLayer_PTR  Lay)

Redraw surface.

Parameters
LayLayer instance

Procedure forcing a redraw of the TrackLayerPriv.Surface, ie to show adapted track settings.

Since
0.0

Definition at line 897 of file track_layer.bas.

Here is the call graph for this function:
Here is the caller graph for this function:

◆ track_layer_center_track()

SUB_CDECL track_layer_center_track ( BYVAL_AS_TrackLayer_PTR  Lay)

Show complete track.

Parameters
LayLayer instance

Procedure setting map position (center) and zoom to show the active track completely on the map.

Since
0.0

Definition at line 853 of file track_layer.bas.

◆ track_layer_get_point()

FUNCTION_CDECL_AS_gint track_layer_get_point ( BYVAL_AS_TrackLayer_PTR  Lay)

Get current point in active track.

Parameters
LayLayer instance
Returns
The point number (or -1)

When the TrackLayer holds an active track, a current point in that track can get centered on the map. This function provides the point index (0 <= p# <= AZ).

Since
0.0

Definition at line 915 of file track_layer.bas.

◆ track_layer_set_point()

SUB_CDECL track_layer_set_point ( BYVAL_AS_TrackLayer_PTR  Lay,
BYVAL_AS_gint  N 
)

Set current point in active track.

Parameters
LayLayer instance
NNew current point index

When the TrackLayer holds an active track, a current point in that track can get centered on the map. This function sets a point index to for the next current point. The N parameter gets clamped to the allowed range (0 <= N <= AZ).

Since
0.0

Definition at line 935 of file track_layer.bas.

◆ track_layer_point_move()

SUB_CDECL track_layer_point_move ( BYVAL_AS_TrackLayer_PTR  Lay,
BYVAL_AS_gchar_PTR  S 
)

Move current point.

Parameters
LayLayer instance
SMovement type

Procedure adapting the index of the current point, showing that new current point centered on the map (at current zoom level).

Since
0.0

Definition at line 988 of file track_layer.bas.

◆ track_layer_set_bbox()

SUB_CDECL track_layer_set_bbox ( BYVAL_AS_TrackLayer_PTR  Lay,
BYVAL_AS_float  La0,
BYVAL_AS_float  La1,
BYVAL_AS_float  Lo0,
BYVAL_AS_float  Lo1 
)

Set map segment to the given bounding box.

Parameters
LayLayer instance
La0Top latitude [radians]
La1Bottom latitude [radians]
Lo0Left longitude [radians]
Lo1Right longitude [radians]

Procedure setting the map center and zoom in order to show a given rectangle.

Note
Coordinates in radians here!
Since
0.0

Definition at line 964 of file track_layer.bas.

Here is the call graph for this function:
Here is the caller graph for this function: