doc: update copyright line for 2021

[adg.git] / src / adg / adg-ldim.c

/* ADG - Automatic Drawing Generation
 * Copyright (C) 2007-2021  Nicola Fontana <ntd at entidi.it>
 *
 * This library is free software; you can redistribute it and/or
 * modify it under the terms of the GNU Lesser General Public
 * License as published by the Free Software Foundation; either
 * version 2 of the License, or (at your option) any later version.
 *
 * This library is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
 * Lesser General Public License for more details.
 *
 * You should have received a copy of the GNU Lesser General Public
 * License along with this library; if not, write to the
 * Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
 * Boston, MA  02110-1301, USA.
 */


/**
 * SECTION:adg-ldim
 * @short_description: Linear dimensions
 *
 * The #AdgLDim entity represents a linear dimension.
 *
 * Since: 1.0
 **/

/**
 * AdgLDim:
 *
 * All fields are private and should not be used directly.
 * Use its public methods instead.
 *
 * Since: 1.0
 **/


#include "adg-internal.h"
#include "adg-container.h"
#include "adg-alignment.h"
#include "adg-model.h"
#include "adg-point.h"
#include "adg-trail.h"
#include "adg-marker.h"
#include "adg-style.h"
#include "adg-dim-style.h"
#include "adg-textual.h"
#include "adg-toy-text.h"
#include "adg-dim.h"
#include "adg-dim-private.h"
#include <math.h>

#include "adg-ldim.h"
#include "adg-ldim-private.h"


#define _ADG_OLD_OBJECT_CLASS  ((GObjectClass *) adg_ldim_parent_class)
#define _ADG_OLD_ENTITY_CLASS  ((AdgEntityClass *) adg_ldim_parent_class)


G_DEFINE_TYPE_WITH_PRIVATE(AdgLDim, adg_ldim, ADG_TYPE_DIM)

enum {
    PROP_0,
    PROP_DIRECTION,
    PROP_HAS_EXTENSION1,
    PROP_HAS_EXTENSION2
};


static void             _adg_dispose            (GObject        *object);
static void             _adg_get_property       (GObject        *object,
                                                 guint           param_id,
                                                 GValue         *value,
                                                 GParamSpec     *pspec);
static void             _adg_set_property       (GObject        *object,
                                                 guint           param_id,
                                                 const GValue   *value,
                                                 GParamSpec     *pspec);
static void             _adg_global_changed     (AdgEntity      *entity);
static void             _adg_local_changed      (AdgEntity      *entity);
static void             _adg_invalidate         (AdgEntity      *entity);
static void             _adg_arrange            (AdgEntity      *entity);
static void             _adg_render             (AdgEntity      *entity,
                                                 cairo_t        *cr);
static gchar *          _adg_default_value      (AdgDim         *dim);
static gboolean         _adg_compute_geometry   (AdgDim         *dim);
static void             _adg_update_shift       (AdgLDim        *ldim);
static void             _adg_update_entities    (AdgLDim        *ldim);
static void             _adg_choose_flags       (AdgLDim        *ldim,
                                                 gboolean       *to_outside,
                                                 gboolean       *to_detach);
static void             _adg_update_quote       (AdgLDim        *ldim,
                                                 CpmlPair       *base1,
                                                 CpmlPair       *base2,
                                                 CpmlPair       *pos,
                                                 gboolean        detach,
                                                 gboolean        outside,
                                                 gdouble         gap);
static void             _adg_update_extents     (AdgLDim        *ldim);
static void             _adg_unset_trail        (AdgLDim        *ldim);
static void             _adg_dispose_trail      (AdgLDim        *ldim);
static void             _adg_dispose_markers    (AdgLDim        *ldim);
static cairo_path_t *   _adg_trail_callback     (AdgTrail       *trail,
                                                 gpointer        user_data);


static void
adg_ldim_class_init(AdgLDimClass *klass)
{
    GObjectClass *gobject_class;
    AdgEntityClass *entity_class;
    AdgDimClass *dim_class;
    GParamSpec *param;

    gobject_class = (GObjectClass *) klass;
    entity_class = (AdgEntityClass *) klass;
    dim_class = (AdgDimClass *) klass;

    gobject_class->dispose = _adg_dispose;
    gobject_class->get_property = _adg_get_property;
    gobject_class->set_property = _adg_set_property;

    entity_class->global_changed = _adg_global_changed;
    entity_class->local_changed = _adg_local_changed;
    entity_class->invalidate = _adg_invalidate;
    entity_class->arrange = _adg_arrange;
    entity_class->render = _adg_render;

    dim_class->default_value = _adg_default_value;
    dim_class->compute_geometry = _adg_compute_geometry;

    param = g_param_spec_double("direction",
                                P_("Direction"),
                                P_("The inclination angle of the extension lines"),
                                -G_PI, G_PI, ADG_DIR_RIGHT,
                                G_PARAM_READWRITE | G_PARAM_CONSTRUCT);
    g_object_class_install_property(gobject_class, PROP_DIRECTION, param);

    param = g_param_spec_boolean("has-extension1",
                                 P_("Has First Extension Line flag"),
                                 P_("Show (TRUE) or hide (FALSE) the first extension line"),
                                 TRUE, G_PARAM_READWRITE);
    g_object_class_install_property(gobject_class, PROP_HAS_EXTENSION1, param);

    param = g_param_spec_boolean("has-extension2",
                                 P_("Has Second Extension Line flag"),
                                 P_("Show (TRUE) or hide (FALSE) the second extension line"),
                                 TRUE, G_PARAM_READWRITE);
    g_object_class_install_property(gobject_class, PROP_HAS_EXTENSION2, param);
}

