ACF $AcfVersion:0$
Public Types | Public Member Functions | Protected Attributes | List of all members
i2d::CArc Class Reference

Represents a circular arc defined by a center point, radius, and start/end angles. More...

#include <CArc.h>

Inheritance diagram for i2d::CArc:
i2d::CCircle i2d::CPosition2d i2d::CObject2dBase i2d::IObject2d iser::IObject i2d::ICalibrationProvider iser::ISerializable istd::IChangeable istd::IChangeable istd::IPolymorphic istd::IPolymorphic i2d::TObject2dCompWrap< CArc > i2d::CArcComp

Public Types

typedef CCircle BaseClass
 
- Public Types inherited from i2d::CCircle
typedef CPosition2d BaseClass
 
- Public Types inherited from i2d::IObject2d
enum  ChangeFlags { CF_OBJECT_POSITION = 0x6ba340 }
 
- Public Types inherited from istd::IChangeable
enum  ChangeFlags {
  CF_ACF_INTERNAL = 0 , CF_ALL_DATA , CF_ANY , CF_DESTROYING ,
  CF_DELEGATED , CF_NO_UNDO
}
 Data model change notification flags. More...
 
enum  SupportedOperations {
  SO_NONE = 0 , SO_OBSERVE = 1 << 0 , SO_COPY = 1 << 1 , SO_CLONE = 1 << 2 ,
  SO_COMPARE = 1 << 3 , SO_RESET = 1 << 4
}
 Flags for supported operations. More...
 
enum  CompatibilityMode { CM_STRICT , CM_WITHOUT_REFS , CM_WITH_REFS , CM_CONVERT }
 Control how relationship betweeen objects are interpreted. More...
 
typedef QMultiMap< QByteArray, QVariant > ChangeInfoMap
 

Public Member Functions

 CArc ()
 Construct an empty arc object.
 
 CArc (double startAngle, double endAngle, const double radius, const CVector2d &center)
 Construct an arc with specified parameters.
 
double GetStartAngle () const
 Get the starting angle of the arc.
 
void SetStartAngle (double angle)
 Set the starting angle of the arc.
 
double GetEndAngle () const
 Get the ending angle of the arc.
 
void SetEndAngle (double angle)
 Set the ending angle of the arc.
 
bool operator== (const CArc &arc) const
 Compare this arc with another arc for equality.
 
bool operator!= (const CArc &arc) const
 Compare this arc with another arc for inequality.
 
CVector2d GetPositionFromAlpha (double alpha) const
 Get position of point using normed 'alpha' value.
 
virtual CRectangle GetBoundingBox () const override
 Get bounding box of this shape.
 
virtual bool Transform (const ITransformation2d &transformation, ITransformation2d::ExactnessMode mode=ITransformation2d::EM_NONE, double *errorFactorPtr=NULL) override
 Transform this object using some transformation.
 
virtual bool InvTransform (const ITransformation2d &transformation, ITransformation2d::ExactnessMode mode=ITransformation2d::EM_NONE, double *errorFactorPtr=NULL) override
 Do inverse transformation of this object.
 
virtual bool GetTransformed (const ITransformation2d &transformation, IObject2d &result, ITransformation2d::ExactnessMode mode=ITransformation2d::EM_NONE, double *errorFactorPtr=NULL) const override
 Calulate transformation of the object into second one.
 
virtual bool GetInvTransformed (const ITransformation2d &transformation, IObject2d &result, ITransformation2d::ExactnessMode mode=ITransformation2d::EM_NONE, double *errorFactorPtr=NULL) const override
 Calulate inverse transformation of the object into second one.
 
virtual int GetSupportedOperations () const override
 Get set of flags for supported operations.
 
virtual bool CopyFrom (const IChangeable &object, CompatibilityMode mode=CM_WITHOUT_REFS) override
 
virtual istd::TUniqueInterfacePtr< istd::IChangeableCloneMe (CompatibilityMode mode=CM_WITHOUT_REFS) const override
 Make a copy of this object.
 
virtual bool Serialize (iser::IArchive &archive) override
 Load or store state of this object as a archive stream.
 
- Public Member Functions inherited from i2d::CCircle
 CCircle ()
 
 CCircle (double radius, const CVector2d &center)
 
double GetRadius () const
 
void SetRadius (double radius)
 
bool operator== (const CCircle &circle) const
 
bool operator!= (const CCircle &circle) const
 
virtual bool ConvertToPolygon (i2d::CPolygon &result, int segmentsCount=0) const
 Performs conversion of the circle splitting it to segmentsCount segments to the polygon result.
 
bool IsIntersectedBy (const CCircle &circle, bool isFilled=false) const
 Check if this circle is intersected by another circle (or disk).
 
bool IsIntersectedBy (const CLine2d &line, bool isFilled=false) const
 Check if this circle is intersected by line.
 
int GetIntersectionAlphas (const CLine2d &line, double result[2]) const
 Get points of intersection circle by line.
 
int GetIntersectionPoints (const CLine2d &line, i2d::CVector2d &result1, i2d::CVector2d &result2) const
 Get points of intersection circle by line.
 
