Packageorg.ffilmation.engine.interfaces
Interfacepublic interface fEnginePathfindCriteria

This interface defines the methods that any class that is to be used as pathFind criteria must implement


Public Methods
 MethodDefined by
  
getAccessibleFrom(cell:fCell):Array
Returns a weighed list of a cells's accessible neighbours.
fEnginePathfindCriteria
  
getDestiny():fPoint3d
This method return the destiny point for this search
fEnginePathfindCriteria
  
getDestinyCell():fCell
This method return the destiny cell for this search
fEnginePathfindCriteria
  
getHeuristic(cell:fCell):Number
Returns a n heuristic value for any cell in the scene.
fEnginePathfindCriteria
  
getOrigin():fPoint3d
This method return the origin point for this search
fEnginePathfindCriteria
  
getOriginCell():fCell
This method return the origin cell for this search
fEnginePathfindCriteria
Method detail
getAccessibleFrom()method
public function getAccessibleFrom(cell:fCell):Array

Returns a weighed list of a cells's accessible neighbours. This method updates each cell in the returned list, setting its "cost" temporal property with the cost associated to move from the input cell into that cell.

Parameters
cell:fCell

Returns
Array — An array of fCells.
getDestiny()method 
public function getDestiny():fPoint3d

This method return the destiny point for this search

Returns
fPoint3d — The destiny point
getDestinyCell()method 
public function getDestinyCell():fCell

This method return the destiny cell for this search

Returns
fCell — The destiny cell
getHeuristic()method 
public function getHeuristic(cell:fCell):Number

Returns a n heuristic value for any cell in the scene. The engine works with cell precision: any point inside the same cell as the destination point has to be considered the destination point.

Parameters
cell:fCell — The cell for which we must calculate its heuristic

Returns
Number — The heuristic score for this cell. A value of 0 indicates that we reached our objective
getOrigin()method 
public function getOrigin():fPoint3d

This method return the origin point for this search

Returns
fPoint3d — The origin point
getOriginCell()method 
public function getOriginCell():fCell

This method return the origin cell for this search

Returns
fCell — The origin cell