static void
adg_ldim_init(AdgLDim *ldim)
{
    AdgLDimPrivate *data = adg_ldim_get_instance_private(ldim);
    cairo_path_data_t move_to, line_to;

    move_to.header.type = CPML_MOVE;
    move_to.header.length = 2;
    line_to.header.type = CPML_LINE;
    line_to.header.length = 2;

    data->direction = ADG_DIR_RIGHT;
    data->has_extension1 = TRUE;
    data->has_extension2 = TRUE;

    data->cairo.path.status = CAIRO_STATUS_INVALID_PATH_DATA;
    data->cairo.path.data = data->cairo.data;
    data->cairo.path.num_data = G_N_ELEMENTS(data->cairo.data);
    data->cairo.path.data[0] = move_to;
    data->cairo.path.data[2] = line_to;
    data->cairo.path.data[4] = move_to;
    data->cairo.path.data[6] = line_to;
    data->cairo.path.data[8] = move_to;
    data->cairo.path.data[10] = line_to;
    data->cairo.path.data[12] = move_to;
    data->cairo.path.data[14] = line_to;
    data->cairo.path.data[16] = move_to;
    data->cairo.path.data[18] = line_to;

    data->trail = NULL;
    data->marker1 = NULL;
    data->marker2 = NULL;
}

static void
_adg_dispose(GObject *object)
{
    AdgLDim *ldim = (AdgLDim *) object;

    _adg_dispose_trail(ldim);
    _adg_dispose_markers(ldim);

    if (_ADG_OLD_OBJECT_CLASS->dispose)
        _ADG_OLD_OBJECT_CLASS->dispose(object);
}

static void
_adg_get_property(GObject *object, guint prop_id,
                  GValue *value, GParamSpec *pspec)
{
    AdgLDimPrivate *data = adg_ldim_get_instance_private((AdgLDim *) object);

    switch (prop_id) {
    case PROP_DIRECTION:
        g_value_set_double(value, data->direction);
        break;
    case PROP_HAS_EXTENSION1:
        g_value_set_boolean(value, data->has_extension1);
        break;
    case PROP_HAS_EXTENSION2:
        g_value_set_boolean(value, data->has_extension2);
        break;
    default:
        G_OBJECT_WARN_INVALID_PROPERTY_ID(object, prop_id, pspec);
        break;
    }
}

static void
_adg_set_property(GObject *object, guint prop_id,
                  const GValue *value, GParamSpec *pspec)
{
    AdgLDimPrivate *data = adg_ldim_get_instance_private((AdgLDim *) object);

    switch (prop_id) {
    case PROP_DIRECTION:
        data->direction = cpml_angle(g_value_get_double(value));
        break;
    case PROP_HAS_EXTENSION1:
        data->has_extension1 = g_value_get_boolean(value);
        break;
    case PROP_HAS_EXTENSION2:
        data->has_extension2 = g_value_get_boolean(value);
        break;
    default:
        G_OBJECT_WARN_INVALID_PROPERTY_ID(object, prop_id, pspec);
        break;
    }
}


/**
 * adg_ldim_new:
 *
 * Creates a new - undefined - linear dimension. You must, at least,
 * define the start of the dimension in #AdgDim:ref1, the end in
 * #AdgDim:ref2 and the position of the quote in #AdgDim:pos using
 * any valid #AdgDim method. The director of the dimension (that is,
 * if it is horizontal, vertical or oblique at a specific angle)
 * should be specified with adg_ldim_set_direction().
 *
 * Returns: the newly created linear dimension entity
 *
 * Since: 1.0
 **/
AdgLDim *
adg_ldim_new(void)
{
    return g_object_new(ADG_TYPE_LDIM, NULL);
}

