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">
<!-- NewPage -->
< HTML >
< HEAD >
2013-07-19 09:51:30 +00:00
<!-- Generated by javadoc (build 1.6.0_43) on Fri Jul 19 11:48:34 CEST 2013 -->
2012-05-21 20:32:26 +00:00
< TITLE >
2013-07-19 09:51:30 +00:00
mxICostFunction (mxGraph 2.1.0.3 API Specification)
2012-05-21 20:32:26 +00:00
< / TITLE >
2013-07-19 09:51:30 +00:00
< META NAME = "date" CONTENT = "2013-07-19" >
2012-05-21 20:32:26 +00:00
< LINK REL = "stylesheet" TYPE = "text/css" HREF = "../../../stylesheet.css" TITLE = "Style" >
< SCRIPT type = "text/javascript" >
function windowTitle()
{
if (location.href.indexOf('is-external=true') == -1) {
2013-07-19 09:51:30 +00:00
parent.document.title="mxICostFunction (mxGraph 2.1.0.3 API Specification)";
2012-05-21 20:32:26 +00:00
}
}
< / SCRIPT >
< NOSCRIPT >
< / NOSCRIPT >
< / HEAD >
< BODY BGCOLOR = "white" onload = "windowTitle();" >
< HR >
<!-- ========= START OF TOP NAVBAR ======= -->
< A NAME = "navbar_top" > <!-- --> < / A >
< A HREF = "#skip-navbar_top" title = "Skip navigation links" > < / A >
< TABLE BORDER = "0" WIDTH = "100%" CELLPADDING = "1" CELLSPACING = "0" SUMMARY = "" >
< TR >
< TD COLSPAN = 2 BGCOLOR = "#EEEEFF" CLASS = "NavBarCell1" >
< A NAME = "navbar_top_firstrow" > <!-- --> < / A >
< TABLE BORDER = "0" CELLPADDING = "0" CELLSPACING = "3" SUMMARY = "" >
< TR ALIGN = "center" VALIGN = "top" >
< TD BGCOLOR = "#EEEEFF" CLASS = "NavBarCell1" > < A HREF = "../../../overview-summary.html" > < FONT CLASS = "NavBarFont1" > < B > Overview< / B > < / FONT > < / A > < / TD >
< TD BGCOLOR = "#EEEEFF" CLASS = "NavBarCell1" > < A HREF = "package-summary.html" > < FONT CLASS = "NavBarFont1" > < B > Package< / B > < / FONT > < / A > < / TD >
< TD BGCOLOR = "#FFFFFF" CLASS = "NavBarCell1Rev" > < FONT CLASS = "NavBarFont1Rev" > < B > Class< / B > < / FONT > < / TD >
< TD BGCOLOR = "#EEEEFF" CLASS = "NavBarCell1" > < A HREF = "class-use/mxICostFunction.html" > < FONT CLASS = "NavBarFont1" > < B > Use< / B > < / FONT > < / A > < / TD >
< TD BGCOLOR = "#EEEEFF" CLASS = "NavBarCell1" > < A HREF = "package-tree.html" > < FONT CLASS = "NavBarFont1" > < B > Tree< / B > < / FONT > < / A > < / TD >
< TD BGCOLOR = "#EEEEFF" CLASS = "NavBarCell1" > < A HREF = "../../../deprecated-list.html" > < FONT CLASS = "NavBarFont1" > < B > Deprecated< / B > < / FONT > < / A > < / TD >
< TD BGCOLOR = "#EEEEFF" CLASS = "NavBarCell1" > < A HREF = "../../../index-all.html" > < FONT CLASS = "NavBarFont1" > < B > Index< / B > < / FONT > < / A > < / TD >
< TD BGCOLOR = "#EEEEFF" CLASS = "NavBarCell1" > < A HREF = "../../../help-doc.html" > < FONT CLASS = "NavBarFont1" > < B > Help< / B > < / FONT > < / A > < / TD >
< / TR >
< / TABLE >
< / TD >
< TD ALIGN = "right" VALIGN = "top" ROWSPAN = 3 > < EM >
2013-07-19 09:51:30 +00:00
< p > < b > mxGraph 2.1.0.3< / b > < / p > < / EM >
2012-05-21 20:32:26 +00:00
< / TD >
< / TR >
< TR >
< TD BGCOLOR = "white" CLASS = "NavBarCell2" > < FONT SIZE = "-2" >
2012-12-18 13:09:38 +00:00
< A HREF = "../../../com/mxgraph/analysis/mxGraphStructure.html" title = "class in com.mxgraph.analysis" > < B > PREV CLASS< / B > < / A >
2012-10-29 20:17:12 +00:00
< A HREF = "../../../com/mxgraph/analysis/mxTraversal.html" title = "class in com.mxgraph.analysis" > < B > NEXT CLASS< / B > < / A > < / FONT > < / TD >
2012-05-21 20:32:26 +00:00
< TD BGCOLOR = "white" CLASS = "NavBarCell2" > < FONT SIZE = "-2" >
< A HREF = "../../../index.html?com/mxgraph/analysis/mxICostFunction.html" target = "_top" > < B > FRAMES< / B > < / A >
< A HREF = "mxICostFunction.html" target = "_top" > < B > NO FRAMES< / B > < / A >
< SCRIPT type = "text/javascript" >
<!--
if(window==top) {
document.writeln('< A HREF = "../../../allclasses-noframe.html" > < B > All Classes< / B > < / A > ');
}
//-->
< / SCRIPT >
< NOSCRIPT >
< A HREF = "../../../allclasses-noframe.html" > < B > All Classes< / B > < / A >
< / NOSCRIPT >
< / FONT > < / TD >
< / TR >
< TR >
< TD VALIGN = "top" CLASS = "NavBarCell3" > < FONT SIZE = "-2" >
SUMMARY: NESTED | FIELD | CONSTR | < A HREF = "#method_summary" > METHOD< / A > < / FONT > < / TD >
< TD VALIGN = "top" CLASS = "NavBarCell3" > < FONT SIZE = "-2" >
DETAIL: FIELD | CONSTR | < A HREF = "#method_detail" > METHOD< / A > < / FONT > < / TD >
< / TR >
< / TABLE >
< A NAME = "skip-navbar_top" > < / A >
<!-- ========= END OF TOP NAVBAR ========= -->
< HR >
<!-- ======== START OF CLASS DATA ======== -->
< H2 >
< FONT SIZE = "-1" >
com.mxgraph.analysis< / FONT >
< BR >
Interface mxICostFunction< / H2 >
< DL >
2012-12-18 13:09:38 +00:00
< DT > < B > All Known Implementing Classes:< / B > < 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 >
2012-05-21 20:32:26 +00:00
< / DL >
< HR >
< DL >
< DT > < PRE > public interface < B > mxICostFunction< / B > < / DL >
< / PRE >
< P >
The cost function takes a cell and returns it's cost as a double. Two typical
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
< code > new mxConstantCostFunction(1)< / code > .
< P >
< P >
< HR >
< P >
<!-- ========== METHOD SUMMARY =========== -->
< A NAME = "method_summary" > <!-- --> < / A >
< TABLE BORDER = "1" WIDTH = "100%" CELLPADDING = "3" CELLSPACING = "0" SUMMARY = "" >
< TR BGCOLOR = "#CCCCFF" CLASS = "TableHeadingColor" >
< TH ALIGN = "left" COLSPAN = "2" > < FONT SIZE = "+2" >
< B > Method Summary< / B > < / FONT > < / TH >
< / TR >
< TR BGCOLOR = "white" CLASS = "TableRowColor" >
< TD ALIGN = "right" VALIGN = "top" WIDTH = "1%" > < FONT SIZE = "-1" >
< CODE > double< / CODE > < / FONT > < / TD >
< TD > < CODE > < B > < A HREF = "../../../com/mxgraph/analysis/mxICostFunction.html#getCost(com.mxgraph.view.mxCellState)" > getCost< / A > < / B > (< A HREF = "../../../com/mxgraph/view/mxCellState.html" title = "class in com.mxgraph.view" > mxCellState< / A > state)< / CODE >
< BR >
Evaluates the cost of the given cell state.< / TD >
< / TR >
< / TABLE >
< P >
<!-- ============ METHOD DETAIL ========== -->
< A NAME = "method_detail" > <!-- --> < / A >
< TABLE BORDER = "1" WIDTH = "100%" CELLPADDING = "3" CELLSPACING = "0" SUMMARY = "" >
< TR BGCOLOR = "#CCCCFF" CLASS = "TableHeadingColor" >
< TH ALIGN = "left" COLSPAN = "1" > < FONT SIZE = "+2" >
< B > Method Detail< / B > < / FONT > < / TH >
< / TR >
< / TABLE >
< A NAME = "getCost(com.mxgraph.view.mxCellState)" > <!-- --> < / A > < H3 >
getCost< / H3 >
< PRE >
double < B > getCost< / B > (< A HREF = "../../../com/mxgraph/view/mxCellState.html" title = "class in com.mxgraph.view" > mxCellState< / A > state)< / PRE >
< DL >
< DD > Evaluates the cost of the given cell state.
< P >
< DD > < DL >
< DT > < B > Parameters:< / B > < DD > < CODE > state< / CODE > - The cell state to be evaluated
< DT > < B > Returns:< / B > < DD > Returns the cost to traverse the given cell state.< / DL >
< / DD >
< / DL >
<!-- ========= END OF CLASS DATA ========= -->
< HR >
<!-- ======= START OF BOTTOM NAVBAR ====== -->
< A NAME = "navbar_bottom" > <!-- --> < / A >
< A HREF = "#skip-navbar_bottom" title = "Skip navigation links" > < / A >
< TABLE BORDER = "0" WIDTH = "100%" CELLPADDING = "1" CELLSPACING = "0" SUMMARY = "" >
< TR >
< TD COLSPAN = 2 BGCOLOR = "#EEEEFF" CLASS = "NavBarCell1" >
< A NAME = "navbar_bottom_firstrow" > <!-- --> < / A >
< TABLE BORDER = "0" CELLPADDING = "0" CELLSPACING = "3" SUMMARY = "" >
< TR ALIGN = "center" VALIGN = "top" >
< TD BGCOLOR = "#EEEEFF" CLASS = "NavBarCell1" > < A HREF = "../../../overview-summary.html" > < FONT CLASS = "NavBarFont1" > < B > Overview< / B > < / FONT > < / A > < / TD >
< TD BGCOLOR = "#EEEEFF" CLASS = "NavBarCell1" > < A HREF = "package-summary.html" > < FONT CLASS = "NavBarFont1" > < B > Package< / B > < / FONT > < / A > < / TD >
< TD BGCOLOR = "#FFFFFF" CLASS = "NavBarCell1Rev" > < FONT CLASS = "NavBarFont1Rev" > < B > Class< / B > < / FONT > < / TD >
< TD BGCOLOR = "#EEEEFF" CLASS = "NavBarCell1" > < A HREF = "class-use/mxICostFunction.html" > < FONT CLASS = "NavBarFont1" > < B > Use< / B > < / FONT > < / A > < / TD >
< TD BGCOLOR = "#EEEEFF" CLASS = "NavBarCell1" > < A HREF = "package-tree.html" > < FONT CLASS = "NavBarFont1" > < B > Tree< / B > < / FONT > < / A > < / TD >
< TD BGCOLOR = "#EEEEFF" CLASS = "NavBarCell1" > < A HREF = "../../../deprecated-list.html" > < FONT CLASS = "NavBarFont1" > < B > Deprecated< / B > < / FONT > < / A > < / TD >
< TD BGCOLOR = "#EEEEFF" CLASS = "NavBarCell1" > < A HREF = "../../../index-all.html" > < FONT CLASS = "NavBarFont1" > < B > Index< / B > < / FONT > < / A > < / TD >
< TD BGCOLOR = "#EEEEFF" CLASS = "NavBarCell1" > < A HREF = "../../../help-doc.html" > < FONT CLASS = "NavBarFont1" > < B > Help< / B > < / FONT > < / A > < / TD >
< / TR >
< / TABLE >
< / TD >
< TD ALIGN = "right" VALIGN = "top" ROWSPAN = 3 > < EM >
2013-07-19 09:51:30 +00:00
< p > < b > mxGraph 2.1.0.3< / b > < / p > < / EM >
2012-05-21 20:32:26 +00:00
< / TD >
< / TR >
< TR >
< TD BGCOLOR = "white" CLASS = "NavBarCell2" > < FONT SIZE = "-2" >
2012-12-18 13:09:38 +00:00
< A HREF = "../../../com/mxgraph/analysis/mxGraphStructure.html" title = "class in com.mxgraph.analysis" > < B > PREV CLASS< / B > < / A >
2012-10-29 20:17:12 +00:00
< A HREF = "../../../com/mxgraph/analysis/mxTraversal.html" title = "class in com.mxgraph.analysis" > < B > NEXT CLASS< / B > < / A > < / FONT > < / TD >
2012-05-21 20:32:26 +00:00
< TD BGCOLOR = "white" CLASS = "NavBarCell2" > < FONT SIZE = "-2" >
< A HREF = "../../../index.html?com/mxgraph/analysis/mxICostFunction.html" target = "_top" > < B > FRAMES< / B > < / A >
< A HREF = "mxICostFunction.html" target = "_top" > < B > NO FRAMES< / B > < / A >
< SCRIPT type = "text/javascript" >
<!--
if(window==top) {
document.writeln('< A HREF = "../../../allclasses-noframe.html" > < B > All Classes< / B > < / A > ');
}
//-->
< / SCRIPT >
< NOSCRIPT >
< A HREF = "../../../allclasses-noframe.html" > < B > All Classes< / B > < / A >
< / NOSCRIPT >
< / FONT > < / TD >
< / TR >
< TR >
< TD VALIGN = "top" CLASS = "NavBarCell3" > < FONT SIZE = "-2" >
SUMMARY: NESTED | FIELD | CONSTR | < A HREF = "#method_summary" > METHOD< / A > < / FONT > < / TD >
< TD VALIGN = "top" CLASS = "NavBarCell3" > < FONT SIZE = "-2" >
DETAIL: FIELD | CONSTR | < A HREF = "#method_detail" > METHOD< / A > < / FONT > < / TD >
< / TR >
< / TABLE >
< A NAME = "skip-navbar_bottom" > < / A >
<!-- ======== END OF BOTTOM NAVBAR ======= -->
< HR >
< font size = 1 > Copyright (c) 2010 < a href = "http://www.mxgraph.com/"
target="_blank">Gaudenz Alder, David Benson< / a > . All rights reserved.< / font >
< / BODY >
< / HTML >
