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/View3DSwingManager.java

View differences:

View3DSwingManager.java
48 48
    public enum TYPE {
49 49
        SPHERE, FLAT
50 50
    }
51
    
51

  
52 52
    /**
53
     * Creates the general 3D properties panel. General 3D properties is used to
54
     * show and change General 3D properties in a graphical way. See
55
     * {@link GeneralProperties3D}.
53 56
     * 
54
     * @param mapControl3D
55
     * @param title
56
     * @return
57
     * @param properties
58
     *            Model of general 3D properties panel.
59
     * @return general 3D properties panel.
57 60
     */
58
    public View3DPanel createView3DPanel(MapControl3D mapControl3D, String title);
61
    public GeneralProperties3DPanel createGeneralProperties3DPanel(
62
        GeneralProperties3D properties);
59 63

  
60 64
    /**
61
     * Creates a <code>View3DPanel</code> with a {@link MapControl3D}.
65
     * Creates the layer 3D properties panel. Layer 3D properties panel is used
66
     * to show and change layer 3D properties in a graphical way. See
67
     * {@link LayerProperties3D}.
62 68
     * 
69
     * @param layer
70
     *            Layer to get model of layer 3D properties panel.
71
     * @return layer 3D properties panel.
72
     */
73
    public LayerProperties3DPanel createLayerProperties3DPanel(FLayer layer);
74

  
75
    /**
76
     * Registers and creatres a <code>MapControl3D</code> as from
77
     * {@link MapContext} {@link TYPE}. When an {@link MapControl3D} is created,
78
     * it automatically adds all available and visible layers of
79
     * <code>MapControl</code>.
80
     * 
63 81
     * @param theMapContext
64 82
     *            associated <code>MapContext</code> of
65 83
     *            <code>MapControl3D</code>
66
     * @param title
67
     *            Title of window
68 84
     * @param type
69 85
     *            Type of <code>MapControl3D</code>. See {@link TYPE}.
70 86
     * @param viewProperties
71 87
     *            View properties to register this <code>MapControl3D</code>
72
     * @see View3DSwingManager#createMapControl3D(MapContext, TYPE)
73
     * @return
88
     * @see View3DSwingManager#createView3DPanel(MapControl3D, String)
89
     * @see View3DSwingManager#createViewProperties3DPanel(MapControlProperties3D)
90
     * @return an instance of <code>MapControl3D</code> ready to be shown.
74 91
     */
