ICF 3.1.1.10
Technical documentation of ICF Libraries
i2d::CAnnulus Class Reference

Definition of graphical annulus object. More...

#include <CAnnulus.h>

Inheritance diagram for i2d::CAnnulus:
Collaboration diagram for i2d::CAnnulus:

Public Types

typedef i2d::CPosition2d BaseClass
 
- Public Types inherited from i2d::IObject2d
enum  ChangeFlags { CF_OBJECT_POSITION = 0x6ba340 }
 
- Public Types inherited from istd::IChangeable
enum  ChangeFlags {
  CF_ICF_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 , SO_CHANGE_LOCK = 1 << 5
}
 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...
 

Public Member Functions

 CAnnulus ()
 Construct an empty annulus object.
 
 CAnnulus (const i2d::CVector2d &center, double innerRadius, double outerRadius)
 Construct an annulus object by the given position, inner and outer radius.
 
bool IsAnnulusValid () const
 Check, if the annulus is valid.
 
double GetInnerRadius () const
 Get the inner radius of the annulus.
 
void SetInnerRadius (double innerRadius)
 Set the inner radius of the annulus.
 
double GetOuterRadius () const
 Get the outer radius of the annulus.
 
void SetOuterRadius (double outerRadius)
 Set the outer radius of the annulus.
 
void SetInnerOuterRadius (double radius1, double radius2)
 Set the inner and outer radius of the annulus.
 
CCircle GetInnerCircle () const
 Set the inner circle of the annulus object.
 
CCircle GetOuterCircle () const
 Set the outer circle of the annulus object.
 
bool operator== (const CAnnulus &annulus) const
 Compare with another annulus.
 
bool operator!= (const CAnnulus &annulus) const
 Compare with another annulus.
 
bool ConvertToPolygon (i2d::CPolygon &result, int segmentsCount=0) const
 Performs conversion of the annulus splitting it to segmentsCount segments to the polygon result.
 
CRectangle GetBoundingBox () const override
 Get bounding box of this shape.
 
bool Transform (const ITransformation2d &transformation, ITransformation2d::ExactnessMode mode=ITransformation2d::EM_NONE, double *errorFactorPtr=nullptr) override
 Transform this object using some transformation.
 
bool InvTransform (const ITransformation2d &transformation, ITransformation2d::ExactnessMode mode=ITransformation2d::EM_NONE, double *errorFactorPtr=nullptr) override
 Do inverse transformation of this object.
 
bool GetTransformed (const ITransformation2d &transformation, IObject2d &result, ITransformation2d::ExactnessMode mode=ITransformation2d::EM_NONE, double *errorFactorPtr=nullptr) const override
 Calulate transformation of the object into second one.
 
bool GetInvTransformed (const ITransformation2d &transformation, IObject2d &result, ITransformation2d::ExactnessMode mode=ITransformation2d::EM_NONE, double *errorFactorPtr=nullptr) const override
 Calulate inverse transformation of the object into second one.
 
int GetSupportedOperations () const override
 Get set of flags for supported operations.
 
bool CopyFrom (const IChangeable &object, CompatibilityMode mode=CM_WITHOUT_REFS) override
 
std::unique_ptr< istd::IChangeable > CloneMe (CompatibilityMode mode=CM_WITHOUT_REFS) const override
 Make a copy of this object.
 
bool Serialize (iser::IArchive &archive) override
 Load or store state of this object as a archive stream.
 
- Public Member Functions inherited from i2d::CPosition2d
 CPosition2d ()
 
 CPosition2d (const CVector2d &center)
 
const CVector2d & GetPosition () const
 
void SetPosition (const CVector2d &position)
 
void Translate (const i2d::CVector2d &vector)
 
CPosition2d GetTranslated (const i2d::CVector2d &vector) const
 
CVector2d GetCenter () const override
 Returns center of this 2D-object.
 
void MoveCenterTo (const CVector2d &position) override
 Move object to position position.
 
CRectangle GetBoundingBox () const override
 Get bounding box of this shape.
 
bool Transform (const ITransformation2d &transformation, ITransformation2d::ExactnessMode mode=ITransformation2d::EM_NONE, double *errorFactorPtr=nullptr) override
 Transform this object using some transformation.
 
