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

#include <qgarlib/primitives.H>

Inheritance diagram for qgar::GenQgarArc< T >:

List of all members.

Detailed Description

template<class T>
class qgar::GenQgarArc< T >

Arc of circle, so-called Qgar arc, with coordinates of type T.

   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                                 O
    +----------------------> X        +----------------------> X
    | center                          | 
    |      +       +  source          |           -----
    |              |                  |     arc /       \
    |             / arc               |         |   +    v
    | target  +<-                     |         \        + target
    |                                 |          +
    V                                 V        source

    Y                                 Y

A Qgar arc is oriented: It is provided with a so-called source point and a so-called target point, which determine the part of the circle supporting the arc.

Predefined types: qgar::QgarArc, qgar::IQgarArc, qgar::FQgarArc, qgar::DQgarArc.
A Qgar arc is provided with attributes: thickness, color, and outline. When such features are useless, see class qgar::GenArc (for geometrical arcs).

Warning:: The coherence of the data structure of a Qgar arc after modifications of its source and/or its target and/or its center is the user's responsibility!

Author:: Gérald Masini

Date:: June 20, 2003 17:35

Since:: Qgar 2.1

Definition at line 131 of file _QGAR_GenQgarArc.H.

Public Types

Types related to Qgar arcs

typedef T value_type

Type of the coordinates of the source, target and center.

typedef value_type & reference

Reference to qgar::GenQgarArc::value_type.

typedef const value_type & const_reference

Constant reference to qgar::GenQgarArc::value_type.

typedef value_type * pointer

Pointer to qgar::GenQgarArc::value_type.

typedef const value_type * const_pointer

Constant pointer to qgar::GenQgarArc::value_type.

Public Member Functions

Constructors

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

Default constructor.

GenQgarArc (const GenQgarArc< value_type > &aQArc)

Copy constructor.

GenQgarArc (const GenArc< value_type > &anArc, int aThickness=1, QGEcolor aColor=QGE_COLOR_DEFAULT, QGEoutline anOutline=QGE_OUTLINE_DEFAULT)

Initialize from a geometrical arc.

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

Initialize from three points.

Destructor

virtual ~GenQgarArc ()

Virtual destructor.

Copy

virtual GenQgarArc< value_type > * clone () const

Create a dynamically allocated deep copy of the primitive.

Access to geometrical features

const GenArc< value_type > & accessGeomStructure () const

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

double radius () const

Get the radius.

double length () const

Get length of the arc.

double angle () const

Get the angle of the arc, in [0, 2PI] radians.

double angleDegrees () const

Get the angle of the arc, in [0, 360] degrees.

double sourceAngle () const

Get the so-called source angle.

double sourceAngleDegrees () const

Get the source angle, in [0, 360] degrees.

double targetAngle () const

Get the so-called target angle.

double targetAngleDegrees () const

Get the target angle, in [0, 360] degrees.

Center

const GenPoint< value_type > & accessCenter () const

Get the center point.

GenPoint< value_type > center () const

Get a copy of the center point.

value_type xCenter () const

Get X coordinate of center point.

value_type yCenter () const

Get Y coordinate of center point.

void setXCenter (value_type aX)

Set X coordinate of the center point.

void setYCenter (value_type aY)

Set Y coordinate of the center point.

void setCenter (value_type aX, value_type aY)

Set the center point.

void setCenter (const GenPoint< value_type > &aCenter)

Set the center point.

Operators

GenQgarArc< value_type > & operator= (const GenQgarArc< value_type > &aQArc)

Assignment.

bool operator== (const GenQgarArc< value_type > &aQArc) const

Same as function qgar::GenQgarArc::eq.

bool operator!= (const GenQgarArc< value_type > &aQArc) const

Same as function qgar::GenQgarArc::notEq.

Functional operators

bool eq (const GenQgarArc< value_type > &aQArc) const

Equality.

bool equal (const GenQgarArc< value_type > &aQArc) const

Equality.

bool notEq (const GenQgarArc< value_type > &aQArc) const

