Public Types | Public Member Functions | Protected Attributes | List of all members
i2d::CAnnulus Class Reference

Definition of graphical annulus object. More...

#include <CAnnulus.h>

Inheritance diagram for i2d::CAnnulus:
i2d::CPosition2d i2d::CObject2dBase i2d::IObject2d iser::IObject i2d::ICalibrationProvider iser::ISerializable istd::IChangeable istd::IChangeable istd::IPolymorphic istd::IPolymorphic i2d::CAnnulusSegment i2d::TObject2dCompWrap< CAnnulus > i2d::TObject2dCompWrap< CAnnulusSegment > i2d::CAnnulusComp i2d::CAnnulusSegmentComp

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_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...
 

Public Member Functions

 CAnnulus ()
 Construct an empty annulus object. More...
 
 CAnnulus (const i2d::CVector2d &center, double innerRadius, double outerRadius)
 Construct an annulus object by the given position, inner and outer radius. More...
 
bool IsAnnulusValid () const
 Check, if the annulus is valid. More...
 
double GetInnerRadius () const
 Get the inner radius of the annulus. More...
 
void SetInnerRadius (double innerRadius)
 Set the inner radius of the annulus. More...
 
double GetOuterRadius () const
 Get the outer radius of the annulus. More...
 
void SetOuterRadius (double outerRadius)
 Set the outer radius of the annulus. More...
 
void SetInnerOuterRadius (double radius1, double radius2)
 Set the inner and outer radius of the annulus. More...
 
CCircle GetInnerCircle () const
 Set the inner circle of the annulus object. More...
 
CCircle GetOuterCircle () const
 Set the outer circle of the annulus object. More...
 
bool operator== (const CAnnulus &annulus) const
 Compare with another annulus. More...
 
bool operator!= (const CAnnulus &annulus) const
 Compare with another annulus. More...
 
bool ConvertToPolygon (i2d::CPolygon &result, int segmentsCount=0) const
 Performs conversion of the annulus splitting it to segmentsCount segments to the polygon result. More...
 
virtual CRectangle GetBoundingBox () const
 Get bounding box of this shape. More...
 
virtual bool Transform (const ITransformation2d &transformation, ITransformation2d::ExactnessMode mode=ITransformation2d::EM_NONE, double *errorFactorPtr=NULL)
 Transform this object using some transformation. More...
 
virtual bool InvTransform (const ITransformation2d &transformation, ITransformation2d::ExactnessMode mode=ITransformation2d::EM_NONE, double *errorFactorPtr=NULL)
 Do inverse transformation of this object. More...
 
virtual bool GetTransformed (const ITransformation2d &transformation, IObject2d &result, ITransformation2d::ExactnessMode mode=ITransformation2d::EM_NONE, double *errorFactorPtr=NULL) const
 Calulate transformation of the object into second one. More...
 
virtual bool GetInvTransformed (const ITransformation2d &transformation, IObject2d &result, ITransformation2d::ExactnessMode mode=ITransformation2d::EM_NONE, double *errorFactorPtr=NULL) const
 Calulate inverse transformation of the object into second one. More...
 
virtual int GetSupportedOperations () const
 Get set of flags for supported operations. More...
 
virtual bool CopyFrom (const IChangeable &object, CompatibilityMode mode=CM_WITHOUT_REFS)
 
virtual istd::IChangeableCloneMe (CompatibilityMode mode=CM_WITHOUT_REFS) const
 Make a copy of this object. More...
 
virtual bool Serialize (iser::IArchive &archive)
 Load or store state of this object as a archive stream. More...
 
- 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
 Returns center of this 2D-object. More...
 
virtual void MoveCenterTo (const CVector2d &position)
 Move object to position position. More...
 
virtual QByteArray GetFactoryId () const
 
virtual bool IsEqual (const istd::IChangeable &object) const
 Compare this object with another object. More...
 
- Public Member Functions inherited from i2d::CObject2dBase
 CObject2dBase ()
 
 CObject2dBase (const CObject2dBase &object2d)
 
