zeus::ILineSegment2D Class Reference

#include <ILineSegment2D.hpp>

Inheritance diagram for zeus::ILineSegment2D:

List of all members.

Public Member Functions
virtual IStraightLine2D &MQUALIFIER	getStraightLine ()=0
virtual const IStraightLine2D &MQUALIFIER	getStraightLineConst () const =0
virtual void MQUALIFIER	getStartPoint (IVector2D &rVecStart) const =0
virtual void MQUALIFIER	getEndPoint (IVector2D &rVecEnd) const =0
virtual void MQUALIFIER	setStartPoint (const IVector2D &rVecStart)=0
virtual void MQUALIFIER	setEndPoint (const IVector2D &rVecEnd)=0
virtual bool MQUALIFIER	isStartPointIncluded () const =0
virtual void MQUALIFIER	setStartPointIncluded (bool bInclude)=0
virtual bool MQUALIFIER	isEndPointIncluded () const =0
virtual void MQUALIFIER	setEndPointIncluded (bool bInclude)=0
virtual Float MQUALIFIER	getLength () const =0
virtual void MQUALIFIER	assign (const ILineSegment2D &rLineSegment)=0
virtual bool MQUALIFIER	isValid () const =0
virtual bool MQUALIFIER	isEqual (const ILineSegment2D &rLineSegment, bool bCheckBorderPointIncludedFlags=true) const =0
virtual bool MQUALIFIER	isParallel (const ILineSegment2D &rLineSegment) const =0

---

Detailed Description

ILineSegment2D encapsulates a three dimensional floating point line segment for vector geometry calculations.

---

Member Function Documentation

virtual void MQUALIFIER zeus::ILineSegment2D::assign

(

const ILineSegment2D &

rLineSegment )

[pure virtual]

Assignment.

Parameters:

rLineSegment

[IN]: Line segment to be assigned to this line segment.

Implemented in zeus::TLineSegment2D.

virtual void MQUALIFIER zeus::ILineSegment2D::getEndPoint

(

IVector2D &

rVecEnd )

const [pure virtual]

Get the end point.

Parameters:

rVecEnd

[OUT]: The end point.

Implemented in zeus::TLineSegment2D.

virtual Float MQUALIFIER zeus::ILineSegment2D::getLength

(

)

const [pure virtual]

Get the length of this line segment.

Returns:

: The length.

Implemented in zeus::TLineSegment2D.

virtual void MQUALIFIER zeus::ILineSegment2D::getStartPoint

(

IVector2D &

rVecStart )

const [pure virtual]

Get the start point.

Parameters:

rVecStart

[OUT]: The start point.

Implemented in zeus::TLineSegment2D.

virtual IStraightLine2D& MQUALIFIER zeus::ILineSegment2D::getStraightLine

(

)

[pure virtual]

Get the defining straight line.

Returns:

: Defining straight line.

Implemented in zeus::TLineSegment2D.

virtual const IStraightLine2D& MQUALIFIER zeus::ILineSegment2D::getStraightLineConst

(

)

const [pure virtual]

Get the defining straight line.

Returns:

: Defining straight line.

Implemented in zeus::TLineSegment2D.

virtual bool MQUALIFIER zeus::ILineSegment2D::isEndPointIncluded

(

)

const [pure virtual]

Is the end point itself included?

Implemented in zeus::TLineSegment2D.

virtual bool MQUALIFIER zeus::ILineSegment2D::isEqual	(	const ILineSegment2D &	rLineSegment,
		bool	bCheckBorderPointIncludedFlags = true
	)		const [pure virtual]

Comparisons.

Equality with another line segment?

Parameters:

rLineSegment	[IN]: The other line segment.
bCheckBorderPointIncludedFlags	[IN]: Check the isStart/EndPointIncluded() flags.

Returns:

: Equality.

Implemented in zeus::TLineSegment2D.

virtual bool MQUALIFIER zeus::ILineSegment2D::isParallel

(

const ILineSegment2D &

rLineSegment )

const [pure virtual]

Parallel to another line segment?

Parameters:

rLineSegment

[IN]: The other line segment.

Returns:

: Parallel.

Implemented in zeus::TLineSegment2D.

virtual bool MQUALIFIER zeus::ILineSegment2D::isStartPointIncluded

(

)

const [pure virtual]

Is the start point itself included?

Implemented in zeus::TLineSegment2D.

virtual bool MQUALIFIER zeus::ILineSegment2D::isValid

(

)

const [pure virtual]

Check the validity.

Returns:

: Valid.

Implemented in zeus::TLineSegment2D.

virtual void MQUALIFIER zeus::ILineSegment2D::setEndPoint

(

const IVector2D &

rVecEnd )

[pure virtual]

Set the end point.

Parameters:

rVecEnd

[IN]: The end point.

Implemented in zeus::TLineSegment2D.

virtual void MQUALIFIER zeus::ILineSegment2D::setEndPointIncluded

(

bool

bInclude )

[pure virtual]

Set if the end point itself is included.

Parameters:

bInclude

[IN]: Include the end point.

Implemented in zeus::TLineSegment2D.

virtual void MQUALIFIER zeus::ILineSegment2D::setStartPoint

(

const IVector2D &

rVecStart )

[pure virtual]

Set the start point.

Parameters:

rVecStart

[IN]: The start point.

Implemented in zeus::TLineSegment2D.

virtual void MQUALIFIER zeus::ILineSegment2D::setStartPointIncluded

(

bool

bInclude )

[pure virtual]

Set if the start point itself is included.

Parameters:

bInclude

[IN]: Include the start point.

Implemented in zeus::TLineSegment2D.

---

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

• ILineSegment2D.hpp