Inequality.

bool notEqual (const GenQgarArc< value_type > &aQArc) const

Inequality.

Serialization/deserialization

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

Deserializes the current arc from an input stream.

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

Serializes the current arc to an input stream.

Protected Member Functions

Non-protected access to the geometrical aspect

virtual AbstractGenPrimitive<
value_type > & getGeomStructure ()

Return the geometrical aspect.

Protected Attributes

Geometrical structure of a Qgar arc

GenArc< value_type > _geomStructure

Geometrical structure.

Member Typedef Documentation

template<class T>

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

Constant pointer to qgar::GenQgarArc::value_type.

Reimplemented from qgar::AbstractGenQgarPrimitive< T >.
Definition at line 169 of file _QGAR_GenQgarArc.H.

template<class T>

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

Constant reference to qgar::GenQgarArc::value_type.

Reimplemented from qgar::AbstractGenQgarPrimitive< T >.
Definition at line 159 of file _QGAR_GenQgarArc.H.

template<class T>

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

Pointer to qgar::GenQgarArc::value_type.

Reimplemented from qgar::AbstractGenQgarPrimitive< T >.
Definition at line 164 of file _QGAR_GenQgarArc.H.

template<class T>

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

Reference to qgar::GenQgarArc::value_type.

Reimplemented from qgar::AbstractGenQgarPrimitive< T >.
Definition at line 154 of file _QGAR_GenQgarArc.H.

template<class T>

typedef T qgar::GenQgarArc< T >::value_type

Type of the coordinates of the source, target and center.

Reimplemented from qgar::AbstractGenQgarPrimitive< T >.
Definition at line 149 of file _QGAR_GenQgarArc.H.

Constructor & Destructor Documentation

template<class T>

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

QGEcolor aColor = QGE_COLOR_DEFAULT,

QGEoutline anOutline = QGE_OUTLINE_DEFAULT

)

Default constructor.
Zero-length arc located at the origin of the coordinate system.

Parameters:

aThickness thickness (default 1)

aColor color (default qgar::QGE_COLOR_DEFAULT)

anOutline outline (default qgar::QGE_OUTLINE_DEFAULT)

Todo:
The created arc does not conform to the definition of an arc!

Definition at line 59 of file _QGAR_GenQgarArc.TCC.

template<class T>

qgar::GenQgarArc< T >::GenQgarArc ( const GenQgarArc< value_type > & aQArc )

Copy constructor.

Definition at line 76 of file _QGAR_GenQgarArc.TCC.

template<class T>

qgar::GenQgarArc< T >::GenQgarArc ( const GenArc< value_type > & anArc,

int aThickness = 1,

QGEcolor aColor = QGE_COLOR_DEFAULT,

QGEoutline anOutline = QGE_OUTLINE_DEFAULT

)

Initialize from a geometrical arc.

Parameters:

anArc a geometrical arc

aThickness thickness (default 1)

aColor color (default qgar::QGE_COLOR_DEFAULT)

anOutline outline (default qgar::QGE_OUTLINE_DEFAULT)

template<class T>

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

const GenPoint< value_type > & aTarget,

const GenPoint< value_type > & aCenter,

int aThickness = 1,

QGEcolor aColor = QGE_COLOR_DEFAULT,

QGEoutline anOutline = QGE_OUTLINE_DEFAULT

)

Initialize from three points.

Parameters:

aSource source point

aTarget target point

aCenter center point

aThickness thickness (default 1)

aColor color (default qgar::QGE_COLOR_DEFAULT)

anOutline outline (default qgar::QGE_OUTLINE_DEFAULT)

template<class T>

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

Virtual destructor.

Definition at line 128 of file _QGAR_GenQgarArc.TCC.

Member Function Documentation

template<class T>

const GenPoint< T > & qgar::GenQgarArc< T >::accessCenter ( ) const [inline]

Get the center point.

Definition at line 322 of file _QGAR_GenQgarArc.TCC.

template<class T>

const GenArc< T > & qgar::GenQgarArc< T >::accessGeomStructure ( ) const [inline, virtual]

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

