Source Code Cross Referenced for ShadedRelief.java in  » GIS » GeoTools-2.4.1 » org » geotools » styling » Java Source Code / Java DocumentationJava Source Code and Java Documentation

01:        /*
02:         *    GeoTools - OpenSource mapping toolkit
03:         *    http://geotools.org
04:         *    (C) 2002-2006, GeoTools Project Managment Committee (PMC)
05:         *
06:         *    This library is free software; you can redistribute it and/or
07:         *    modify it under the terms of the GNU Lesser General Public
08:         *    License as published by the Free Software Foundation;
09:         *    version 2.1 of the License.
10:         *
11:         *    This library is distributed in the hope that it will be useful,
12:         *    but WITHOUT ANY WARRANTY; without even the implied warranty of
13:         *    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
14:         *    Lesser General Public License for more details.
15:         */
16:        package org.geotools.styling;
17:
18:        import org.opengis.filter.expression.Expression;
19:        import org.geotools.event.GTComponent;
20:
21:        /**
22:         * The ShadedRelief element selects the application of relief shading (or ?hill
23:         * shading?) to an image for a three-dimensional visual effect.  It is defined
24:         * as:
25:         * <pre>
26:         * &lt;xs:element name="ShadedRelief"&gt;
27:         *   &lt;xs:complexType&gt;
28:         *     &lt;xs:sequence&gt;
29:         *       &lt;xs:element ref="sld:BrightnessOnly" minOccurs="0"/&gt;
30:         *       &lt;xs:element ref="sld:ReliefFactor" minOccurs="0"/&gt;
31:         *     &lt;/xs:sequence&gt;
32:         *   &lt;/xs:complexType&gt;
33:         * &lt;/xs:element&gt;
34:         * &lt;xs:element name="BrightnessOnly" type="xs:boolean"/&gt;
35:         * &lt;xs:element name="ReliefFactor" type="xs:double"/&gt;
36:         * </pre>
37:         * Exact parameters of the shading are system-dependent (for now).  If the
38:         * BrightnessOnly flag is ?0? (false, default), the shading is applied to the
39:         * layer being rendered as the current RasterSymbol. If BrightnessOnly is ?1?
40:         * (true), the shading is applied to the brightness of the colors in the
41:         * rendering canvas generated so far by other layers, with the effect of
42:         * relief-shading these other layers. The default for BrightnessOnly is ?0?
43:         * (false).  The ReliefFactor gives the amount of exaggeration to use for the
44:         * height of the ?hills.?  A value of around 55 (times) gives reasonable
45:         * results for Earth-based DEMs. The default value is system-dependent.
46:         *
47:         * @author iant
48:         * @source $URL: http://svn.geotools.org/geotools/tags/2.4.1/modules/library/api/src/main/java/org/geotools/styling/ShadedRelief.java $
49:         */
50:        public interface ShadedRelief extends GTComponent {
51:            /**
52:             * turns brightnessOnly on or off depending on value of flag.
53:             *
54:             * @param flag boolean
55:             */
56:            public void setBrightnessOnly(boolean flag);
57:
58:            /**
59:             * indicates if brightnessOnly is true or false. Default is false.
60:             *
61:             * @return boolean brightnessOn.
62:             */
63:            public boolean isBrightnessOnly();
64:
65:            /**
66:             * The ReliefFactor gives the amount of exaggeration to use for the height
67:             * of the ?hills.?  A value of around 55 (times) gives reasonable results
68:             * for Earth-based DEMs. The default value is system-dependent.
69:             *
70:             * @param reliefFactor an expression which evaluates to a double.
71:             */
72:            public void setReliefFactor(Expression reliefFactor);
73:
74:            /**
75:             * The ReliefFactor gives the amount of exaggeration to use for the height
76:             * of the ?hills.?  A value of around 55 (times) gives reasonable results
77:             * for Earth-based DEMs. The default value is system-dependent.
78:             *
79:             * @return an expression which evaluates to a double.
80:             */
81:            public Expression getReliefFactor();
82:        }