summaryrefslogtreecommitdiff
path: root/src/de/lmu/ifi/dbs/elki/visualization/svg/SVGSimpleLinearAxis.java
blob: 930e9e8e878d977995ae7dfd3fe631e8c51ad19c (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
package de.lmu.ifi.dbs.elki.visualization.svg;

/*
 This file is part of ELKI:
 Environment for Developing KDD-Applications Supported by Index-Structures

 Copyright (C) 2012
 Ludwig-Maximilians-Universität München
 Lehr- und Forschungseinheit für Datenbanksysteme
 ELKI Development Team

 This program is free software: you can redistribute it and/or modify
 it under the terms of the GNU Affero General Public License as published by
 the Free Software Foundation, either version 3 of the License, or
 (at your option) any later version.

 This program 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 Affero General Public License for more details.

 You should have received a copy of the GNU Affero General Public License
 along with this program.  If not, see <http://www.gnu.org/licenses/>.
 */

import org.apache.batik.util.SVGConstants;
import org.w3c.dom.Element;

import de.lmu.ifi.dbs.elki.math.scales.LinearScale;
import de.lmu.ifi.dbs.elki.visualization.css.CSSClass;
import de.lmu.ifi.dbs.elki.visualization.css.CSSClassManager;
import de.lmu.ifi.dbs.elki.visualization.css.CSSClassManager.CSSNamingConflict;
import de.lmu.ifi.dbs.elki.visualization.style.StyleLibrary;

/**
 * Class to draw a simple axis with tick marks on the plot.
 * 
 * @author Erich Schubert
 * 
 * @apiviz.uses CSSClass
 * @apiviz.uses CSSClassManager
 * @apiviz.uses LinearScale
 * @apiviz.uses StyleLibrary
 * @apiviz.uses Element oneway - - «create»
 */
public class SVGSimpleLinearAxis {
  /**
   * Flag for axis label position. First char: right-hand or left-hand side of
   * line. Second char: text alignment
   * 
   * @apiviz.exclude
   */
  private enum Alignment {
    LL, RL, LC, RC, LR, RR
  }

  /**
   * Labeling style: left-handed, right-handed, no ticks, labels at ends
   * 
   * @apiviz.exclude
   */
  public enum LabelStyle {
    LEFTHAND, RIGHTHAND, NOLABELS, NOTHING, ENDLABEL
  }

  /**
   * CSS class name for the axes
   */
  private static final String CSS_AXIS = "axis";

  /**
   * CSS class name for the axes
   */
  private static final String CSS_AXIS_TICK = "axis-tick";

  /**
   * CSS class name for the axes
   */
  private static final String CSS_AXIS_LABEL = "axis-label";

  /**
   * Register CSS classes with a {@link CSSClassManager}
   * 
   * @param owner Owner of the CSS classes
   * @param manager Manager to register the classes with
   * @throws CSSNamingConflict when a name clash occurs
   */
  private static void setupCSSClasses(Object owner, CSSClassManager manager, StyleLibrary style) throws CSSNamingConflict {
    if(!manager.contains(CSS_AXIS)) {
      CSSClass axis = new CSSClass(owner, CSS_AXIS);
      axis.setStatement(SVGConstants.CSS_STROKE_PROPERTY, style.getColor(StyleLibrary.AXIS));
      axis.setStatement(SVGConstants.CSS_STROKE_WIDTH_PROPERTY, style.getLineWidth(StyleLibrary.AXIS));
      manager.addClass(axis);
    }
    if(!manager.contains(CSS_AXIS_TICK)) {
      CSSClass tick = new CSSClass(owner, CSS_AXIS_TICK);
      tick.setStatement(SVGConstants.CSS_STROKE_PROPERTY, style.getColor(StyleLibrary.AXIS_TICK));
      tick.setStatement(SVGConstants.CSS_STROKE_WIDTH_PROPERTY, style.getLineWidth(StyleLibrary.AXIS_TICK));
      manager.addClass(tick);
    }
    if(!manager.contains(CSS_AXIS_LABEL)) {
      CSSClass label = new CSSClass(owner, CSS_AXIS_LABEL);
      label.setStatement(SVGConstants.CSS_FILL_PROPERTY, style.getTextColor(StyleLibrary.AXIS_LABEL));
      label.setStatement(SVGConstants.CSS_FONT_FAMILY_PROPERTY, style.getFontFamily(StyleLibrary.AXIS_LABEL));
      label.setStatement(SVGConstants.CSS_FONT_SIZE_PROPERTY, style.getTextSize(StyleLibrary.AXIS_LABEL));
      manager.addClass(label);
    }
  }

  /**
   * Plot an axis with appropriate scales
   * 
   * @param plot Plot object
   * @param parent Containing element
   * @param scale axis scale information
   * @param x1 starting coordinate
   * @param y1 starting coordinate
   * @param x2 ending coordinate
   * @param y2 ending coordinate
   * @param labelstyle Style for placing the labels
   * @param style Style library
   * @throws CSSNamingConflict when a conflict occurs in CSS
   */
  public static void drawAxis(SVGPlot plot, Element parent, LinearScale scale, double x1, double y1, double x2, double y2, LabelStyle labelstyle, StyleLibrary style) throws CSSNamingConflict {
    assert (parent != null);
    Element line = plot.svgLine(x1, y1, x2, y2);
    SVGUtil.setCSSClass(line, CSS_AXIS);
    parent.appendChild(line);

    final double tx = x2 - x1;
    final double ty = y2 - y1;
    // ticks are orthogonal
    final double tw = ty * 0.01;
    final double th = -tx * 0.01;

    // choose where to print labels.
    final boolean labels, ticks;
    switch(labelstyle){
    case LEFTHAND:
    case RIGHTHAND:
      labels = true;
      ticks = true;
      break;
    case NOLABELS:
      labels = false;
      ticks = true;
      break;
    case ENDLABEL: // end labels are handle specially
    case NOTHING:
    default:
      labels = false;
      ticks = false;
    }
    Alignment pos = Alignment.LL;
    if(labels) {
      double angle = Math.atan2(ty, tx);
      // System.err.println(tx + " " + (-ty) + " " + angle);
      if(angle > 2.6) { // pi .. 2.6 = 180 .. 150
        pos = labelstyle == LabelStyle.RIGHTHAND ? Alignment.RC : Alignment.LC;
      }
      else if(angle > 0.5) { // 2.3 .. 0.7 = 130 .. 40
        pos = labelstyle == LabelStyle.RIGHTHAND ? Alignment.RR : Alignment.LL;
      }
      else if(angle > -0.5) { // 0.5 .. -0.5 = 30 .. -30
        pos = labelstyle == LabelStyle.RIGHTHAND ? Alignment.RC : Alignment.LC;
      }
      else if(angle > -2.6) { // -0.5 .. -2.6 = -30 .. -150
        pos = labelstyle == LabelStyle.RIGHTHAND ? Alignment.RL : Alignment.LR;
      }
      else { // -2.6 .. -pi = -150 .. -180
        pos = labelstyle == LabelStyle.RIGHTHAND ? Alignment.RC : Alignment.LC;
      }
    }
    // vertical text offset; align approximately with middle instead of
    // baseline.
    double textvoff = style.getTextSize(StyleLibrary.AXIS_LABEL) * .35;

    // draw ticks on x axis
    if(ticks || labels) {
      int sw = 1;
      { // Compute how many ticks to draw
        int numticks = (int) ((scale.getMax() - scale.getMin()) / scale.getRes());
        double tlen = Math.sqrt(tx * tx + ty * ty);
        double minl = 10 * style.getLineWidth(StyleLibrary.AXIS_TICK);
        // Try proper divisors first.
        if(sw * tlen / numticks < minl) {
          for(int i = 2; i <= (numticks >> 1); i++) {
            if(numticks % i == 0) {
              if(i * tlen / numticks >= minl) {
                sw = i;
                break;
              }
            }
          }
        }
        // Otherwise, also allow non-divisors.
        if(sw * tlen / numticks < minl) {
          sw = (int)Math.floor(minl * numticks / tlen);
        }
      }
      for(double tick = scale.getMin(); tick <= scale.getMax() + scale.getRes() / 10; tick += sw * scale.getRes()) {
        double x = x1 + tx * scale.getScaled(tick);
        double y = y1 + ty * scale.getScaled(tick);
        if(ticks) {
          // This is correct. Vectors: (vec - tvec) to (vec + tvec)
          Element tickline = plot.svgLine(x - tw, y - th, x + tw, y + th);
          SVGUtil.setAtt(tickline, SVGConstants.SVG_CLASS_ATTRIBUTE, CSS_AXIS_TICK);
          parent.appendChild(tickline);
        }
        // draw labels
        if(labels) {
          double tex = x;
          double tey = y;
          switch(pos){
          case LL:
          case LC:
          case LR:
            tex = x + tw * 2.5;
            tey = y + th * 2.5 + textvoff;
            break;
          case RL:
          case RC:
          case RR:
            tex = x - tw * 2.5;
            tey = y - th * 2.5 + textvoff;
          }
          Element text = plot.svgText(tex, tey, scale.formatValue(tick));
          text.setAttribute(SVGConstants.SVG_CLASS_ATTRIBUTE, CSS_AXIS_LABEL);
          switch(pos){
          case LL:
          case RL:
            text.setAttribute(SVGConstants.SVG_TEXT_ANCHOR_ATTRIBUTE, SVGConstants.SVG_START_VALUE);
            break;
          case LC:
          case RC:
            text.setAttribute(SVGConstants.SVG_TEXT_ANCHOR_ATTRIBUTE, SVGConstants.SVG_MIDDLE_VALUE);
            break;
          case LR:
          case RR:
            text.setAttribute(SVGConstants.SVG_TEXT_ANCHOR_ATTRIBUTE, SVGConstants.SVG_END_VALUE);
            break;
          }
          parent.appendChild(text);
        }
      }
    }
    if(labelstyle == LabelStyle.ENDLABEL) {
      {
        Element text = plot.svgText(x1 - tx * 0.02, y1 - ty * 0.02 + textvoff, scale.formatValue(scale.getMin()));
        text.setAttribute(SVGConstants.SVG_CLASS_ATTRIBUTE, CSS_AXIS_LABEL);
        text.setAttribute(SVGConstants.SVG_TEXT_ANCHOR_ATTRIBUTE, SVGConstants.SVG_MIDDLE_VALUE);
        parent.appendChild(text);
      }
      {
        Element text = plot.svgText(x2 + tx * 0.02, y2 + ty * 0.02 + textvoff, scale.formatValue(scale.getMax()));
        text.setAttribute(SVGConstants.SVG_CLASS_ATTRIBUTE, CSS_AXIS_LABEL);
        text.setAttribute(SVGConstants.SVG_TEXT_ANCHOR_ATTRIBUTE, SVGConstants.SVG_MIDDLE_VALUE);
        parent.appendChild(text);
      }
    }
    setupCSSClasses(plot, plot.getCSSClassManager(), style);
  }
}