Implements qgar::AbstractGenQgarPrimitive< T >.
Definition at line 479 of file _QGAR_GenQgarArc.TCC.
References qgar::GenQgarArc< T >::_geomStructure.
Referenced by qgar::GenQgarArc< T >::eq(), qgar::GenQgarArc< T >::notEq(), 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::GenQgarArc< T >::angle ( ) const [inline]

Get the angle of the arc, in [0, 2PI] radians.
Always positive.
Definition at line 297 of file _QGAR_GenQgarArc.TCC.

template<class T>

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

Get the angle of the arc, in [0, 360] degrees.
Always positive.
Definition at line 307 of file _QGAR_GenQgarArc.TCC.

template<class T>

GenPoint< T > qgar::GenQgarArc< T >::center ( ) const [inline]

Get a copy of the center point.

Definition at line 332 of file _QGAR_GenQgarArc.TCC.
Referenced by RWARCVECTOR_arcsInLoop().

template<class T>

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

Create a dynamically allocated deep copy of the primitive.

Implements qgar::AbstractGenQgarPrimitive< T >.
Definition at line 463 of file _QGAR_GenQgarArc.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>

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::GenQgarArc< T >::eq ( const GenQgarArc< value_type > & aQArc ) const [inline]

Equality.

Parameters:

aQArc a Qgar arc

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

Definition at line 184 of file _QGAR_GenQgarArc.TCC.
References qgar::GenQgarArc< T >::accessGeomStructure().
Referenced by qgar::GenQgarArc< T >::equal(), and qgar::GenQgarArc< T >::operator==().

template<class T>

bool qgar::GenQgarArc< T >::equal ( const GenQgarArc< value_type > & aQArc ) const

Equality.

Parameters:

aQArc a Qgar arc

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

Definition at line 194 of file _QGAR_GenQgarArc.TCC.
References qgar::AbstractGenQgarPrimitive< T >::_color, qgar::AbstractGenQgarPrimitive< T >::_outline, qgar::AbstractGenQgarPrimitive< T >::_thickness, and qgar::GenQgarArc< T >::eq().

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::GenQgarArc< 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 495 of file _QGAR_GenQgarArc.TCC.
References qgar::GenQgarArc< T >::_geomStructure.

template<class T>

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

Get length of the arc.

Definition at line 247 of file _QGAR_GenQgarArc.TCC.

template<class T>

bool qgar::GenQgarArc< T >::notEq ( const GenQgarArc< value_type > & aQArc ) const [inline]

Inequality.

Parameters:

aQArc a Qgar arc

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

Definition at line 208 of file _QGAR_GenQgarArc.TCC.
References qgar::GenQgarArc< T >::accessGeomStructure().
Referenced by qgar::GenQgarArc< T >::notEqual(), and qgar::GenQgarArc< T >::operator!=().

template<class T>

bool qgar::GenQgarArc< T >::notEqual ( const GenQgarArc< value_type > & aQArc ) const

Inequality.

Parameters:

aQArc a Qgar arc

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

Definition at line 218 of file _QGAR_GenQgarArc.TCC.
References qgar::GenQgarArc< T >::notEq().

template<class T>

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

Same as function qgar::GenQgarArc::notEq.

Definition at line 169 of file _QGAR_GenQgarArc.TCC.
References qgar::GenQgarArc< T >::notEq().

template<class T>

GenQgarArc< T > & qgar::GenQgarArc< T >::operator= ( const GenQgarArc< value_type > & aQArc )

Assignment.

Parameters:

aQArc a Qgar arc

Definition at line 143 of file _QGAR_GenQgarArc.TCC.
References qgar::GenQgarArc< T >::_geomStructure.

template<class T>

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

Same as function qgar::GenQgarArc::eq.

Definition at line 159 of file _QGAR_GenQgarArc.TCC.
References qgar::GenQgarArc< T >::eq().

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>

double qgar::GenQgarArc< T >::radius ( ) const [inline]

Get the radius.