virtual const ICalibration2dGetCalibration () const
 Get access to transformation object, which transforms a local logical coordinate system to global one. More...
 
virtual void SetCalibration (const ICalibration2d *calibrationPtr, bool releaseFlag=false)
 Set calibration of this object. More...
 
virtual bool CopyFrom (const istd::IChangeable &object, CompatibilityMode mode=CM_WITHOUT_REFS)
 Copy this object from another one. More...
 
virtual bool ResetData (CompatibilityMode mode=CM_WITHOUT_REFS)
 Reset data to its default state. More...
 
- Public Member Functions inherited from iser::ISerializable
virtual quint32 GetMinimalVersion (int versionId) const
 Get minimal needed version to correct storing of this data. More...
 
- Public Member Functions inherited from istd::IChangeable
virtual void BeginChanges (const ChangeSet &changeSet)
 Starts the change transaction. More...
 
virtual void EndChanges (const ChangeSet &changeSet)
 Ends the change transaction. More...
 
virtual void BeginChangeGroup (const ChangeSet &changeSet)
 Starts group of changes. More...
 
virtual void EndChangeGroup (const ChangeSet &changeSet)
 Ends group of changes. More...
 
- Public Member Functions inherited from istd::IPolymorphic
virtual ~IPolymorphic ()
 

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 ChangeSetGetNoChanges ()
 Get empty set of changes. More...
 
static const ChangeSetGetAnyChange ()
 Get anonymous change set. More...
 
static const ChangeSetGetAllChanges ()
 Get anonymous change set. More...
 
static const ChangeSetGetDelegatedChanges ()
 Get delegated change set. More...
 
- Protected Member Functions inherited from istd::IChangeable
virtual void OnBeginChanges ()
 Callback function for begin change event. More...
 
virtual void OnEndChanges (const ChangeSet &changeSet)
 Callback function for end change event. More...
 
- 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 19 of file CAnnulus.h.

Member Typedef Documentation

Definition at line 22 of file CAnnulus.h.

Constructor & Destructor Documentation

i2d::CAnnulus::CAnnulus ( )

Construct an empty annulus object.

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

virtual istd::IChangeable* i2d::CAnnulus::CloneMe ( CompatibilityMode  mode = CM_WITHOUT_REFS) const
virtual

Make a copy of this object.

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

Reimplemented from i2d::CPosition2d.

Reimplemented in i2d::CAnnulusSegment.

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.

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

Reimplemented from i2d::CPosition2d.

Reimplemented in i2d::CAnnulusSegment.

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

Get bounding box of this shape.

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

Reimplemented from i2d::CPosition2d.

Reimplemented in i2d::CAnnulusSegment.

CCircle i2d::CAnnulus::GetInnerCircle ( ) const

Set the inner circle of the annulus object.

double i2d::CAnnulus::GetInnerRadius ( ) const

Get the inner radius of the annulus.

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

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::CPosition2d.

CCircle i2d::CAnnulus::GetOuterCircle ( ) const

Set the outer circle of the annulus object.

double i2d::CAnnulus::GetOuterRadius ( ) const

Get the outer radius of the annulus.

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

Get set of flags for supported operations.

See Also
SupportedOperations

Reimplemented from i2d::CPosition2d.

Reimplemented in i2d::CAnnulusSegment.

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

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::CPosition2d.

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

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::CPosition2d.

Reimplemented in i2d::CAnnulusSegment.

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()
bool i2d::CAnnulus::operator!= ( const CAnnulus annulus) const

Compare with another annulus.

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

Compare with another annulus.

virtual bool i2d::CAnnulus::Serialize ( iser::IArchive archive)
virtual

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::CPosition2d.

Reimplemented in i2d::CAnnulusSegment.

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

Set the inner and outer radius of the annulus.

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

Set the inner radius of the annulus.

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

Set the outer radius of the annulus.

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

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::CPosition2d.

Reimplemented in i2d::CAnnulusSegment.

Member Data Documentation

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

Definition at line 122 of file CAnnulus.h.


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

© 2007-2017 Witold Gantzke and Kirill Lepskiy