/**
 * adg_ldim_new_full:
 * @ref1: (allow-none): the first reference point
 * @ref2: (allow-none): the second reference point
 * @pos:  (allow-none): the position reference
 * @direction: angle where to extend the dimension
 *
 * Creates a new linear dimension, specifing all the needed properties in
 * one shot.
 *
 * Returns: the newly created linear dimension entity
 *
 * Since: 1.0
 **/
AdgLDim *
adg_ldim_new_full(const CpmlPair *ref1, const CpmlPair *ref2,
                  const CpmlPair *pos, gdouble direction)
{
    AdgLDim *ldim;
    AdgDim *dim;

    ldim = adg_ldim_new();
    dim = (AdgDim *) ldim;

    if (ref1 != NULL)
        adg_dim_set_ref1_from_pair(dim, ref1);

    if (ref2 != NULL)
        adg_dim_set_ref2_from_pair(dim, ref2);

    if (pos != NULL)
        adg_dim_set_pos_from_pair(dim, pos);

    adg_ldim_set_direction(ldim, direction);
    return ldim;
}

/**
 * adg_ldim_new_full_explicit:
 * @ref1_x: the x coordinate of the first reference point
 * @ref1_y: the y coordinate of the first reference point
 * @ref2_x: the x coordinate of the second reference point
 * @ref2_y: the y coordinate of the second reference point
 * @pos_x: the x coordinate of the position reference
 * @pos_y: the y coordinate of the position reference
 * @direction: angle where to extend the dimension
 *
 * Wrappes adg_ldim_new_full() with explicit values.
 *
 * Returns: the newly created linear dimension entity
 *
 * Since: 1.0
 **/
AdgLDim *
adg_ldim_new_full_explicit(gdouble ref1_x, gdouble ref1_y,
                           gdouble ref2_x, gdouble ref2_y,
                           gdouble pos_x, gdouble pos_y, gdouble direction)
{
    CpmlPair ref1;
    CpmlPair ref2;
    CpmlPair pos;

    ref1.x = ref1_x;
    ref1.y = ref1_y;
    ref2.x = ref2_x;
    ref2.y = ref2_y;
    pos.x = pos_x;
    pos.y = pos_y;

    return adg_ldim_new_full(&ref1, &ref2, &pos, direction);
}

/**
 * adg_ldim_new_full_from_model:
 * @model: (transfer none): the model from which the named pairs are taken
 * @ref1:  (allow-none):    the first reference point
 * @ref2:  (allow-none):    the second reference point
 * @pos:   (allow-none):    the position reference
 * @direction:              angle where to extend the dimension
 *
 * Creates a new linear dimension, specifing all the needed properties in
 * one shot and using named pairs from @model.
 *
 * Returns: the newly created linear dimension entity
 *
 * Since: 1.0
 **/
AdgLDim *
adg_ldim_new_full_from_model(AdgModel *model,
                             const gchar *ref1, const gchar *ref2,
                             const gchar *pos, gdouble direction)
{
    AdgLDim *ldim;
    AdgDim *dim;

    g_return_val_if_fail(model != NULL, NULL);

    ldim = adg_ldim_new();
    dim = (AdgDim *) ldim;

    if (ref1 != NULL)
        adg_dim_set_ref1_from_model(dim, model, ref1);

    if (ref2 != NULL)
        adg_dim_set_ref2_from_model(dim, model, ref2);

    if (pos != NULL)
        adg_dim_set_pos_from_model(dim, model, pos);

    adg_ldim_set_direction(ldim, direction);
    return (AdgLDim *) dim;
}

/**
 * adg_ldim_set_direction:
 * @ldim: an #AdgLDim entity
 * @direction: an angle value, in radians
 *
 * Sets the direction angle where to extend @ldim.
 * @direction is normalized by cpml_angle() before being used.
 *
 * Since: 1.0
 **/
void
adg_ldim_set_direction(AdgLDim *ldim, gdouble direction)
{
    g_return_if_fail(ADG_IS_LDIM(ldim));
    g_object_set(ldim, "direction", direction, NULL);
}

/**
 * adg_ldim_get_direction:
 * @ldim: an #AdgLDim entity
 *
 * Gets the direction where @ldim will extend.
 *
 * Returns: the direction angle in radians
 *
 * Since: 1.0
 **/
gdouble
adg_ldim_get_direction(AdgLDim *ldim)
{
    AdgLDimPrivate *data;

    g_return_val_if_fail(ADG_IS_LDIM(ldim), 0);

    data = adg_ldim_get_instance_private(ldim);
    return data->direction;
}

/**
 * adg_ldim_switch_extension1:
 * @ldim: an #AdgLDim entity
 * @new_state: the new state
 *
 * Shows (if @new_state is <constant>TRUE</constant>) or hide (if
 * @new_state is <constant>FALSE</constant>) the first extension
 * line of @ldim.
 *
 * Since: 1.0
 **/