Definition at line 237 of file _QGAR_GenQgarArc.TCC.

template<class T>

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

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

Parameters:

anInStream The input stream

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

template<class T>

void qgar::GenQgarArc< T >::setCenter ( const GenPoint< value_type > & aCenter )

Set the center point.

Parameters:

aCenter point representing the new center

template<class T>

void qgar::GenQgarArc< T >::setCenter ( value_type aX,

value_type aY

) [inline]

Set the center point.

Parameters:

aX X coordinate of the new center

aY Y coordinate of the new center

Definition at line 382 of file _QGAR_GenQgarArc.TCC.
References qgar::GenQgarArc< T >::_geomStructure.

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::GenQgarArc< T >::setXCenter ( value_type aX ) [inline]

Set X coordinate of the center point.

Parameters:

aX new X coordinate

Definition at line 362 of file _QGAR_GenQgarArc.TCC.
References qgar::GenQgarArc< T >::_geomStructure.

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::GenQgarArc< T >::setYCenter ( value_type aY ) [inline]

Set Y coordinate of the center point.

Parameters:

aY new Y coordinate

Definition at line 372 of file _QGAR_GenQgarArc.TCC.
References qgar::GenQgarArc< T >::_geomStructure.

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>

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::GenQgarArc< T >::sourceAngle ( ) const [inline]

Get the so-called source angle.
It is the angle between the vector joining the center to the source point and the X axis, in [0, 2PI] radians.
Definition at line 257 of file _QGAR_GenQgarArc.TCC.

template<class T>

double qgar::GenQgarArc< T >::sourceAngleDegrees ( ) const [inline]

Get the source angle, in [0, 360] degrees.

Definition at line 267 of file _QGAR_GenQgarArc.TCC.

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::GenQgarArc< T >::targetAngle ( ) const [inline]

Get the so-called target angle.
Its is the angle between the vector joining the center to the target point and the X axis, in [0, 2PI] radians.
Definition at line 277 of file _QGAR_GenQgarArc.TCC.

template<class T>

double qgar::GenQgarArc< T >::targetAngleDegrees ( ) const [inline]

Get the target angle, in [0, 360] degrees.

Definition at line 287 of file _QGAR_GenQgarArc.TCC.

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::GenQgarArc< T >::write ( std::ostream & anOutStream ) const [virtual]

Serializes the current arc to an input stream.
A serialized Qgar arc is represented as:
QgarArc(<GEOMETRICAL STRUCTURE>)(<THICKNESS>)(<COLOR>)(<OUTLINE>)

Parameters:

anOutStream The output stream

Implements qgar::ISerializable.
Definition at line 429 of file _QGAR_GenQgarArc.TCC.
References qgar::AbstractGenQgarPrimitive< T >::_color, qgar::GenQgarArc< T >::_geomStructure, qgar::AbstractGenQgarPrimitive< T >::_outline, and qgar::AbstractGenQgarPrimitive< T >::_thickness.

template<class T>

T qgar::GenQgarArc< T >::xCenter ( ) const [inline]

Get X coordinate of center point.

Definition at line 342 of file _QGAR_GenQgarArc.TCC.

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::GenQgarArc< T >::yCenter ( ) const [inline]

Get Y coordinate of center point.

Definition at line 352 of file _QGAR_GenQgarArc.TCC.

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>

GenArc<value_type> qgar::GenQgarArc< T >::_geomStructure [protected]

Geometrical structure.

Definition at line 499 of file _QGAR_GenQgarArc.H.
Referenced by qgar::GenQgarArc< T >::accessGeomStructure(), qgar::GenQgarArc< T >::getGeomStructure(), qgar::GenQgarArc< T >::operator=(), qgar::GenQgarArc< T >::setCenter(), qgar::GenQgarArc< T >::setXCenter(), qgar::GenQgarArc< T >::setYCenter(), 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 related to Qgar arcs
typedef T	value_type
	Type of the coordinates of the source, target and center.
typedef value_type &	reference
	Reference to qgar::GenQgarArc::value_type.