bool InvTransform (const ITransformation2d &transformation, ITransformation2d::ExactnessMode mode=ITransformation2d::EM_NONE, double *errorFactorPtr=nullptr) override
 Do inverse transformation of this object.
 
bool GetTransformed (const ITransformation2d &transformation, IObject2d &result, ITransformation2d::ExactnessMode mode=ITransformation2d::EM_NONE, double *errorFactorPtr=nullptr) const override
 Calulate transformation of the object into second one.
 
bool GetInvTransformed (const ITransformation2d &transformation, IObject2d &result, ITransformation2d::ExactnessMode mode=ITransformation2d::EM_NONE, double *errorFactorPtr=nullptr) const override
 Calulate inverse transformation of the object into second one.
 
QByteArray GetFactoryId () const override
 
bool Serialize (iser::IArchive &archive) override
 Load or store state of this object as a archive stream.
 
int GetSupportedOperations () const override
 Get set of flags for supported operations.
 
bool CopyFrom (const IChangeable &object, CompatibilityMode mode=CM_WITHOUT_REFS) override
 
bool IsEqual (const istd::IChangeable &object) const override
 Compare this object with another object.
 
std::unique_ptr< istd::IChangeable > CloneMe (CompatibilityMode mode=CM_WITHOUT_REFS) const override
 Make a copy of this object.
 
- Public Member Functions inherited from i2d::CObject2dBase
 CObject2dBase ()
 
 CObject2dBase (const CObject2dBase &object2d)
 
 CObject2dBase (CObject2dBase &&object2d)
 
const ICalibration2d * GetCalibration () const override
 Get access to transformation object, which transforms a local logical coordinate system to global one.
 
void SetCalibration (istd::TOptDelPtr< const ICalibration2d > &&calibrationPtr) override
 Set calibration of this object.
 
bool CopyFrom (const istd::IChangeable &object, CompatibilityMode mode=CM_WITHOUT_REFS) override
 Copy this object from another one.
 
bool ResetData (CompatibilityMode mode=CM_WITHOUT_REFS) override
 Reset data to its default state.
 
CObject2dBase & operator= (const CObject2dBase &object2d)
 
CObject2dBase & operator= (CObject2dBase &&object2d)
 
- Public Member Functions inherited from i2d::IObject2d
- Public Member Functions inherited from iser::IObject
- 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 QMutex * GetChangesLock () const
 Get mutex beeing locked during changes, if available.
 
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 i2d::ICalibration2dProvider

Protected Attributes

istd::CRange m_radiusRange
 
- Protected Attributes inherited from i2d::CPosition2d
CVector2d m_position
 

Additional Inherited Members

- Static Public Member Functions inherited from i2d::CPosition2d
static QByteArray GetTypeName ()
 
- Static Public Member Functions inherited from istd::IChangeable
static const ChangeSet & GetNoChanges ()
 Get empty set of changes.
 
static const ChangeSet & GetAnyChange ()
 Get anonymous change set.
 
static const ChangeSet & GetAllChanges ()
 Get anonymous change set.
 
static const ChangeSet & GetDelegatedChanges ()
 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

Definition of graphical annulus object.

Annulus is area between two concentrical circles. This object is stored using center position and two radii.

Definition at line 23 of file CAnnulus.h.

Member Typedef Documentation

◆ BaseClass

Constructor & Destructor Documentation

◆ CAnnulus() [1/2]

i2d::CAnnulus::CAnnulus ( )

Construct an empty annulus object.

◆ CAnnulus() [2/2]

i2d::CAnnulus::CAnnulus ( const i2d::CVector2d & center,
double innerRadius,
double outerRadius )

Construct an annulus object by the given position, inner and outer radius.

Member Function Documentation

◆ CloneMe()

std::unique_ptr< istd::IChangeable > i2d::CAnnulus::CloneMe ( CompatibilityMode mode = CM_WITHOUT_REFS) const
overridevirtual

Make a copy of this object.

You may check, if this functionality is supported over GetSupportedOperations().

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

Reimplemented from istd::IChangeable.

Reimplemented in i2d::CAnnulusSegment.

◆ ConvertToPolygon()

