AdgMarker

AdgMarker

typedef struct _AdgMarker AdgMarker;

All fields are privates and should not be used directly. Use its public methods instead.

adg_marker_set_trail ()

void                adg_marker_set_trail                (AdgMarker *marker,
                                                         AdgTrail *trail);

Sets the "trail" property to trail. It is allowed to pass NULL to clear the current trail.

This method could fail unexpectedly if the segment index specified by the "n-segment" property is not present inside the new segment: if you want to set a new segment it is more convenient to change both properties ("trail" and "n-segment") at once with adg_marker_set_segment().

adg_marker_get_trail ()

AdgTrail *          adg_marker_get_trail                (AdgMarker *marker);

Gets the trail where this marker should be applied.

adg_marker_set_n_segment ()

void                adg_marker_set_n_segment            (AdgMarker *marker,
                                                         guint n_segment);

Sets the "n-segment" property to n_segment. The trail is unchanged. If you want to set both properties at once (as usually requested to refer to a specific segment), adg_marker_set_segment() should be more convenient.

adg_marker_get_n_segment ()

guint               adg_marker_get_n_segment            (AdgMarker *marker);

Returns the segment of the associated trail where this marker will be applied, where 1 is the first segment.

adg_marker_set_segment ()

void                adg_marker_set_segment              (AdgMarker *marker,
                                                         AdgTrail *trail,
                                                         guint n_segment);

Sets a new segment where the marker should be applied at once. A dependency between trail and marker is added, so when trail changes marker is invalidated.

A callback is added to "remove-dependency" so manually removing the dependency (such as when trail is destroyed) will unlink marker from it.

adg_marker_get_segment ()

const AdgSegment *  adg_marker_get_segment              (AdgMarker *marker);

Gets the segment where the marker will be applied. This segment is eventually a modified version of the backup segment, after having applied the marker.

adg_marker_backup_segment ()

void                adg_marker_backup_segment           (AdgMarker *marker);

Duplicates the current subject segment for backup purpose: this segment can be accessed by adg_marker_get_backup_segment(). Obviously, a current segment should exist (either the "trail" and "n-segment" properties must be properly defined) or this method will fail without further processing.

When the subject segment is changed (either by changing "trail" or "n-segment") the original segment is automatically restored.

adg_marker_get_backup_segment ()

const AdgSegment *  adg_marker_get_backup_segment       (AdgMarker *marker);

Gets the original segment where the marker has been applied. Applying a marker could modify the underlying trail, usually by trimming the original segment of a "size" dependent length from the ends. The marker instance holds a copy of the original segment, generated by adg_marker_backup_segment(), to be used in recomputation, for example when the marker changes its size.

When the subject segment is changed (either by changing "trail" or "n-segment") the original segment is automatically restored.

adg_marker_set_pos ()

void                adg_marker_set_pos                  (AdgMarker *marker,
                                                         gdouble pos);

Sets a new position on marker. Check out adg_marker_get_pos() for details on what pos represents.

adg_marker_get_pos ()

gdouble             adg_marker_get_pos                  (AdgMarker *marker);

Gets the current position of marker. The returned value is a ratio position referred to the segment associated to marker: 0 means the start point and 1 means the end point of the segment.

adg_marker_set_size ()

void                adg_marker_set_size                 (AdgMarker *marker,
                                                         gdouble size);

Sets a new size on marker. The size is an implementation-dependent property: it has meaning only when used by an AdgMarker derived type.

adg_marker_get_size ()

gdouble             adg_marker_get_size                 (AdgMarker *marker);

Gets the current size of marker.

adg_marker_set_model ()

void                adg_marker_set_model                (AdgMarker *marker,
                                                         AdgModel *model);

Sets a new model for marker. The reference to the old model (if an old model was present) is dropped while a new reference is added to model.

adg_marker_get_model ()

AdgModel *          adg_marker_get_model                (AdgMarker *marker);

Gets the current model of marker. This is an accessor method: if you need to get the model for rendering, use adg_marker_model() instead.

adg_marker_model ()

AdgModel *          adg_marker_model                    (AdgMarker *marker);

Gets the model of marker. If the model is not found, it is automatically created by calling the create_model() virtual method.

The "model" property

  "model"                    AdgModel*             : Read / Write

A general purpose model usable by the marker implementations.

The "n-segment" property

  "n-segment"                guint                 : Read / Write

The segment on trail where this marker should be applied (where 0 means undefined segment, 1 the first segment and so on).

Default value: 0

The "pos" property

  "pos"                      gdouble               : Read / Write / Construct

The position ratio inside the segment where to put the marker (0 means the start point while 1 means the end point).

Allowed values: [0,1]

Default value: 0

The "size" property

  "size"                     gdouble               : Read / Write

The size (in global space) of the marker.

Allowed values: >= 0

Default value: 10

The "trail" property

  "trail"                    AdgTrail*             : Read / Write / Construct

The subject AdgTrail for this marker.