void
adg_ldim_switch_extension1(AdgLDim *ldim, gboolean new_state)
{
    g_return_if_fail(ADG_IS_LDIM(ldim));
    g_return_if_fail(adg_is_boolean_value(new_state));
    g_object_set(ldim, "has-extension1", new_state, NULL);
}

/**
 * adg_ldim_has_extension1:
 * @ldim: an #AdgLDim entity
 *
 * Checks if @ldim should render also the first extension line.
 *
 * Returns: <constant>TRUE</constant> on first extension line presents, <constant>FALSE</constant> otherwise.
 *
 * Since: 1.0
 **/
gboolean
adg_ldim_has_extension1(AdgLDim *ldim)
{
    AdgLDimPrivate *data;

    g_return_val_if_fail(ADG_IS_LDIM(ldim), FALSE);

    data = adg_ldim_get_instance_private(ldim);
    return data->has_extension1;
}

/**
 * adg_ldim_switch_extension2:
 * @ldim: an #AdgLDim entity
 * @new_state: the new new_state
 *
 * Shows (if @new_state is <constant>TRUE</constant>) or hide (if
 * @new_state is <constant>FALSE</constant>) the second extension
 * line of @ldim.
 *
 * Since: 1.0
 **/
void
adg_ldim_switch_extension2(AdgLDim *ldim, gboolean new_state)
{
    g_return_if_fail(ADG_IS_LDIM(ldim));
    g_return_if_fail(adg_is_boolean_value(new_state));
    g_object_set(ldim, "has-extension2", new_state, NULL);
}

/**
 * adg_ldim_has_extension2:
 * @ldim: an #AdgLDim entity
 *
 * Checks if @ldim should render also the second extension line.
 *
 * Returns: <constant>TRUE</constant> on first extension line presents, <constant>FALSE</constant> otherwise.
 *
 * Since: 1.0
 **/
gboolean
adg_ldim_has_extension2(AdgLDim *ldim)
{
    AdgLDimPrivate *data;

    g_return_val_if_fail(ADG_IS_LDIM(ldim), FALSE);

    data = adg_ldim_get_instance_private(ldim);
    return data->has_extension2;
}


static void
_adg_global_changed(AdgEntity *entity)
{
    AdgLDimPrivate *data = adg_ldim_get_instance_private((AdgLDim *) entity);

    _adg_unset_trail((AdgLDim *) entity);

    if (_ADG_OLD_ENTITY_CLASS->global_changed)
        _ADG_OLD_ENTITY_CLASS->global_changed(entity);

    if (data->marker1)
        adg_entity_global_changed((AdgEntity *) data->marker1);

    if (data->marker2)
        adg_entity_global_changed((AdgEntity *) data->marker2);
}

static void
_adg_local_changed(AdgEntity *entity)
{
    _adg_unset_trail((AdgLDim *) entity);

    if (_ADG_OLD_ENTITY_CLASS->local_changed)
        _ADG_OLD_ENTITY_CLASS->local_changed(entity);
}

static void
_adg_invalidate(AdgEntity *entity)
{
    AdgLDim *ldim = (AdgLDim *) entity;

    _adg_dispose_trail(ldim);
    _adg_dispose_markers(ldim);
    _adg_unset_trail(ldim);

    if (_ADG_OLD_ENTITY_CLASS->invalidate)
        _ADG_OLD_ENTITY_CLASS->invalidate(entity);
}

