_MinchinWeb_LW_ Class Reference

Line Walker. More...

Public Member Functions
function	Start (Tile)
	Sets the starting tile for LineWalker.
function	End (Tile)
	Sets the ending tile for LineWalker.
function	Slope (Slope, ThirdQuadrant=false)
	Sets the slope for LineWalker.
function	Reset ()
	Resets the variables for the LineWalker.
function	Restart ()
	Moves the LineWalker to the original starting position.
function	Walk ()
	'Walks' the LineWalker one tile at a tile
function	IsEnd ()
	Returns True if we are at the edge of the bounding box defined by the Starting and Ending point.
function	GetStart ()
	Returns the tile the LineWalker is starting on.
function	GetEnd ()
	Returns the tile the LineWalker is ending on.

Private Member Functions
	constructor ()

Private Attributes
	_start = null
	start tile
	_end = null
	end tile
	_slope = null
	line slope
	_start_x = null
	x value of start tile
	_start_y = null
	y value of start tile
	_end_x = null
	x value of end tile
	_end_y = null
	y value of end tile
	_past_end = null
	_x = null
	x value of current tile
	_y = null
	y value of current tile
	_dir_x = null
	_current_tile = null
	current tile

Detailed Description

Line Walker.

Version

v.1 (2012-01-28)

Author

W. Minchin (MinchinWeb)

Since

MetaLibrary v.4

The LineWalker class allows you to define a starting and endpoint, and then 'walk' all the tiles between the two. Alternately, you can give a starting point and a slope. It was originally part of my Ship Pathfinder, also part of Minchinweb's MetaLibrary.

Note

Plane geometry does funky things when you don't have an infinity, or by extension, zero (the inverse of infinity) for slopes. To get around the fact integer conversions drop everything past the decimal point (effectively rounding down), slopes are set so that there is a slight inflection point at the 'origin' so that as you move out from the start point, so stay slightly above the 'unchanging' index...

LineWalker is designed to be a persistent class.

See also

_MinchinWeb_SW_

Definition at line 53 of file Line.Walker.nut.

Member Function Documentation

constructor()

_MinchinWeb_LW_::constructor ( )

inlineprivate

Definition at line 67 of file Line.Walker.nut.

End()

function _MinchinWeb_LW_::End

(

Tile

)

Sets the ending tile for LineWalker.

Note

If the slope is also directly set, the start and end tiles define a bounding box. Otherwise, the slope is calculated between the start and end tiles.

See also

Start()

Slope()

GetEnd()

Definition at line 187 of file Line.Walker.nut.

GetEnd()

function _MinchinWeb_LW_::GetEnd ( )

inline

Returns the tile the LineWalker is ending on.

Returns

The tile the LineWalker is ending on

See also

End()

IsEnd()

Definition at line 142 of file Line.Walker.nut.

GetStart()

function _MinchinWeb_LW_::GetStart ( )

inline

Returns the tile the LineWalker is starting on.

Returns

The tile the LineWalker is starting on

See also

Start()

Definition at line 135 of file Line.Walker.nut.

IsEnd()

function _MinchinWeb_LW_::IsEnd ( )

inline

Returns True if we are at the edge of the bounding box defined by the Starting and Ending point.

Returns

True if we are at the edge of the bounding box defined by the Starting and Ending point

See also

End()

GetEnd()

Definition at line 129 of file Line.Walker.nut.

Reset()

function _MinchinWeb_LW_::Reset

(

)

Resets the variables for the LineWalker.

See also

Restart()

Definition at line 260 of file Line.Walker.nut.

Restart()

function _MinchinWeb_LW_::Restart

(

)

Moves the LineWalker to the original starting position.

See also

Reset()

Definition at line 275 of file Line.Walker.nut.

Slope()

function _MinchinWeb_LW_::Slope	(	Slope	,
		ThirdQuadrant	= false )

Sets the slope for LineWalker.

Note

Assumes that the slope is in the first or second quadrant unless ThirdQuadrant == true

Todo

Add a picture of the four Cartesian quadrants

Definition at line 220 of file Line.Walker.nut.

Start()

function _MinchinWeb_LW_::Start

(

Tile

)

Sets the starting tile for LineWalker.

See also

End()

Slope()

Restart()

Reset()

GetStart()

Definition at line 148 of file Line.Walker.nut.

Walk()

function _MinchinWeb_LW_::Walk

(

)

'Walks' the LineWalker one tile at a tile

Returns

the tile that the LineWalker is now "standing on"

Note

This is where (most) of the action is!

Before calling this function, you need to set the Start() and at least one of End() or Slope().

Definition at line 284 of file Line.Walker.nut.

Member Data Documentation

_current_tile

_MinchinWeb_LW_::_current_tile = null

private

current tile

Definition at line 65 of file Line.Walker.nut.

_dir_x

_MinchinWeb_LW_::_dir_x = null

private

Definition at line 64 of file Line.Walker.nut.

_end

_MinchinWeb_LW_::_end = null

private

end tile

Definition at line 55 of file Line.Walker.nut.

_end_x

_MinchinWeb_LW_::_end_x = null

private

x value of end tile

Definition at line 59 of file Line.Walker.nut.

_end_y

_MinchinWeb_LW_::_end_y = null

private

y value of end tile

Definition at line 60 of file Line.Walker.nut.

_past_end

_MinchinWeb_LW_::_past_end = null

private

Definition at line 61 of file Line.Walker.nut.

_slope

_MinchinWeb_LW_::_slope = null

private

line slope

Definition at line 56 of file Line.Walker.nut.

_start

_MinchinWeb_LW_::_start = null

private

start tile

Definition at line 54 of file Line.Walker.nut.

_start_x

_MinchinWeb_LW_::_start_x = null

private

x value of start tile

Definition at line 57 of file Line.Walker.nut.

_start_y

_MinchinWeb_LW_::_start_y = null

private

y value of start tile

Definition at line 58 of file Line.Walker.nut.

_x

_MinchinWeb_LW_::_x = null

private

x value of current tile

Definition at line 62 of file Line.Walker.nut.

_y

_MinchinWeb_LW_::_y = null

private

y value of current tile

Definition at line 63 of file Line.Walker.nut.

---

The documentation for this class was generated from the following file:

• Line.Walker.nut