Revision 533 2.1/trunk/org.gvsig.view3d/org.gvsig.view3d.swing/org.gvsig.view3d.swing.api/src/main/java/org/gvsig/view3d/swing/api/properties/GeneralProperties3D.java
GeneralProperties3D.java | ||
---|---|---|
4 | 4 |
import java.io.File; |
5 | 5 |
|
6 | 6 |
/** |
7 |
* This class represents the general properties of 3D library. |
|
7 | 8 |
* |
8 | 9 |
* @author <a href="mailto:lmarques@disid.com">Lluis Marques</a> |
9 | 10 |
* |
10 | 11 |
*/ |
11 | 12 |
public interface GeneralProperties3D { |
12 |
|
|
13 |
|
|
14 |
/** |
|
15 |
* Adds {@link PropertyChangeListener} that will listen properties changes. |
|
16 |
* |
|
17 |
* @param listener |
|
18 |
* @see GeneralProperties3D#removePropertyChangeListener(PropertyChangeListener) |
|
19 |
*/ |
|
13 | 20 |
public void addPropertyChangeListener(PropertyChangeListener listener); |
14 | 21 |
|
15 |
public boolean getViewPortAnimation(); |
|
16 |
|
|
22 |
/** |
|
23 |
* Gets the atmosphere visibility. |
|
24 |
* |
|
25 |
* @see GeneralProperties3D#setAtmosphereVisibility(boolean) |
|
26 |
* @return visibility of atmosphere component. |
|
27 |
*/ |
|
17 | 28 |
public boolean getAtmosphereVisibility(); |
18 | 29 |
|
30 |
/** |
|
31 |
* Gets path of tile cache. |
|
32 |
* |
|
33 |
* @see GeneralProperties3D#setCachePath(File) |
|
34 |
* @return |
|
35 |
*/ |
|
19 | 36 |
public File getCachePath(); |
20 | 37 |
|
38 |
/** |
|
39 |
* Gets the default view heigth of 3D views. |
|
40 |
* |
|
41 |
* @see GeneralProperties3D#setDefaultViewHeight(int) |
|
42 |
* @return Default height of 3D views. |
|
43 |
*/ |
|
21 | 44 |
public int getDefaultViewHeight(); |
22 | 45 |
|
46 |
/** |
|
47 |
* Gets the default view width of 3D views. |
|
48 |
* |
|
49 |
* @see GeneralProperties3D#setDefaultViewWidth(int) |
|
50 |
* @return Default width of 3D views. |
|
51 |
*/ |
|
23 | 52 |
public int getDefaultViewWidth(); |
24 | 53 |
|
54 |
/** |
|
55 |
* Gets minimap visibility. |
|
56 |
* |
|
57 |
* @see GeneralProperties3D#setMinimapVisibility(boolean) |
|
58 |
* @return Visibility of minimap. |
|
59 |
*/ |
|
25 | 60 |
public boolean getMinimapVisibility(); |
26 | 61 |
|
62 |
/** |
|
63 |
* Gets north indicator visibility. |
|
64 |
* |
|
65 |
* @see GeneralProperties3D#setNorthIndicatorVisibility(boolean) |
|
66 |
* @return Visibility of north indicator component. |
|
67 |
*/ |
|
27 | 68 |
public boolean getNorthIndicatorVisibility(); |
28 |
|
|
69 |
|
|
70 |
/** |
|
71 |
* Get visibility of scale component. |
|
72 |
* |
|
73 |
* @see GeneralProperties3D#setScaleVisibility(boolean) |
|
74 |
* @return Visibility of scale component. |
|
75 |
*/ |
|
76 |
public boolean getScaleVisibility(); |
|
77 |
|
|
78 |
/** |
|
79 |
* Get starts background visibility. |
|
80 |
* |
|
81 |
* @see GeneralProperties3D#setStarsBackgroundVisibility(boolean) |
|
82 |
* @return Visibility of starts background component. |
|
83 |
*/ |
|
29 | 84 |
public boolean getStarsBackgroundVisibility(); |
30 | 85 |
|
31 |
public boolean getScaleVisibility(); |
|
32 |
|
|
86 |
/** |
|
87 |
* Gets if the view port synchronize is animated |
|
88 |
* |
|
89 |
* @see GeneralProperties3D#setViewPortAnimation(boolean) |
|
90 |
* @return True if view port synchronize is animated, false if it is not |
|
91 |
* animated. |
|
92 |
*/ |
|
93 |
public boolean getViewPortAnimation(); |
|
94 |
|
|
95 |
/** |
|
96 |
* Removes {@link PropertyChangeListener}. |
|
97 |
* |
|
98 |
* @param listener |
|
99 |
* @see GeneralProperties3D#addPropertyChangeListener(PropertyChangeListener) |
|
100 |
*/ |
|
33 | 101 |
public void removePropertyChangeListener(PropertyChangeListener listener); |
34 | 102 |
|
35 |
public void setViewPortAnimation(boolean flag); |
|
36 |
|
|
103 |
/** |
|
104 |
* Sets visibility of atmosphere component. |
|
105 |
* |
|
106 |
* @param visibility |
|
107 |
* @see GeneralProperties3D#getAtmosphereVisibility() |
|
108 |
*/ |
|
37 | 109 |
public void setAtmosphereVisibility(boolean visibility); |
38 | 110 |
|
111 |
/** |
|
112 |
* Sets path of tile cache. |
|
113 |
* |
|
114 |
* @param path |
|
115 |
* @see GeneralProperties3D#getCachePath() |
|
116 |
*/ |
|
39 | 117 |
public void setCachePath(File path); |
40 | 118 |
|
119 |
/** |
|
120 |
* Sets default view height. |
|
121 |
* |
|
122 |
* @param height |
|
123 |
* @see GeneralProperties3D#getDefaultViewHeight() |
|
124 |
*/ |
|
41 | 125 |
public void setDefaultViewHeight(int height); |
42 | 126 |
|
127 |
/** |
|
128 |
* Sets default view width. |
|
129 |
* |
|
130 |
* @param width |
|
131 |
* @see GeneralProperties3D#getDefaultViewWidth() |
|
132 |
*/ |
|
43 | 133 |
public void setDefaultViewWidth(int width); |
44 | 134 |
|
135 |
/** |
|
136 |
* Sets visibility of miniMap component. |
|
137 |
* |
|
138 |
* @param visibility |
|
139 |
* @see GeneralProperties3D#getMinimapVisibility() |
|
140 |
*/ |
|
45 | 141 |
public void setMinimapVisibility(boolean visibility); |
46 | 142 |
|
143 |
/** |
|
144 |
* Sets visibility of north indicator component. |
|
145 |
* |
|
146 |
* @param visibility |
|
147 |
* @see GeneralProperties3D#getNorthIndicatorVisibility() |
|
148 |
*/ |
|
47 | 149 |
public void setNorthIndicatorVisibility(boolean visibility); |
48 | 150 |
|
151 |
/** |
|
152 |
* Sets visibility of scale component. |
|
153 |
* |
|
154 |
* @param visibility |
|
155 |
* @see GeneralProperties3D#getScaleVisibility() |
|
156 |
*/ |
|
157 |
public void setScaleVisibility(boolean visibility); |
|
158 |
|
|
159 |
/** |
|
160 |
* Sets visibility of starts background component. |
|
161 |
* |
|
162 |
* @param visibility |
|
163 |
* @see GeneralProperties3D#getStarsBackgroundVisibility() |
|
164 |
*/ |
|
49 | 165 |
public void setStarsBackgroundVisibility(boolean visibility); |
50 |
|
|
51 |
public void setScaleVisibility(boolean visibility); |
|
166 |
|
|
167 |
/** |
|
168 |
* Sets if the view port synchronize is animated or not. |
|
169 |
* |
|
170 |
* @param flag |
|
171 |
* @see GeneralProperties3D#getViewPortAnimation() |
|
172 |
*/ |
|
173 |
public void setViewPortAnimation(boolean flag); |
|
52 | 174 |
} |
Also available in: Unified diff