Class Land.Point
raft.kilavuz.runtime
java.lang.Object
  raft.kilavuz.runtime.Land.Point
Enclosing class:

public static class Land.Point
extends Object
a point in grid space. point instances are generally created by Land.getPoint(Vector3) points are generally used in path seqeunces
See Also:
Land.getPoint(SimpleVector)

Field Summary
sector
sector this point belongs to
float
x
x coordinate in grid space
float
z
z coordinate in grid space
Method Summary
clone()
clones this point
boolean
equals(Object other)
checks if this point equals another object.
boolean
equals(Land.Point other)
checks if this point equals another.
int
getAction()
returns the action should be taken at this point (such as jump, open door etc) this information is only meaningful in path sequences
float
getElevation()
return interpolated elevation at this point
getLand()
returns land this point belongs to
getLocation()
returns location of this point in world space.
getPointOnAdjacentSector()
returns a point with same coordinates but belongs to adjacent sector.
boolean
inSameCell(Land.Point other)
checks if this point is in same cell with another.
boolean
isPortalExit()
returns true if this point at exit line of regular portal.
toString()
returns string represantation of this point
Field Detail
x
public final float x
x coordinate in grid space

z
public final float z
z coordinate in grid space

sector
public final Land.Sector sector
sector this point belongs to
Method Detail
clone
public Land.Point clone()
clones this point
Overrides:
clone in class Object

getAction
public int getAction()
returns the action should be taken at this point (such as jump, open door etc) this information is only meaningful in path sequences

isPortalExit
public boolean isPortalExit()
returns true if this point at exit line of regular portal. exits points are by Path.Iterator's to mark sector boundaries

inSameCell
public boolean inSameCell(Land.Point other)
checks if this point is in same cell with another. for a healty land returning true should mean two points are the same

getLocation
public Vector3 getLocation()
returns location of this point in world space.

getElevation
public float getElevation()
return interpolated elevation at this point

getLand
public Land getLand()
returns land this point belongs to

equals
public boolean equals(Object other)
checks if this point equals another object. return true if other is an instance of Point and x, z and sector are equal to other's
Overrides:
equals in class Object

equals
public boolean equals(Land.Point other)
checks if this point equals another. return true if x, z and sector are equal to other's

getPointOnAdjacentSector
public Land.Point getPointOnAdjacentSector()
returns a point with same coordinates but belongs to adjacent sector. calling this method on a point which is not a border point make no sense and results in exception
Throws:
IllegalStateException - if this is not a border point
See Also:

toString
public String toString()
returns string represantation of this point
Overrides:
toString in class Object
Java API documentation generated with DocFlex/Doclet v1.5.2
DocFlex/Doclet is both a multi-format Javadoc doclet and a free edition of DocFlex/Javadoc. If you need to customize your Javadoc without writing a full-blown doclet from scratch, DocFlex/Javadoc may be the only tool able to help you! Find out more at www.docflex.com