Application: gvSIG desktop

/* gvSIG. Geographic Information System of the Valencian Government

*

* Copyright (C) 2007-2008 Infrastructures and Transports Department

* of the Valencian Government (CIT)

*

* This program is free software; you can redistribute it and/or

* modify it under the terms of the GNU General Public License

* as published by the Free Software Foundation; either version 2

* of the License, or (at your option) any later version.

*

* This program is distributed in the hope that it will be useful,

* but WITHOUT ANY WARRANTY; without even the implied warranty of

* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the

* GNU General Public License for more details.

*

* You should have received a copy of the GNU General Public License

* along with this program; if not, write to the Free Software

* Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston,

* MA  02110-1301, USA.

*

*/

/*

* AUTHORS (In addition to CIT):

* ${year} IVER T.I. S.A.   {{Task}}

*/

/* gvSIG. Geographic Information System of the Valencian Government

*

* Copyright (C) 2007-2008 Infrastructures and Transports Department

* of the Valencian Government (CIT)

*

* This program is free software; you can redistribute it and/or

* modify it under the terms of the GNU General Public License

* as published by the Free Software Foundation; either version 2

* of the License, or (at your option) any later version.

*

* This program is distributed in the hope that it will be useful,

* but WITHOUT ANY WARRANTY; without even the implied warranty of

* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the

* GNU General Public License for more details.

*

* You should have received a copy of the GNU General Public License

* along with this program; if not, write to the Free Software

* Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston,

* MA  02110-1301, USA.

*

*/

/*

* AUTHORS (In addition to CIT):

* ${year} IVER T.I. S.A.   {{Task}}

*/

package org.gvsig.fmap.geom.primitive;

import org.gvsig.fmap.geom.Geometry;

/**

 * A minimum bounding box or rectangle. Regardless of dimension, an Envelope

 * can be represented without ambiguity as two direct positions (coordinate

 * points). To encode an Envelope, it is sufficient to encode these two

 * points. This is consistent with all of the data types in this

 * specification, their state is represented by their publicly accessible

 * attributes.

 */

public interface Envelope {

    /**

     * Returns the center ordinate along the specified dimension.

     *

     * @param dimension DOCUMENT ME!

     *

     * @return DOCUMENT ME!

     */

    double getCenter(int dimension);

    /**

     * The length of coordinate sequence (the number of entries) in this

     * envelope.

     *

     * @return DOCUMENT ME!

     */

    int getDimension();

    /**

     * Returns the envelope length along the specified dimension.

     *

     * @param dimension

     *

     * @return

     */

    double getLength(int dimension);

    /**

     * A coordinate position consisting of all the minimal ordinates for each

     * dimension for all points within the Envelope.

     *

     * @return

     */

    double[] getLowerCorner();

    /**

     * Returns the maximal ordinate along the specified dimension.

     *

     * @param dimension

     *

     * @return

     */

    double getMaximum(int dimension);

    /**

     * Returns the minimal ordinate along the specified dimension.

     *

     * @param dimension

     *

     * @return

     */

    double getMinimum(int dimension);

    /**

     * A coordinate position consisting of all the maximal ordinates for each

     * dimension for all points within the Envelope.

     *

     * @return

     */

    double[] getUpperCorner();

        void add(Envelope boundsShp);

        Geometry getGeometry();

        boolean contains(Envelope envelope);

        boolean intersects(Envelope envelope);

}