Application: gvSIG desktop » gvSIG 3D

package org.gvsig.animation3d.swing.api;

import java.util.List;

import java.util.Map;

import org.gvsig.fmap.geom.primitive.Point;

import org.gvsig.fmap.mapcontext.layers.ExtendedPropertiesSupport;

import org.gvsig.view3d.swing.api.MapControl3D;

/**

 * 

 * @author <a href="mailto:lmarques@disid.com">Lluis Marques</a>

 *

 */

public interface Animation3DSwingManager {

    /**

     * Creates a new {@link Frame3D}.

     * 

     * @param name

     * @param heading

     * @param pitch

     * @param elevation

     * @param position

     * @param zoom

     * @return New {@link Frame3D}.

     */

    public Frame3D createFrame3D(String name, double heading, double pitch, double elevation,

        Point position, double zoom);

    /**

     * 

     * @param name

     * @param mapControl3D

     * @return frame3d

     * @throws Frame3DCreationException

     */

    public Frame3D createFrame3D(String name, MapControl3D mapControl3D)

        throws Frame3DCreationException;

    /**

     * Creates new instance of {@link Animation3D} with name and {@link Frame3D}

     * list.

     * 

     * @param name

     *            Name of animation

     * @param sphericalFrames

     *            List of spherical frames

     * @param flatFrames

     *            List of flat frames

     * @return New {@link Animation3D}.

     */

    public Animation3D createAnimation3D(String name, List<Frame3D> sphericalFrames,

        List<Frame3D> flatFrames);

    /**

     * Gets animations associated with the properties. If properties does not

     * have animations, it will be initialized with an empty list.

     * 

     * @param properties

     *            Properties to get animations.

     * @return Animations of properties.

     */

    public List<Animation3D> getAnimations(ExtendedPropertiesSupport properties);

    /**

     * Sets list animations to properties.

     * 

     * @param properties

     *            Properties to link with animations.

     * @param animations

     *            Animation list.

     */

    public void setAnimations(ExtendedPropertiesSupport properties, List<Animation3D> animations);

    /**

     * Creates an animation panel to manager view 3D animations

     * 

     * @param properties

     * 

     * @return An instance of Animation panel

     */

    public Animation3DPanel createAnimationPanel(Map<String, ExtendedPropertiesSupport> properties);

    /**

     * 

     * @param mapControl3D

     * @param frame

     * @param minMillis

     * @param maxMillis

     * @return animator

     */

    public Animator createGoToAnimator(MapControl3D mapControl3D, Frame3D frame,

        final long minMillis, final long maxMillis);

    /**

     * 

     * @param mapControl3D

     * @param frames

     * @param minMillis

     * @param maxMillis

     * @return animator

     */

    public Animator createGoToAnimator(MapControl3D mapControl3D, List<Frame3D> frames,

        final long minMillis, final long maxMillis);

    /**

     * 

     * @param mapControl3D

     * @param goToAnimator

     */

    public void addAnimator(MapControl3D mapControl3D, Animator goToAnimator);

    /**

     * 

     * @param mapControl3D

     */

    public void stopAnimations(MapControl3D mapControl3D);

    /**

     * 

     * @param mapControl3D

     * @return boolean

     */

    public boolean isAnimating(MapControl3D mapControl3D);

}