static void
_adg_arrange(AdgEntity *entity)
{
    AdgLDim *ldim;
    AdgDim *dim;
    AdgLDimPrivate *data;
    AdgAlignment *quote;
    AdgDimStyle *dim_style;
    gboolean outside, detach;
    const cairo_matrix_t *local;
    CpmlPair ref1, ref2, pos, base1, base2;
    CpmlPair pair;

    if (_ADG_OLD_ENTITY_CLASS->arrange)
        _ADG_OLD_ENTITY_CLASS->arrange(entity);

    dim = (AdgDim *) entity;
    if (! adg_dim_compute_geometry(dim))
        return;

    ldim = (AdgLDim *) entity;
    data = adg_ldim_get_instance_private(ldim);
    quote = adg_dim_get_quote(dim);

    _adg_update_entities(ldim);

    /* Check for cached result */
    if (data->cairo.path.status == CAIRO_STATUS_SUCCESS) {
        adg_entity_set_global_map((AdgEntity *) quote, &data->quote.global_map);
        return;
    }

    _adg_choose_flags(ldim, &outside, &detach);

    dim_style = adg_dim_get_dim_style(dim);
    local = adg_entity_get_local_matrix(entity);

    cpml_pair_copy(&ref1, (CpmlPair *) adg_dim_get_ref1(dim));
    cpml_pair_copy(&ref2, (CpmlPair *) adg_dim_get_ref2(dim));
    cpml_pair_copy(&pos,  (CpmlPair *) adg_dim_get_pos(dim));
    cpml_pair_copy(&base1, &data->geometry.base1);
    cpml_pair_copy(&base2, &data->geometry.base2);

    cpml_pair_transform(&ref1, local);
    cpml_pair_transform(&ref2, local);
    cpml_pair_transform(&pos, local);
    cpml_pair_transform(&base1, local);
    base1.x += data->shift.base.x;
    base1.y += data->shift.base.y;
    cpml_pair_transform(&base2, local);
    base2.x += data->shift.base.x;
    base2.y += data->shift.base.y;

    pair.x = ref1.x + data->shift.from.x;
    pair.y = ref1.y + data->shift.from.y;
    cpml_pair_to_cairo(&pair, &data->cairo.data[13]);

    cpml_pair_to_cairo(&base1, &data->cairo.data[1]);

    pair.x = base1.x + data->shift.to.x;
    pair.y = base1.y + data->shift.to.y;
    cpml_pair_to_cairo(&pair, &data->cairo.data[15]);

    pair.x = ref2.x + data->shift.from.x;
    pair.y = ref2.y + data->shift.from.y;
    cpml_pair_to_cairo(&pair, &data->cairo.data[17]);

    cpml_pair_to_cairo(&base2, &data->cairo.data[3]);

    pair.x = base2.x + data->shift.to.x;
    pair.y = base2.y + data->shift.to.y;
    cpml_pair_to_cairo(&pair, &data->cairo.data[19]);

    /* Calculate the outside segments */
    if (outside) {
        gdouble beyond;
        CpmlVector vector;

        beyond = adg_dim_style_get_beyond(dim_style);
        cpml_pair_from_cairo(&pair, &data->cairo.data[1]);

        cpml_pair_from_cairo(&vector, &data->cairo.data[3]);
        vector.x -= pair.x;
        vector.y -= pair.y;
        cpml_vector_set_length(&vector, beyond);

        cpml_pair_from_cairo(&pair, &data->cairo.data[1]);
        cpml_pair_to_cairo(&pair, &data->cairo.data[5]);

        pair.x -= vector.x;
        pair.y -= vector.y;
        cpml_pair_to_cairo(&pair, &data->cairo.data[7]);

        cpml_pair_from_cairo(&pair, &data->cairo.data[3]);
        cpml_pair_to_cairo(&pair, &data->cairo.data[11]);

        pair.x += vector.x;
        pair.y += vector.y;
        cpml_pair_to_cairo(&pair, &data->cairo.data[9]);

        data->cairo.data[2].header.length = 2;
    } else {
        data->cairo.data[2].header.length = 10;
    }
    data->cairo.data[10].header.length = 2;

    _adg_update_quote(ldim, &base1, &base2, &pos, detach, outside,
                      adg_dim_style_get_quote_shift(dim_style)->x);

    /* Play with header lengths to show or hide the extension lines */
    if (data->has_extension1) {
        data->cairo.data[14].header.length = data->has_extension2 ? 2 : 6;
    } else {
        gint n = ! outside && ! detach ? 2 : 10;
        data->cairo.data[14].header.length = 2;
        data->cairo.data[n].header.length += 4;
        if (!data->has_extension2)
            data->cairo.data[n].header.length += 4;
    }

    data->cairo.path.status = CAIRO_STATUS_SUCCESS;

    /* Update the markers, if present */
    if (data->trail != NULL) {
        if (data->marker1 != NULL)
            adg_marker_set_segment(data->marker1, data->trail, outside ? 2 : 1);
        if (data->marker2 != NULL)
            adg_marker_set_segment(data->marker2, data->trail, outside ? 3 : 1);
    } else {
        _adg_dispose_markers(ldim);
    }

    _adg_update_extents(ldim);
}

static void
_adg_render(AdgEntity *entity, cairo_t *cr)
{
    AdgLDim *ldim;
    AdgDim *dim;
    AdgLDimPrivate *data;
    AdgDimStyle *dim_style;
    AdgDress dress;
    const cairo_path_t *cairo_path;

    dim = (AdgDim *) entity;
    if (! adg_dim_compute_geometry(dim))
        return;

    ldim = (AdgLDim *) entity;
    data = adg_ldim_get_instance_private(ldim);
    dim_style = adg_dim_get_dim_style(dim);

    adg_style_apply((AdgStyle *) dim_style, entity, cr);
    adg_entity_render((AdgEntity *) adg_dim_get_quote(dim), cr);

    if (data->marker1)
        adg_entity_render((AdgEntity *) data->marker1, cr);
    if (data->marker2)
        adg_entity_render((AdgEntity *) data->marker2, cr);

    cairo_transform(cr, adg_entity_get_global_matrix(entity));
    dress = adg_dim_style_get_line_dress(dim_style);
    adg_entity_apply_dress(entity, dress, cr);

    cairo_path = adg_trail_get_cairo_path(data->trail);
    cairo_append_path(cr, cairo_path);
    cairo_stroke(cr);
}

