qgar::GenQgarSegment< T > Class Template Reference
[Qgar (graphical) primitives]

#include <qgarlib/primitives.H>

Inheritance diagram for qgar::GenQgarSegment< T >:

List of all members.

Detailed Description

template<class T>
class qgar::GenQgarSegment< T >

Graphical segment, so-called Qgar segment, with coordinates of type T.

It typically results from vectorization.

   O
    +---------------> X
    |\    |
    | \ <-'
    |  \    angle (in radians, unless specified)
    |   \
    |
    V

    Y

The origin of the coordinate system is at top left corner and angles are clockwise from the X axis.

```
   O
    +---------------> X
    |
    |        + source
    |       /
    |      /
    |     v
    V    + target

    Y
```
A Qgar segment is oriented: It is provided with a so-called source point and a so-called target point, which determine the orientation of the vector representing the segment in geometrical computations.
Predefined types: qgar::QgarSegment, qgar::IQgarSegment, qgar::FQgarSegment, qgar::DQgarSegment.
A Qgar segment is provided with attributes: thickness, color, and outline. When such features are useless, see class qgar::GenSegment (for geometrical segments).

Author:: Gérald Masini

Date:: July 2, 2001 18:07

Since:: Qgar 2.1

Definition at line 131 of file _QGAR_GenQgarSegment.H.

Public Types

Types

typedef T value_type

Type of the source and target coordinates.

typedef value_type & reference

Reference to qgar::GenQgarSegment::value_type.

typedef const value_type & const_reference

Constant reference to qgar::GenQgarSegment::value_type.

typedef value_type * pointer

Pointer to qgar::GenQgarSegment::value_type.

typedef const value_type * const_pointer

Constant pointer to qgar::GenQgarSegment::value_type.

Public Member Functions

Access to attributes

int thickness () const

Get thickness.

QGEcolor color () const

Get color.

QGEoutline outline () const

Get outline.

Access to source and target

const GenPoint< value_type > & accessSource () const

Get source point.

GenPoint< value_type > source () const

Get a copy of the source point.

const GenPoint< value_type > & accessTarget () const

Get target point.

GenPoint< value_type > target () const

Get a copy of the target point.

Access to separate coordinates

value_type xSource () const

Get X coordinate of the source point.

value_type xTarget () const

Get X coordinate of the target point.

value_type ySource () const

Get Y coordinate of the source point.

value_type yTarget () const

Get Y coordinate of the target point.

Access to geometrical characteristics

value_type dx () const

Difference between target and source X coordinates.

value_type dy () const

Difference between target and source Y coordinates.

Set attributes

void setThickness (int aThickness)

Set thickness.

void setColor (QGEcolor aColor)

Set color.

void setOutline (QGEoutline anOutline)

Set outline.

Set source and/or target without update

void setSource (value_type aX, value_type aY)

Set source point.

void setSource (const GenPoint< value_type > &aPt)

Set source point.

void setTarget (value_type aX, value_type aY)

Set target point.

void setTarget (const GenPoint< value_type > &aPt)

Set target point.

void setSourceTarget (value_type aXSource, value_type aYSource, value_type aXTarget, value_type aYTarget)

Set both source and target points.

void setSourceTarget (const GenPoint< value_type > &aSource, const GenPoint< value_type > &aTarget)

Set both source and target points.

Set source and/or target with update

void fixSource (value_type aX, value_type aY)

Set source point.

void fixSource (const GenPoint< value_type > &aPt)

Set source point.

void fixTarget (value_type aX, value_type aY)

Set target point.

void fixTarget (const GenPoint< value_type > &aPt)

Set target point.

void fixSourceTarget (value_type aXSource, value_type aYSource, value_type aXTarget, value_type aYTarget)

Set both source and target points.

void fixSourceTarget (const GenPoint< value_type > &aSource, const GenPoint< value_type > &aTarget)

Set both source and target points.

Set separate (source and target) coordinates without update

void setXSource (value_type aX)

Set X coordinate of the source point.

void setXTarget (value_type aX)

Set X coordinate of the target point.

void setYSource (value_type aY)

Set Y coordinate of the source point.

void setYTarget (value_type aY)

Set Y coordinate of the target point.

Set separate (source and target) coordinates with update

void fixXSource (value_type aX)

Set X coordinate of the source point.

void fixXTarget (value_type aX)

Set X coordinate of the target point.

void fixYSource (value_type aY)

Set Y coordinate of the source point.

void fixYTarget (value_type aY)

Set Y coordinate of the target point.

Geometry: Translation

void translate (value_type aTransX, value_type aTransY)

Translate along X and Y axis.

Constructors

GenQgarSegment (int aThickness=1, QGEcolor aColor=QGE_COLOR_DEFAULT, QGEoutline anOutline=QGE_OUTLINE_DEFAULT)

Default constructor.

GenQgarSegment (const GenQgarSegment< value_type > &aQSeg)

Copy constructor.

GenQgarSegment (const GenSegment< value_type > &aSeg, int aThickness=1, QGEcolor aColor=QGE_COLOR_DEFAULT, QGEoutline anOutline=QGE_OUTLINE_DEFAULT)

Initialize from a geometrical segment.

GenQgarSegment (const GenPoint< value_type > &aSource, const GenPoint< value_type > &aTarget, int aThickness=1, QGEcolor aColor=QGE_COLOR_DEFAULT, QGEoutline anOutline=QGE_OUTLINE_DEFAULT)

Initialize from source and target points.

GenQgarSegment (value_type aXSource, value_type aYSource, value_type aXTarget, value_type aYTarget, int aThickness=1, QGEcolor aColor=QGE_COLOR_DEFAULT, QGEoutline anOutline=QGE_OUTLINE_DEFAULT)

Initialize from coordinates.

Destructor

virtual ~GenQgarSegment ()

Virtual destructor.

Copy

virtual GenQgarSegment< value_type > * clone () const

Create a dynamically allocated deep copy of the primitive.

Access to geometrical features

const GenSegment< value_type > & accessGeomStructure () const

Get the structure implementing the geometrical aspect of a Qgar segment.

double length () const

Get length of the segment.

double sqr_length () const

Get squared length of the segment.

double rho () const

Distance between point (0,0) and its perpendicular projection onto the line supporting the current segment.

double theta () const