bool i2d::CAnnulus::ConvertToPolygon ( i2d::CPolygon & result,
int segmentsCount = 0 ) const

Performs conversion of the annulus splitting it to segmentsCount segments to the polygon result.

If segmentsCount <= 0 then number of segments will be calculated automatically, otherwise segmentsCount must be equal or greater then 3.

◆ CopyFrom()

bool i2d::CAnnulus::CopyFrom ( const IChangeable & object,
CompatibilityMode mode = CM_WITHOUT_REFS )
override

◆ GetBoundingBox()

CRectangle i2d::CAnnulus::GetBoundingBox ( ) const
overridevirtual

Get bounding box of this shape.

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

Implements i2d::IObject2d.

Reimplemented in i2d::CAnnulusSegment.

◆ GetInnerCircle()

CCircle i2d::CAnnulus::GetInnerCircle ( ) const

Set the inner circle of the annulus object.

◆ GetInnerRadius()

double i2d::CAnnulus::GetInnerRadius ( ) const

Get the inner radius of the annulus.

◆ GetInvTransformed()

bool i2d::CAnnulus::GetInvTransformed ( const ITransformation2d & transformation,
IObject2d & result,
ITransformation2d::ExactnessMode mode = ITransformation2d::EM_NONE,
double * errorFactorPtr = nullptr ) 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.

Implements i2d::IObject2d.

◆ GetOuterCircle()

CCircle i2d::CAnnulus::GetOuterCircle ( ) const

Set the outer circle of the annulus object.

◆ GetOuterRadius()

double i2d::CAnnulus::GetOuterRadius ( ) const

Get the outer radius of the annulus.

◆ GetSupportedOperations()

int i2d::CAnnulus::GetSupportedOperations ( ) const
overridevirtual

Get set of flags for supported operations.

See also
SupportedOperations

Reimplemented from istd::IChangeable.

Reimplemented in i2d::CAnnulusSegment.

◆ GetTransformed()

bool i2d::CAnnulus::GetTransformed ( const ITransformation2d & transformation,
IObject2d & result,
ITransformation2d::ExactnessMode mode = ITransformation2d::EM_NONE,
double * errorFactorPtr = nullptr ) 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.

Implements i2d::IObject2d.

◆ InvTransform()

bool i2d::CAnnulus::InvTransform ( const ITransformation2d & transformation,
ITransformation2d::ExactnessMode mode = ITransformation2d::EM_NONE,
double * errorFactorPtr = nullptr )
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.

Implements i2d::IObject2d.

Reimplemented in i2d::CAnnulusSegment.

◆ IsAnnulusValid()

bool i2d::CAnnulus::IsAnnulusValid ( ) const

Check, if the annulus is valid.

An annulus is valid, if its radius range is valid.

See also
TRange::IsValid()

◆ operator!=()

bool i2d::CAnnulus::operator!= ( const CAnnulus & annulus) const

Compare with another annulus.

◆ operator==()

bool i2d::CAnnulus::operator== ( const CAnnulus & annulus) const

Compare with another annulus.

◆ Serialize()

bool i2d::CAnnulus::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

Implements iser::ISerializable.

Reimplemented in i2d::CAnnulusSegment.

◆ SetInnerOuterRadius()

void i2d::CAnnulus::SetInnerOuterRadius ( double radius1,
double radius2 )

Set the inner and outer radius of the annulus.

◆ SetInnerRadius()

void i2d::CAnnulus::SetInnerRadius ( double innerRadius)

Set the inner radius of the annulus.

◆ SetOuterRadius()

void i2d::CAnnulus::SetOuterRadius ( double outerRadius)

Set the outer radius of the annulus.

◆ Transform()

bool i2d::CAnnulus::Transform ( const ITransformation2d & transformation,
ITransformation2d::ExactnessMode mode = ITransformation2d::EM_NONE,
double * errorFactorPtr = nullptr )
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.

Implements i2d::IObject2d.

Reimplemented in i2d::CAnnulusSegment.

Member Data Documentation

◆ m_radiusRange

istd::CRange i2d::CAnnulus::m_radiusRange
protected

Definition at line 126 of file CAnnulus.h.


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

© Witold Gantzke and Kirill Lepskiy