| <!DOCTYPE HTML> |
| <html lang="en"> |
| <head> |
| <!-- Generated by javadoc (19) --> |
| <title>TransformChangeEvent (Apache SIS 1.3 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="description" content="declaration: package: org.apache.sis.portrayal, class: TransformChangeEvent"> |
| <meta name="generator" content="javadoc/ClassWriterImpl"> |
| <meta name="keywords" content="org.apache.sis.portrayal.TransformChangeEvent class"> |
| <meta name="keywords" content="getSource()"> |
| <meta name="keywords" content="getReason()"> |
| <meta name="keywords" content="getOldValue()"> |
| <meta name="keywords" content="getNewValue()"> |
| <meta name="keywords" content="getObjectiveChange()"> |
| <meta name="keywords" content="getDisplayChange()"> |
| <meta name="keywords" content="getObjectiveChange2D()"> |
| <meta name="keywords" content="getDisplayChange2D()"> |
| <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"> |
| <link rel="stylesheet" type="text/css" href="../../../../jquery-ui.overrides.css" title="Style"> |
| <script type="text/javascript" src="../../../../script.js"></script> |
| <script type="text/javascript" src="../../../../script-dir/jquery-3.6.0.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"> </span><span class="nav-bar-toggle-icon"> </span><span class="nav-bar-toggle-icon"> </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="package-summary.html">Package</a></li> |
| <li class="nav-bar-cell1-rev">Class</li> |
| <li><a href="class-use/TransformChangeEvent.html">Use</a></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><a href="#nested-class-summary">Nested</a></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>Field</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: </li> |
| <li><a href="#nested-class-summary">Nested</a> | </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> |
| <ul class="sub-nav-list"> |
| <li>Detail: </li> |
| <li>Field | </li> |
| <li><a href="#constructor-detail">Constr</a> | </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="package-label-in-type">Package</span> <a href="package-summary.html">org.apache.sis.portrayal</a></div> |
| <h1 title="Class TransformChangeEvent" class="title">Class TransformChangeEvent</h1> |
| </div> |
| <div class="inheritance" title="Inheritance Tree"><a href="https://docs.oracle.com/en/java/javase/16/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="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/util/EventObject.html" title="class or interface in java.util" class="external-link">EventObject</a> |
| <div class="inheritance"><a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.desktop/java/beans/PropertyChangeEvent.html" title="class or interface in java.beans" class="external-link">PropertyChangeEvent</a> |
| <div class="inheritance">TransformChangeEvent</div> |
| </div> |
| </div> |
| </div> |
| <section class="class-description" id="class-description"> |
| <dl class="notes"> |
| <dt>All Implemented Interfaces:</dt> |
| <dd><code><a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/io/Serializable.html" title="class or interface in java.io" class="external-link">Serializable</a></code></dd> |
| </dl> |
| <hr> |
| <div class="type-signature"><span class="modifiers">public class </span><span class="element-name type-name-label">TransformChangeEvent</span> |
| <span class="extends-implements">extends <a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.desktop/java/beans/PropertyChangeEvent.html" title="class or interface in java.beans" class="external-link">PropertyChangeEvent</a></span></div> |
| <div class="block">A change in the "objective to display" transform that <code>Canvas</code> uses for rendering data. |
| That transform is updated frequently following gestures events such as zoom, translation or rotation. |
| All events fired by <a href="Canvas.html" title="class in org.apache.sis.portrayal"><code>Canvas</code></a> for the <a href="Canvas.html#OBJECTIVE_TO_DISPLAY_PROPERTY">"objectiveToDisplay"</a> property |
| are instances of this class. |
| This specialization provides methods for computing the difference between the old and new state. |
| |
| <h2>Multi-threading</h2> |
| This class is <strong>not</strong> thread-safe. |
| All listeners should process this event in the same thread.</div> |
| <dl class="notes"> |
| <dt>Since:</dt> |
| <dd>1.3</dd> |
| <dt>See Also:</dt> |
| <dd> |
| <ul class="see-list-long"> |
| <li><a href="Canvas.html#OBJECTIVE_TO_DISPLAY_PROPERTY"><code>Canvas.OBJECTIVE_TO_DISPLAY_PROPERTY</code></a></li> |
| <li><a href="../../../../serialized-form.html#org.apache.sis.portrayal.TransformChangeEvent">Serialized Form</a></li> |
| </ul> |
| </dd> |
| |
| <p><font size="-1">Defined in the <code>sis-portrayal</code> module</font></p> |
| </dl> |
| </section> |
| <section class="summary"> |
| <ul class="summary-list"> |
| <!-- ======== NESTED CLASS SUMMARY ======== --> |
| <li> |
| <section class="nested-class-summary" id="nested-class-summary"> |
| <h2>Nested Class Summary</h2> |
| <div class="caption"><span>Nested Classes</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">Class</div> |
| <div class="table-header col-last">Description</div> |
| <div class="col-first even-row-color"><code>static enum </code></div> |
| <div class="col-second even-row-color"><code><a href="TransformChangeEvent.Reason.html" class="type-name-link" title="enum class in org.apache.sis.portrayal">TransformChangeEvent.Reason</a></code></div> |
| <div class="col-last even-row-color"> |
| <div class="block">The reason why the "objective to display" transform changed.</div> |
| </div> |
| </div> |
| </section> |
| </li> |
| <!-- =========== FIELD SUMMARY =========== --> |
| <li> |
| <section class="field-summary" id="field-summary"> |
| <h2>Field Summary</h2> |
| <div class="inherited-list"> |
| <h3 id="fields-inherited-from-class-EventObject">Fields inherited from class <a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/util/EventObject.html" title="class or interface in java.util" class="external-link">EventObject</a></h3> |
| <code><a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/util/EventObject.html#source" title="class or interface in java.util" class="external-link">source</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 two-column-summary"> |
| <div class="table-header col-first">Constructor</div> |
| <div class="table-header col-last">Description</div> |
| <div class="col-constructor-name even-row-color"><code><a href="#%3Cinit%3E(org.apache.sis.portrayal.Canvas,org.apache.sis.referencing.operation.transform.LinearTransform,org.apache.sis.referencing.operation.transform.LinearTransform,java.awt.geom.AffineTransform,java.awt.geom.AffineTransform,org.apache.sis.portrayal.TransformChangeEvent.Reason)" class="member-name-link">TransformChangeEvent</a><wbr>(<a href="Canvas.html" title="class in org.apache.sis.portrayal">Canvas</a> source, |
| <a href="../referencing/operation/transform/LinearTransform.html" title="interface in org.apache.sis.referencing.operation.transform">LinearTransform</a> oldValue, |
| <a href="../referencing/operation/transform/LinearTransform.html" title="interface in org.apache.sis.referencing.operation.transform">LinearTransform</a> newValue, |
| <a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.desktop/java/awt/geom/AffineTransform.html" title="class or interface in java.awt.geom" class="external-link">AffineTransform</a> objective, |
| <a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.desktop/java/awt/geom/AffineTransform.html" title="class or interface in java.awt.geom" class="external-link">AffineTransform</a> display, |
| <a href="TransformChangeEvent.Reason.html" title="enum class in org.apache.sis.portrayal">TransformChangeEvent.Reason</a> reason)</code></div> |
| <div class="col-last even-row-color"> |
| <div class="block">Creates a new event for an incremental change of the "objective to display" property.</div> |
| </div> |
| <div class="col-constructor-name odd-row-color"><code><a href="#%3Cinit%3E(org.apache.sis.portrayal.Canvas,org.apache.sis.referencing.operation.transform.LinearTransform,org.apache.sis.referencing.operation.transform.LinearTransform,org.apache.sis.portrayal.TransformChangeEvent.Reason)" class="member-name-link">TransformChangeEvent</a><wbr>(<a href="Canvas.html" title="class in org.apache.sis.portrayal">Canvas</a> source, |
| <a href="../referencing/operation/transform/LinearTransform.html" title="interface in org.apache.sis.referencing.operation.transform">LinearTransform</a> oldValue, |
| <a href="../referencing/operation/transform/LinearTransform.html" title="interface in org.apache.sis.referencing.operation.transform">LinearTransform</a> newValue, |
| <a href="TransformChangeEvent.Reason.html" title="enum class in org.apache.sis.portrayal">TransformChangeEvent.Reason</a> reason)</code></div> |
| <div class="col-last odd-row-color"> |
| <div class="block">Creates a new event for a change of the "objective to display" property.</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><a href="../referencing/operation/transform/LinearTransform.html" title="interface in org.apache.sis.referencing.operation.transform">LinearTransform</a></code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getDisplayChange()" class="member-name-link">getDisplayChange</a>()</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| <div class="block">Returns the change from old display coordinates to new display coordinates.</div> |
| </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/util/Optional.html" title="class or interface in java.util" class="external-link">Optional</a><<a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.desktop/java/awt/geom/AffineTransform.html" title="class or interface in java.awt.geom" class="external-link">AffineTransform</a>></code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getDisplayChange2D()" class="member-name-link">getDisplayChange2D</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 change in display coordinates as a Java2D affine transform.</div> |
| </div> |
| <div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="../referencing/operation/transform/LinearTransform.html" title="interface in org.apache.sis.referencing.operation.transform">LinearTransform</a></code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getNewValue()" class="member-name-link">getNewValue</a>()</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| <div class="block">Gets the new "objective to display" transform.</div> |
| </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="../referencing/operation/transform/LinearTransform.html" title="interface in org.apache.sis.referencing.operation.transform">LinearTransform</a></code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getObjectiveChange()" class="member-name-link">getObjectiveChange</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 change from old objective coordinates to new objective coordinates.</div> |
| </div> |
| <div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/util/Optional.html" title="class or interface in java.util" class="external-link">Optional</a><<a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.desktop/java/awt/geom/AffineTransform.html" title="class or interface in java.awt.geom" class="external-link">AffineTransform</a>></code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getObjectiveChange2D()" class="member-name-link">getObjectiveChange2D</a>()</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| <div class="block">Returns the change in objective coordinates as a Java2D affine transform.</div> |
| </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="../referencing/operation/transform/LinearTransform.html" title="interface in org.apache.sis.referencing.operation.transform">LinearTransform</a></code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getOldValue()" class="member-name-link">getOldValue</a>()</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| <div class="block">Gets the old "objective to display" transform.</div> |
| </div> |
| <div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="TransformChangeEvent.Reason.html" title="enum class in org.apache.sis.portrayal">TransformChangeEvent.Reason</a></code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getReason()" class="member-name-link">getReason</a>()</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| <div class="block">Returns the reason why the "objective to display" transform changed.</div> |
| </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="Canvas.html" title="class in org.apache.sis.portrayal">Canvas</a></code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getSource()" class="member-name-link">getSource</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 canvas on which this event initially occurred.</div> |
| </div> |
| </div> |
| </div> |
| </div> |
| <div class="inherited-list"> |
| <h3 id="methods-inherited-from-class-PropertyChangeEvent">Methods inherited from class <a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.desktop/java/beans/PropertyChangeEvent.html" title="class or interface in java.beans" class="external-link">PropertyChangeEvent</a></h3> |
| <code><a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.desktop/java/beans/PropertyChangeEvent.html#getPropagationId()" title="class or interface in java.beans" class="external-link">getPropagationId</a>, <a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.desktop/java/beans/PropertyChangeEvent.html#getPropertyName()" title="class or interface in java.beans" class="external-link">getPropertyName</a>, <a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.desktop/java/beans/PropertyChangeEvent.html#setPropagationId(java.lang.Object)" title="class or interface in java.beans" class="external-link">setPropagationId</a>, <a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.desktop/java/beans/PropertyChangeEvent.html#toString()" title="class or interface in java.beans" class="external-link">toString</a></code></div> |
| <div class="inherited-list"> |
| <h3 id="methods-inherited-from-class-Object">Methods inherited from class <a href="https://docs.oracle.com/en/java/javase/16/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/16/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/16/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/16/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/16/docs/api/java.base/java/lang/Object.html#getClass()" title="class or interface in java.lang" class="external-link">getClass</a>, <a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/lang/Object.html#hashCode()" title="class or interface in java.lang" class="external-link">hashCode</a>, <a href="https://docs.oracle.com/en/java/javase/16/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/16/docs/api/java.base/java/lang/Object.html#notifyAll()" title="class or interface in java.lang" class="external-link">notifyAll</a>, <a href="https://docs.oracle.com/en/java/javase/16/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/16/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/16/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"> |
| <!-- ========= CONSTRUCTOR DETAIL ======== --> |
| <li> |
| <section class="constructor-details" id="constructor-detail"> |
| <h2>Constructor Details</h2> |
| <ul class="member-list"> |
| <li> |
| <section class="detail" id="<init>(org.apache.sis.portrayal.Canvas,org.apache.sis.referencing.operation.transform.LinearTransform,org.apache.sis.referencing.operation.transform.LinearTransform,org.apache.sis.portrayal.TransformChangeEvent.Reason)"> |
| <h3>TransformChangeEvent</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="element-name">TransformChangeEvent</span><wbr><span class="parameters">(<a href="Canvas.html" title="class in org.apache.sis.portrayal">Canvas</a> source, |
| <a href="../referencing/operation/transform/LinearTransform.html" title="interface in org.apache.sis.referencing.operation.transform">LinearTransform</a> oldValue, |
| <a href="../referencing/operation/transform/LinearTransform.html" title="interface in org.apache.sis.referencing.operation.transform">LinearTransform</a> newValue, |
| <a href="TransformChangeEvent.Reason.html" title="enum class in org.apache.sis.portrayal">TransformChangeEvent.Reason</a> reason)</span></div> |
| <div class="block">Creates a new event for a change of the "objective to display" property. |
| The old and new transforms should not be null, except on initialization or for lazy computation: |
| a null <code>newValue</code> means to take the value from <a href="Canvas.html#getObjectiveToDisplay()"><code>Canvas.getObjectiveToDisplay()</code></a> when needed.</div> |
| <dl class="notes"> |
| <dt>Parameters:</dt> |
| <dd><code>source</code> - the canvas that fired the event.</dd> |
| <dd><code>oldValue</code> - the old "objective to display" transform, or <code>null</code> if none.</dd> |
| <dd><code>newValue</code> - the new transform, or <code>null</code> for lazy computation.</dd> |
| <dd><code>reason</code> - the reason why the "objective to display" transform changed..</dd> |
| <dt>Throws:</dt> |
| <dd><code><a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/lang/IllegalArgumentException.html" title="class or interface in java.lang" class="external-link">IllegalArgumentException</a></code> - if <code>source</code> is <code>null</code>.</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="<init>(org.apache.sis.portrayal.Canvas,org.apache.sis.referencing.operation.transform.LinearTransform,org.apache.sis.referencing.operation.transform.LinearTransform,java.awt.geom.AffineTransform,java.awt.geom.AffineTransform,org.apache.sis.portrayal.TransformChangeEvent.Reason)"> |
| <h3>TransformChangeEvent</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="element-name">TransformChangeEvent</span><wbr><span class="parameters">(<a href="Canvas.html" title="class in org.apache.sis.portrayal">Canvas</a> source, |
| <a href="../referencing/operation/transform/LinearTransform.html" title="interface in org.apache.sis.referencing.operation.transform">LinearTransform</a> oldValue, |
| <a href="../referencing/operation/transform/LinearTransform.html" title="interface in org.apache.sis.referencing.operation.transform">LinearTransform</a> newValue, |
| <a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.desktop/java/awt/geom/AffineTransform.html" title="class or interface in java.awt.geom" class="external-link">AffineTransform</a> objective, |
| <a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.desktop/java/awt/geom/AffineTransform.html" title="class or interface in java.awt.geom" class="external-link">AffineTransform</a> display, |
| <a href="TransformChangeEvent.Reason.html" title="enum class in org.apache.sis.portrayal">TransformChangeEvent.Reason</a> reason)</span></div> |
| <div class="block">Creates a new event for an incremental change of the "objective to display" property. |
| The incremental change can be specified by the <code>objective</code> and/or the <code>display</code> argument. |
| Usually only one of those two arguments is non-null.</div> |
| <dl class="notes"> |
| <dt>Parameters:</dt> |
| <dd><code>source</code> - the canvas that fired the event.</dd> |
| <dd><code>oldValue</code> - the old "objective to display" transform, or <code>null</code> if none.</dd> |
| <dd><code>newValue</code> - the new transform, or <code>null</code> for lazy computation.</dd> |
| <dd><code>objective</code> - the incremental change in objective coordinates, or <code>null</code> for lazy computation.</dd> |
| <dd><code>display</code> - the incremental change in display coordinates, or <code>null</code> for lazy computation.</dd> |
| <dd><code>reason</code> - the reason why the "objective to display" transform changed..</dd> |
| <dt>Throws:</dt> |
| <dd><code><a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/lang/IllegalArgumentException.html" title="class or interface in java.lang" class="external-link">IllegalArgumentException</a></code> - if <code>source</code> is <code>null</code>.</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="getSource()"> |
| <h3>getSource</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type"><a href="Canvas.html" title="class in org.apache.sis.portrayal">Canvas</a></span> <span class="element-name">getSource</span>()</div> |
| <div class="block">Returns the canvas on which this event initially occurred.</div> |
| <dl class="notes"> |
| <dt>Overrides:</dt> |
| <dd><code><a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/util/EventObject.html#getSource()" title="class or interface in java.util" class="external-link">getSource</a></code> in class <code><a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/util/EventObject.html" title="class or interface in java.util" class="external-link">EventObject</a></code></dd> |
| <dt>Returns:</dt> |
| <dd>the canvas on which this event initially occurred.</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="getReason()"> |
| <h3>getReason</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type"><a href="TransformChangeEvent.Reason.html" title="enum class in org.apache.sis.portrayal">TransformChangeEvent.Reason</a></span> <span class="element-name">getReason</span>()</div> |
| <div class="block">Returns the reason why the "objective to display" transform changed. |
| It may be because of canvas initialization, or an adjustment for a change of CRS |
| without change in the viewing area, or a navigation for viewing a different area.</div> |
| <dl class="notes"> |
| <dt>Returns:</dt> |
| <dd>the reason why the "objective to display" transform changed.</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="getOldValue()"> |
| <h3>getOldValue</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type"><a href="../referencing/operation/transform/LinearTransform.html" title="interface in org.apache.sis.referencing.operation.transform">LinearTransform</a></span> <span class="element-name">getOldValue</span>()</div> |
| <div class="block">Gets the old "objective to display" transform.</div> |
| <dl class="notes"> |
| <dt>Overrides:</dt> |
| <dd><code><a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.desktop/java/beans/PropertyChangeEvent.html#getOldValue()" title="class or interface in java.beans" class="external-link">getOldValue</a></code> in class <code><a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.desktop/java/beans/PropertyChangeEvent.html" title="class or interface in java.beans" class="external-link">PropertyChangeEvent</a></code></dd> |
| <dt>Returns:</dt> |
| <dd>the old "objective to display" transform, or <code>null</code> if none.</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="getNewValue()"> |
| <h3>getNewValue</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type"><a href="../referencing/operation/transform/LinearTransform.html" title="interface in org.apache.sis.referencing.operation.transform">LinearTransform</a></span> <span class="element-name">getNewValue</span>()</div> |
| <div class="block">Gets the new "objective to display" transform. |
| It should be the current value of <a href="Canvas.html#getObjectiveToDisplay()"><code>Canvas.getObjectiveToDisplay()</code></a>.</div> |
| <dl class="notes"> |
| <dt>Overrides:</dt> |
| <dd><code><a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.desktop/java/beans/PropertyChangeEvent.html#getNewValue()" title="class or interface in java.beans" class="external-link">getNewValue</a></code> in class <code><a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.desktop/java/beans/PropertyChangeEvent.html" title="class or interface in java.beans" class="external-link">PropertyChangeEvent</a></code></dd> |
| <dt>Returns:</dt> |
| <dd>the new "objective to display" transform.</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="getObjectiveChange()"> |
| <h3>getObjectiveChange</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type"><a href="../referencing/operation/transform/LinearTransform.html" title="interface in org.apache.sis.referencing.operation.transform">LinearTransform</a></span> <span class="element-name">getObjectiveChange</span>()</div> |
| <div class="block">Returns the change from old objective coordinates to new objective coordinates. |
| When the "objective to display" transform changed (e.g. because the user did a zoom, translation or rotation), |
| this method expresses how the "real world" coordinates (typically in metres) of any point on the screen changed. |
| |
| <div class="note"><b>Example:</b> |
| if the map is shifted 10 metres toward the right side of the canvas, then (assuming no rotation or axis flip) |
| the <var>x</var> translation coefficient of the change is +10 (same sign than <a href="#getDisplayChange()"><code>getDisplayChange()</code></a>). |
| Note that it may correspond to any amount of pixels, depending on the zoom factor.</div> |
| |
| The <a href="#getObjectiveChange2D()"><code>getObjectiveChange2D()</code></a> method gives the same transform as a Java2D object. |
| That change can be replicated on another canvas by giving the transform to |
| <a href="PlanarCanvas.html#transformObjectiveCoordinates(java.awt.geom.AffineTransform)"><code>PlanarCanvas.transformObjectiveCoordinates(AffineTransform)</code></a>.</div> |
| <dl class="notes"> |
| <dt>Returns:</dt> |
| <dd>the change in objective coordinates. Usually not <code>null</code>, |
| unless one of the canvas is initializing or has a non-invertible transform.</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="getDisplayChange()"> |
| <h3>getDisplayChange</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type"><a href="../referencing/operation/transform/LinearTransform.html" title="interface in org.apache.sis.referencing.operation.transform">LinearTransform</a></span> <span class="element-name">getDisplayChange</span>()</div> |
| <div class="block">Returns the change from old display coordinates to new display coordinates. |
| When the "objective to display" transform changed (e.g. because the user did a zoom, translation or rotation), |
| this method expresses how the display coordinates (typically pixels) of any given point on the map changed. |
| |
| <div class="note"><b>Example:</b> |
| if the map is shifted 10 pixels toward the right side of the canvas, then (assuming no rotation or axis flip) |
| the <var>x</var> translation coefficient of the change is +10: the points on the map which were located at |
| <var>x</var>=0 pixel before the change are now located at <var>x</var>=10 pixels after the change.</div> |
| |
| The <a href="#getDisplayChange2D()"><code>getDisplayChange2D()</code></a> method gives the same transform as a Java2D object. |
| That change can be replicated on another canvas by giving the transform to |
| <a href="PlanarCanvas.html#transformDisplayCoordinates(java.awt.geom.AffineTransform)"><code>PlanarCanvas.transformDisplayCoordinates(AffineTransform)</code></a>.</div> |
| <dl class="notes"> |
| <dt>Returns:</dt> |
| <dd>the change in display coordinates. Usually not <code>null</code>, |
| unless one of the canvas is initializing or has a non-invertible transform.</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="getObjectiveChange2D()"> |
| <h3>getObjectiveChange2D</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type"><a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/util/Optional.html" title="class or interface in java.util" class="external-link">Optional</a><<a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.desktop/java/awt/geom/AffineTransform.html" title="class or interface in java.awt.geom" class="external-link">AffineTransform</a>></span> <span class="element-name">getObjectiveChange2D</span>()</div> |
| <div class="block">Returns the change in objective coordinates as a Java2D affine transform. |
| This method is suitable for two-dimensional canvas only. |
| For performance reason, it does not clone the returned transform.</div> |
| <dl class="notes"> |
| <dt>Returns:</dt> |
| <dd>the change in objective coordinates. <strong>Do not modify.</strong></dd> |
| <dt>See Also:</dt> |
| <dd> |
| <ul class="see-list"> |
| <li><a href="#getObjectiveChange()"><code>getObjectiveChange()</code></a></li> |
| </ul> |
| </dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="getDisplayChange2D()"> |
| <h3>getDisplayChange2D</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type"><a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/util/Optional.html" title="class or interface in java.util" class="external-link">Optional</a><<a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.desktop/java/awt/geom/AffineTransform.html" title="class or interface in java.awt.geom" class="external-link">AffineTransform</a>></span> <span class="element-name">getDisplayChange2D</span>()</div> |
| <div class="block">Returns the change in display coordinates as a Java2D affine transform. |
| This method is suitable for two-dimensional canvas only. |
| For performance reason, it does not clone the returned transform.</div> |
| <dl class="notes"> |
| <dt>Returns:</dt> |
| <dd>the change in display coordinates. <strong>Do not modify.</strong></dd> |
| <dt>See Also:</dt> |
| <dd> |
| <ul class="see-list"> |
| <li><a href="#getDisplayChange()"><code>getDisplayChange()</code></a></li> |
| </ul> |
| </dd> |
| </dl> |
| </section> |
| </li> |
| </ul> |
| </section> |
| </li> |
| </ul> |
| </section> |
| <!-- ========= END OF CLASS DATA ========= --> |
| </main> |
| <footer role="contentinfo"> |
| <hr> |
| <p class="legal-copy"><small>Copyright © 2010–2022 <a href="https://www.apache.org/">The Apache Software Foundation</a>. All rights reserved.</small></p> |
| </footer> |
| </div> |
| </div> |
| </body> |
| </html> |