Angle between the X axis and the segment, in [0, 2PI[ radians.

double angle () const

Same as qgar::GenQgarSegment::theta.

double slope () const

Angle between the X axis and the segment, in [0, PI[ radians.

double thetaDegrees () const

Same as qgar::GenQgarSegment::theta, but the result is given in [0,360[ degrees.

double angleDegrees () const

Same as qgar::GenQgarSegment::theta, but the result is given in [0,360[ degrees.

double slopeDegrees () const

Same as qgar::GenQgarSegment::slope, but the result is given in [0,180[ degrees.

Geometrical predicates

bool contains (const GenPoint< T > &c, double aDist=Math::epsilonD())

Return true if the given point approximately belongs to the current Qgar segment.

Operators

GenQgarSegment< value_type > & operator= (const GenQgarSegment< value_type > &aQSeg)

Assignment.

bool operator== (const GenQgarSegment< value_type > &aQSeg) const

Same as function qgar::GenQgarSegment::eq.

bool operator!= (const GenQgarSegment< value_type > &aQSeg) const

Same as function qgar::GenQgarSegment::notEq.

Functional operators

bool eq (const GenQgarSegment< value_type > &aQSeg) const

Equality.

bool equal (const GenQgarSegment< value_type > &aQSeg) const

Equality.

bool notEq (const GenQgarSegment< value_type > &aQSeg) const

Inequality.

bool notEqual (const GenQgarSegment< value_type > &aQSeg) const

Inequality.

Serialization/deserialization

virtual std::istream & read (std::istream &anInStream)

Deserializes the current segment from an input stream.

virtual std::ostream & write (std::ostream &anOutStream) const

Serializes an object to an input stream.

Access to attributes

int thickness () const

Get thickness.

QGEcolor color () const

Get color.

QGEoutline outline () const

Get outline.

Access to source and target

const GenPoint< value_type > & accessSource () const

Get source point.

GenPoint< value_type > source () const

Get a copy of the source point.

const GenPoint< value_type > & accessTarget () const

Get target point.

GenPoint< value_type > target () const

Get a copy of the target point.

Access to separate coordinates

value_type xSource () const

Get X coordinate of the source point.

value_type xTarget () const

Get X coordinate of the target point.

value_type ySource () const

Get Y coordinate of the source point.

value_type yTarget () const

Get Y coordinate of the target point.

Access to geometrical characteristics

value_type dx () const

Difference between target and source X coordinates.

value_type dy () const

Difference between target and source Y coordinates.

Set attributes

void setThickness (int aThickness)

Set thickness.

void setColor (QGEcolor aColor)

Set color.

void setOutline (QGEoutline anOutline)

Set outline.

Set source and/or target without update

void setSource (value_type aX, value_type aY)

Set source point.

void setSource (const GenPoint< value_type > &aPt)

Set source point.

void setTarget (value_type aX, value_type aY)

Set target point.

void setTarget (const GenPoint< value_type > &aPt)

Set target point.

void setSourceTarget (value_type aXSource, value_type aYSource, value_type aXTarget, value_type aYTarget)

Set both source and target points.

void setSourceTarget (const GenPoint< value_type > &aSource, const GenPoint< value_type > &aTarget)

Set both source and target points.

Set source and/or target with update

void fixSource (value_type aX, value_type aY)

Set source point.

void fixSource (const GenPoint< value_type > &aPt)

Set source point.

void fixTarget (value_type aX, value_type aY)

Set target point.

void fixTarget (const GenPoint< value_type > &aPt)

Set target point.

void fixSourceTarget (value_type aXSource, value_type aYSource, value_type aXTarget, value_type aYTarget)

Set both source and target points.

void fixSourceTarget (const GenPoint< value_type > &aSource, const GenPoint< value_type > &aTarget)

Set both source and target points.

Set separate (source and target) coordinates without update

void setXSource (value_type aX)

Set X coordinate of the source point.

void setXTarget (value_type aX)

Set X coordinate of the target point.

void setYSource (value_type aY)

Set Y coordinate of the source point.

void setYTarget (value_type aY)

Set Y coordinate of the target point.

Set separate (source and target) coordinates with update

void fixXSource (value_type aX)

Set X coordinate of the source point.

void fixXTarget (value_type aX)

Set X coordinate of the target point.

void fixYSource (value_type aY)

Set Y coordinate of the source point.

void fixYTarget (value_type aY)

Set Y coordinate of the target point.

Geometry: Translation

void translate (value_type aTransX, value_type aTransY)

Translate along X and Y axis.

Protected Member Functions

Non-protected access to the geometrical aspect

AbstractGenPrimitive< value_type > & getGeomStructure ()

Return the geometrical aspect.

Protected Attributes

Attributes

Apply a central symmetry to the current primitive, using the point of given coordinates as the symmetry center. Apply a central symmetry to the current primitive, using the given point as the symmetry center. Apply a mirror symmetry to the current primitive, using the line passing through the two given points for the symmetry. Apply a mirror symmetry to the current primitive, using the line supporting the given segment for the symmetry.

int _thickness

Thickness of the outline.

QGEcolor _color

Color of the outline.

QGEoutline _outline

Type of outline.

Geometrical structure of a Qgar segment

GenSegment< value_type > _geomStructure

Structure implementing the geometrical aspect.

Attributes

Apply a central symmetry to the current primitive, using the point of given coordinates as the symmetry center. Apply a central symmetry to the current primitive, using the given point as the symmetry center. Apply a mirror symmetry to the current primitive, using the line passing through the two given points for the symmetry. Apply a mirror symmetry to the current primitive, using the line supporting the given segment for the symmetry.

int _thickness

Thickness of the outline.

QGEcolor _color

Color of the outline.

QGEoutline _outline

Type of outline.

Member Typedef Documentation

template<class T>

typedef const value_type* qgar::GenQgarSegment< T >::const_pointer

Constant pointer to qgar::GenQgarSegment::value_type.

Reimplemented from qgar::AbstractGenQgarPrimitive< T >.
Definition at line 170 of file _QGAR_GenQgarSegment.H.

template<class T>

typedef const value_type& qgar::GenQgarSegment< T >::const_reference

Constant reference to qgar::GenQgarSegment::value_type.

Reimplemented from qgar::AbstractGenQgarPrimitive< T >.
Definition at line 160 of file _QGAR_GenQgarSegment.H.

template<class T>

typedef value_type* qgar::GenQgarSegment< T >::pointer

Pointer to qgar::GenQgarSegment::value_type.

Reimplemented from qgar::AbstractGenQgarPrimitive< T >.
Definition at line 165 of file _QGAR_GenQgarSegment.H.

template<class T>

typedef value_type& qgar::GenQgarSegment< T >::reference

Reference to qgar::GenQgarSegment::value_type.

Reimplemented from qgar::AbstractGenQgarPrimitive< T >.
Definition at line 155 of file _QGAR_GenQgarSegment.H.

template<class T>

typedef T qgar::GenQgarSegment< T >::value_type

Type of the source and target coordinates.

Reimplemented from qgar::AbstractGenQgarPrimitive< T >.
Definition at line 150 of file _QGAR_GenQgarSegment.H.

Constructor & Destructor Documentation

template<class T>

qgar::GenQgarSegment< T >::GenQgarSegment ( int aThickness = 1,

QGEcolor aColor = QGE_COLOR_DEFAULT,

QGEoutline anOutline = QGE_OUTLINE_DEFAULT

)

Default constructor.
Zero-length segment located at (0, 0).

Parameters:

aThickness thickness (default 1)

aColor color (default qgar::QGE_COLOR_DEFAULT)

anOutline outline (default qgar::QGE_OUTLINE_DEFAULT)

Todo:
The created Qgar segment does not conform to the definition of a segment!

Definition at line 61 of file _QGAR_GenQgarSegment.TCC.

template<class T>

qgar::GenQgarSegment< T >::GenQgarSegment ( const GenQgarSegment< value_type > & aQSeg )

Copy constructor.

Definition at line 76 of file _QGAR_GenQgarSegment.TCC.

template<class T>

qgar::GenQgarSegment< T >::GenQgarSegment ( const GenSegment< value_type > & aSeg,

int aThickness = 1,

QGEcolor aColor = QGE_COLOR_DEFAULT,

QGEoutline anOutline = QGE_OUTLINE_DEFAULT

) [explicit]

Initialize from a geometrical segment.

Parameters:

aSeg a segment

aThickness thickness (default 1)

aColor color (default qgar::QGE_COLOR_DEFAULT)

anOutline outline (default qgar::QGE_OUTLINE_DEFAULT)

template<class T>

qgar::GenQgarSegment< T >::GenQgarSegment ( const GenPoint< value_type > & aSource,

const GenPoint< value_type > & aTarget,

int aThickness = 1,

QGEcolor aColor = QGE_COLOR_DEFAULT,

QGEoutline anOutline = QGE_OUTLINE_DEFAULT

)

Initialize from source and target points.

Parameters:

aSource source point

aTarget target point

aThickness thickness (default 1)

aColor color (default qgar::QGE_COLOR_DEFAULT)

anOutline outline (default qgar::QGE_OUTLINE_DEFAULT)

template<class T>

qgar::GenQgarSegment< T >::GenQgarSegment ( value_type aXSource,

value_type aYSource,

value_type aXTarget,

value_type aYTarget,

int aThickness = 1,

QGEcolor aColor = QGE_COLOR_DEFAULT,

QGEoutline anOutline = QGE_OUTLINE_DEFAULT

)

Initialize from coordinates.

Parameters:

aXSource X coordinate of the source point

aYSource Y coordinate of the source point

aXTarget X coordinate of the target point

aYTarget X coordinate of the target point

aThickness thickness (default 1)

aColor color (default qgar::QGE_COLOR_DEFAULT)

anOutline outline (default qgar::QGE_OUTLINE_DEFAULT)

Definition at line 124 of file _QGAR_GenQgarSegment.TCC.

template<class T>

qgar::GenQgarSegment< T >::~GenQgarSegment ( ) [virtual]

Virtual destructor.

Definition at line 146 of file _QGAR_GenQgarSegment.TCC.

Member Function Documentation

template<class T>

const GenSegment< T > & qgar::GenQgarSegment< T >::accessGeomStructure ( ) const [inline, virtual]

Get the structure implementing the geometrical aspect of a Qgar segment.

Implements qgar::AbstractGenQgarPrimitive< T >.
Definition at line 445 of file _QGAR_GenQgarSegment.TCC.
References qgar::GenQgarSegment< T >::_geomStructure.
Referenced by qgar::GenQgarPolyline< T >::GenQgarPolyline(), and qgar::AbstractGraphicsFile::write().

template<class T>

const GenPoint< T > & qgar::AbstractGenQgarPrimitive< T >::accessSource ( ) const [inline, inherited]

Get source point.

Definition at line 147 of file _QGAR_AbstractGenQgarPrimitive.TCC.
References qgar::AbstractGenQgarPrimitive< T >::accessGeomStructure(), and qgar::AbstractGenPrimitive< T >::accessSource().

template<class T>

const GenPoint< T > & qgar::AbstractGenQgarPrimitive< T >::accessTarget ( ) const [inline, inherited]

Get target point.

Definition at line 167 of file _QGAR_AbstractGenQgarPrimitive.TCC.
References qgar::AbstractGenQgarPrimitive< T >::accessGeomStructure(), and qgar::AbstractGenPrimitive< T >::accessTarget().

template<class T>

double qgar::GenQgarSegment< T >::angle ( ) const [inline]

Same as qgar::GenQgarSegment::theta.

Definition at line 206 of file _QGAR_GenQgarSegment.TCC.
References qgar::GenQgarSegment< T >::_geomStructure, and qgar::GenSegment< T >::angle().

template<class T>

double qgar::GenQgarSegment< T >::angleDegrees ( ) const [inline]

Same as qgar::GenQgarSegment::theta, but the result is given in [0,360[ degrees.

Definition at line 226 of file _QGAR_GenQgarSegment.TCC.
References qgar::GenQgarSegment< T >::_geomStructure, and qgar::GenSegment< T >::angleDegrees().

template<class T>

GenQgarSegment< T > * qgar::GenQgarSegment< T >::clone ( ) const [virtual]

Create a dynamically allocated deep copy of the primitive.

Implements qgar::AbstractGenQgarPrimitive< T >.
Definition at line 429 of file _QGAR_GenQgarSegment.TCC.

template<class T>

QGEcolor qgar::AbstractGenQgarPrimitive< T >::color ( ) const [inline, inherited]

Get color.

Definition at line 122 of file _QGAR_AbstractGenQgarPrimitive.TCC.
References qgar::AbstractGenQgarPrimitive< T >::_color.
Referenced by qgar::GenQgarSegment< T >::read(), qgar::GenQgarPolyline< T >::read(), qgar::GenQgarPolygon< T >::read(), qgar::GenQgarArc< T >::read(), and qgar::AbstractGraphicsFile::write().

template<class T>

bool qgar::GenQgarSegment< T >::contains ( const GenPoint< T > & c,

double aDist = Math::epsilonD()

) [inline]

Return true if the given point approximately belongs to the current Qgar segment.
Here, ''to belong'' means to be at a distance smaller or equal to the given threshold from some point between the source and the target of the segment.

Parameters:

c a point

aDist threshold used to decide whether the given point belongs to the segment (default qgar::Math::epsilonD)

Definition at line 262 of file _QGAR_GenQgarSegment.TCC.
References qgar::GenQgarSegment< T >::_geomStructure, and qgar::GenSegment< T >::contains().

template<class T>

T qgar::AbstractGenQgarPrimitive< T >::dx ( ) const [inline, inherited]

Difference between target and source X coordinates.

Definition at line 237 of file _QGAR_AbstractGenQgarPrimitive.TCC.
References qgar::AbstractGenQgarPrimitive< T >::accessGeomStructure(), and qgar::AbstractGenPrimitive< T >::dx().

template<class T>

T qgar::AbstractGenQgarPrimitive< T >::dy ( ) const [inline, inherited]

Difference between target and source Y coordinates.

Definition at line 247 of file _QGAR_AbstractGenQgarPrimitive.TCC.
References qgar::AbstractGenQgarPrimitive< T >::accessGeomStructure(), and qgar::AbstractGenPrimitive< T >::dy().

template<class T>

bool qgar::GenQgarSegment< T >::eq ( const GenQgarSegment< value_type > & aQSeg ) const [inline]

Equality.

Parameters:

aQSeg a segment

Returns:
true if the current segment and the given segment have the same coordinates, regardless other features.

Definition at line 319 of file _QGAR_GenQgarSegment.TCC.
References qgar::GenQgarSegment< T >::_geomStructure, and qgar::GenSegment< T >::eq().

template<class T>

bool qgar::GenQgarSegment< T >::equal ( const GenQgarSegment< value_type > & aQSeg ) const

Equality.

Parameters:

aQSeg a segment

Returns:
true if the current segment and the given segment have the same coordinates and attributes.

Definition at line 329 of file _QGAR_GenQgarSegment.TCC.
References qgar::AbstractGenQgarPrimitive< T >::_color, qgar::GenQgarSegment< T >::_geomStructure, qgar::AbstractGenQgarPrimitive< T >::_outline, and qgar::AbstractGenQgarPrimitive< T >::_thickness.

template<class T>

void qgar::AbstractGenQgarPrimitive< T >::fixSource ( const GenPoint< value_type > & aPt ) [inline, inherited]

Set source point.

Parameters:

aPt a point

Warning:
Function qgar::AbstractGenPrimitive::updateSource is called after the modification of the source point.

template<class T>

void qgar::AbstractGenQgarPrimitive< T >::fixSource ( value_type aX,

value_type aY

) [inline, inherited]

Set source point.

Parameters:

aX new X coordinate of the source point

aY new Y coordinate of the source point

Warning:
Function qgar::AbstractGenPrimitive::updateSource is called after the modification of the source point.

Definition at line 364 of file _QGAR_AbstractGenQgarPrimitive.TCC.
References qgar::AbstractGenPrimitive< T >::fixSource(), and qgar::AbstractGenQgarPrimitive< T >::getGeomStructure().

template<class T>

void qgar::AbstractGenQgarPrimitive< T >::fixSourceTarget ( const GenPoint< value_type > & aSource,

const GenPoint< value_type > & aTarget

) [inline, inherited]

Set both source and target points.

Parameters:

aSource source point

aTarget target point

Warning:
Function qgar::AbstractGenPrimitive::updateTarget is called after the modification of the source target.

template<class T>

void qgar::AbstractGenQgarPrimitive< T >::fixSourceTarget ( value_type aXSource,

value_type aYSource,

value_type aXTarget,

value_type aYTarget

) [inline, inherited]

Set both source and target points.

Parameters:

aXSource new X coordinate of the source point

aYSource new Y coordinate of the source point

aXTarget new X coordinate of the target point

aYTarget new Y coordinate of the target point

Warning:
Function qgar::AbstractGenPrimitive::updateTarget is called after the modification of the source target.

Definition at line 402 of file _QGAR_AbstractGenQgarPrimitive.TCC.
References qgar::AbstractGenPrimitive< T >::fixSourceTarget(), and qgar::AbstractGenQgarPrimitive< T >::getGeomStructure().

template<class T>

void qgar::AbstractGenQgarPrimitive< T >::fixTarget ( const GenPoint< value_type > & aPt ) [inline, inherited]

Set target point.

Parameters:

aPt a point

Warning:
Function qgar::AbstractGenPrimitive::updateTarget is called after the modification of the target point.

template<class T>

void qgar::AbstractGenQgarPrimitive< T >::fixTarget ( value_type aX,

value_type aY

) [inline, inherited]

Set target point.

Parameters:

aX new X coordinate of the target point

aY new Y coordinate of the target point

Warning:
Function qgar::AbstractGenPrimitive::updateTarget is called after the modification of the target point.

Definition at line 383 of file _QGAR_AbstractGenQgarPrimitive.TCC.
References qgar::AbstractGenPrimitive< T >::fixTarget(), and qgar::AbstractGenQgarPrimitive< T >::getGeomStructure().

template<class T>

void qgar::AbstractGenQgarPrimitive< T >::fixXSource ( value_type aX ) [inline, inherited]

Set X coordinate of the source point.

Parameters:

aX new X coordinate of the source point

Warning:
Function qgar::AbstractGenPrimitive::updateSource is called after the modification of the source point.

Definition at line 474 of file _QGAR_AbstractGenQgarPrimitive.TCC.
References qgar::AbstractGenPrimitive< T >::fixXSource(), and qgar::AbstractGenQgarPrimitive< T >::getGeomStructure().

template<class T>

void qgar::AbstractGenQgarPrimitive< T >::fixXTarget ( value_type aX ) [inline, inherited]

Set X coordinate of the target point.

Parameters:

aX new X coordinate of the target point

Warning:
Function qgar::AbstractGenPrimitive::updateTarget is called after the modification of the target point.

Definition at line 484 of file _QGAR_AbstractGenQgarPrimitive.TCC.
References qgar::AbstractGenPrimitive< T >::fixXTarget(), and qgar::AbstractGenQgarPrimitive< T >::getGeomStructure().

template<class T>

void qgar::AbstractGenQgarPrimitive< T >::fixYSource ( value_type aY ) [inline, inherited]

Set Y coordinate of the source point.

Parameters:

aY new Y coordinate of the source point

Warning:
Function qgar::AbstractGenPrimitive::updateSource is called after the modification of the source point.

Definition at line 494 of file _QGAR_AbstractGenQgarPrimitive.TCC.
References qgar::AbstractGenPrimitive< T >::fixYSource(), and qgar::AbstractGenQgarPrimitive< T >::getGeomStructure().

template<class T>

void qgar::AbstractGenQgarPrimitive< T >::fixYTarget ( value_type aY ) [inline, inherited]

Set Y coordinate of the target point.

Parameters:

aY new Y coordinate of the target point

Warning:
Function qgar::AbstractGenPrimitive::updateTarget is called after the modification of the target point.

Definition at line 504 of file _QGAR_AbstractGenQgarPrimitive.TCC.
References qgar::AbstractGenPrimitive< T >::fixYTarget(), and qgar::AbstractGenQgarPrimitive< T >::getGeomStructure().

template<class T>

AbstractGenPrimitive< T > & qgar::GenQgarSegment< T >::getGeomStructure ( ) [inline, protected, virtual]

Return the geometrical aspect.
It may then be modified using appropriate transformation function members.
Implements qgar::AbstractGenQgarPrimitive< T >.
Definition at line 461 of file _QGAR_GenQgarSegment.TCC.
References qgar::GenQgarSegment< T >::_geomStructure.

template<class T>

double qgar::GenQgarSegment< T >::length ( ) const [inline]

Get length of the segment.

Definition at line 161 of file _QGAR_GenQgarSegment.TCC.
References qgar::GenQgarSegment< T >::_geomStructure, and qgar::GenSegment< T >::length().

template<class T>

bool qgar::GenQgarSegment< T >::notEq ( const GenQgarSegment< value_type > & aQSeg ) const [inline]

Inequality.

Parameters:

aQSeg a segment

Returns:
true if the coordinates of the current segment and of the given segment are different, regardless other features.

Definition at line 343 of file _QGAR_GenQgarSegment.TCC.
References qgar::GenQgarSegment< T >::_geomStructure.

template<class T>

bool qgar::GenQgarSegment< T >::notEqual ( const GenQgarSegment< value_type > & aQSeg ) const

Inequality.

Parameters:

aQSeg a segment

Returns:
true if the coordinates or attributes of the current segment and of the given segment are different.

Definition at line 353 of file _QGAR_GenQgarSegment.TCC.
References qgar::AbstractGenQgarPrimitive< T >::_color, qgar::GenQgarSegment< T >::_geomStructure, qgar::AbstractGenQgarPrimitive< T >::_outline, and qgar::AbstractGenQgarPrimitive< T >::_thickness.

template<class T>

bool qgar::GenQgarSegment< T >::operator!= ( const GenQgarSegment< value_type > & aQSeg ) const [inline]

Same as function qgar::GenQgarSegment::notEq.

Definition at line 303 of file _QGAR_GenQgarSegment.TCC.
References qgar::GenQgarSegment< T >::_geomStructure.

template<class T>

GenQgarSegment< T > & qgar::GenQgarSegment< T >::operator= ( const GenQgarSegment< value_type > & aQSeg )

Assignment.

Parameters:

aQSeg a Qgar segment

Definition at line 277 of file _QGAR_GenQgarSegment.TCC.
References qgar::GenQgarSegment< T >::_geomStructure.

template<class T>

bool qgar::GenQgarSegment< T >::operator== ( const GenQgarSegment< value_type > & aQSeg ) const [inline]

Same as function qgar::GenQgarSegment::eq.

Definition at line 293 of file _QGAR_GenQgarSegment.TCC.
References qgar::GenQgarSegment< T >::_geomStructure.

template<class T>

QGEoutline qgar::AbstractGenQgarPrimitive< T >::outline ( ) const [inline, inherited]

Get outline.

Definition at line 132 of file _QGAR_AbstractGenQgarPrimitive.TCC.
References qgar::AbstractGenQgarPrimitive< T >::_outline.
Referenced by qgar::GenQgarSegment< T >::read(), qgar::GenQgarPolyline< T >::read(), qgar::GenQgarPolygon< T >::read(), qgar::GenQgarArc< T >::read(), and qgar::AbstractGraphicsFile::write().

template<class T>

std::istream & qgar::GenQgarSegment< T >::read ( std::istream & anInStream ) [virtual]

Deserializes the current segment from an input stream.
A serialized Qgar segment is represented as:
QgarSegment(<GEOMETRICAL STRUCTURE>)(<THICKNESS>)(<COLOR>)(<OUTLINE>)

Parameters:

anInStream the input stream

Implements qgar::ISerializable.
Definition at line 370 of file _QGAR_GenQgarSegment.TCC.
References qgar::AbstractGenQgarPrimitive< T >::_color, qgar::GenQgarSegment< T >::_geomStructure, qgar::AbstractGenQgarPrimitive< T >::_outline, qgar::AbstractGenQgarPrimitive< T >::color(), qgar::AbstractGenQgarPrimitive< T >::outline(), qgar::qgReadObjData(), and qgar::qgReadObjName().

template<class T>

double qgar::GenQgarSegment< T >::rho ( ) const [inline]

Distance between point (0,0) and its perpendicular projection onto the line supporting the current segment.
Always positive.
Definition at line 185 of file _QGAR_GenQgarSegment.TCC.
References qgar::GenQgarSegment< T >::_geomStructure, and qgar::GenSegment< T >::rho().

template<class T>

void qgar::AbstractGenQgarPrimitive< T >::setColor ( QGEcolor aColor ) [inline, inherited]

Set color.

Parameters:

aColor a color

Definition at line 272 of file _QGAR_AbstractGenQgarPrimitive.TCC.
References qgar::AbstractGenQgarPrimitive< T >::_color.

template<class T>

void qgar::AbstractGenQgarPrimitive< T >::setOutline ( QGEoutline anOutline ) [inline, inherited]

Set outline.

Parameters:

anOutline an outline

Definition at line 282 of file _QGAR_AbstractGenQgarPrimitive.TCC.
References qgar::AbstractGenQgarPrimitive< T >::_outline.

template<class T>

void qgar::AbstractGenQgarPrimitive< T >::setSource ( const GenPoint< value_type > & aPt ) [inline, inherited]

Set source point.

Parameters:

aPt a point

Warning:
The data structure of the primitive is not subsequently updated.

template<class T>

void qgar::AbstractGenQgarPrimitive< T >::setSource ( value_type aX,

value_type aY

) [inline, inherited]

Set source point.

Parameters:

aX new X coordinate of the source point

aY new Y coordinate of the source point

Warning:
The data structure of the primitive is not subsequently updated.

Definition at line 298 of file _QGAR_AbstractGenQgarPrimitive.TCC.
References qgar::AbstractGenQgarPrimitive< T >::getGeomStructure(), and qgar::AbstractGenPrimitive< T >::setSource().

template<class T>

void qgar::AbstractGenQgarPrimitive< T >::setSourceTarget ( const GenPoint< value_type > & aSource,

const GenPoint< value_type > & aTarget

) [inline, inherited]

Set both source and target points.

Parameters:

aSource source point

aTarget target point

Warning:
The data structure of the primitive is not subsequently updated.

template<class T>

void qgar::AbstractGenQgarPrimitive< T >::setSourceTarget ( value_type aXSource,

value_type aYSource,

value_type aXTarget,

value_type aYTarget

) [inline, inherited]

Set both source and target points.

Parameters:

aXSource new X coordinate of the source point

aYSource new Y coordinate of the source point

aXTarget new X coordinate of the target point

aYTarget new Y coordinate of the target point

Warning:
The data structure of the primitive is not subsequently updated.

Definition at line 336 of file _QGAR_AbstractGenQgarPrimitive.TCC.
References qgar::AbstractGenQgarPrimitive< T >::getGeomStructure(), and qgar::AbstractGenPrimitive< T >::setSourceTarget().

template<class T>

void qgar::AbstractGenQgarPrimitive< T >::setTarget ( const GenPoint< value_type > & aPt ) [inline, inherited]

Set target point.

Parameters:

aPt a point

Warning:
The data structure of the primitive is not subsequently updated.

template<class T>

void qgar::AbstractGenQgarPrimitive< T >::setTarget ( value_type aX,

value_type aY

) [inline, inherited]

Set target point.

Parameters:

aX new X coordinate of the target point

aY new Y coordinate of the target point

Warning:
The data structure of the primitive is not subsequently updated.

Definition at line 317 of file _QGAR_AbstractGenQgarPrimitive.TCC.
References qgar::AbstractGenQgarPrimitive< T >::getGeomStructure(), and qgar::AbstractGenPrimitive< T >::setTarget().

template<class T>

void qgar::AbstractGenQgarPrimitive< T >::setThickness ( int aThickness ) [inline, inherited]

Set thickness.

Parameters:

aThickness a thickness

Definition at line 262 of file _QGAR_AbstractGenQgarPrimitive.TCC.
References qgar::AbstractGenQgarPrimitive< T >::_thickness.

template<class T>

void qgar::AbstractGenQgarPrimitive< T >::setXSource ( value_type aX ) [inline, inherited]

Set X coordinate of the source point.

Parameters:

aX new X coordinate of the source point

Warning:
The data structure of the primitive is not subsequently updated.

Definition at line 429 of file _QGAR_AbstractGenQgarPrimitive.TCC.
References qgar::AbstractGenQgarPrimitive< T >::getGeomStructure(), and qgar::AbstractGenPrimitive< T >::setXSource().

template<class T>

void qgar::AbstractGenQgarPrimitive< T >::setXTarget ( value_type aX ) [inline, inherited]

Set X coordinate of the target point.

Parameters:

aX new X coordinate of the target point

Warning:
The data structure of the primitive is not subsequently updated.

Definition at line 439 of file _QGAR_AbstractGenQgarPrimitive.TCC.
References qgar::AbstractGenQgarPrimitive< T >::getGeomStructure(), and qgar::AbstractGenPrimitive< T >::setXTarget().

template<class T>

void qgar::AbstractGenQgarPrimitive< T >::setYSource ( value_type aY ) [inline, inherited]

Set Y coordinate of the source point.

Parameters:

aY new Y coordinate of the source point

Warning:
The data structure of the primitive is not subsequently updated.

Definition at line 449 of file _QGAR_AbstractGenQgarPrimitive.TCC.
References qgar::AbstractGenQgarPrimitive< T >::getGeomStructure(), and qgar::AbstractGenPrimitive< T >::setYSource().

template<class T>

void qgar::AbstractGenQgarPrimitive< T >::setYTarget ( value_type aY ) [inline, inherited]

Set Y coordinate of the target point.

Parameters:

aY new Y coordinate of the target point

Warning:
The data structure of the primitive is not subsequently updated.

Definition at line 459 of file _QGAR_AbstractGenQgarPrimitive.TCC.
References qgar::AbstractGenQgarPrimitive< T >::getGeomStructure(), and qgar::AbstractGenPrimitive< T >::setYTarget().

template<class T>

double qgar::GenQgarSegment< T >::slope ( ) const [inline]

Angle between the X axis and the segment, in [0, PI[ radians.

O O +------------------> X +-----------------> X | \ | | \ | | \ <-' angle | \ <-' angle | \ | \ | + source | + target | \ | \ | \ | \ | \ | \ v + target v + source Y Y

Warning:
The current segment is not assimilited to a vector.

Definition at line 236 of file _QGAR_GenQgarSegment.TCC.
References qgar::GenQgarSegment< T >::_geomStructure, and qgar::GenSegment< T >::slope().

template<class T>

double qgar::GenQgarSegment< T >::slopeDegrees ( ) const [inline]

Same as qgar::GenQgarSegment::slope, but the result is given in [0,180[ degrees.

Definition at line 246 of file _QGAR_GenQgarSegment.TCC.
References qgar::GenQgarSegment< T >::_geomStructure, and qgar::GenSegment< T >::slopeDegrees().

template<class T>

GenPoint< T > qgar::AbstractGenQgarPrimitive< T >::source ( ) const [inline, inherited]

Get a copy of the source point.

Definition at line 157 of file _QGAR_AbstractGenQgarPrimitive.TCC.
References qgar::AbstractGenQgarPrimitive< T >::accessGeomStructure(), and qgar::AbstractGenPrimitive< T >::source().
Referenced by RWARCVECTOR_arcsInLoop().

template<class T>

double qgar::GenQgarSegment< T >::sqr_length ( ) const [inline]

Get squared length of the segment.

Definition at line 171 of file _QGAR_GenQgarSegment.TCC.
References qgar::GenQgarSegment< T >::_geomStructure, and qgar::GenSegment< T >::sqr_length().

template<class T>

GenPoint< T > qgar::AbstractGenQgarPrimitive< T >::target ( ) const [inline, inherited]

Get a copy of the target point.

Definition at line 177 of file _QGAR_AbstractGenQgarPrimitive.TCC.
References qgar::AbstractGenQgarPrimitive< T >::accessGeomStructure(), and qgar::AbstractGenPrimitive< T >::target().
Referenced by qgar::GenPolyline< T >::append(), and RWARCVECTOR_arcsInLoop().

template<class T>

double qgar::GenQgarSegment< T >::theta ( ) const [inline]

Angle between the X axis and the segment, in [0, 2PI[ radians.

----->/ O O / / +------------------> X +---------|-------------> X | \ | | | / | | \ <-' angle | angle \_ /__/ | \ | / | + source | + target | \ | ^ | \ | / | v | / v + target v + source Y Y

Warning:
The current segment is assimilited to a vector joining its source to its target.

Definition at line 196 of file _QGAR_GenQgarSegment.TCC.
References qgar::GenQgarSegment< T >::_geomStructure, and qgar::GenSegment< T >::theta().

template<class T>

double qgar::GenQgarSegment< T >::thetaDegrees ( ) const [inline]

Same as qgar::GenQgarSegment::theta, but the result is given in [0,360[ degrees.

Definition at line 216 of file _QGAR_GenQgarSegment.TCC.
References qgar::GenQgarSegment< T >::_geomStructure, and qgar::GenSegment< T >::thetaDegrees().

template<class T>

int qgar::AbstractGenQgarPrimitive< T >::thickness ( ) const [inline, inherited]

Get thickness.

Definition at line 112 of file _QGAR_AbstractGenQgarPrimitive.TCC.
References qgar::AbstractGenQgarPrimitive< T >::_thickness.
Referenced by qgar::AbstractGraphicsFile::write().

template<class T>

void qgar::AbstractGenQgarPrimitive< T >::translate ( value_type aTransX,

value_type aTransY

) [inline, inherited]

Translate along X and Y axis.

Parameters:

aTransX X translation factor

aTransY Y translation factor

Reimplemented in qgar::GenQgarPolygon< T >, and qgar::GenQgarPolyline< T >.
Definition at line 542 of file _QGAR_AbstractGenQgarPrimitive.TCC.
References qgar::AbstractGenQgarPrimitive< T >::getGeomStructure().

template<class T>

std::ostream & qgar::GenQgarSegment< T >::write ( std::ostream & anOutStream ) const [virtual]

Serializes an object to an input stream.
A serialized Qgar segment is represented as:
QgarSegment(<GEOMETRICAL STRUCTURE>)(<THICKNESS>)(<COLOR>)(<OUTLINE>)

Parameters:

anOutStream the output stream

Implements qgar::ISerializable.
Definition at line 396 of file _QGAR_GenQgarSegment.TCC.
References qgar::AbstractGenQgarPrimitive< T >::_color, qgar::GenQgarSegment< T >::_geomStructure, qgar::AbstractGenQgarPrimitive< T >::_outline, and qgar::AbstractGenQgarPrimitive< T >::_thickness.

template<class T>

T qgar::AbstractGenQgarPrimitive< T >::xSource ( ) const [inline, inherited]

Get X coordinate of the source point.

Definition at line 192 of file _QGAR_AbstractGenQgarPrimitive.TCC.
References qgar::AbstractGenQgarPrimitive< T >::accessGeomStructure(), and qgar::AbstractGenPrimitive< T >::xSource().

template<class T>

T qgar::AbstractGenQgarPrimitive< T >::xTarget ( ) const [inline, inherited]

Get X coordinate of the target point.

Definition at line 202 of file _QGAR_AbstractGenQgarPrimitive.TCC.
References qgar::AbstractGenQgarPrimitive< T >::accessGeomStructure(), and qgar::AbstractGenPrimitive< T >::xTarget().

template<class T>

T qgar::AbstractGenQgarPrimitive< T >::ySource ( ) const [inline, inherited]

Get Y coordinate of the source point.

Definition at line 212 of file _QGAR_AbstractGenQgarPrimitive.TCC.
References qgar::AbstractGenQgarPrimitive< T >::accessGeomStructure(), and qgar::AbstractGenPrimitive< T >::ySource().

template<class T>

T qgar::AbstractGenQgarPrimitive< T >::yTarget ( ) const [inline, inherited]

Get Y coordinate of the target point.

Definition at line 222 of file _QGAR_AbstractGenQgarPrimitive.TCC.
References qgar::AbstractGenQgarPrimitive< T >::accessGeomStructure(), and qgar::AbstractGenPrimitive< T >::yTarget().

Member Data Documentation

template<class T>

QGEcolor qgar::AbstractGenQgarPrimitive< T >::_color [protected, inherited]

Color of the outline.

Definition at line 666 of file _QGAR_AbstractGenQgarPrimitive.H.
Referenced by qgar::AbstractGenQgarPrimitive< T >::color(), qgar::GenQgarSegment< T >::equal(), qgar::GenQgarArc< T >::equal(), qgar::GenQgarSegment< T >::notEqual(), qgar::AbstractGenQgarPrimitive< T >::operator=(), qgar::GenQgarSegment< T >::read(), qgar::GenQgarPolyline< T >::read(), qgar::GenQgarPolygon< T >::read(), qgar::GenQgarArc< T >::read(), qgar::AbstractGenQgarPrimitive< T >::setColor(), qgar::GenQgarSegment< T >::write(), qgar::GenQgarPolyline< T >::write(), qgar::GenQgarPolygon< T >::write(), and qgar::GenQgarArc< T >::write().

template<class T>

QGEoutline qgar::AbstractGenQgarPrimitive< T >::_outline [protected, inherited]

Type of outline.

See also:
Enum type qgar::QGEoutline

Definition at line 673 of file _QGAR_AbstractGenQgarPrimitive.H.
Referenced by qgar::GenQgarSegment< T >::equal(), qgar::GenQgarArc< T >::equal(), qgar::GenQgarSegment< T >::notEqual(), qgar::AbstractGenQgarPrimitive< T >::operator=(), qgar::AbstractGenQgarPrimitive< T >::outline(), qgar::GenQgarSegment< T >::read(), qgar::GenQgarPolyline< T >::read(), qgar::GenQgarPolygon< T >::read(), qgar::GenQgarArc< T >::read(), qgar::AbstractGenQgarPrimitive< T >::setOutline(), qgar::GenQgarSegment< T >::write(), qgar::GenQgarPolyline< T >::write(), qgar::GenQgarPolygon< T >::write(), and qgar::GenQgarArc< T >::write().

template<class T>

int qgar::AbstractGenQgarPrimitive< T >::_thickness [protected, inherited]

Thickness of the outline.

Definition at line 661 of file _QGAR_AbstractGenQgarPrimitive.H.
Referenced by qgar::GenQgarSegment< T >::equal(), qgar::GenQgarArc< T >::equal(), qgar::GenQgarSegment< T >::notEqual(), qgar::AbstractGenQgarPrimitive< T >::operator=(), qgar::AbstractGenQgarPrimitive< T >::setThickness(), qgar::AbstractGenQgarPrimitive< T >::thickness(), qgar::GenQgarSegment< T >::write(), qgar::GenQgarPolyline< T >::write(), qgar::GenQgarPolygon< T >::write(), and qgar::GenQgarArc< T >::write().

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


Public Types
Types
typedef T	value_type
	Type of the source and target coordinates.
typedef value_type &	reference
	Reference to qgar::GenQgarSegment::value_type.
typedef const value_type &	const_reference
	Constant reference to qgar::GenQgarSegment::value_type.
typedef value_type *	pointer
	Pointer to qgar::GenQgarSegment::value_type.
typedef const value_type *	const_pointer
	Constant pointer to qgar::GenQgarSegment::value_type.
Public Member Functions
Access to attributes
int	thickness () const
	Get thickness.
QGEcolor	color () const
	Get color.
QGEoutline	outline () const
	Get outline.
Access to source and target
const GenPoint< value_type > &	accessSource () const
	Get source point.
GenPoint< value_type >	source () const
	Get a copy of the source point.
const GenPoint< value_type > &	accessTarget () const
	Get target point.
GenPoint< value_type >	target () const
	Get a copy of the target point.
Access to separate coordinates
value_type	xSource () const
	Get X coordinate of the source point.
value_type	xTarget () const
	Get X coordinate of the target point.
value_type	ySource () const
	Get Y coordinate of the source point.
value_type	yTarget () const
	Get Y coordinate of the target point.
Access to geometrical characteristics
value_type	dx () const
	Difference between target and source X coordinates.
value_type	dy () const
	Difference between target and source Y coordinates.
Set attributes
void	setThickness (int aThickness)
	Set thickness.
void	setColor (QGEcolor aColor)
	Set color.
void	setOutline (QGEoutline anOutline)
	Set outline.
Set source and/or target without update
void	setSource (value_type aX, value_type aY)
	Set source point.
void	setSource (const GenPoint< value_type > &aPt)
	Set source point.
void	setTarget (value_type aX, value_type aY)
	Set target point.
void	setTarget (const GenPoint< value_type > &aPt)
	Set target point.
void	setSourceTarget (value_type aXSource, value_type aYSource, value_type aXTarget, value_type aYTarget)
	Set both source and target points.
void	setSourceTarget (const GenPoint< value_type > &aSource, const GenPoint< value_type > &aTarget)
	Set both source and target points.
Set source and/or target with update
void	fixSource (value_type aX, value_type aY)
	Set source point.
void	fixSource (const GenPoint< value_type > &aPt)
	Set source point.
void	fixTarget (value_type aX, value_type aY)
	Set target point.
void	fixTarget (const GenPoint< value_type > &aPt)
	Set target point.
void	fixSourceTarget (value_type aXSource, value_type aYSource, value_type aXTarget, value_type aYTarget)
	Set both source and target points.
void	fixSourceTarget (const GenPoint< value_type > &aSource, const GenPoint< value_type > &aTarget)
	Set both source and target points.
Set separate (source and target) coordinates without update
void	setXSource (value_type aX)
	Set X coordinate of the source point.
void	setXTarget (value_type aX)
	Set X coordinate of the target point.
void	setYSource (value_type aY)
	Set Y coordinate of the source point.
void	setYTarget (value_type aY)
	Set Y coordinate of the target point.
Set separate (source and target) coordinates with update
void	fixXSource (value_type aX)
	Set X coordinate of the source point.
void	fixXTarget (value_type aX)
	Set X coordinate of the target point.
void	fixYSource (value_type aY)
	Set Y coordinate of the source point.
void	fixYTarget (value_type aY)
	Set Y coordinate of the target point.
Geometry: Translation
void	translate (value_type aTransX, value_type aTransY)
	Translate along X and Y axis.
Constructors
	GenQgarSegment (int aThickness=1, QGEcolor aColor=QGE_COLOR_DEFAULT, QGEoutline anOutline=QGE_OUTLINE_DEFAULT)
	Default constructor.
	GenQgarSegment (const GenQgarSegment< value_type > &aQSeg)
	Copy constructor.
	GenQgarSegment (const GenSegment< value_type > &aSeg, int aThickness=1, QGEcolor aColor=QGE_COLOR_DEFAULT, QGEoutline anOutline=QGE_OUTLINE_DEFAULT)
	Initialize from a geometrical segment.
	GenQgarSegment (const GenPoint< value_type > &aSource, const GenPoint< value_type > &aTarget, int aThickness=1, QGEcolor aColor=QGE_COLOR_DEFAULT, QGEoutline anOutline=QGE_OUTLINE_DEFAULT)
	Initialize from source and target points.
	GenQgarSegment (value_type aXSource, value_type aYSource, value_type aXTarget, value_type aYTarget, int aThickness=1, QGEcolor aColor=QGE_COLOR_DEFAULT, QGEoutline anOutline=QGE_OUTLINE_DEFAULT)
	Initialize from coordinates.
Destructor
virtual	~GenQgarSegment ()
	Virtual destructor.
Copy
virtual GenQgarSegment< value_type > *	clone () const
	Create a dynamically allocated deep copy of the primitive.
Access to geometrical features
const GenSegment< value_type > &	accessGeomStructure () const
	Get the structure implementing the geometrical aspect of a Qgar segment.
double	length () const
	Get length of the segment.
double	sqr_length () const
	Get squared length of the segment.
double	rho () const
	Distance between point (0,0) and its perpendicular projection onto the line supporting the current segment.
double	theta () const
	Angle between the X axis and the segment, in [0, 2PI[ radians.
double	angle () const
	Same as qgar::GenQgarSegment::theta.
double	slope () const
	Angle between the X axis and the segment, in [0, PI[ radians.
double	thetaDegrees () const
	Same as qgar::GenQgarSegment::theta, but the result is given in [0,360[ degrees.
double	angleDegrees () const
	Same as qgar::GenQgarSegment::theta, but the result is given in [0,360[ degrees.
double	slopeDegrees () const
	Same as qgar::GenQgarSegment::slope, but the result is given in [0,180[ degrees.
Geometrical predicates
bool	contains (const GenPoint< T > &c, double aDist=Math::epsilonD())
	Return true if the given point approximately belongs to the current Qgar segment.
Operators
GenQgarSegment< value_type > &	operator= (const GenQgarSegment< value_type > &aQSeg)
	Assignment.
bool	operator== (const GenQgarSegment< value_type > &aQSeg) const
	Same as function qgar::GenQgarSegment::eq.
bool	operator!= (const GenQgarSegment< value_type > &aQSeg) const
	Same as function qgar::GenQgarSegment::notEq.
Functional operators
bool	eq (const GenQgarSegment< value_type > &aQSeg) const
	Equality.
bool	equal (const GenQgarSegment< value_type > &aQSeg) const
	Equality.
bool	notEq (const GenQgarSegment< value_type > &aQSeg) const
	Inequality.
bool	notEqual (const GenQgarSegment< value_type > &aQSeg) const
	Inequality.
Serialization/deserialization
virtual std::istream &	read (std::istream &anInStream)
	Deserializes the current segment from an input stream.
virtual std::ostream &	write (std::ostream &anOutStream) const
	Serializes an object to an input stream.
Access to attributes
int	thickness () const
	Get thickness.
QGEcolor	color () const
	Get color.
QGEoutline	outline () const
	Get outline.
Access to source and target
const GenPoint< value_type > &	accessSource () const
	Get source point.
GenPoint< value_type >	source () const
	Get a copy of the source point.
const GenPoint< value_type > &	accessTarget () const
	Get target point.
GenPoint< value_type >	target () const
	Get a copy of the target point.
Access to separate coordinates
value_type	xSource () const
	Get X coordinate of the source point.
value_type	xTarget () const
	Get X coordinate of the target point.
value_type	ySource () const
	Get Y coordinate of the source point.
value_type	yTarget () const
	Get Y coordinate of the target point.
Access to geometrical characteristics
value_type	dx () const
	Difference between target and source X coordinates.
value_type	dy () const
	Difference between target and source Y coordinates.
Set attributes
void	setThickness (int aThickness)
	Set thickness.
void	setColor (QGEcolor aColor)
	Set color.
void	setOutline (QGEoutline anOutline)
	Set outline.
Set source and/or target without update
void	setSource (value_type aX, value_type aY)
	Set source point.
void	setSource (const GenPoint< value_type > &aPt)
	Set source point.
void	setTarget (value_type aX, value_type aY)
	Set target point.
void	setTarget (const GenPoint< value_type > &aPt)
	Set target point.
void	setSourceTarget (value_type aXSource, value_type aYSource, value_type aXTarget, value_type aYTarget)
	Set both source and target points.
void	setSourceTarget (const GenPoint< value_type > &aSource, const GenPoint< value_type > &aTarget)
	Set both source and target points.
Set source and/or target with update
void	fixSource (value_type aX, value_type aY)
	Set source point.
void	fixSource (const GenPoint< value_type > &aPt)
	Set source point.
void	fixTarget (value_type aX, value_type aY)
	Set target point.
void	fixTarget (const GenPoint< value_type > &aPt)
	Set target point.
void	fixSourceTarget (value_type aXSource, value_type aYSource, value_type aXTarget, value_type aYTarget)
	Set both source and target points.
void	fixSourceTarget (const GenPoint< value_type > &aSource, const GenPoint< value_type > &aTarget)
	Set both source and target points.
Set separate (source and target) coordinates without update
void	setXSource (value_type aX)
	Set X coordinate of the source point.
void	setXTarget (value_type aX)
	Set X coordinate of the target point.
void	setYSource (value_type aY)
	Set Y coordinate of the source point.
void	setYTarget (value_type aY)
	Set Y coordinate of the target point.
Set separate (source and target) coordinates with update
void	fixXSource (value_type aX)
	Set X coordinate of the source point.
void	fixXTarget (value_type aX)
	Set X coordinate of the target point.
void	fixYSource (value_type aY)
	Set Y coordinate of the source point.
void	fixYTarget (value_type aY)
	Set Y coordinate of the target point.
Geometry: Translation
void	translate (value_type aTransX, value_type aTransY)
	Translate along X and Y axis.
Protected Member Functions
Non-protected access to the geometrical aspect
AbstractGenPrimitive< value_type > &	getGeomStructure ()
	Return the geometrical aspect.
Protected Attributes
Attributes
Apply a central symmetry to the current primitive, using the point of given coordinates as the symmetry center. Apply a central symmetry to the current primitive, using the given point as the symmetry center. Apply a mirror symmetry to the current primitive, using the line passing through the two given points for the symmetry. Apply a mirror symmetry to the current primitive, using the line supporting the given segment for the symmetry.
int	_thickness
	Thickness of the outline.
QGEcolor	_color
	Color of the outline.
QGEoutline	_outline
	Type of outline.
Geometrical structure of a Qgar segment
GenSegment< value_type >	_geomStructure
	Structure implementing the geometrical aspect.
Attributes
Apply a central symmetry to the current primitive, using the point of given coordinates as the symmetry center. Apply a central symmetry to the current primitive, using the given point as the symmetry center. Apply a mirror symmetry to the current primitive, using the line passing through the two given points for the symmetry. Apply a mirror symmetry to the current primitive, using the line supporting the given segment for the symmetry.
int	_thickness
	Thickness of the outline.
QGEcolor	_color
	Color of the outline.
QGEoutline	_outline
	Type of outline.

qgar::GenQgarSegment< T > Class Template Reference [Qgar (graphical) primitives]

Detailed Description

template<class T> class qgar::GenQgarSegment< T >

Public Types

Public Member Functions