maxGraph/java/docs/com/mxgraph/analysis/mxDistanceCostFunction.html

331 lines
11 KiB
HTML
Raw Normal View History

2019-07-02 06:45:58 +00:00
<!DOCTYPE HTML>
2014-04-01 11:30:48 +00:00
<!-- NewPage -->
<html lang="en">
<head>
2020-01-24 13:46:50 +00:00
<!-- Generated by javadoc (11.0.5) on Fri Jan 24 13:39:46 UTC 2020 -->
2020-01-24 13:32:03 +00:00
<title>mxDistanceCostFunction (mxGraph 4.1.0 API Specification)</title>
2018-11-06 11:46:01 +00:00
<meta http-equiv="Content-Type" content="text/html; charset=utf-8">
2020-01-24 13:32:03 +00:00
<meta name="dc.created" content="2020-01-24">
2014-04-01 11:30:48 +00:00
<link rel="stylesheet" type="text/css" href="../../../stylesheet.css" title="Style">
2018-11-06 11:46:01 +00:00
<link rel="stylesheet" type="text/css" href="../../../jquery/jquery-ui.css" title="Style">
2016-06-02 09:57:18 +00:00
<script type="text/javascript" src="../../../script.js"></script>
2018-11-06 11:46:01 +00:00
<script type="text/javascript" src="../../../jquery/jszip/dist/jszip.min.js"></script>
<script type="text/javascript" src="../../../jquery/jszip-utils/dist/jszip-utils.min.js"></script>
<!--[if IE]>
<script type="text/javascript" src="../../../jquery/jszip-utils/dist/jszip-utils-ie.min.js"></script>
<![endif]-->
2019-07-02 06:45:58 +00:00
<script type="text/javascript" src="../../../jquery/jquery-3.3.1.js"></script>
<script type="text/javascript" src="../../../jquery/jquery-migrate-3.0.1.js"></script>
2018-11-06 11:46:01 +00:00
<script type="text/javascript" src="../../../jquery/jquery-ui.js"></script>
2014-04-01 11:30:48 +00:00
</head>
<body>
<script type="text/javascript"><!--
2016-06-02 09:57:18 +00:00
try {
if (location.href.indexOf('is-external=true') == -1) {
2020-01-24 13:32:03 +00:00
parent.document.title="mxDistanceCostFunction (mxGraph 4.1.0 API Specification)";
2016-06-02 09:57:18 +00:00
}
}
catch(err) {
2012-05-21 20:32:26 +00:00
}
2014-04-01 11:30:48 +00:00
//-->
2019-07-02 06:45:58 +00:00
var data = {"i0":10};
2016-06-02 09:57:18 +00:00
var tabs = {65535:["t0","All Methods"],2:["t2","Instance Methods"],8:["t4","Concrete Methods"]};
var altColor = "altColor";
var rowColor = "rowColor";
var tableTab = "tableTab";
var activeTableTab = "activeTableTab";
2019-07-02 06:45:58 +00:00
var pathtoroot = "../../../";
var useModuleDirectories = true;
loadScripts(document, 'script');</script>
2014-04-01 11:30:48 +00:00
<noscript>
<div>JavaScript is disabled on your browser.</div>
</noscript>
2019-07-02 06:45:58 +00:00
<header role="banner">
<nav role="navigation">
2018-11-06 11:46:01 +00:00
<div class="fixedNav">
2012-05-21 20:32:26 +00:00
<!-- ========= START OF TOP NAVBAR ======= -->
2019-07-02 06:45:58 +00:00
<div class="topNav"><a id="navbar.top">
2014-04-01 11:30:48 +00:00
<!-- -->
2016-06-02 09:57:18 +00:00
</a>
<div class="skipNav"><a href="#skip.navbar.top" title="Skip navigation links">Skip navigation links</a></div>
2019-07-02 06:45:58 +00:00
<a id="navbar.top.firstrow">
2014-04-01 11:30:48 +00:00
<!-- -->
</a>
<ul class="navList" title="Navigation">
2019-07-02 06:45:58 +00:00
<li><a href="../../../index.html">Overview</a></li>
2014-04-01 11:30:48 +00:00
<li><a href="package-summary.html">Package</a></li>
<li class="navBarCell1Rev">Class</li>
<li><a href="class-use/mxDistanceCostFunction.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">Help</a></li>
</ul>
2020-01-24 13:32:03 +00:00
<div class="aboutLanguage"><p><b>mxGraph 4.1.0</b></p></div>
2014-04-01 11:30:48 +00:00
</div>
<div class="subNav">
<ul class="navList" id="allclasses_navbar_top">
2019-07-02 06:45:58 +00:00
<li><a href="../../../allclasses.html">All&nbsp;Classes</a></li>
2014-04-01 11:30:48 +00:00
</ul>
2018-11-06 11:46:01 +00:00
<ul class="navListSearch">
<li><label for="search">SEARCH:</label>
<input type="text" id="search" value="search" disabled="disabled">
<input type="reset" id="reset" value="reset" disabled="disabled">
</li>
</ul>
2014-04-01 11:30:48 +00:00
<div>
<script type="text/javascript"><!--
allClassesLink = document.getElementById("allclasses_navbar_top");
2012-05-21 20:32:26 +00:00
if(window==top) {
2014-04-01 11:30:48 +00:00
allClassesLink.style.display = "block";
}
else {
allClassesLink.style.display = "none";
2012-05-21 20:32:26 +00:00
}
//-->
2014-04-01 11:30:48 +00:00
</script>
2018-11-06 11:46:01 +00:00
<noscript>
<div>JavaScript is disabled on your browser.</div>
</noscript>
2014-04-01 11:30:48 +00:00
</div>
<div>
<ul class="subNavList">
<li>Summary:&nbsp;</li>
<li>Nested&nbsp;|&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
2016-06-02 09:57:18 +00:00
<li><a href="#constructor.summary">Constr</a>&nbsp;|&nbsp;</li>
<li><a href="#method.summary">Method</a></li>
2014-04-01 11:30:48 +00:00
</ul>
<ul class="subNavList">
<li>Detail:&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
2016-06-02 09:57:18 +00:00
<li><a href="#constructor.detail">Constr</a>&nbsp;|&nbsp;</li>
<li><a href="#method.detail">Method</a></li>
2014-04-01 11:30:48 +00:00
</ul>
</div>
2019-07-02 06:45:58 +00:00
<a id="skip.navbar.top">
2014-04-01 11:30:48 +00:00
<!-- -->
</a></div>
2012-05-21 20:32:26 +00:00
<!-- ========= END OF TOP NAVBAR ========= -->
2018-11-06 11:46:01 +00:00
</div>
<div class="navPadding">&nbsp;</div>
<script type="text/javascript"><!--
$('.navPadding').css('padding-top', $('.fixedNav').css("height"));
//-->
</script>
2019-07-02 06:45:58 +00:00
</nav>
</header>
2012-05-21 20:32:26 +00:00
<!-- ======== START OF CLASS DATA ======== -->
2019-07-02 06:45:58 +00:00
<main role="main">
2014-04-01 11:30:48 +00:00
<div class="header">
2019-07-02 06:45:58 +00:00
<div class="subTitle"><span class="packageLabelInType">Package</span>&nbsp;<a href="package-summary.html">com.mxgraph.analysis</a></div>
2014-04-01 11:30:48 +00:00
<h2 title="Class mxDistanceCostFunction" class="title">Class mxDistanceCostFunction</h2>
</div>
<div class="contentContainer">
<ul class="inheritance">
2017-11-24 16:16:54 +00:00
<li>java.lang.Object</li>
2014-04-01 11:30:48 +00:00
<li>
<ul class="inheritance">
<li>com.mxgraph.analysis.mxDistanceCostFunction</li>
</ul>
</li>
</ul>
<div class="description">
<ul class="blockList">
<li class="blockList">
<dl>
<dt>All Implemented Interfaces:</dt>
2019-07-02 06:45:58 +00:00
<dd><code><a href="mxICostFunction.html" title="interface in com.mxgraph.analysis">mxICostFunction</a></code></dd>
2014-04-01 11:30:48 +00:00
</dl>
<hr>
2016-06-02 09:57:18 +00:00
<pre>public class <span class="typeNameLabel">mxDistanceCostFunction</span>
2017-11-24 16:16:54 +00:00
extends java.lang.Object
2019-07-02 06:45:58 +00:00
implements <a href="mxICostFunction.html" title="interface in com.mxgraph.analysis">mxICostFunction</a></pre>
2014-04-01 11:30:48 +00:00
<div class="block">Implements a cost function for the Euclidean length of an edge.</div>
</li>
</ul>
</div>
<div class="summary">
<ul class="blockList">
<li class="blockList">
2012-05-21 20:32:26 +00:00
<!-- ======== CONSTRUCTOR SUMMARY ======== -->
2019-07-02 06:45:58 +00:00
<section role="region">
2014-04-01 11:30:48 +00:00
<ul class="blockList">
2019-07-02 06:45:58 +00:00
<li class="blockList"><a id="constructor.summary">
2014-04-01 11:30:48 +00:00
<!-- -->
</a>
<h3>Constructor Summary</h3>
2019-07-02 06:45:58 +00:00
<table class="memberSummary">
2014-04-01 11:30:48 +00:00
<caption><span>Constructors</span><span class="tabEnd">&nbsp;</span></caption>
<tr>
2018-11-06 11:46:01 +00:00
<th class="colFirst" scope="col">Constructor</th>
<th class="colLast" scope="col">Description</th>
2014-04-01 11:30:48 +00:00
</tr>
<tr class="altColor">
2019-07-02 06:45:58 +00:00
<th class="colConstructorName" scope="row"><code><span class="memberNameLink"><a href="#%3Cinit%3E()">mxDistanceCostFunction</a></span>()</code></th>
2018-11-06 11:46:01 +00:00
<td class="colLast">&nbsp;</td>
2014-04-01 11:30:48 +00:00
</tr>
</table>
</li>
</ul>
2019-07-02 06:45:58 +00:00
</section>
2012-05-21 20:32:26 +00:00
<!-- ========== METHOD SUMMARY =========== -->
2019-07-02 06:45:58 +00:00
<section role="region">
2014-04-01 11:30:48 +00:00
<ul class="blockList">
2019-07-02 06:45:58 +00:00
<li class="blockList"><a id="method.summary">
2014-04-01 11:30:48 +00:00
<!-- -->
</a>
<h3>Method Summary</h3>
2019-07-02 06:45:58 +00:00
<table class="memberSummary">
2016-06-02 09:57:18 +00:00
<caption><span id="t0" class="activeTableTab"><span>All Methods</span><span class="tabEnd">&nbsp;</span></span><span id="t2" class="tableTab"><span><a href="javascript:show(2);">Instance Methods</a></span><span class="tabEnd">&nbsp;</span></span><span id="t4" class="tableTab"><span><a href="javascript:show(8);">Concrete Methods</a></span><span class="tabEnd">&nbsp;</span></span></caption>
2014-04-01 11:30:48 +00:00
<tr>
<th class="colFirst" scope="col">Modifier and Type</th>
2018-11-06 11:46:01 +00:00
<th class="colSecond" scope="col">Method</th>
<th class="colLast" scope="col">Description</th>
2014-04-01 11:30:48 +00:00
</tr>
2016-06-02 09:57:18 +00:00
<tr id="i0" class="altColor">
2014-04-01 11:30:48 +00:00
<td class="colFirst"><code>double</code></td>
2019-07-02 06:45:58 +00:00
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getCost(com.mxgraph.view.mxCellState)">getCost</a></span>&#8203;(<a href="../view/mxCellState.html" title="class in com.mxgraph.view">mxCellState</a>&nbsp;state)</code></th>
2018-11-06 11:46:01 +00:00
<td class="colLast">
2014-04-01 11:30:48 +00:00
<div class="block">Returns the Euclidean length of the edge defined by the absolute
points in the given state or 0 if no points are defined.</div>
</td>
</tr>
</table>
<ul class="blockList">
2019-07-02 06:45:58 +00:00
<li class="blockList"><a id="methods.inherited.from.class.java.lang.Object">
2014-04-01 11:30:48 +00:00
<!-- -->
</a>
2017-11-24 16:16:54 +00:00
<h3>Methods inherited from class&nbsp;java.lang.Object</h3>
<code>clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait</code></li>
2014-04-01 11:30:48 +00:00
</ul>
</li>
</ul>
2019-07-02 06:45:58 +00:00
</section>
2014-04-01 11:30:48 +00:00
</li>
</ul>
</div>
<div class="details">
<ul class="blockList">
<li class="blockList">
2012-05-21 20:32:26 +00:00
<!-- ========= CONSTRUCTOR DETAIL ======== -->
2019-07-02 06:45:58 +00:00
<section role="region">
2014-04-01 11:30:48 +00:00
<ul class="blockList">
2019-07-02 06:45:58 +00:00
<li class="blockList"><a id="constructor.detail">
2014-04-01 11:30:48 +00:00
<!-- -->
</a>
<h3>Constructor Detail</h3>
2019-07-02 06:45:58 +00:00
<a id="&lt;init&gt;()">
2014-04-01 11:30:48 +00:00
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>mxDistanceCostFunction</h4>
<pre>public&nbsp;mxDistanceCostFunction()</pre>
</li>
</ul>
</li>
</ul>
2019-07-02 06:45:58 +00:00
</section>
2012-05-21 20:32:26 +00:00
<!-- ============ METHOD DETAIL ========== -->
2019-07-02 06:45:58 +00:00
<section role="region">
2014-04-01 11:30:48 +00:00
<ul class="blockList">
2019-07-02 06:45:58 +00:00
<li class="blockList"><a id="method.detail">
2014-04-01 11:30:48 +00:00
<!-- -->
</a>
<h3>Method Detail</h3>
2019-07-02 06:45:58 +00:00
<a id="getCost(com.mxgraph.view.mxCellState)">
2014-04-01 11:30:48 +00:00
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>getCost</h4>
2019-07-02 06:45:58 +00:00
<pre class="methodSignature">public&nbsp;double&nbsp;getCost&#8203;(<a href="../view/mxCellState.html" title="class in com.mxgraph.view">mxCellState</a>&nbsp;state)</pre>
2014-04-01 11:30:48 +00:00
<div class="block">Returns the Euclidean length of the edge defined by the absolute
points in the given state or 0 if no points are defined.</div>
<dl>
2016-06-02 09:57:18 +00:00
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
2019-07-02 06:45:58 +00:00
<dd><code><a href="mxICostFunction.html#getCost(com.mxgraph.view.mxCellState)">getCost</a></code>&nbsp;in interface&nbsp;<code><a href="mxICostFunction.html" title="interface in com.mxgraph.analysis">mxICostFunction</a></code></dd>
2016-06-02 09:57:18 +00:00
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>state</code> - The cell state to be evaluated</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>Returns the cost to traverse the given cell state.</dd>
</dl>
2014-04-01 11:30:48 +00:00
</li>
</ul>
</li>
</ul>
2019-07-02 06:45:58 +00:00
</section>
2014-04-01 11:30:48 +00:00
</li>
</ul>
</div>
</div>
2019-07-02 06:45:58 +00:00
</main>
2012-05-21 20:32:26 +00:00
<!-- ========= END OF CLASS DATA ========= -->
2019-07-02 06:45:58 +00:00
<footer role="contentinfo">
<nav role="navigation">
2012-05-21 20:32:26 +00:00
<!-- ======= START OF BOTTOM NAVBAR ====== -->
2019-07-02 06:45:58 +00:00
<div class="bottomNav"><a id="navbar.bottom">
2014-04-01 11:30:48 +00:00
<!-- -->
2016-06-02 09:57:18 +00:00
</a>
<div class="skipNav"><a href="#skip.navbar.bottom" title="Skip navigation links">Skip navigation links</a></div>
2019-07-02 06:45:58 +00:00
<a id="navbar.bottom.firstrow">
2014-04-01 11:30:48 +00:00
<!-- -->
</a>
<ul class="navList" title="Navigation">
2019-07-02 06:45:58 +00:00
<li><a href="../../../index.html">Overview</a></li>
2014-04-01 11:30:48 +00:00
<li><a href="package-summary.html">Package</a></li>
<li class="navBarCell1Rev">Class</li>
<li><a href="class-use/mxDistanceCostFunction.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">Help</a></li>
</ul>
2020-01-24 13:32:03 +00:00
<div class="aboutLanguage"><p><b>mxGraph 4.1.0</b></p></div>
2014-04-01 11:30:48 +00:00
</div>
<div class="subNav">
<ul class="navList" id="allclasses_navbar_bottom">
2019-07-02 06:45:58 +00:00
<li><a href="../../../allclasses.html">All&nbsp;Classes</a></li>
2014-04-01 11:30:48 +00:00
</ul>
<div>
<script type="text/javascript"><!--
allClassesLink = document.getElementById("allclasses_navbar_bottom");
2012-05-21 20:32:26 +00:00
if(window==top) {
2014-04-01 11:30:48 +00:00
allClassesLink.style.display = "block";
}
else {
allClassesLink.style.display = "none";
2012-05-21 20:32:26 +00:00
}
//-->
2014-04-01 11:30:48 +00:00
</script>
2018-11-06 11:46:01 +00:00
<noscript>
<div>JavaScript is disabled on your browser.</div>
</noscript>
2014-04-01 11:30:48 +00:00
</div>
<div>
<ul class="subNavList">
<li>Summary:&nbsp;</li>
<li>Nested&nbsp;|&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
2016-06-02 09:57:18 +00:00
<li><a href="#constructor.summary">Constr</a>&nbsp;|&nbsp;</li>
<li><a href="#method.summary">Method</a></li>
2014-04-01 11:30:48 +00:00
</ul>
<ul class="subNavList">
<li>Detail:&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
2016-06-02 09:57:18 +00:00
<li><a href="#constructor.detail">Constr</a>&nbsp;|&nbsp;</li>
<li><a href="#method.detail">Method</a></li>
2014-04-01 11:30:48 +00:00
</ul>
</div>
2019-07-02 06:45:58 +00:00
<a id="skip.navbar.bottom">
2014-04-01 11:30:48 +00:00
<!-- -->
</a></div>
2012-05-21 20:32:26 +00:00
<!-- ======== END OF BOTTOM NAVBAR ======= -->
2019-07-02 06:45:58 +00:00
</nav>
2017-06-27 11:43:19 +00:00
<p class="legalCopy"><small><font size=1>Copyright (c) 2010-2017 <a href="http://www.jgraph.com/"
target="_blank">Gaudenz Alder, JGraph Ltd</a>. All rights reserved.</font></small></p>
2019-07-02 06:45:58 +00:00
</footer>
2014-04-01 11:30:48 +00:00
</body>
</html>