blob: ea8a155e78655bfe4a57225a4a395ea1a1a7d96c [file] [log] [blame]
<!DOCTYPE HTML>
<html lang="en">
<head>
<!-- Generated by javadoc (21) on Thu Oct 05 19:54:57 CEST 2023 -->
<title>PlanarCanvas (Apache SIS 1.4 API)</title>
<meta name="viewport" content="width=device-width, initial-scale=1">
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<meta name="dc.created" content="2023-10-05">
<meta name="description" content="declaration: module: org.apache.sis.portrayal, package: org.apache.sis.portrayal, class: PlanarCanvas">
<meta name="generator" content="javadoc/ClassWriterImpl">
<meta name="keywords" content="org.apache.sis.portrayal.PlanarCanvas class">
<meta name="keywords" content="BIDIMENSIONAL">
<meta name="keywords" content="objectiveToDisplay">
<meta name="keywords" content="getDisplayBounds()">
<meta name="keywords" content="transformObjectiveCoordinates()">
<meta name="keywords" content="transformDisplayCoordinates()">
<link rel="stylesheet" type="text/css" href="../../../../../stylesheet.css" title="Style">
<link rel="stylesheet" type="text/css" href="../../../../../sis.css" title="Style">
<link rel="stylesheet" type="text/css" href="../../../../../script-dir/jquery-ui.min.css" title="Style">
<script type="text/javascript" src="../../../../../script.js"></script>
<script type="text/javascript" src="../../../../../script-dir/jquery-3.6.1.min.js"></script>
<script type="text/javascript" src="../../../../../script-dir/jquery-ui.min.js"></script>
</head>
<body class="class-declaration-page">
<script type="text/javascript">var pathtoroot = "../../../../../";
loadScripts(document, 'script');</script>
<noscript>
<div>JavaScript is disabled on your browser.</div>
</noscript>
<div class="flex-box">
<header role="banner" class="flex-header">
<nav role="navigation">
<!-- ========= START OF TOP NAVBAR ======= -->
<div class="top-nav" id="navbar-top"><button id="navbar-toggle-button" aria-controls="navbar-top" aria-expanded="false" aria-label="Toggle navigation links"><span class="nav-bar-toggle-icon">&nbsp;</span><span class="nav-bar-toggle-icon">&nbsp;</span><span class="nav-bar-toggle-icon">&nbsp;</span></button>
<div class="skip-nav"><a href="#skip-navbar-top" title="Skip navigation links">Skip navigation links</a></div>
<ul id="navbar-top-firstrow" class="nav-list" title="Navigation">
<li><a href="../../../../../index.html">Overview</a></li>
<li><a href="../../../../module-summary.html">Module</a></li>
<li><a href="package-summary.html">Package</a></li>
<li class="nav-bar-cell1-rev">Class</li>
<li><a href="package-tree.html">Tree</a></li>
<li><a href="../../../../../deprecated-list.html">Deprecated</a></li>
<li><a href="../../../../../index-all.html">Index</a></li>
<li><a href="../../../../../help-doc.html#class">Help</a></li>
</ul>
<ul class="sub-nav-list-small">
<li>
<p>Summary:</p>
<ul>
<li>Nested</li>
<li><a href="#field-summary">Field</a></li>
<li><a href="#constructor-summary">Constr</a></li>
<li><a href="#method-summary">Method</a></li>
</ul>
</li>
<li>
<p>Detail:</p>
<ul>
<li><a href="#field-detail">Field</a></li>
<li><a href="#constructor-detail">Constr</a></li>
<li><a href="#method-detail">Method</a></li>
</ul>
</li>
</ul>
</div>
<div class="sub-nav">
<div id="navbar-sub-list">
<ul class="sub-nav-list">
<li>Summary:&nbsp;</li>
<li>Nested&nbsp;|&nbsp;</li>
<li><a href="#field-summary">Field</a>&nbsp;|&nbsp;</li>
<li><a href="#constructor-summary">Constr</a>&nbsp;|&nbsp;</li>
<li><a href="#method-summary">Method</a></li>
</ul>
<ul class="sub-nav-list">
<li>Detail:&nbsp;</li>
<li><a href="#field-detail">Field</a>&nbsp;|&nbsp;</li>
<li><a href="#constructor-detail">Constr</a>&nbsp;|&nbsp;</li>
<li><a href="#method-detail">Method</a></li>
</ul>
</div>
<div class="nav-list-search"><a href="../../../../../search.html">SEARCH</a>
<input type="text" id="search-input" disabled placeholder="Search">
<input type="reset" id="reset-button" disabled value="reset">
</div>
</div>
<!-- ========= END OF TOP NAVBAR ========= -->
<span class="skip-nav" id="skip-navbar-top"></span></nav>
</header>
<div class="flex-content">
<main role="main">
<!-- ======== START OF CLASS DATA ======== -->
<div class="header">
<div class="sub-title"><span class="module-label-in-type">Module</span>&nbsp;<a href="../../../../module-summary.html">org.apache.sis.portrayal</a></div>
<div class="sub-title"><span class="package-label-in-type">Package</span>&nbsp;<a href="package-summary.html">org.apache.sis.portrayal</a></div>
<h1 title="Class PlanarCanvas" class="title">Class PlanarCanvas</h1>
</div>
<div class="inheritance" title="Inheritance Tree"><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html" title="class or interface in java.lang" class="external-link">Object</a>
<div class="inheritance"><a href="Canvas.html" title="class in org.apache.sis.portrayal">Canvas</a>
<div class="inheritance">PlanarCanvas</div>
</div>
</div>
<section class="class-description" id="class-description">
<dl class="notes">
<dt>All Implemented Interfaces:</dt>
<dd><code><a href="../../../../../org.apache.sis.util/org/apache/sis/util/Localized.html" title="interface in org.apache.sis.util">Localized</a></code></dd>
</dl>
<dl class="notes">
<dt>Direct Known Subclasses:</dt>
<dd><code><a href="../../../../../org.apache.sis.gui/org/apache/sis/gui/map/MapCanvas.html" title="class in org.apache.sis.gui.map">Map­Canvas</a></code></dd>
</dl>
<hr>
<div class="type-signature"><span class="modifiers">public abstract class </span><span class="element-name type-name-label">PlanarCanvas</span>
<span class="extends-implements">extends <a href="Canvas.html" title="class in org.apache.sis.portrayal">Canvas</a></span></div>
<div class="block">A canvas for two-dimensional display device using a Cartesian coordinate system.
Data are reduced to a two-dimensional slice before to be displayed.
<h2 id="multi-threading-heading">Multi-threading</h2>
<code>Planar­Canvas</code> is not thread-safe. Synchronization, if desired, must be done by the caller.
Another common strategy is to interact with <code>Planar­Canvas</code> from a single thread,
for example the Swing or JavaFX event queue.</div>
<dl class="notes">
<dt>Since:</dt>
<dd>1.1</dd>
</dl>
</section>
<section class="summary">
<ul class="summary-list">
<!-- =========== FIELD SUMMARY =========== -->
<li>
<section class="field-summary" id="field-summary">
<h2>Field Summary</h2>
<div class="caption"><span>Fields</span></div>
<div class="summary-table three-column-summary">
<div class="table-header col-first">Modifier and Type</div>
<div class="table-header col-second">Field</div>
<div class="table-header col-last">Description</div>
<div class="col-first even-row-color"><code>protected static final int</code></div>
<div class="col-second even-row-color"><code><a href="#BIDIMENSIONAL" class="member-name-link">BIDIMENSIONAL</a></code></div>
<div class="col-last even-row-color">
<div class="block">The 2 constant for identifying code specific to bi-dimensional case.</div>
</div>
<div class="col-first odd-row-color"><code>protected final <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.desktop/java/awt/geom/AffineTransform.html" title="class or interface in java.awt.geom" class="external-link">Affine­Transform</a></code></div>
<div class="col-second odd-row-color"><code><a href="#objectiveToDisplay" class="member-name-link">objective­To­Display</a></code></div>
<div class="col-last odd-row-color">
<div class="block">The conversion from <a href="Canvas.html#getObjectiveCRS()">objective CRS</a> to the display coordinate system as a
Java2D affine transform.</div>
</div>
</div>
<div class="inherited-list">
<h3 id="fields-inherited-from-class-Canvas">Fields inherited from class&nbsp;<a href="Canvas.html" title="class in org.apache.sis.portrayal">Canvas</a></h3>
<code><a href="Canvas.html#DISPLAY_BOUNDS_PROPERTY">DISPLAY_BOUNDS_PROPERTY</a>, <a href="Canvas.html#OBJECTIVE_CRS_PROPERTY">OBJECTIVE_CRS_PROPERTY</a>, <a href="Canvas.html#OBJECTIVE_TO_DISPLAY_PROPERTY">OBJECTIVE_TO_DISPLAY_PROPERTY</a>, <a href="Canvas.html#POINT_OF_INTEREST_PROPERTY">POINT_OF_INTEREST_PROPERTY</a></code></div>
</section>
</li>
<!-- ======== CONSTRUCTOR SUMMARY ======== -->
<li>
<section class="constructor-summary" id="constructor-summary">
<h2>Constructor Summary</h2>
<div class="caption"><span>Constructors</span></div>
<div class="summary-table three-column-summary">
<div class="table-header col-first">Modifier</div>
<div class="table-header col-second">Constructor</div>
<div class="table-header col-last">Description</div>
<div class="col-first even-row-color"><code>protected </code></div>
<div class="col-constructor-name even-row-color"><code><a href="#%3Cinit%3E(java.util.Locale)" class="member-name-link">Planar­Canvas</a><wbr>(<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/util/Locale.html" title="class or interface in java.util" class="external-link">Locale</a>&nbsp;locale)</code></div>
<div class="col-last even-row-color">
<div class="block">Creates a new two-dimensional canvas.</div>
</div>
</div>
</section>
</li>
<!-- ========== METHOD SUMMARY =========== -->
<li>
<section class="method-summary" id="method-summary">
<h2>Method Summary</h2>
<div id="method-summary-table">
<div class="table-tabs" role="tablist" aria-orientation="horizontal"><button id="method-summary-table-tab0" role="tab" aria-selected="true" aria-controls="method-summary-table.tabpanel" tabindex="0" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table', 3)" class="active-table-tab">All Methods</button><button id="method-summary-table-tab2" role="tab" aria-selected="false" aria-controls="method-summary-table.tabpanel" tabindex="-1" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table-tab2', 3)" class="table-tab">Instance Methods</button><button id="method-summary-table-tab4" role="tab" aria-selected="false" aria-controls="method-summary-table.tabpanel" tabindex="-1" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table-tab4', 3)" class="table-tab">Concrete Methods</button></div>
<div id="method-summary-table.tabpanel" role="tabpanel">
<div class="summary-table three-column-summary" aria-labelledby="method-summary-table-tab0">
<div class="table-header col-first">Modifier and Type</div>
<div class="table-header col-second">Method</div>
<div class="table-header col-last">Description</div>
<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>final void</code></div>
<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#addPropertyChangeListener(java.lang.String,java.beans.PropertyChangeListener)" class="member-name-link">add­Property­Change­Listener</a><wbr>(<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a>&nbsp;property­Name,
<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.desktop/java/beans/PropertyChangeListener.html" title="class or interface in java.beans" class="external-link">Property­Change­Listener</a>&nbsp;listener)</code></div>
<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">
<div class="block">Registers a listener for the property of the given name.</div>
</div>
<div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>protected void</code></div>
<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#firePropertyChange(java.beans.PropertyChangeEvent)" class="member-name-link">fire­Property­Change</a><wbr>(<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.desktop/java/beans/PropertyChangeEvent.html" title="class or interface in java.beans" class="external-link">Property­Change­Event</a>&nbsp;event)</code></div>
<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">
<div class="block">Notifies all registered listeners that a property changed its value.</div>
</div>
<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>protected void</code></div>
<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#firePropertyChange(java.lang.String,java.lang.Object,java.lang.Object)" class="member-name-link">fire­Property­Change</a><wbr>(<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a>&nbsp;property­Name,
<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html" title="class or interface in java.lang" class="external-link">Object</a>&nbsp;old­Value,
<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html" title="class or interface in java.lang" class="external-link">Object</a>&nbsp;new­Value)</code></div>
<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">
<div class="block">Notifies all registered listeners that a property of the given name changed its value.</div>
</div>
<div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="../../../../../org.apache.sis.referencing/org/apache/sis/geometry/Envelope2D.html" title="class in org.apache.sis.geometry">Envelope2D</a></code></div>
<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getDisplayBounds()" class="member-name-link">get­Display­Bounds</a>()</code></div>
<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">
<div class="block">Returns the size and location of the display device.</div>
</div>
<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>protected final boolean</code></div>
<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#hasPropertyChangeListener(java.lang.String)" class="member-name-link">has­Property­Change­Listener</a><wbr>(<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a>&nbsp;property­Name)</code></div>
<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">
<div class="block">Returns <code>true</code> if the given property has at least one listener.</div>
</div>
<div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>final void</code></div>
<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#removePropertyChangeListener(java.lang.String,java.beans.PropertyChangeListener)" class="member-name-link">remove­Property­Change­Listener</a><wbr>(<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a>&nbsp;property­Name,
<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.desktop/java/beans/PropertyChangeListener.html" title="class or interface in java.beans" class="external-link">Property­Change­Listener</a>&nbsp;listener)</code></div>
<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">
<div class="block">Unregisters a property listener.</div>
</div>
<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>void</code></div>
<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#transformDisplayCoordinates(java.awt.geom.AffineTransform)" class="member-name-link">transform­Display­Coordinates</a><wbr>(<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.desktop/java/awt/geom/AffineTransform.html" title="class or interface in java.awt.geom" class="external-link">Affine­Transform</a>&nbsp;after)</code></div>
<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">
<div class="block">Updates the <cite>objective to display</cite> transform as if the given transform was applied <em>after</em>
the current transform.</div>
</div>
<div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>void</code></div>
<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#transformObjectiveCoordinates(java.awt.geom.AffineTransform)" class="member-name-link">transform­Objective­Coordinates</a><wbr>(<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.desktop/java/awt/geom/AffineTransform.html" title="class or interface in java.awt.geom" class="external-link">Affine­Transform</a>&nbsp;before)</code></div>
<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">
<div class="block">Updates the <cite>objective to display</cite> transform as if the given transform was applied <em>before</em>
the current transform.</div>
</div>
</div>
</div>
</div>
<div class="inherited-list">
<h3 id="methods-inherited-from-class-Canvas">Methods inherited from class&nbsp;<a href="Canvas.html" title="class in org.apache.sis.portrayal">Canvas</a></h3>
<code><a href="Canvas.html#getDisplayCRS()">get­Display­CRS</a>, <a href="Canvas.html#getGeographicArea()">get­Geographic­Area</a>, <a href="Canvas.html#getGridGeometry()">get­Grid­Geometry</a>, <a href="Canvas.html#getLocale()">get­Locale</a>, <a href="Canvas.html#getObjectiveCRS()">get­Objective­CRS</a>, <a href="Canvas.html#getObjectiveToDisplay()">get­Objective­To­Display</a>, <a href="Canvas.html#getPointOfInterest(boolean)">get­Point­Of­Interest</a>, <a href="Canvas.html#getSpatialResolution()">get­Spatial­Resolution</a>, <a href="Canvas.html#setDisplayBounds(org.opengis.geometry.Envelope)">set­Display­Bounds</a>, <a href="Canvas.html#setGridGeometry(org.apache.sis.coverage.grid.GridGeometry)">set­Grid­Geometry</a>, <a href="Canvas.html#setObjectiveCRS(org.opengis.referencing.crs.CoordinateReferenceSystem,org.opengis.geometry.DirectPosition)">set­Objective­CRS</a>, <a href="Canvas.html#setObjectiveToDisplay(org.apache.sis.referencing.operation.transform.LinearTransform)">set­Objective­To­Display</a>, <a href="Canvas.html#setPointOfInterest(org.opengis.geometry.DirectPosition)">set­Point­Of­Interest</a></code></div>
<div class="inherited-list">
<h3 id="methods-inherited-from-class-Object">Methods inherited from class&nbsp;<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html" title="class or interface in java.lang" class="external-link">Object</a></h3>
<code><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html#clone()" title="class or interface in java.lang" class="external-link">clone</a>, <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html#equals(java.lang.Object)" title="class or interface in java.lang" class="external-link">equals</a>, <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html#finalize()" title="class or interface in java.lang" class="external-link">finalize</a>, <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html#getClass()" title="class or interface in java.lang" class="external-link">get­Class</a>, <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html#hashCode()" title="class or interface in java.lang" class="external-link">hash­Code</a>, <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html#notify()" title="class or interface in java.lang" class="external-link">notify</a>, <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html#notifyAll()" title="class or interface in java.lang" class="external-link">notify­All</a>, <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html#toString()" title="class or interface in java.lang" class="external-link">to­String</a>, <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html#wait()" title="class or interface in java.lang" class="external-link">wait</a>, <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html#wait(long)" title="class or interface in java.lang" class="external-link">wait</a>, <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html#wait(long,int)" title="class or interface in java.lang" class="external-link">wait</a></code></div>
</section>
</li>
</ul>
</section>
<section class="details">
<ul class="details-list">
<!-- ============ FIELD DETAIL =========== -->
<li>
<section class="field-details" id="field-detail">
<h2>Field Details</h2>
<ul class="member-list">
<li>
<section class="detail" id="BIDIMENSIONAL">
<h3>BIDIMENSIONAL</h3>
<div class="member-signature"><span class="modifiers">protected static final</span>&nbsp;<span class="return-type">int</span>&nbsp;<span class="element-name">BIDIMENSIONAL</span></div>
<div class="block">The 2 constant for identifying code specific to bi-dimensional case.</div>
<dl class="notes">
<dt>See Also:</dt>
<dd>
<ul class="tag-list">
<li><a href="../../../../../constant-values.html#org.apache.sis.portrayal.PlanarCanvas.BIDIMENSIONAL">Constant Field Values</a></li>
</ul>
</dd>
</dl>
</section>
</li>
<li>
<section class="detail" id="objectiveToDisplay">
<h3>objectiveToDisplay</h3>
<div class="member-signature"><span class="modifiers">protected final</span>&nbsp;<span class="return-type"><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.desktop/java/awt/geom/AffineTransform.html" title="class or interface in java.awt.geom" class="external-link">AffineTransform</a></span>&nbsp;<span class="element-name">objectiveToDisplay</span></div>
<div class="block">The conversion from <a href="Canvas.html#getObjectiveCRS()">objective CRS</a> to the display coordinate system as a
Java2D affine transform. This transform will be modified in-place when user applies zoom, translation or
rotation on the view area. Subclasses should generally not modify this affine transform directly; invoke
one of the <code>transform<var>Foo</var>Coordinates(Affine­Transform)</code> methods instead.</div>
<dl class="notes">
<dt>See Also:</dt>
<dd>
<ul class="tag-list-long">
<li><a href="Canvas.html#getObjectiveToDisplay()"><code>Canvas​.get­Objective­To­Display()</code></a></li>
<li><a href="#transformObjectiveCoordinates(java.awt.geom.AffineTransform)"><code>transform­Objective­Coordinates(Affine­Transform)</code></a></li>
<li><a href="#transformDisplayCoordinates(java.awt.geom.AffineTransform)"><code>transform­Display­Coordinates(Affine­Transform)</code></a></li>
</ul>
</dd>
</dl>
</section>
</li>
</ul>
</section>
</li>
<!-- ========= CONSTRUCTOR DETAIL ======== -->
<li>
<section class="constructor-details" id="constructor-detail">
<h2>Constructor Details</h2>
<ul class="member-list">
<li>
<section class="detail" id="&lt;init&gt;(java.util.Locale)">
<h3>PlanarCanvas</h3>
<div class="member-signature"><span class="modifiers">protected</span>&nbsp;<span class="element-name">PlanarCanvas</span><wbr><span class="parameters">(<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/util/Locale.html" title="class or interface in java.util" class="external-link">Locale</a>&nbsp;locale)</span></div>
<div class="block">Creates a new two-dimensional canvas.</div>
<dl class="notes">
<dt>Parameters:</dt>
<dd><code>locale</code> - the locale to use for labels and some messages, or <code>null</code> for default.</dd>
</dl>
</section>
</li>
</ul>
</section>
</li>
<!-- ============ METHOD DETAIL ========== -->
<li>
<section class="method-details" id="method-detail">
<h2>Method Details</h2>
<ul class="member-list">
<li>
<section class="detail" id="getDisplayBounds()">
<h3>getDisplayBounds</h3>
<div class="member-signature"><span class="modifiers">public</span>&nbsp;<span class="return-type"><a href="../../../../../org.apache.sis.referencing/org/apache/sis/geometry/Envelope2D.html" title="class in org.apache.sis.geometry">Envelope2D</a></span>&nbsp;<span class="element-name">getDisplayBounds</span>()</div>
<div class="block">Returns the size and location of the display device. The unit of measurement is
<a href="../../../../../org.apache.sis.util/org/apache/sis/measure/Units.html#PIXEL"><code>Units​.PIXEL</code></a> and coordinate values are usually (but not necessarily) integers.
<p>This value may be <code>null</code> on newly created <code>Canvas</code>, before data are added and canvas
is configured. It should not be <code>null</code> anymore once a <code>Canvas</code> is ready for displaying.
The returned envelope is a copy; display changes happening after this method invocation will not be
reflected in the returned envelope.</p></div>
<dl class="notes">
<dt>Overrides:</dt>
<dd><code><a href="Canvas.html#getDisplayBounds()">get­Display­Bounds</a></code>&nbsp;in class&nbsp;<code><a href="Canvas.html" title="class in org.apache.sis.portrayal">Canvas</a></code></dd>
<dt>Returns:</dt>
<dd>size and location of the display device in pixel coordinates.</dd>
<dt>See Also:</dt>
<dd>
<ul class="tag-list-long">
<li><a href="Canvas.html#setDisplayBounds(org.opengis.geometry.Envelope)"><code>Canvas​.set­Display­Bounds(Envelope)</code></a></li>
</ul>
</dd>
</dl>
</section>
</li>
<li>
<section class="detail" id="transformObjectiveCoordinates(java.awt.geom.AffineTransform)">
<h3>transformObjectiveCoordinates</h3>
<div class="member-signature"><span class="modifiers">public</span>&nbsp;<span class="return-type">void</span>&nbsp;<span class="element-name">transformObjectiveCoordinates</span><wbr><span class="parameters">(<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.desktop/java/awt/geom/AffineTransform.html" title="class or interface in java.awt.geom" class="external-link">AffineTransform</a>&nbsp;before)</span></div>
<div class="block">Updates the <cite>objective to display</cite> transform as if the given transform was applied <em>before</em>
the current transform. For example if the given <code>before</code> transform is a translation, then the translation
vector is in units of the <a href="Canvas.html#getObjectiveCRS()">objective CRS</a> (typically metres on the map).
<p>This method does nothing if the given transform is identity.
Otherwise an <a href="Canvas.html#OBJECTIVE_TO_DISPLAY_PROPERTY">"objectiveToDisplay"</a> property change event will be sent with the
<a href="TransformChangeEvent.Reason.html#OBJECTIVE_NAVIGATION"><code>Transform­Change­Event​.Reason​.OBJECTIVE_NAVIGATION</code></a> reason after the change became effective.
Depending on the implementation, the change may not take effect immediately.
For example, subclasses may do the rendering in a background thread.</p></div>
<dl class="notes">
<dt>Parameters:</dt>
<dd><code>before</code> - coordinate conversion to apply before the current <cite>objective to display</cite> transform.</dd>
<dt>See Also:</dt>
<dd>
<ul class="tag-list-long">
<li><a href="TransformChangeEvent.html#getObjectiveChange()"><code>Transform­Change­Event​.get­Objective­Change()</code></a></li>
</ul>
</dd>
</dl>
</section>
</li>
<li>
<section class="detail" id="transformDisplayCoordinates(java.awt.geom.AffineTransform)">
<h3>transformDisplayCoordinates</h3>
<div class="member-signature"><span class="modifiers">public</span>&nbsp;<span class="return-type">void</span>&nbsp;<span class="element-name">transformDisplayCoordinates</span><wbr><span class="parameters">(<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.desktop/java/awt/geom/AffineTransform.html" title="class or interface in java.awt.geom" class="external-link">AffineTransform</a>&nbsp;after)</span></div>
<div class="block">Updates the <cite>objective to display</cite> transform as if the given transform was applied <em>after</em>
the current transform. For example if the given <code>after</code> transform is a translation, then the translation
vector is in pixel units.
<p>This method does nothing if the given transform is identity.
Otherwise an <a href="Canvas.html#OBJECTIVE_TO_DISPLAY_PROPERTY">"objectiveToDisplay"</a> property change event will be sent with the
<a href="TransformChangeEvent.Reason.html#DISPLAY_NAVIGATION"><code>Transform­Change­Event​.Reason​.DISPLAY_NAVIGATION</code></a> reason after the change became effective.
Depending on the implementation, the change may not take effect immediately.
For example, subclasses may do the rendering in a background thread.</p></div>
<dl class="notes">
<dt>Parameters:</dt>
<dd><code>after</code> - coordinate conversion to apply after the current <cite>objective to display</cite> transform.</dd>
<dt>See Also:</dt>
<dd>
<ul class="tag-list-long">
<li><a href="TransformChangeEvent.html#getDisplayChange()"><code>Transform­Change­Event​.get­Display­Change()</code></a></li>
</ul>
</dd>
</dl>
</section>
</li>
<li>
<section class="detail" id="addPropertyChangeListener(java.lang.String,java.beans.PropertyChangeListener)">
<h3>addPropertyChangeListener</h3>
<div class="member-signature"><span class="modifiers">public final</span>&nbsp;<span class="return-type">void</span>&nbsp;<span class="element-name">addPropertyChangeListener</span><wbr><span class="parameters">(<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a>&nbsp;propertyName,
<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.desktop/java/beans/PropertyChangeListener.html" title="class or interface in java.beans" class="external-link">PropertyChangeListener</a>&nbsp;listener)</span></div>
<div class="block">Registers a listener for the property of the given name.
The listener will be notified every time that the property of the given name got a new value.
If the same listener is registered twice for the same property, then it will be notified twice
(this method does not perform duplication checks).</div>
<dl class="notes">
<dt>Parameters:</dt>
<dd><code>property­Name</code> - name of the property to listen (should be one of the <code>*_PROPERTY</code> constants).</dd>
<dd><code>listener</code> - property listener to register.</dd>
</dl>
</section>
</li>
<li>
<section class="detail" id="removePropertyChangeListener(java.lang.String,java.beans.PropertyChangeListener)">
<h3>removePropertyChangeListener</h3>
<div class="member-signature"><span class="modifiers">public final</span>&nbsp;<span class="return-type">void</span>&nbsp;<span class="element-name">removePropertyChangeListener</span><wbr><span class="parameters">(<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a>&nbsp;propertyName,
<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.desktop/java/beans/PropertyChangeListener.html" title="class or interface in java.beans" class="external-link">PropertyChangeListener</a>&nbsp;listener)</span></div>
<div class="block">Unregisters a property listener. The given <code>property­Name</code> should be the name used during
<a href="#addPropertyChangeListener(java.lang.String,java.beans.PropertyChangeListener)">listener registration</a>.
If the specified listener is not registered for the named property, then nothing happen.
If the listener has been registered twice, then only one registration is removed
(one registration will remain).</div>
<dl class="notes">
<dt>Parameters:</dt>
<dd><code>property­Name</code> - name of the listened property.</dd>
<dd><code>listener</code> - property listener to unregister.</dd>
</dl>
</section>
</li>
<li>
<section class="detail" id="hasPropertyChangeListener(java.lang.String)">
<h3>hasPropertyChangeListener</h3>
<div class="member-signature"><span class="modifiers">protected final</span>&nbsp;<span class="return-type">boolean</span>&nbsp;<span class="element-name">hasPropertyChangeListener</span><wbr><span class="parameters">(<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a>&nbsp;propertyName)</span></div>
<div class="block">Returns <code>true</code> if the given property has at least one listener.</div>
<dl class="notes">
<dt>Parameters:</dt>
<dd><code>property­Name</code> - name of the property to test.</dd>
<dt>Returns:</dt>
<dd><code>true</code> if the given property has at least one listener.</dd>
</dl>
</section>
</li>
<li>
<section class="detail" id="firePropertyChange(java.lang.String,java.lang.Object,java.lang.Object)">
<h3>firePropertyChange</h3>
<div class="member-signature"><span class="modifiers">protected</span>&nbsp;<span class="return-type">void</span>&nbsp;<span class="element-name">firePropertyChange</span><wbr><span class="parameters">(<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a>&nbsp;propertyName,
<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html" title="class or interface in java.lang" class="external-link">Object</a>&nbsp;oldValue,
<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html" title="class or interface in java.lang" class="external-link">Object</a>&nbsp;newValue)</span></div>
<div class="block">Notifies all registered listeners that a property of the given name changed its value.
The <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/util/EventObject.html#getSource()" title="class or interface in java.util" class="external-link">change event source</a> will be <code>this</code>.
It is caller responsibility to verify that the old and new values are different
(this method does not check for equality).</div>
<dl class="notes">
<dt>Parameters:</dt>
<dd><code>property­Name</code> - name of the property that changed its value.</dd>
<dd><code>old­Value</code> - the old property value (may be <code>null</code>).</dd>
<dd><code>new­Value</code> - the new property value (may be <code>null</code>).</dd>
<dt>See Also:</dt>
<dd>
<ul class="tag-list">
<li><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.desktop/java/beans/PropertyChangeEvent.html" title="class or interface in java.beans" class="external-link"><code>Property­Change­Event</code></a></li>
<li><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.desktop/java/beans/PropertyChangeListener.html" title="class or interface in java.beans" class="external-link"><code>Property­Change­Listener</code></a></li>
</ul>
</dd>
</dl>
</section>
</li>
<li>
<section class="detail" id="firePropertyChange(java.beans.PropertyChangeEvent)">
<h3>firePropertyChange</h3>
<div class="member-signature"><span class="modifiers">protected</span>&nbsp;<span class="return-type">void</span>&nbsp;<span class="element-name">firePropertyChange</span><wbr><span class="parameters">(<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.desktop/java/beans/PropertyChangeEvent.html" title="class or interface in java.beans" class="external-link">PropertyChangeEvent</a>&nbsp;event)</span></div>
<div class="block">Notifies all registered listeners that a property changed its value.
It is caller responsibility to verify that the event source and property name are valid.</div>
<dl class="notes">
<dt>Parameters:</dt>
<dd><code>event</code> - the event to forward. Cannot be null.</dd>
<dt>See Also:</dt>
<dd>
<ul class="tag-list">
<li><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.desktop/java/beans/PropertyChangeEvent.html" title="class or interface in java.beans" class="external-link"><code>Property­Change­Event</code></a></li>
<li><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.desktop/java/beans/PropertyChangeListener.html" title="class or interface in java.beans" class="external-link"><code>Property­Change­Listener</code></a></li>
</ul>
</dd>
</dl>
</section>
</li>
</ul>
</section>
</li>
</ul>
</section>
<!-- ========= END OF CLASS DATA ========= -->
</main>
</div>
</div>
</body>
</html>