org.osm2world.core.world.network
Interface NetworkWaySegmentWorldObject

All Superinterfaces:

WorldObject

All Known Implementing Classes:

AbstractNetworkWaySegmentWorldObject, RoadModule.Road, WaterModule.Waterway

public interface NetworkWaySegmentWorldObject
extends WorldObject

"networks" are sets of WorldObjects that have certain frequently required characteristics. Most importantly, a network consists of nodes, lines and areas linked with each other. Other characteristics include - cut angles where lines (or lines and areas) connect - junctions at nodes that occupy some area and push back connecting lines //TODO (documentation): explain more Features using these types of representation include roads, railways and rivers.

Method Summary

VectorXZ	getEndCutVector() returns the cut vector for the end of the line.
VectorXZ	getEndOffset() returns the current offset for the end of the line.
VectorXZ	getStartCutVector() returns the cut vector for the start of the line.
VectorXZ	getStartOffset() returns the current offset for the end of the line.
float	getWidth() returns the line's width
void	setEndCutVector(VectorXZ cutVector) Sets the cut vector for the end of the line.
void	setEndOffset(VectorXZ offsetVector) Sets the offset for the end of the line.
void	setStartCutVector(VectorXZ cutVector) Sets the cut vector for the start of the line.
void	setStartOffset(VectorXZ offsetVector) Sets the offset for the start of the line.

Methods inherited from interface WorldObject

getClearingAbove, getClearingBelow, getGroundState, getPrimaryMapElement

Method Detail

getWidth

float getWidth()

returns the line's width

getStartCutVector

VectorXZ getStartCutVector()

returns the cut vector for the start of the line. Only available after setStartCutVector(VectorXZ).

setStartCutVector

void setStartCutVector(VectorXZ cutVector)

Sets the cut vector for the start of the line. //TODO: explain "cut vectors" To be used by NetworkCalculator.

getEndCutVector

VectorXZ getEndCutVector()

returns the cut vector for the end of the line. Only available after setStartCutVector(VectorXZ).

setEndCutVector

void setEndCutVector(VectorXZ cutVector)

Sets the cut vector for the end of the line. //TODO: explain "cut vectors" To be used by NetworkCalculator.

getStartOffset

VectorXZ getStartOffset()

returns the current offset for the end of the line. Should already be usable before first setEndOffset(VectorXZ) call, returning (0,0).

setStartOffset

void setStartOffset(VectorXZ offsetVector)

Sets the offset for the start of the line. To be used by NetworkCalculator.

getEndOffset

VectorXZ getEndOffset()

returns the current offset for the end of the line. Should already be usable before first setEndOffset(VectorXZ) call, returning (0,0).

setEndOffset

void setEndOffset(VectorXZ offsetVector)

Sets the offset for the end of the line. To be used by NetworkCalculator.