typedef const value_type &	const_reference
	Constant reference to qgar::GenQgarArc::value_type.
typedef value_type *	pointer
	Pointer to qgar::GenQgarArc::value_type.
typedef const value_type *	const_pointer
	Constant pointer to qgar::GenQgarArc::value_type.
Public Member Functions
Constructors
	GenQgarArc (int aThickness=1, QGEcolor aColor=QGE_COLOR_DEFAULT, QGEoutline anOutline=QGE_OUTLINE_DEFAULT)
	Default constructor.
	GenQgarArc (const GenQgarArc< value_type > &aQArc)
	Copy constructor.
	GenQgarArc (const GenArc< value_type > &anArc, int aThickness=1, QGEcolor aColor=QGE_COLOR_DEFAULT, QGEoutline anOutline=QGE_OUTLINE_DEFAULT)
	Initialize from a geometrical arc.
	GenQgarArc (const GenPoint< value_type > &aSource, const GenPoint< value_type > &aTarget, const GenPoint< value_type > &aCenter, int aThickness=1, QGEcolor aColor=QGE_COLOR_DEFAULT, QGEoutline anOutline=QGE_OUTLINE_DEFAULT)
	Initialize from three points.
Destructor
virtual	~GenQgarArc ()
	Virtual destructor.
Copy
virtual GenQgarArc< value_type > *	clone () const
	Create a dynamically allocated deep copy of the primitive.
Access to geometrical features
const GenArc< value_type > &	accessGeomStructure () const
	Get the structure implementing the geometrical aspect of a Qgar arc.
double	radius () const
	Get the radius.
double	length () const
	Get length of the arc.
double	angle () const
	Get the angle of the arc, in [0, 2PI] radians.
double	angleDegrees () const
	Get the angle of the arc, in [0, 360] degrees.
double	sourceAngle () const
	Get the so-called source angle.
double	sourceAngleDegrees () const
	Get the source angle, in [0, 360] degrees.
double	targetAngle () const
	Get the so-called target angle.
double	targetAngleDegrees () const
	Get the target angle, in [0, 360] degrees.
Center
const GenPoint< value_type > &	accessCenter () const
	Get the center point.
GenPoint< value_type >	center () const
	Get a copy of the center point.
value_type	xCenter () const
	Get X coordinate of center point.
value_type	yCenter () const
	Get Y coordinate of center point.
void	setXCenter (value_type aX)
	Set X coordinate of the center point.
void	setYCenter (value_type aY)
	Set Y coordinate of the center point.
void	setCenter (value_type aX, value_type aY)
	Set the center point.
void	setCenter (const GenPoint< value_type > &aCenter)
	Set the center point.
Operators
GenQgarArc< value_type > &	operator= (const GenQgarArc< value_type > &aQArc)
	Assignment.
bool	operator== (const GenQgarArc< value_type > &aQArc) const
	Same as function qgar::GenQgarArc::eq.
bool	operator!= (const GenQgarArc< value_type > &aQArc) const
	Same as function qgar::GenQgarArc::notEq.
Functional operators
bool	eq (const GenQgarArc< value_type > &aQArc) const
	Equality.
bool	equal (const GenQgarArc< value_type > &aQArc) const
	Equality.
bool	notEq (const GenQgarArc< value_type > &aQArc) const
	Inequality.
bool	notEqual (const GenQgarArc< value_type > &aQArc) const
	Inequality.
Serialization/deserialization
virtual std::istream &	read (std::istream &anInStream)
	Deserializes the current arc from an input stream.
virtual std::ostream &	write (std::ostream &anOutStream) const
	Serializes the current arc to an input stream.
Protected Member Functions
Non-protected access to the geometrical aspect
virtual AbstractGenPrimitive< value_type > &	getGeomStructure ()
	Return the geometrical aspect.
Protected Attributes
Geometrical structure of a Qgar arc
GenArc< value_type >	_geomStructure
	Geometrical structure.

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

Detailed Description

template<class T> class qgar::GenQgarArc< T >

Public Types

Public Member Functions