2012-05-21 20:32:26 +00:00
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
2014-04-01 11:30:48 +00:00
<!-- NewPage -->
< html lang = "en" >
< head >
2014-11-28 08:55:09 +00:00
<!-- Generated by javadoc (version 1.7.0_51) on Fri Nov 28 03:53:16 EST 2014 -->
< title > mxICostFunction (mxGraph 3.1.2.0 API Specification)< / title >
< meta name = "date" content = "2014-11-28" >
2014-04-01 11:30:48 +00:00
< link rel = "stylesheet" type = "text/css" href = "../../../stylesheet.css" title = "Style" >
< / head >
< body >
< script type = "text/javascript" > < ! - -
2012-05-21 20:32:26 +00:00
if (location.href.indexOf('is-external=true') == -1) {
2014-11-28 08:55:09 +00:00
parent.document.title="mxICostFunction (mxGraph 3.1.2.0 API Specification)";
2012-05-21 20:32:26 +00:00
}
2014-04-01 11:30:48 +00:00
//-->
< / script >
< noscript >
< div > JavaScript is disabled on your browser.< / div >
< / noscript >
2012-05-21 20:32:26 +00:00
<!-- ========= START OF TOP NAVBAR ======= -->
2014-04-01 11:30:48 +00:00
< div class = "topNav" > < a name = "navbar_top" >
<!-- -->
< / a > < a href = "#skip-navbar_top" title = "Skip navigation links" > < / a > < a name = "navbar_top_firstrow" >
<!-- -->
< / a >
< ul class = "navList" title = "Navigation" >
< li > < a href = "../../../overview-summary.html" > Overview< / a > < / li >
< li > < a href = "package-summary.html" > Package< / a > < / li >
< li class = "navBarCell1Rev" > Class< / li >
< li > < a href = "class-use/mxICostFunction.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 >
2014-11-28 08:55:09 +00:00
< div class = "aboutLanguage" > < em > < p > < b > mxGraph 3.1.2.0< / b > < / p > < / em > < / div >
2014-04-01 11:30:48 +00:00
< / div >
< div class = "subNav" >
< ul class = "navList" >
< li > < a href = "../../../com/mxgraph/analysis/mxGraphStructure.html" title = "class in com.mxgraph.analysis" > < span class = "strong" > Prev Class< / span > < / a > < / li >
< li > < a href = "../../../com/mxgraph/analysis/mxTraversal.html" title = "class in com.mxgraph.analysis" > < span class = "strong" > Next Class< / span > < / a > < / li >
< / ul >
< ul class = "navList" >
< li > < a href = "../../../index.html?com/mxgraph/analysis/mxICostFunction.html" target = "_top" > Frames< / a > < / li >
< li > < a href = "mxICostFunction.html" target = "_top" > No Frames< / a > < / li >
< / ul >
< ul class = "navList" id = "allclasses_navbar_top" >
< li > < a href = "../../../allclasses-noframe.html" > All Classes< / a > < / li >
< / ul >
< 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 >
< / div >
< div >
< ul class = "subNavList" >
< li > Summary: < / li >
< li > Nested | < / li >
< li > Field | < / li >
< li > Constr | < / li >
< li > < a href = "#method_summary" > Method< / a > < / li >
< / ul >
< ul class = "subNavList" >
< li > Detail: < / li >
< li > Field | < / li >
< li > Constr | < / li >
< li > < a href = "#method_detail" > Method< / a > < / li >
< / ul >
< / div >
< a name = "skip-navbar_top" >
<!-- -->
< / a > < / div >
2012-05-21 20:32:26 +00:00
<!-- ========= END OF TOP NAVBAR ========= -->
<!-- ======== START OF CLASS DATA ======== -->
2014-04-01 11:30:48 +00:00
< div class = "header" >
< div class = "subTitle" > com.mxgraph.analysis< / div >
< h2 title = "Interface mxICostFunction" class = "title" > Interface mxICostFunction< / h2 >
< / div >
< div class = "contentContainer" >
< div class = "description" >
< ul class = "blockList" >
< li class = "blockList" >
< dl >
< dt > All Known Implementing Classes:< / dt >
< dd > < a href = "../../../com/mxgraph/analysis/mxConstantCostFunction.html" title = "class in com.mxgraph.analysis" > mxConstantCostFunction< / a > , < a href = "../../../com/mxgraph/costfunction/mxConstCostFunction.html" title = "class in com.mxgraph.costfunction" > mxConstCostFunction< / a > , < a href = "../../../com/mxgraph/costfunction/mxCostFunction.html" title = "class in com.mxgraph.costfunction" > mxCostFunction< / a > , < a href = "../../../com/mxgraph/analysis/mxDistanceCostFunction.html" title = "class in com.mxgraph.analysis" > mxDistanceCostFunction< / a > , < a href = "../../../com/mxgraph/costfunction/mxDoubleValCostFunction.html" title = "class in com.mxgraph.costfunction" > mxDoubleValCostFunction< / a > , < a href = "../../../com/mxgraph/generatorfunction/mxGeneratorConstFunction.html" title = "class in com.mxgraph.generatorfunction" > mxGeneratorConstFunction< / a > , < a href = "../../../com/mxgraph/generatorfunction/mxGeneratorFunction.html" title = "class in com.mxgraph.generatorfunction" > mxGeneratorFunction< / a > , < a href = "../../../com/mxgraph/generatorfunction/mxGeneratorRandomFunction.html" title = "class in com.mxgraph.generatorfunction" > mxGeneratorRandomFunction< / a > , < a href = "../../../com/mxgraph/generatorfunction/mxGeneratorRandomIntFunction.html" title = "class in com.mxgraph.generatorfunction" > mxGeneratorRandomIntFunction< / a > < / dd >
< / dl >
< hr >
< br >
< pre > public interface < span class = "strong" > mxICostFunction< / span > < / pre >
< div class = "block" > The cost function takes a cell and returns it's cost as a double. Two typical
2012-05-21 20:32:26 +00:00
examples of cost functions are the euclidian length of edges or a constant
number for each edge. To use one of the built-in cost functions, use either
< code > new mxDistanceCostFunction(graph)< / code > or
2014-04-01 11:30:48 +00:00
< code > new mxConstantCostFunction(1)< / code > .< / div >
< / li >
< / ul >
< / div >
< div class = "summary" >
< ul class = "blockList" >
< li class = "blockList" >
2012-05-21 20:32:26 +00:00
<!-- ========== METHOD SUMMARY =========== -->
2014-04-01 11:30:48 +00:00
< ul class = "blockList" >
< li class = "blockList" > < a name = "method_summary" >
<!-- -->
< / a >
< h3 > Method Summary< / h3 >
< table class = "overviewSummary" border = "0" cellpadding = "3" cellspacing = "0" summary = "Method Summary table, listing methods, and an explanation" >
< caption > < span > Methods< / span > < span class = "tabEnd" > < / span > < / caption >
< tr >
< th class = "colFirst" scope = "col" > Modifier and Type< / th >
< th class = "colLast" scope = "col" > Method and Description< / th >
< / tr >
< tr class = "altColor" >
< td class = "colFirst" > < code > double< / code > < / td >
< td class = "colLast" > < code > < strong > < a href = "../../../com/mxgraph/analysis/mxICostFunction.html#getCost(com.mxgraph.view.mxCellState)" > getCost< / a > < / strong > (< a href = "../../../com/mxgraph/view/mxCellState.html" title = "class in com.mxgraph.view" > mxCellState< / a > state)< / code >
< div class = "block" > Evaluates the cost of the given cell state.< / div >
< / td >
< / tr >
< / table >
< / li >
< / ul >
< / li >
< / ul >
< / div >
< div class = "details" >
< ul class = "blockList" >
< li class = "blockList" >
2012-05-21 20:32:26 +00:00
<!-- ============ METHOD DETAIL ========== -->
2014-04-01 11:30:48 +00:00
< ul class = "blockList" >
< li class = "blockList" > < a name = "method_detail" >
<!-- -->
< / a >
< h3 > Method Detail< / h3 >
< a name = "getCost(com.mxgraph.view.mxCellState)" >
<!-- -->
< / a >
< ul class = "blockListLast" >
< li class = "blockList" >
< h4 > getCost< / h4 >
< pre > double getCost(< a href = "../../../com/mxgraph/view/mxCellState.html" title = "class in com.mxgraph.view" > mxCellState< / a > state)< / pre >
< div class = "block" > Evaluates the cost of the given cell state.< / div >
< dl > < dt > < span class = "strong" > Parameters:< / span > < / dt > < dd > < code > state< / code > - The cell state to be evaluated< / dd >
< dt > < span class = "strong" > Returns:< / span > < / dt > < dd > Returns the cost to traverse the given cell state.< / dd > < / dl >
< / li >
< / ul >
< / li >
< / ul >
< / li >
< / ul >
< / div >
< / div >
2012-05-21 20:32:26 +00:00
<!-- ========= END OF CLASS DATA ========= -->
<!-- ======= START OF BOTTOM NAVBAR ====== -->
2014-04-01 11:30:48 +00:00
< div class = "bottomNav" > < a name = "navbar_bottom" >
<!-- -->
< / a > < a href = "#skip-navbar_bottom" title = "Skip navigation links" > < / a > < a name = "navbar_bottom_firstrow" >
<!-- -->
< / a >
< ul class = "navList" title = "Navigation" >
< li > < a href = "../../../overview-summary.html" > Overview< / a > < / li >
< li > < a href = "package-summary.html" > Package< / a > < / li >
< li class = "navBarCell1Rev" > Class< / li >
< li > < a href = "class-use/mxICostFunction.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 >
2014-11-28 08:55:09 +00:00
< div class = "aboutLanguage" > < em > < p > < b > mxGraph 3.1.2.0< / b > < / p > < / em > < / div >
2014-04-01 11:30:48 +00:00
< / div >
< div class = "subNav" >
< ul class = "navList" >
< li > < a href = "../../../com/mxgraph/analysis/mxGraphStructure.html" title = "class in com.mxgraph.analysis" > < span class = "strong" > Prev Class< / span > < / a > < / li >
< li > < a href = "../../../com/mxgraph/analysis/mxTraversal.html" title = "class in com.mxgraph.analysis" > < span class = "strong" > Next Class< / span > < / a > < / li >
< / ul >
< ul class = "navList" >
< li > < a href = "../../../index.html?com/mxgraph/analysis/mxICostFunction.html" target = "_top" > Frames< / a > < / li >
< li > < a href = "mxICostFunction.html" target = "_top" > No Frames< / a > < / li >
< / ul >
< ul class = "navList" id = "allclasses_navbar_bottom" >
< li > < a href = "../../../allclasses-noframe.html" > All Classes< / a > < / li >
< / 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 >
< / div >
< div >
< ul class = "subNavList" >
< li > Summary: < / li >
< li > Nested | < / li >
< li > Field | < / li >
< li > Constr | < / li >
< li > < a href = "#method_summary" > Method< / a > < / li >
< / ul >
< ul class = "subNavList" >
< li > Detail: < / li >
< li > Field | < / li >
< li > Constr | < / li >
< li > < a href = "#method_detail" > Method< / a > < / li >
< / ul >
< / div >
< a name = "skip-navbar_bottom" >
<!-- -->
< / a > < / div >
2012-05-21 20:32:26 +00:00
<!-- ======== END OF BOTTOM NAVBAR ======= -->
2014-04-01 11:30:48 +00:00
< p class = "legalCopy" > < small > < font size = 1 > Copyright (c) 2010 < a href = "http://www.mxgraph.com/"
target="_blank">Gaudenz Alder, David Benson< / a > . All rights reserved.< / font > < / small > < / p >
< / body >
< / html >
