ChamplainBaseMarker

ChamplainBaseMarker — A base marker to identify points of interest on a map

Synopsis

                    ChamplainBaseMarker;
ClutterActor *      champlain_base_marker_new           (void);
void                champlain_base_marker_set_position  (ChamplainBaseMarker *marker,
                                                         gdouble latitude,
                                                         gdouble longitude);
gdouble             champlain_base_marker_get_latitude  (ChamplainBaseMarker *marker);
gdouble             champlain_base_marker_get_longitude (ChamplainBaseMarker *marker);
void                champlain_base_marker_animate_in    (ChamplainBaseMarker *marker);
void                champlain_base_marker_animate_in_with_delay
                                                        (ChamplainBaseMarker *marker,
                                                         guint delay);
void                champlain_base_marker_animate_out   (ChamplainBaseMarker *marker);
void                champlain_base_marker_animate_out_with_delay
                                                        (ChamplainBaseMarker *marker,
                                                         guint delay);
void                champlain_base_marker_set_highlighted
                                                        (ChamplainBaseMarker *marker,
                                                         gboolean value);
gboolean            champlain_base_marker_get_highlighted
                                                        (ChamplainBaseMarker *marker);

Object Hierarchy

  GObject
   +----GInitiallyUnowned
         +----ClutterActor
               +----ClutterGroup
                     +----ChamplainBaseMarker
                           +----ChamplainMarker

Implemented Interfaces

ChamplainBaseMarker implements ClutterScriptable and ClutterContainer.

Properties

  "highlighted"              gboolean              : Read / Write
  "latitude"                 gdouble               : Read / Write
  "longitude"                gdouble               : Read / Write

Description

Base markers reprensent points of interest on a map. Base markers need to be placed on a layer (a ChamplainLayer). Layers have to be added to a champlainview for the base_markers to show on the map.

A basemarker is nothing more than a regular clutteractor. You can draw on it what ever you want. Don't forget to set the anchor position in the base marker using clutter_actor_set_anchor_point. Set the base_markers position on the map using champlain_base_marker_set_position.

champlain has a more evoluted type of markers with text and image support. See ChamplainMarker.

Details

ChamplainBaseMarker

typedef struct _ChamplainBaseMarker ChamplainBaseMarker;

champlain_base_marker_new ()

ClutterActor *      champlain_base_marker_new           (void);

Creates a new instance of ChamplainBaseMarker.

Returns :

 a new ChamplainBaseMarker ready to be used as a ClutterActor.

Since 0.4

champlain_base_marker_set_position ()

void                champlain_base_marker_set_position  (ChamplainBaseMarker *marker,
                                                         gdouble latitude,
                                                         gdouble longitude);

Positions the base_marker on the map at the coordinates

marker :

 a ChamplainBaseMarker

latitude :

 the longitude to center the map at

longitude :

 the longitude to center the map at

Since 0.4

champlain_base_marker_get_latitude ()

gdouble             champlain_base_marker_get_latitude  (ChamplainBaseMarker *marker);

Gets the latitude of the marker.

marker :

 a ChamplainBaseMarker

Returns :

 the latitude of the marker.

Since 0.6

champlain_base_marker_get_longitude ()

gdouble             champlain_base_marker_get_longitude (ChamplainBaseMarker *marker);

Gets the longitude of the marker.

marker :

 a ChamplainBaseMarker

Returns :

 the longitude of the marker.

Since 0.6

champlain_base_marker_animate_in ()

void                champlain_base_marker_animate_in    (ChamplainBaseMarker *marker);

Animates the marker as if it were falling from the sky onto the map.

marker :

 The marker

Since 0.4

champlain_base_marker_animate_in_with_delay ()

void                champlain_base_marker_animate_in_with_delay
                                                        (ChamplainBaseMarker *marker,
                                                         guint delay);

Animates the marker as if it were falling from the sky onto the map after delay.

marker :

 The marker

delay :

 The delay in milliseconds

Since 0.4

champlain_base_marker_animate_out ()

void                champlain_base_marker_animate_out   (ChamplainBaseMarker *marker);

Animates the marker as if it were drawn through the sky.

marker :

 The marker

Since 0.4

champlain_base_marker_animate_out_with_delay ()

void                champlain_base_marker_animate_out_with_delay
                                                        (ChamplainBaseMarker *marker,
                                                         guint delay);

Animates the marker as if it were drawn through the sky after delay.

marker :

 The marker

delay :

 The delay in milliseconds

Since 0.4

champlain_base_marker_set_highlighted ()

void                champlain_base_marker_set_highlighted
                                                        (ChamplainBaseMarker *marker,
                                                         gboolean value);

Sets the marker as highlighted or not. This will affect the "Selected" look of the marker.

marker :

 a ChamplainBaseMarker

value :

 the highlighted state

Since 0.4

champlain_base_marker_get_highlighted ()

gboolean            champlain_base_marker_get_highlighted
                                                        (ChamplainBaseMarker *marker);

Checks whether the marker is highlighted.

marker :

 a ChamplainBaseMarker

Returns :

 the highlighted or not state of the marker.

Since 0.4

Property Details

The "highlighted" property

  "highlighted"              gboolean              : Read / Write

The highlighted state of the marker

Default value: FALSE

Since 0.4

The "latitude" property

  "latitude"                 gdouble               : Read / Write

The latitude coordonate of the map

Allowed values: [-90,90]

Default value: 0

Since 0.4

The "longitude" property

  "longitude"                gdouble               : Read / Write

The longitude coordonate of the map

Allowed values: [-180,180]

Default value: 0

Since 0.4

Generated by GTK-Doc V1.15