virtual QByteArray GetFactoryId () const override
 
- Public Member Functions inherited from i2d::CPosition2d
 CPosition2d ()
 
 CPosition2d (const CVector2d &center)
 
const CVector2dGetPosition () const
 
void SetPosition (const CVector2d &position)
 
void Translate (const i2d::CVector2d &vector)
 
CPosition2d GetTranslated (const i2d::CVector2d &vector) const
 
virtual CVector2d GetCenter () const override
 Returns center of this 2D-object.
 
virtual void MoveCenterTo (const CVector2d &position) override
 Move object to position position.
 
virtual bool IsEqual (const istd::IChangeable &object) const override
 Compare this object with another object.
 
- Public Member Functions inherited from i2d::CObject2dBase
 CObject2dBase ()
 
 CObject2dBase (const CObject2dBase &object2d)
 
 CObject2dBase (CObject2dBase &&object2d)
 
CObject2dBaseoperator= (const CObject2dBase &object2d)
 
CObject2dBaseoperator= (CObject2dBase &&object2d)
 
virtual const ICalibration2dGetCalibration () const override
 Get access to transformation object, which transforms a local logical coordinate system to global one.
 
virtual void SetCalibration (const ICalibration2d *calibrationPtr, bool releaseFlag=false) override
 Set calibration of this object.
 
virtual bool CopyFrom (const istd::IChangeable &object, CompatibilityMode mode=CM_WITHOUT_REFS) override
 Copy this object from another one.
 
virtual bool ResetData (CompatibilityMode mode=CM_WITHOUT_REFS) override
 Reset data to its default state.
 
- Public Member Functions inherited from iser::ISerializable
virtual quint32 GetMinimalVersion (int versionId) const
 Get minimal needed version to correct storing of this data.
 
- Public Member Functions inherited from istd::IChangeable
virtual void BeginChanges (const ChangeSet &changeSet)
 Starts the change transaction.
 
virtual void EndChanges (const ChangeSet &changeSet)
 Ends the change transaction.
 
virtual void BeginChangeGroup (const ChangeSet &changeSet)
 Starts group of changes.
 
virtual void EndChangeGroup (const ChangeSet &changeSet)
 Ends group of changes.
 
- Public Member Functions inherited from istd::IPolymorphic
virtual ~IPolymorphic ()
 

Protected Attributes

double m_startAngle
 
double m_endAngle
 
- Protected Attributes inherited from i2d::CCircle
double m_radius
 
- Protected Attributes inherited from i2d::CPosition2d
CVector2d m_position
 

Additional Inherited Members

- Static Public Member Functions inherited from i2d::CCircle
static QByteArray GetTypeName ()
 
- Static Public Member Functions inherited from i2d::CPosition2d
static QByteArray GetTypeName ()
 
- Static Public Member Functions inherited from istd::IChangeable
static const ChangeSetGetNoChanges ()
 Get empty set of changes.
 
static const ChangeSetGetAnyChange ()
 Get anonymous change set.
 
static const ChangeSetGetAllChanges ()
 Get anonymous change set.
 
static const ChangeSetGetDelegatedChanges ()
 Get delegated change set.
 
- Protected Member Functions inherited from istd::IChangeable
virtual void OnBeginChanges ()
 Callback function for begin change event.
 
virtual void OnEndChanges (const ChangeSet &changeSet)
 Callback function for end change event.
 
- Static Protected Attributes inherited from i2d::CObject2dBase
static const ChangeSet s_objectMovedChange
 
static const ChangeSet s_objectModifiedChange
 

Detailed Description

Represents a circular arc defined by a center point, radius, and start/end angles.

An arc is a portion of a circle's circumference between two angles.

Definition at line 17 of file CArc.h.

Member Typedef Documentation

◆ BaseClass

Definition at line 20 of file CArc.h.

Constructor & Destructor Documentation

◆ CArc() [1/2]

i2d::CArc::CArc ( )

Construct an empty arc object.

◆ CArc() [2/2]

i2d::CArc::CArc ( double  startAngle,
double  endAngle,
const double  radius,
const CVector2d center 
)

Construct an arc with specified parameters.

Parameters
startAngleStarting angle in radians.
endAngleEnding angle in radians.
radiusRadius of the arc.
centerCenter point of the arc.

Member Function Documentation

◆ CloneMe()

virtual istd::TUniqueInterfacePtr< istd::IChangeable > i2d::CArc::CloneMe ( CompatibilityMode  mode = CM_WITHOUT_REFS) const
overridevirtual

Make a copy of this object.

Returns
new instance or NULL, if this operation is not supported.

Reimplemented from i2d::CCircle.

◆ CopyFrom()

virtual bool i2d::CArc::CopyFrom ( const IChangeable &  object,
CompatibilityMode  mode = CM_WITHOUT_REFS 
)
overridevirtual

Reimplemented from i2d::CCircle.

◆ GetBoundingBox()

virtual CRectangle i2d::CArc::GetBoundingBox ( ) const
overridevirtual