75
    public View3DPanel createView3DPanel(MapContext theMapContext,String title, TYPE type,
92
    public MapControl3D createMapControl3D(MapContext theMapContext, TYPE type,
76 93
        ExtendedPropertiesSupport viewProperties);
77 94

  
78 95
    /**
79
     * Registers and creatres a <code>MapControl3D</code> as from
80
     * {@link MapContext} {@link TYPE}. When an {@link MapControl3D} is created,
81
     * it automatically adds all available and visible layers of
82
     * <code>MapControl</code>.
96
     * Creates a <code>View3DPanel</code> with a {@link MapControl3D}.
83 97
     * 
84 98
     * @param theMapContext
85 99
     *            associated <code>MapContext</code> of
86 100
     *            <code>MapControl3D</code>
101
     * @param title
102
     *            Title of window
87 103
     * @param type
88 104
     *            Type of <code>MapControl3D</code>. See {@link TYPE}.
89 105
     * @param viewProperties
90 106
     *            View properties to register this <code>MapControl3D</code>
91
     * @return an instance of <code>MapControl3D</code> ready to be shown.
107
     * @see View3DSwingManager#createMapControl3D(MapContext, TYPE)
108
     * @see View3DSwingManager#createView3DPanel(MapControl3D, String)
109
     * @return
92 110
     */
93
    public MapControl3D createMapControl3D(MapContext theMapContext, TYPE type,
94
        ExtendedPropertiesSupport viewProperties);
111
    public View3DPanel createView3DPanel(MapContext theMapContext,
112
        String title, TYPE type, ExtendedPropertiesSupport viewProperties);
95 113

  
96 114
    /**
115
     * Creates a <code>View3DPanel</code> with a {@link MapControl3D}.
116
     * 
117
     * @param mapControl3D
118
     *            Model of the <code>View3DPanel</code>.
119
     * @param title
120
     *            Title of panel.
121
     * @see View3DSwingManager#createView3DPanel(MapContext, String, TYPE,
122
     *      ExtendedPropertiesSupport)
123
     * @see View3DSwingManager#createMapControl3D(MapContext, TYPE,
124
     *      ExtendedPropertiesSupport)
125
     * @return The <code>View3DPanel</code>.
126
     */
127
    public View3DPanel createView3DPanel(MapControl3D mapControl3D, String title);
128

  
129
    /**
130
     * Creates the view 3D properties panel. View 3D properties panel is used to
131
     * show and change MapControl 3D properties in a graphical way. See
132
     * {@link MapControlProperties3D}.
133
     * 
134
     * @param properties
135
     *            Model of view 3D properties panel.
136
     * @return view 3D properites panel.
137
     */
138
    public ViewProperties3DPanel createViewProperties3DPanel(
139
        MapControlProperties3D properties);
140

  
141
    /**
142
     * Gets <code>GeneralProperties3D<code> of 3D library.
143
     * 
144
     * @see View3DSwingManager#setGeneral3DProperties(GeneralProperties3D)
145
     * @return
146
     */
147
    public GeneralProperties3D getGeneral3DProperties();
148

  
149
    /**
97 150
     * Gets the {@link MapControl3D} associated with view properties
98 151
     * {@link ExtendedPropertiesSupport}. If there are not indicated type of
99 152
     * <code>MapControl3D</code> associated with view properties, it will return
100 153
     * an empty list.
101 154
     * 
102 155
     * @param viewProperties
156
     * @see View3DSwingManager#getMapControl3D(ExtendedPropertiesSupport, TYPE)
103 157
     * @return List of <code>MapControl3D</code> associated with the view
104 158
     *         propoerties.
105 159
     */
......
116 170
     * @param viewProperties
117 171
     * @param type
118 172
     *            Type of <code>MapControl3D</code>
173
     * @see View3DSwingManager#getMapControl3D(ExtendedPropertiesSupport)
119 174
     * @return
120 175
     */
121 176
    public MapControl3D getMapControl3D(
122 177
        ExtendedPropertiesSupport viewProperties, TYPE type);
123 178

  
124 179
    /**
180
     * Gets <code>MapControlProperties3D</code> linked with the view properties.
125 181
     * 
126
     * @param layer
182
     * @param viewProperties
183
     *            View properties to get the <code>MapControlProperties3D</code>
184
     *            associated.
185
     * @see View3DSwingManager#setMapControlProperties3D(ExtendedPropertiesSupport,
186
     *      MapControlProperties3D)
127 187
     * @return
128 188
     */
129
    public LayerProperties3DPanel createLayerProperties3DPanel(FLayer layer);
189
    public MapControlProperties3D getMapControl3DProperties(
190
        ExtendedPropertiesSupport viewProperties);
130 191

  
131 192
    /**
193
     * Sets <code>GeneralProperties3D</code> to 3D library.
132 194
     * 
133
     * @return
195
     * @param properties
196
     *            General 3D properties.
197
     * @see View3DSwingManager#getGeneral3DProperties()
134 198
     */
135
    public ViewProperties3DPanel createViewProperties3DPanel(
136
        MapControlProperties3D properties);
137
    
199
    public void setGeneral3DProperties(GeneralProperties3D properties);
200

  
138 201
    /**
202
     * Sets <code>MapControlProperties3D</code> to view properties.
139 203
     * 
140
     * @param properties
141
     * @return
204
     * @param viewProperties
205
     *            View properties to link the
206
     *            <code>MapControlProperties3D</code>.
207
     * @param mapControl3DProperties
208
     *            The {@link MapControlProperties3D} to be linked.
209
     * @see View3DSwingManager#getMapControl3DProperties(ExtendedPropertiesSupport)
142 210
     */
143
    public GeneralProperties3DPanel createGeneralProperties3DPanel(
144
        GeneralProperties3D properties);
145
    
146
    public MapControlProperties3D getMapControl3DProperties(
147
        ExtendedPropertiesSupport viewProperties);
148
    
149 211
    public void setMapControlProperties3D(
150 212
        ExtendedPropertiesSupport viewProperties,
151 213
        MapControlProperties3D mapControl3DProperties);
152
    
153
    public GeneralProperties3D getGeneral3DProperties();
154
    
155
    public void setGeneral3DProperties(GeneralProperties3D properties);
156 214
}

Also available in: Unified diff