| gvSIG desktop 1

/* gvSIG. Sistema de Informaci?n Geogr?fica de la Generalitat Valenciana

 *

 * Copyright (C) 2005 IVER T.I. and Generalitat Valenciana.

 *

 * 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., 59 Temple Place - Suite 330, Boston, MA  02111-1307,USA.

 *

 * For more information, contact:

 *

 *  Generalitat Valenciana

 *   Conselleria d'Infraestructures i Transport

 *   Av. Blasco Ib??ez, 50

 *   46010 VALENCIA

 *   SPAIN

 *

 *      +34 963862235

 *   gvsig@gva.es

 *      www.gvsig.gva.es

 *

 *    or

 *

 *   IVER T.I. S.A

 *   Salamanca 50

 *   46005 Valencia

 *   Spain

 *

 *   +34 963163400

 *   dac@iver.es

 */

/* CVS MESSAGES:

 *

 * $Id: IPlacementConstraints.java 10671 2007-03-09 08:33:43Z jaume $

 * $Log$

 * Revision 1.2  2007-03-09 08:33:43  jaume

 * *** empty log message ***

 *

 * Revision 1.1.2.2  2007/02/15 16:23:44  jaume

 * *** empty log message ***

 *

 * Revision 1.1.2.1  2007/02/09 07:47:05  jaume

 * Isymbol moved

 *

 *

 */

package com.iver.cit.gvsig.fmap.rendering.styling;

import org.cresques.px.gml.MultiPolygon;

import com.iver.cit.gvsig.fmap.core.FShape;

import com.iver.cit.gvsig.fmap.core.IGeometry;

import com.iver.cit.gvsig.fmap.core.symbols.ITextSymbol;

/**

 * @author   jaume dominguez faus - jaume.dominguez@iver.es

 */

public interface IPlacementConstraints {

        // constants regarding label duplication

        public static final int REMOVE_DUPLICATE_LABELS = 2;

        public static final int ONE_LABEL_PER_FEATURE = 3;

        public static final int ONE_LABEL_PER_FEATURE_PART = 4;

        // constants regarding point settings

        public static final int OFFSET_HORIZONTALY_AROUND_THE_POINT = 5;

        public static final int ON_TOP_OF_THE_POINT = 6;

        public static final int AT_SPECIFIED_ANGLE = 7;

        public static final int AT_ANGLE_SPECIFIED_BY_A_FIELD = 8;

        // constants regarding polygon settings (also apply for lines)

        public static final int HORIZONTAL = 9;

        public static final int PARALLEL = 10;

        // constants regarding line settings

        public static final int FOLLOWING_LINE = 11;

        public static final int PERPENDICULAR = 12;

        // constants regarding label position along the line

        public static final int ABOVE_THE_LINE = 1000;

        public static final int ON_THE_LINE = 1100;

        public static final int BELLOW_THE_LINE = 1200;

        public abstract void setDuplicateLabelsMode(int mode);

        public abstract void setPlacementMode(int mode);

        public abstract boolean isHorizontal();

        public abstract boolean isPerpendicular();

        public abstract boolean isFollowingLine();

        public abstract boolean isParallel();

        public abstract int getDuplicateLabelsMode();

        /**

         * Calculates the position where the next label will be placed. Or null

         * if the label does not have to be placed.

         *

         * @param geom, the geometry surface

         * @param label, the label to be placed

         * @param MultiPolygon exclusionZone

         * @return FShape[], the FShapes where the label will be placed

         */

        public abstract FShape[] getLocationsFor(IGeometry geom, ITextSymbol label,

                        MultiPolygon exclusionZone);

}