Get bounding box of this shape.

Please note, this bounding box is in logical units, the calibration will not be considered.

Reimplemented from i2d::CCircle.

◆ GetEndAngle()

double i2d::CArc::GetEndAngle ( ) const
inline

Get the ending angle of the arc.

Returns
Ending angle in radians.

Definition at line 119 of file CArc.h.

References m_endAngle.

◆ GetInvTransformed()

virtual bool i2d::CArc::GetInvTransformed ( const ITransformation2d transformation,
IObject2d result,
ITransformation2d::ExactnessMode  mode = ITransformation2d::EM_NONE,
double *  errorFactorPtr = NULL 
) const
overridevirtual

Calulate inverse transformation of the object into second one.

Please note, that this operation transforms logical coordinates, it means that the calibration will be ignored.

Parameters
modecontrols needed transformation exactness.
errorFactorPtroptional output where approximated length of transformation error vector will be stored. Value 0 means that transformation is exactly done.
resultresult object.
Returns
true, if transformation was done correctly.

Reimplemented from i2d::CCircle.

◆ GetPositionFromAlpha()

CVector2d i2d::CArc::GetPositionFromAlpha ( double  alpha) const

Get position of point using normed 'alpha' value.

Value 0 will be mapped to point 1 and value 1 will be mapped to point 2.

◆ GetStartAngle()

double i2d::CArc::GetStartAngle ( ) const
inline

Get the starting angle of the arc.

Returns
Starting angle in radians.

Definition at line 113 of file CArc.h.

References m_startAngle.

◆ GetSupportedOperations()

virtual int i2d::CArc::GetSupportedOperations ( ) const
overridevirtual

Get set of flags for supported operations.

See also
SupportedOperations

Reimplemented from i2d::CCircle.

◆ GetTransformed()

virtual bool i2d::CArc::GetTransformed ( const ITransformation2d transformation,
IObject2d result,
ITransformation2d::ExactnessMode  mode = ITransformation2d::EM_NONE,
double *  errorFactorPtr = NULL 
) const
overridevirtual

Calulate transformation of the object into second one.

Please note, that this operation transforms logical coordinates, it means that the calibration will be ignored.

Parameters
modecontrols needed transformation exactness.
errorFactorPtroptional output where approximated length of transformation error vector will be stored. Value 0 means that transformation is exactly done.
resultresult object.
Returns
true, if transformation was done correctly.

Reimplemented from i2d::CCircle.

◆ InvTransform()

virtual bool i2d::CArc::InvTransform ( const ITransformation2d transformation,
ITransformation2d::ExactnessMode  mode = ITransformation2d::EM_NONE,
double *  errorFactorPtr = NULL 
)
overridevirtual

Do inverse transformation of this object.

Please note, that this operation transforms logical coordinates, it means that the calibration will be ignored.

Parameters
modecontrols needed transformation exactness.
errorFactorPtroptional output where approximated length of transformation error vector will be stored. Value 0 means that transformation is exactly done.
Returns
true, if transformation was done correctly.

Reimplemented from i2d::CCircle.

◆ operator!=()

bool i2d::CArc::operator!= ( const CArc arc) const

Compare this arc with another arc for inequality.

Parameters
arcArc to compare with.
Returns
true if arcs are not equal, false otherwise.

◆ operator==()

bool i2d::CArc::operator== ( const CArc arc) const

Compare this arc with another arc for equality.

Parameters
arcArc to compare with.
Returns
true if arcs are equal, false otherwise.

◆ Serialize()

virtual bool i2d::CArc::Serialize ( iser::IArchive archive)
overridevirtual

Load or store state of this object as a archive stream.

Type of operation is depending on archive type.

See also
iser::IArchive

Reimplemented from i2d::CCircle.

◆ SetEndAngle()

void i2d::CArc::SetEndAngle ( double  angle)

Set the ending angle of the arc.

Parameters
angleEnding angle in radians.

◆ SetStartAngle()

void i2d::CArc::SetStartAngle ( double  angle)

Set the starting angle of the arc.

Parameters
angleStarting angle in radians.

◆ Transform()

virtual bool i2d::CArc::Transform ( const ITransformation2d transformation,
ITransformation2d::ExactnessMode  mode = ITransformation2d::EM_NONE,
double *  errorFactorPtr = NULL 
)
overridevirtual

Transform this object using some transformation.

Please note, that this operation transforms logical coordinates, it means that the calibration will be ignored.

Parameters
modecontrols needed transformation exactness.
errorFactorPtroptional output where approximated length of transformation error vector will be stored. Value 0 means that transformation is exactly done.
Returns
true, if transformation was done correctly.

Reimplemented from i2d::CCircle.

Member Data Documentation

◆ m_endAngle

double i2d::CArc::m_endAngle
protected

Definition at line 107 of file CArc.h.

Referenced by GetEndAngle().

◆ m_startAngle

double i2d::CArc::m_startAngle
protected

Definition at line 106 of file CArc.h.

Referenced by GetStartAngle().


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