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

View differences:

View3DSwingManager.java
31 31
 *
32 32
 */
33 33
public interface View3DSwingManager {
34
    
35
    public enum TYPE{ SPHERE,FLAT }
36
    
34

  
35
    public enum TYPE {
36
        SPHERE, FLAT
37
    }
38

  
37 39
    /**
40
     * Creates a <code>View3DPanel</code> with a {@link MapControl3D}.
38 41
     * 
39 42
     * @param theMapContext
43
     *            associated <code>MapContext</code> of
44
     *            <code>MapControl3D</code>
40 45
     * @param type
46
     *            Type of <code>MapControl3D</code>. See {@link TYPE}.
47
     * @see View3DSwingManager#createMapControl3D(MapContext, TYPE)
41 48
     * @return
42 49
     */
43 50
    public View3DPanel createView3DPanel(MapContext theMapContext, TYPE type);
44
    
51

  
45 52
    /**
53
     * Registers and creatres a <code>MapControl3D</code> as from
54
     * {@link MapContext} {@link TYPE}. When an {@link MapControl3D} is created,
55
     * it automatically adds all available and visible layers of
56
     * <code>MapControl</code>.
46 57
     * 
47 58
     * @param theMapContext
59
     *            associated <code>MapContext</code> of
60
     *            <code>MapControl3D</code>
48 61
     * @param type
49
     * @return
62
     *            Type of <code>MapControl3D</code>. See {@link TYPE}.
63
     * @return an instance of <code>MapControl3D</code> ready to be shown.
50 64
     */
51 65
    public MapControl3D createMapControl3D(MapContext theMapContext, TYPE type);
52
    
66

  
53 67
    /**
68
     * Gets the {@link MapControl3D} registered with {@link MapContext} and
69
     * {@link TYPE} received as paremeter.
70
     * Returns <code>null</code> if there is no intance registered with that
71
     * <code>MapContext</code> and <code>TYPE</code>.
54 72
     * 
55 73
     * @param theMapContext
74
     *            associated <code>MapContext</code> of
75
     *            <code>MapControl3D</code>
56 76
     * @param type
57
     * @return
77
     *            Type of <code>MapControl3D</code>. See {@link TYPE}.
78
     * @return Intance registered with <code>MapContext</code> and
79
     *         <code>TYPE</code>, if there is no intance registered
80
     *         <code> null </code>
58 81
     */
59 82
    public MapControl3D getMapControl3D(MapContext theMapContext, TYPE type);
60
    
61
    
62
    //TODO: Add methods to get properties panels.
63
    
83

  
84
    // TODO: Add methods to get properties panels.
85

  
64 86
}

Also available in: Unified diff