static gchar *
_adg_default_value(AdgDim *dim)
{
    AdgLDim *ldim;
    AdgLDimPrivate *data;
    gdouble value;

    if (! adg_dim_compute_geometry(dim))
        return g_strdup("undef");

    ldim = (AdgLDim *) dim;
    data = adg_ldim_get_instance_private(ldim);
    value = data->geometry.distance;

    return adg_dim_get_text(dim, value);
}

static gboolean
_adg_compute_geometry(AdgDim *dim)
{
    AdgLDim *ldim;
    AdgLDimPrivate *data;
    AdgPoint *ref1_point, *ref2_point, *pos_point;
    const CpmlPair *ref1, *ref2, *pos;
    CpmlVector baseline, extension;
    gdouble d, k;

    ref1_point = adg_dim_get_ref1(dim);
    if (! adg_point_update(ref1_point)) {
        adg_dim_geometry_missing(dim, "ref1");
        return FALSE;
    }

    ref2_point = adg_dim_get_ref2(dim);
    if (! adg_point_update(ref2_point)) {
        adg_dim_geometry_missing(dim, "ref2");
        return FALSE;
    }

    pos_point =  adg_dim_get_pos(dim);
    if (! adg_point_update(pos_point)) {
        adg_dim_geometry_missing(dim, "pos");
        return FALSE;
    }

    ref1 = (CpmlPair *) ref1_point;
    ref2 = (CpmlPair *) ref2_point;
    if (cpml_pair_equal(ref1, ref2)) {
        adg_dim_geometry_coincident(dim, "ref1", "ref2", ref1);
        return FALSE;
    }

    pos = (CpmlPair *) pos_point;
    ldim = (AdgLDim *) dim;
    data = adg_ldim_get_instance_private(ldim);

    cpml_vector_from_angle(&extension, data->direction);
    cpml_pair_copy(&baseline, &extension);
    cpml_vector_normal(&baseline);

    d = extension.y * baseline.x -
        extension.x * baseline.y;
    g_return_val_if_fail(d != 0, FALSE);

    k = ((pos->y - ref1->y) * baseline.x -
         (pos->x - ref1->x) * baseline.y) / d;
    data->geometry.base1.x = ref1->x + k * extension.x;
    data->geometry.base1.y = ref1->y + k * extension.y;

    k = ((pos->y - ref2->y) * baseline.x -
         (pos->x - ref2->x) * baseline.y) / d;
    data->geometry.base2.x = ref2->x + k * extension.x;
    data->geometry.base2.y = ref2->y + k * extension.y;

    data->geometry.distance = cpml_pair_distance(&data->geometry.base1,
                                                 &data->geometry.base2);

    _adg_update_shift(ldim);
    return TRUE;
}

static void
_adg_update_shift(AdgLDim *ldim)
{
    AdgLDimPrivate *data = adg_ldim_get_instance_private(ldim);
    AdgDimStyle *dim_style;
    gdouble from_offset, to_offset;
    gdouble baseline_spacing, level;
    CpmlVector vector;

    if (data->shift.is_arranged)
        return;

    dim_style = adg_dim_get_dim_style((AdgDim *) ldim);
    from_offset = adg_dim_style_get_from_offset(dim_style);
    to_offset = adg_dim_style_get_to_offset(dim_style);
    baseline_spacing = adg_dim_style_get_baseline_spacing(dim_style);
    level = adg_dim_get_level((AdgDim *) ldim);

    cpml_vector_from_angle(&vector, data->direction);

    cpml_vector_set_length(&vector, from_offset);
    cpml_pair_copy(&data->shift.from, &vector);

    cpml_vector_set_length(&vector, to_offset);
    cpml_pair_copy(&data->shift.to, &vector);

    cpml_vector_set_length(&vector, level * baseline_spacing);
    cpml_pair_copy(&data->shift.base, &vector);
}

static void
_adg_update_entities(AdgLDim *ldim)
{
    AdgEntity *entity = (AdgEntity *) ldim;
    AdgLDimPrivate *data = adg_ldim_get_instance_private(ldim);
    AdgDimStyle *dim_style = adg_dim_get_dim_style((AdgDim *) ldim);

    if (data->trail == NULL)
        data->trail = adg_trail_new(_adg_trail_callback, ldim);

    if (data->marker1 == NULL) {
        data->marker1 = adg_dim_style_marker1_new(dim_style);
        adg_entity_set_parent((AdgEntity *) data->marker1, entity);
    }

    if (data->marker2 == NULL) {
        data->marker2 = adg_dim_style_marker2_new(dim_style);
        adg_entity_set_parent((AdgEntity *) data->marker2, entity);
    }
}

