Revision 474 2.1/trunk/org.gvsig.view3d/org.gvsig.view3d.swing/org.gvsig.view3d.swing.api/src/main/java/org/gvsig/view3d/swing/api/MapControl3D.java

View differences:

MapControl3D.java
25 25
package org.gvsig.view3d.swing.api;
26 26

  
27 27
import org.gvsig.fmap.mapcontext.MapContext;
28
import org.gvsig.fmap.mapcontext.layers.FLayer;
28 29
import org.gvsig.tools.dispose.Disposable;
29 30
import org.gvsig.tools.observer.Observable;
30 31
import org.gvsig.tools.swing.api.Component;
31 32
import org.gvsig.tools.task.Cancellable;
32 33
import org.gvsig.view3d.swing.api.View3DSwingManager.TYPE;
33 34

  
34

  
35 35
/**
36
 * 
37
 * 
38
 * 
36 39
 * @author <a href="mailto:lmarques@disid.com">Lluis Marques</a>
37 40
 *
38 41
 */
39 42
@SuppressWarnings("deprecation")
40
public interface MapControl3D extends Component, Disposable, Observable{
41
    
43
public interface MapControl3D extends Component, Disposable, Observable {
44

  
45
    /**
46
     * Notification that notifies just before that this
47
     * <code>MapControl3D</code> diposes.
48
     */
42 49
    static final String BEFORE_DISPOSE_MAPCONTEX3D_NOTIFICATION =
43 50
        "MapControl3D.beforeDisposePanel";
51

  
52
    /**
53
     * Notification that notifies just after that this <code>MapControl3D</code>
54
     * diposes.
55
     */
44 56
    static final String AFTER_DISPOSE_MAPCONTEX3D_NOTIFICATION =
45 57
        "MapControl3D.afterDisposePanel";
46
    
58

  
47 59
    /**
60
     * Gets shared object to cancel draw of loaded layers. To cancel draw use
61
     * set
62
     * canceled <code>true</code> with {@link Cancellable#setCanceled(boolean)}
48 63
     * 
49
     * @return
64
     * Note: {@link Cancellable} is deprecated but we have to use it because
65
     * {@link FLayer#draw(java.awt.image.BufferedImage, java.awt.Graphics2D, org.gvsig.fmap.mapcontext.ViewPort, Cancellable, double)}
66
     * use it.
67
     * 
68
     * @see Cancellable
50 69
     */
51 70
    public Cancellable getCancellable();
52
    
71

  
53 72
    /**
73
     * Gets the <code>MapContext</code> associated.
54 74
     * 
55
     * @return
75
     * @see MapContext
56 76
     */
57 77
    public MapContext getMapContext();
58
    
78

  
59 79
    /**
80
     * Gets {@link TYPE} of this <code>MapControl3D</code>.
60 81
     * 
61
     * @return
62 82
     */
63 83
    public TYPE getType();
64
    
84

  
65 85
    /**
86
     * Gets vertical exaggeration model of this <code>MapControl3D</code>.
66 87
     * 
67
     * @return
88
     * @see MapControl3D#setVerticalExaggeration(double)
68 89
     */
69 90
    public double getVerticalExaggeration();
70 91

  
71 92
    /**
93
     * Hides Atmosphere component.
72 94
     * 
95
     * @see MapControl3D#showAtmosphere()
73 96
     */
74 97
    public void hideAtmosphere();
75 98

  
76 99
    /**
100
     * Hides MiniMap component.
77 101
     * 
102
     * @see MapControl3D#showMiniMap()
78 103
     */
79 104
    public void hideMiniMap();
80 105

  
81 106
    /**
107
     * Hides North Indicator component.
82 108
     * 
109
     * @see MapControl3D#showNortIndicator()
83 110
     */
84 111
    public void hideNorthIndicator();
85 112

  
86 113
    /**
114
     * Hides Scale component.
87 115
     * 
116
     * @see MapControl3D#showScale()
88 117
     */
89 118
    public void hideScale();
90 119

  
91 120
    /**
121
     * Hides Star background layer.
92 122
     * 
123
     * @see MapControl3D#showStarBackgroundLayer()
93 124
     */
94 125
    public void hideStarBackground();
95 126

  
96 127
    /**
128
     * Forces reload all layers of <code>MapContext</code> associted.
97 129
     * 
130
     * @see {@link MapControl3D#synchronizeLayers()}
98 131
     */
99 132
    public void reloadLayers();
100 133

  
101 134
    /**
135
     * Sets MapContext and loads new MapContext layers.
102 136
     * 
137
     * @see MapControl3D#getMapContext()
103 138
     */
104 139
    public void setMapContext(MapContext theMapContext);
105 140

  
106 141
    /**
142
     * Sets vertical exaggeration.
107 143
     * 
144
     * @see MapControl3D#getVerticalExaggeration()
108 145
     */
109 146
    public void setVerticalExaggeration(double verticalExaggeration);
110 147

  
111 148
    /**
149
     * Shows Atmosphere layer.
112 150
     * 
151
     * @see MapControl3D#hideAtmosphere()
113 152
     */
114 153
    public void showAtmosphere();
115 154

  
116 155
    /**
156
     * Shows Minimap component.
117 157
     * 
158
     * @see MapControl3D#hideMiniMap()
118 159
     */
119 160
    public void showMiniMap();
120 161

  
121 162
    /**
163
     * Shows North indicartor component.
122 164
     * 
165
     * @see MapControl3D#hideNorthIndicator()
123 166
     */
124 167
    public void showNortIndicator();
125 168

  
126 169
    /**
170
     * Shows Scale component.
127 171
     * 
172
     * @see MapControl3D#hideScale()
128 173
     */
129 174
    public void showScale();
130 175

  
131 176
    /**
177
     * Shows Star background layer.
132 178
     * 
179
     * @see MapControl3D#hideStarBackground()
133 180
     */
134 181
    public void showStarBackgroundLayer();
135 182

  
136 183
    /**
137
     * 
184
     * Synchronize view of <code>MapControl3D</code> with view port of
185
     * <code>MapContext</code> associated.
138 186
     */
139 187
    public void synchronizeViewPorts();
140
    
188

  
141 189
    /**
190
     * Synchronize with <code>MapContext</code> associted only layers with
191
     * changes. To force synchronize all layers use
192
     * {@link MapControl3D#reloadLayers()}.
142 193
     * 
143 194
     */
144 195
    public void synchronizeLayers();

Also available in: Unified diff