#include <GLViewer_Tools.h>

Public Types
enum	FieldPoint { FP_Start = 0 , FP_End = 1 }
	Searched point. More...

enum	IterationStatus { IS_ERROR = 0 , IS_LOOP , IS_NOT_SOLVED , IS_SOLVED }
	Status of interation. More...

enum	EndStatus { ES_ERROR = 0 , ES_LOOP , ES_SOLVED }
	Final status of solving. More...

Public Member Functions
	GLViewer_LineField ()

	GLViewer_LineField (const int theMAXSize, const int xn, const int yn)

virtual	~GLViewer_LineField ()

void	addLine (FieldDim, GLViewer_LineList *)
	Adds new line. More...

void	addLine (FieldDim theDim, double theMC, double theBegin, double theEnd)
	Calls previous. More...

int	insertLine (FieldDim theDim, GLViewer_LineList *, int thePosition)
	Adds new line and sorted field. More...

int	insertLine (FieldDim theDim, double theMC, double theBegin, double theEnd, int thePosition)
	Calls previous. More...

GLViewer_LineList *	getLine (int index, FieldDim)
	Returns line by index and dimension. More...

void	setBorders (double X1, double X2, double Y1, double Y2)
	Nullifys field and sets same continued segments. More...

void	addRectangle (double top, double right, double bottom, double left)
	Cut rectangle in grid. More...

int *	intersectIndexes (FieldDim theDim, int theIndex, const GLViewer_LineList *theLL, int &theSize)
	returns arrey of intersects indexes with More...

void	print ()

void	show ()

int	getDimSize (FieldDim)

int	segmentNumber ()
	Returns number of segment. More...

bool	setPoint (FieldPoint, double x, double y)
	Sets start/end search point. More...

void	optimize ()
	Optimize field. More...

void	initialize ()
	Some prepare actions. More...

EndStatus	startAlgorithm ()
	Main method. More...

double *	solution (int &size)
	Returns solution and size of solution. More...

Static Public Member Functions
static FieldDim	invertDim (FieldDim)
	Returns other dimension. More...

Protected Member Functions
void	iteration ()
	One iteration of algorithm. More...

IterationStatus	checkComplete ()
	Checks for complete status. More...

int *	findByCount (int &theParam)
	Finds LineList by counts and returns indexes. More...

int	findBySegment (FieldDim, int coord1, int coord2, bool inCurArray=true)
	Finds LineList by segment and dimension. More...

GraphNode *	getCurArray ()
	Returns current solution array. More...

GraphNode *	getSecArray ()
	Returns. More...

int	maxSegmentNum ()
	Returns maximum segment number. More...

GLViewer_LineList **	getLLArray (FieldDim)
	Returns list of LileList by dimension. More...

Private Attributes
GLViewer_LineList **	myXLineArray

GLViewer_LineList **	myYLineArray

int	myXSize

int	myYSize

GraphNode *	myGraphArray1

GraphNode *	myGraphArray2

int	myCurArrayIndex

SearchPoint	myStartPoint

SearchPoint	myEndPoint

int	myCurCount

Detailed Description

Tools for solving algorithm of finding shortest path on rare grid with minimum of line turns number

Member Enumeration Documentation

◆ EndStatus

enum GLViewer_LineField::EndStatus

Final status of solving.

Enumerator
ES_ERROR
ES_LOOP
ES_SOLVED

◆ FieldPoint

enum GLViewer_LineField::FieldPoint

Searched point.

Enumerator
FP_Start
FP_End

◆ IterationStatus

enum GLViewer_LineField::IterationStatus

Status of interation.

Enumerator
IS_ERROR
IS_LOOP
IS_NOT_SOLVED
IS_SOLVED

Constructor & Destructor Documentation

◆ GLViewer_LineField() [1/2]

GLViewer_LineField::GLViewer_LineField ( )

Constructor

References myCurArrayIndex, myCurCount, myGraphArray1, myGraphArray2, myXLineArray, myXSize, myYLineArray, and myYSize.

◆ GLViewer_LineField() [2/2]

GLViewer_LineField::GLViewer_LineField	(	const int	theMAXSize,
		const int	theXN,
		const int	theYN
	)

Constructor

References myCurArrayIndex, myCurCount, myGraphArray1, myGraphArray2, myXLineArray, myXSize, myYLineArray, and myYSize.