static void
_adg_choose_flags(AdgLDim *ldim, gboolean *to_outside, gboolean *to_detach)
{
    AdgDim *dim;
    AdgThreeState outside, detached;
    AdgLDimPrivate *data;
    const cairo_matrix_t *local, *global;
    gdouble local_factor, global_factor;
    gdouble available_space, markers_space, quote_space;

    dim = (AdgDim *) ldim;
    outside = adg_dim_get_outside(dim);
    detached = adg_dim_get_detached(dim);

    *to_outside = outside == ADG_THREE_STATE_ON;
    *to_detach = detached == ADG_THREE_STATE_ON;

    /* On explicit flags, no further investigation is required */
    if (outside != ADG_THREE_STATE_UNKNOWN &&
        detached != ADG_THREE_STATE_UNKNOWN)
        return;

    data = adg_ldim_get_instance_private(ldim);
    local = adg_entity_get_local_matrix((AdgEntity *) ldim);
    global = adg_entity_get_global_matrix((AdgEntity *) ldim);
    local_factor = fabs(local->xx + local->yy) / 2;
    global_factor = fabs(global->xx + global->yy) / 2;
    available_space = data->geometry.distance * local_factor * global_factor;

    markers_space = 0;
    if (outside != ADG_THREE_STATE_ON) {
        if (data->marker1 != NULL)
            markers_space += adg_marker_get_size(data->marker1);
        if (data->marker2 != NULL)
            markers_space += adg_marker_get_size(data->marker2);

        markers_space *= global_factor;
    }

    if (detached == ADG_THREE_STATE_ON) {
        /* Leave at least 0.25 markers_space between the markers */
        quote_space = markers_space * 0.25;
    } else {
        AdgEntity *quote = (AdgEntity *) adg_dim_get_quote(dim);
        adg_entity_arrange(quote);
        quote_space = adg_entity_get_extents(quote)->size.x;
    }

    if (outside == ADG_THREE_STATE_UNKNOWN &&
        detached == ADG_THREE_STATE_UNKNOWN) {
        /* Both flags need to be choosed */
        if (quote_space + markers_space < available_space) {
            *to_detach = FALSE;
            *to_outside = FALSE;
        } else if (quote_space < available_space) {
            *to_detach = FALSE;
            *to_outside = TRUE;
        } else {
            *to_detach = TRUE;
            *to_outside = markers_space * 1.25 > available_space;
        }
    } else if (outside == ADG_THREE_STATE_UNKNOWN) {
        /* Only the outside flag may be guessed */
        *to_outside = quote_space + markers_space > available_space;
    } else {
        /* Only the detached flag may be guessed */
        *to_detach = quote_space + markers_space > available_space;
    }
}

