/*
* GeoTools - The Open Source Java GIS Toolkit
* http://geotools.org
*
* (C) 2002-2008, Open Source Geospatial Foundation (OSGeo)
*
* This library is free software; you can redistribute it and/or
* modify it under the terms of the GNU Lesser General Public
* License as published by the Free Software Foundation;
* version 2.1 of the License.
*
* This library 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
* Lesser General Public License for more details.
*
*/
package org.geotools.styling;
import org.opengis.filter.expression.Expression;
/**
* A PointPlacement specifies how a text label is positioned relative to a
* geometric point.
*
* <p>
* The details of this object are taken from the <a
* href="https://portal.opengeospatial.org/files/?artifact_id=1188"> OGC
* Styled-Layer Descriptor Report (OGC 02-070) version 1.0.0.</a>:
* <pre><code>
* <xsd:element name="PointPlacement">
* <xsd:annotation>
* <xsd:documentation>
* A "PointPlacement" specifies how a text label should be rendered
* relative to a geometric point.
* </xsd:documentation>
* </xsd:annotation>
* <xsd:complexType>
* <xsd:sequence>
* <xsd:element ref="sld:AnchorPoint" minOccurs="0"/>
* <xsd:element ref="sld:Displacement" minOccurs="0"/>
* <xsd:element ref="sld:Rotation" minOccurs="0"/>
* </xsd:sequence>
* </xsd:complexType>
* </xsd:element>
* </code></pre>
* </p>
*
* <p>
* $Id$
* </p>
*
* @author Ian Turton
* @source $URL$
*/
public interface PointPlacement extends org.opengis.style.PointPlacement,LabelPlacement {
/**
* Returns the AnchorPoint which identifies the location inside a textlabel
* to use as an "anchor" for positioning it relative to a point geometry.
*
* @return acnchorPoint from the relative to the origional geometry
*/
AnchorPoint getAnchorPoint();
/**
* sets the AnchorPoint which identifies the location inside a textlabel to
* use as an "anchor" for positioning it relative to a point geometry.
* @param anchorPoint relative to the origional geometry
*/
void setAnchorPoint(org.opengis.style.AnchorPoint anchorPoint);
/**
* Returns the Displacement which gives X and Y offset displacements to use
* for rendering a text label near a point.
*
* @return Offset to use when rendering text near a point
*/
Displacement getDisplacement();
/**
* sets the Displacement which gives X and Y offset displacements to use
* for rendering a text label near a point.
*/
void setDisplacement(org.opengis.style.Displacement displacement);
/**
* Returns the rotation of the label.
*
* @return rotation of the label as a dynamic expression
*/
Expression getRotation();
/**
* sets the rotation of the label.
*
* Sets the rotation of the label.
* @param rotation
*/
void setRotation(Expression rotation);
}