rbeCore::Step Class Reference

#include "Step.h"

Classes
struct	sData

Public Types
enum	eProjection { pUV , pW }

Public Member Functions
	Step ()
virtual	~Step ()
void	setId (int _id)
void	setMayEndWithout (bool _mayEnd)
void	setProjection (eProjection _projection)
void	addPoint (Point *_p)
void	addLimit (Limit *_limit)
void	setupFromJson (RubberbandEngine *_engine, const std::string &_json)
void	givePointOwnershipToEngine (RubberbandEngine *_engine)
int	id (void) const
bool	mayEndWithout (void) const
bool	hasPointOwnership (void) const
eProjection	projection (void) const
Point *	point (int _id)
bool	hasPoint (int _id)
std::string	debugInformation (const std::string &_prefix)
void	addConnectionsToJsonArray (RubberbandEngine *_engine, std::stringstream &_array, bool &_first, bool _isHistory)
void	addConnectionsToList (std::list< AbstractConnection * > &_list, bool _isHistory)
void	adjustCoordinateToLimits (coordinate_t &_u, coordinate_t &_v, coordinate_t &_w)
	Will check the limits for the provided points. If a limit is exceeded the values will be adjusted to match the limtis.
void	setLastPosition (coordinate_t _u, coordinate_t _v, coordinate_t _w)
AbstractPoint *	lastPosition (void)

Member Enumeration Documentation

eProjection

enum rbeCore::Step::eProjection

Enumerator
pUV
pW

Constructor & Destructor Documentation

Step()

Step::Step

(

)

~Step()

Step::~Step ( )

virtual

Member Function Documentation

addConnectionsToJsonArray()

void Step::addConnectionsToJsonArray	(	RubberbandEngine *	_engine,
		std::stringstream &	_array,
		bool &	_first,
		bool	_isHistory )

addConnectionsToList()

void Step::addConnectionsToList	(	std::list< AbstractConnection * > &	_list,
		bool	_isHistory )

addLimit()

void Step::addLimit

(

Limit *

_limit

)

addPoint()

void Step::addPoint

(

Point *

_p

)

adjustCoordinateToLimits()

void Step::adjustCoordinateToLimits	(	coordinate_t &	_u,
		coordinate_t &	_v,
		coordinate_t &	_w )

Will check the limits for the provided points. If a limit is exceeded the values will be adjusted to match the limtis.

debugInformation()

std::string Step::debugInformation

(

const std::string &

_prefix

)

givePointOwnershipToEngine()

void Step::givePointOwnershipToEngine

(

RubberbandEngine *

_engine

)

hasPoint()

bool Step::hasPoint

(

int

_id

)

hasPointOwnership()

bool rbeCore::Step::hasPointOwnership ( void ) const

inline

id()

int rbeCore::Step::id ( void ) const

inline

lastPosition()

AbstractPoint * Step::lastPosition

(

void

)

mayEndWithout()

bool rbeCore::Step::mayEndWithout ( void ) const

inline

point()

Point * Step::point

(

int

_id

)

projection()

eProjection rbeCore::Step::projection ( void ) const

inline

setId()

void rbeCore::Step::setId ( int _id )

inline

setLastPosition()

void Step::setLastPosition	(	coordinate_t	_u,
		coordinate_t	_v,
		coordinate_t	_w )

setMayEndWithout()

void rbeCore::Step::setMayEndWithout ( bool _mayEnd )

inline

setProjection()

void rbeCore::Step::setProjection ( eProjection _projection )

inline

setupFromJson()

void Step::setupFromJson	(	RubberbandEngine *	_engine,
		const std::string &	_json )

---

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

• Libraries/RubberbandEngineCore/include/rbeCore/Step.h
• Libraries/RubberbandEngineCore/src/rbeCore/Step.cpp