static void
_adg_update_quote(AdgLDim *ldim, CpmlPair *base1, CpmlPair *base2, CpmlPair *pos,
                  gboolean detach, gboolean outside, gdouble gap)
{
    AdgLDimPrivate *data;
    AdgEntity *quote_entity;
    CpmlPair middle, factor, org;
    CpmlVector dir;
    cairo_matrix_t map;

    quote_entity = (AdgEntity *) adg_dim_get_quote((AdgDim *) ldim);
    if (quote_entity == NULL)
        return;

    data = adg_ldim_get_instance_private(ldim);
    middle.x = (base1->x + base2->x) / 2;
    middle.y = (base1->y + base2->y) / 2;
    dir.x = base2->x - base1->x;
    dir.y = base2->y - base1->y;
    cpml_vector_set_length(&dir, 1);

    if (detach) {
        /* Detached quote: position the quote at "pos" */
        CpmlPair tmp_pair, quote_end;
        CpmlVector vector;
        gdouble distance1, distance2, quote_size;
        gboolean on_side1;
        cairo_path_data_t *to_extend;

        /* Set "org" to the properly converted "pos" coordinates */
        org.x = pos->x + data->shift.base.x;
        org.y = pos->y + data->shift.base.y;

        /* Check in which side of the base line the quote must be rendered.
         * This is done by checking if the (pos..middle) vector is closer
         * to the base line vector or to its inverse, that is if they are
         * concordants or discordants. For this purpose, an algorithm
         * based on squared distances is used. */
        tmp_pair.x = org.x - middle.x;
        tmp_pair.y = org.y - middle.y;
        vector.x = -dir.x;
        vector.y = -dir.y;
        distance2 = cpml_pair_squared_distance(&dir, &tmp_pair);
        distance1 = cpml_pair_squared_distance(&vector, &tmp_pair);
        on_side1 = distance2 > distance1;

        /* Properly align the quote, depending on its side */
        factor.x = on_side1 ? 1 : 0;
        if (! on_side1)
            vector = dir;

        /* Add a gap between the quote and the extension line */
        org.x += vector.x * gap;
        org.y += vector.y * gap;

        /* Calculate the end point (on the base line) of the quote */
        quote_size = adg_entity_get_extents(quote_entity)->size.x;
        quote_end.x = org.x + vector.x * quote_size;
        quote_end.y = org.y + vector.y * quote_size;

        /* Extends the base line to include the "quote_end" pair,
         * so a detached quote is properly underlined */
        if (outside) {
            to_extend = &data->cairo.data[on_side1 ? 7 : 9];
        } else {
            to_extend = &data->cairo.data[9];
            cpml_pair_to_cairo(&middle, &data->cairo.data[9]);
            cpml_pair_to_cairo(on_side1 ? base1 : base2, &data->cairo.data[11]);
            data->cairo.data[2].header.length = 6;
        }

        /* Extend the base line only if needed */
        cpml_pair_from_cairo(&tmp_pair, to_extend);
        distance1 = cpml_pair_squared_distance(&quote_end, &middle);
        distance2 = cpml_pair_squared_distance(&tmp_pair, &middle);
        if (distance1 > distance2)
            cpml_pair_to_cairo(&quote_end, to_extend);
    } else {
        /* Center the quote in the middle of the base line */
        factor.x = 0.5;
        cpml_pair_copy(&org, &middle);
    }

    factor.y = 0;
    adg_alignment_set_factor((AdgAlignment *) quote_entity, &factor);
    cairo_matrix_init(&map, dir.x, dir.y, -dir.y, dir.x, org.x, org.y);
    adg_entity_set_global_map(quote_entity, &map);
    adg_entity_arrange(quote_entity);

    adg_matrix_copy(&data->quote.global_map, &map);
}

static void
_adg_update_extents(AdgLDim *ldim)
{
    AdgLDimPrivate *data = adg_ldim_get_instance_private(ldim);
    AdgEntity *quote = (AdgEntity *) adg_dim_get_quote((AdgDim *) ldim);
    CpmlExtents new_extents;
    const CpmlExtents *extents;
    AdgEntity *marker_entity;

    new_extents.is_defined = FALSE;

    /* The quote is always present (otherwise something bad happened) */
    extents = adg_entity_get_extents(quote);
    if (extents != NULL)
        cpml_extents_add(&new_extents, extents);

    if (data->trail != NULL) {
        extents = adg_trail_get_extents(data->trail);
        if (extents != NULL)
            cpml_extents_add(&new_extents, extents);
    }

    if (data->marker1 != NULL) {
        marker_entity = (AdgEntity *) data->marker1;
        adg_entity_local_changed(marker_entity);
        adg_entity_arrange(marker_entity);
        extents = adg_entity_get_extents(marker_entity);
        if (extents != NULL)
            cpml_extents_add(&new_extents, extents);
    }

    if (data->marker2 != NULL) {
        marker_entity = (AdgEntity *) data->marker2;
        adg_entity_local_changed(marker_entity);
        adg_entity_arrange(marker_entity);
        extents = adg_entity_get_extents(marker_entity);
        if (extents != NULL)
            cpml_extents_add(&new_extents, extents);
    }

    adg_entity_set_extents((AdgEntity *) ldim, &new_extents);
}

static void
_adg_unset_trail(AdgLDim *ldim)
{
    AdgLDimPrivate *data = adg_ldim_get_instance_private(ldim);

    if (data->trail != NULL)
        adg_model_clear((AdgModel *) data->trail);

    data->cairo.path.status = CAIRO_STATUS_INVALID_PATH_DATA;
}

static void
_adg_dispose_trail(AdgLDim *ldim)
{
    AdgLDimPrivate *data = adg_ldim_get_instance_private(ldim);

    if (data->trail != NULL) {
        g_object_unref(data->trail);
        data->trail = NULL;
    }
}

static void
_adg_dispose_markers(AdgLDim *ldim)
{
    AdgLDimPrivate *data = adg_ldim_get_instance_private(ldim);

    if (data->marker1 != NULL) {
        g_object_unref(data->marker1);
        data->marker1 = NULL;
    }

    if (data->marker2 != NULL) {
        g_object_unref(data->marker2);
        data->marker2 = NULL;
    }
}

static cairo_path_t *
_adg_trail_callback(AdgTrail *trail, gpointer user_data)
{
    AdgLDim *ldim = (AdgLDim *) user_data;
    AdgLDimPrivate *data = adg_ldim_get_instance_private(ldim);
    return &data->cairo.path;
}