◆ ~GLViewer_LineField()

GLViewer_LineField::~GLViewer_LineField ( )

virtual

Destructor

References myGraphArray1, myGraphArray2, myXLineArray, myXSize, myYLineArray, and myYSize.

Member Function Documentation

◆ addLine() [1/2]

void GLViewer_LineField::addLine	(	FieldDim	theDim,
		double	theMC,
		double	theBegin,
		double	theEnd
	)

Calls previous.

Adds line

Parameters

theDim	- dimension
theMC	- main co-ordinate
theBegin	- start co-ordinate
theEnd	- end co-ordinate

References addLine(), GLViewer_LineList::addSegment(), and GLViewer_LineList::setMainCoord().

◆ addLine() [2/2]

void GLViewer_LineField::addLine	(	FieldDim	,
		GLViewer_LineList *
	)

Adds new line.

best way, if line is already sorted

Adds line

◆ addRectangle()

void GLViewer_LineField::addRectangle	(	double	top,
		double	right,
		double	bottom,
		double	left
	)

Cut rectangle in grid.

Adds rectangle

Parameters

top,right	- a corner of rectangle
bottom,left	- other corner of rectangle

References GLViewer_LineList::mainCoord(), myXLineArray, myXSize, myYLineArray, myYSize, and GLViewer_LineList::removeSegment().

◆ checkComplete()

GLViewer_LineField::IterationStatus GLViewer_LineField::checkComplete ( )

protected

Checks for complete status.

Checks for complete status

References FD_X, FD_Y, getCurArray(), getSecArray(), IS_ERROR, IS_LOOP, IS_NOT_SOLVED, IS_SOLVED, GraphNode::myCount, myCurArrayIndex, myEndPoint, myGraphArray1, myGraphArray2, GraphNode::mySegmentindex, SearchPoint::mySolveIndex, myXLineArray, SearchPoint::myXLineIndex, SearchPoint::myXSegmentIndex, myYLineArray, SearchPoint::myYLineIndex, SearchPoint::myYSegmentIndex, GraphNode::prevNodeIndex, and segmentNumber().

◆ findByCount()

int * GLViewer_LineField::findByCount ( int & theParam )

protected

Finds LineList by counts and returns indexes.

Finds LineList by counts and returns indexes

References getCurArray(), GraphNode::myCount, myGraphArray1, myGraphArray2, myXLineArray, myYLineArray, and segmentNumber().

◆ findBySegment()

int GLViewer_LineField::findBySegment	(	FieldDim	theDim,
		int	theLineIndex,
		int	theSegment,
		bool	inCurArray = `true`
	)

protected

Finds LineList by segment and dimension.

Finds LineList by segment and dimension

References getCurArray(), getDimSize(), getSecArray(), GraphNode::myDim, myGraphArray1, myGraphArray2, GraphNode::myLineIndex, GraphNode::mySegmentindex, myXLineArray, myYLineArray, and segmentNumber().

◆ getCurArray()

GraphNode * GLViewer_LineField::getCurArray ( )

protected

Returns current solution array.

Returns: current solution array

References myCurArrayIndex, myGraphArray1, and myGraphArray2.

◆ getDimSize()

int GLViewer_LineField::getDimSize ( FieldDim theDim )

Returns: size

Parameters

theDim - dimension

References FD_X, FD_Y, myXSize, and myYSize.

◆ getLine()

GLViewer_LineList * GLViewer_LineField::getLine	(	int	theIndex,
		FieldDim	theFD
	)

Returns line by index and dimension.

Returns: line list

Parameters

theIndex	- index in list
tehFD	- dimension

References FD_X, FD_Y, myXLineArray, myXSize, myYLineArray, and myYSize.

◆ getLLArray()

GLViewer_LineList ** GLViewer_LineField::getLLArray ( FieldDim theDim )

protected

Returns list of LileList by dimension.

Returns: list of LileList by dimension

Parameters

theDim - dimension

References FD_X, FD_Y, myXLineArray, and myYLineArray.

◆ getSecArray()

GraphNode * GLViewer_LineField::getSecArray ( )

protected

Returns.

Returns: other solution array

References myCurArrayIndex, myGraphArray1, and myGraphArray2.

◆ initialize()

void GLViewer_LineField::initialize ( )

