org.integratedmodelling.api.space.ISpatialExtent Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of klab-api Show documentation
The newest version!
/*******************************************************************************
 *  Copyright (C) 2007, 2015:
 *  
 *    - Ferdinando Villa 
 *    - integratedmodelling.org
 *    - any other authors listed in @author annotations
 *
 *    All rights reserved. This file is part of the k.LAB software suite,
 *    meant to enable modular, collaborative, integrated 
 *    development of interoperable data and model components. For
 *    details, see http://integratedmodelling.org.
 *    
 *    This program is free software; you can redistribute it and/or
 *    modify it under the terms of the Affero General Public License 
 *    Version 3 or 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
 *    Affero General Public License for more details.
 *  
 *     You should have received a copy of the Affero General Public License
 *     along with this program; if not, write to the Free Software
 *     Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA  02111-1307, USA.
 *     The license is also available at: https://www.gnu.org/licenses/agpl.html
 *******************************************************************************/
package org.integratedmodelling.api.space;

import org.integratedmodelling.api.modelling.IExtent;

public interface ISpatialExtent extends IExtent {

    @Override
    ISpatialExtent getExtent();

    @Override
    ISpatialExtent getExtent(int stateIndex);

    /*
     * TODO currently, all spatial extents are locked into a 2D coordinate system, due to the internal state
     * of SpaceExtent and ShapeValue consisting of ReferencedEnvelope and Geometry objects. This should be loosened to allow for
     * n-dimensional space (1, 2, or 3). (extra dimensions would probably be outside the ISpatialExtent hierarchy)
     * @return 
     */
    double getMinX();

    double getMinY();

    double getMaxX();

    double getMaxY();

    /**
     * String code of coordinate reference system. Cannot be null in Thinklab.
     * 
     * @return crs code
     */
    String getCRSCode();

    /**
     * Return the grid topology if we are using one, or null.
     * 
     * @return the grid, or null
     */
    IGrid getGrid();

    /**
     * Return the tessellation topology if we are using one, or null.
     * 
     * @return tessellation
     */
    ITessellation getTessellation();

    /**
     * Get the geometric shape of this extent - usually it's the same as getExtent but
     * with the additional type constraint.
     * 
     * @return full shape
     */
    IShape getShape();

    /**
     * Return a spatial index capable of keeping track of other extents relative to
     * this one. Each extent can have an index stored in it, and may create new (empty)
     * ones as requested.
     * 
     * @param makeNew if true, create and return a new index for this extent. If false,
     *        return the stored index for the extent, creating it if necessary.
     * 
     * @return a spatial index set to our extent
     */
    ISpatialIndex getIndex(boolean makeNew);
}