Some prepare actions.

Needs call setPoint before

Some prepare actions Needs call setPoint before

References GLViewer_LineList::count(), FD_X, FD_Y, getDimSize(), getLine(), GraphNode::myCount, myCurArrayIndex, myCurCount, GraphNode::myDim, myGraphArray1, myGraphArray2, GraphNode::myLineIndex, GraphNode::mySegmentindex, myStartPoint, myXLineArray, SearchPoint::myXLineIndex, SearchPoint::myXSegmentIndex, myYLineArray, SearchPoint::myYLineIndex, SearchPoint::myYSegmentIndex, GraphNode::prevNodeIndex, and segmentNumber().

◆ insertLine() [1/2]

int GLViewer_LineField::insertLine	(	FieldDim	theDim,
		double	theMainCoord,
		double	theBegin,
		double	theEnd,
		int	thePosition
	)

Calls previous.

Adds line

Parameters

theDim	- dimension
theMainCoord	- main co-ordinate
theBegin	- start co-ordinate
theEnd	- end co-ordinate
thePosition	- index in list

References GLViewer_LineList::addSegment(), insertLine(), and GLViewer_LineList::setMainCoord().

◆ insertLine() [2/2]

int GLViewer_LineField::insertLine	(	FieldDim	theDim,
		GLViewer_LineList *	theLL,
		int	thePosition
	)

Adds new line and sorted field.

Returns position

Adds line

Parameters

theDim	- dimension
theLL	- main co-ordinate
thePosition	- index in list

References getDimSize(), getLLArray(), GLViewer_LineList::mainCoord(), myXLineArray, and myYLineArray.

◆ intersectIndexes()

int * GLViewer_LineField::intersectIndexes	(	FieldDim	theDim,
		int	theIndex,
		const GLViewer_LineList *	theLL,
		int &	theSize
	)

returns arrey of intersects indexes with

Parameters

theLL

Returns: array of intersected indexes

Parameters

theDim	- dimension
theIndex	- index
theLL	- line with that intersection is checked
theSize	- to return value of array size

References GLViewer_LineList::contains(), getDimSize(), getLine(), GLViewer_LineList::mainCoord(), myXLineArray, and myYLineArray.

◆ invertDim()

FieldDim GLViewer_LineField::invertDim ( FieldDim theFD )

static

Returns other dimension.

Returns: other dimension

References FD_X, and FD_Y.

◆ iteration()

void GLViewer_LineField::iteration ( )

protected

One iteration of algorithm.

One iteration of algorithm

References findByCount(), findBySegment(), getCurArray(), getLine(), intersectIndexes(), invertDim(), GraphNode::myCount, myCurCount, GraphNode::myDim, GraphNode::myLineIndex, GraphNode::mySegmentindex, and GraphNode::prevNodeIndex.

◆ maxSegmentNum()

int GLViewer_LineField::maxSegmentNum ( )

protected

Returns maximum segment number.

Returns: maximum segment number

References GLViewer_LineList::count(), getDimSize(), getLine(), myXLineArray, and myYLineArray.

◆ optimize()

void GLViewer_LineField::optimize ( )

Optimize field.

Removes all multiple segments

References GLViewer_LineList::count(), getDimSize(), getLine(), myEndPoint, myStartPoint, myXLineArray, SearchPoint::myXLineIndex, SearchPoint::myXSegmentIndex, myYLineArray, SearchPoint::myYLineIndex, SearchPoint::myYSegmentIndex, GLViewer_LineList::readSegment(), and GLViewer_LineList::removeSegment().

◆ print()

void GLViewer_LineField::print ( )

Prints debug info about line field

References myXLineArray, myXSize, myYLineArray, and myYSize.

◆ segmentNumber()

int GLViewer_LineField::segmentNumber ( )

Returns number of segment.

Returns: number of segments

References GLViewer_LineList::count(), getDimSize(), getLine(), myXLineArray, and myYLineArray.

◆ setBorders()

void GLViewer_LineField::setBorders	(	double	X1,
		double	X2,
		double	Y1,
		double	Y2
	)

Nullifys field and sets same continued segments.

Sets borders of field

Parameters

X1,X2	- minimal and maximal abscisses
Y1,Y2	- minimal and maximal ordinates

References GLViewer_LineList::addSegment(), GLViewer_LineList::clear(), myXLineArray, myXSize, myYLineArray, myYSize, and GLViewer_LineList::setMainCoord().

◆ setPoint()

bool GLViewer_LineField::setPoint	(	FieldPoint	thePoint,
		double	theX,
		double	theY
	)

Sets start/end search point.

Sets start/end search point

Parameters

thePoint	- type of point (start: FP_Start; end: FP_End )
theX,theY	- point co-ordinates

References GLViewer_LineList::contains(), FD_X, FD_Y, FP_Start, getLine(), GLViewer_LineList::mainCoord(), myEndPoint, SearchPoint::mySolveIndex, myStartPoint, myXLineArray, SearchPoint::myXLineIndex, SearchPoint::myXSegmentIndex, myXSize, myYLineArray, SearchPoint::myYLineIndex, SearchPoint::myYSegmentIndex, and myYSize.

◆ show()

void GLViewer_LineField::show ( )

Draws field with help of OpenGL

References FD_X, FD_Y, getLine(), myXSize, myYSize, GLViewer_LineList::show(), and solution().

◆ solution()

double * GLViewer_LineField::solution ( int & theSize )

Returns solution and size of solution.

Returns: solution and size of solution

References FD_X, getCurArray(), getLine(), GLViewer_LineList::mainCoord(), myCurCount, myEndPoint, myGraphArray1, myGraphArray2, SearchPoint::mySolveIndex, myXLineArray, myYLineArray, GraphNode::prevNodeIndex, and GLViewer_LineList::readSegment().

◆ startAlgorithm()

GLViewer_LineField::EndStatus GLViewer_LineField::startAlgorithm ( )

Main method.

Main method, performs algorithm execution

References checkComplete(), ES_ERROR, ES_LOOP, ES_SOLVED, IS_ERROR, IS_LOOP, IS_SOLVED, iteration(), myCurCount, myGraphArray1, myGraphArray2, myXLineArray, and myYLineArray.

Member Data Documentation

◆ myCurArrayIndex

int GLViewer_LineField::myCurArrayIndex

private

◆ myCurCount

int GLViewer_LineField::myCurCount

private

◆ myEndPoint

SearchPoint GLViewer_LineField::myEndPoint

private

◆ myGraphArray1

GraphNode* GLViewer_LineField::myGraphArray1

private

◆ myGraphArray2

GraphNode * GLViewer_LineField::myGraphArray2

private

◆ myStartPoint

SearchPoint GLViewer_LineField::myStartPoint

private

◆ myXLineArray

GLViewer_LineList** GLViewer_LineField::myXLineArray

private

◆ myXSize

int GLViewer_LineField::myXSize

private

◆ myYLineArray

GLViewer_LineList ** GLViewer_LineField::myYLineArray

private

◆ myYSize

int GLViewer_LineField::myYSize

private

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

src/GLViewer/GLViewer_Tools.h
src/GLViewer/GLViewer_Tools.cxx

Public Types

Public Member Functions

Static Public Member Functions

Protected Member Functions

Private Attributes

Detailed Description

Member Enumeration Documentation

◆ EndStatus

◆ FieldPoint

◆ IterationStatus

Constructor & Destructor Documentation

◆ GLViewer_LineField() [1/2]

◆ GLViewer_LineField() [2/2]

◆ ~GLViewer_LineField()

Member Function Documentation

◆ addLine() [1/2]

◆ addLine() [2/2]

◆ addRectangle()

◆ checkComplete()

◆ findByCount()

◆ findBySegment()

◆ getCurArray()

◆ getDimSize()

◆ getLine()

◆ getLLArray()

◆ getSecArray()

◆ initialize()

◆ insertLine() [1/2]

◆ insertLine() [2/2]

◆ intersectIndexes()

◆ invertDim()

◆ iteration()

◆ maxSegmentNum()

◆ optimize()

◆ print()

◆ segmentNumber()

◆ setBorders()

◆ setPoint()

◆ show()

◆ solution()

◆ startAlgorithm()

Member Data Documentation

◆ myCurArrayIndex

◆ myCurCount

◆ myEndPoint

◆ myGraphArray1

◆ myGraphArray2

◆ myStartPoint

◆ myXLineArray

◆ myXSize

◆ myYLineArray

◆ myYSize