ICF 3.0.5.47
Technical documentation of ICF Libraries
i2d::CObject2dBase Class Reference

Base class for 2D-objects implementing interface i2d::IObject2d. More...

#include <CObject2dBase.h>

Inheritance diagram for i2d::CObject2dBase:
Collaboration diagram for i2d::CObject2dBase:

Public Member Functions

 CObject2dBase ()
 
 CObject2dBase (const CObject2dBase &object2d)
 
 CObject2dBase (CObject2dBase &&object2d)
 
const ICalibration2dGetCalibration () 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 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.
 
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.
 
CObject2dBaseoperator= (const CObject2dBase &object2d)
 
CObject2dBaseoperator= (CObject2dBase &&object2d)
 
- Public Member Functions inherited from i2d::IObject2d
virtual CVector2d GetCenter () const =0
 Returns center of this 2D-object.
 
virtual void MoveCenterTo (const CVector2d &position)=0
 Move object to position position.
 
virtual CRectangle GetBoundingBox () const =0
 Get bounding box of this shape.
 
- Public Member Functions inherited from iser::IObject
virtual QByteArray GetFactoryId () const
 
- Public Member Functions inherited from iser::ISerializable
virtual bool Serialize (IArchive &archive)=0
 Load or store state of this object as a archive stream.
 
virtual quint32 GetMinimalVersion (int versionId) const
 Get minimal needed version to correct storing of this data.
 
- Public Member Functions inherited from istd::IChangeable
virtual int GetSupportedOperations () const
 Get set of flags for supported operations.
 
virtual bool IsEqual (const IChangeable &object) const
 Compare this object with another object.
 
virtual std::unique_ptr< IChangeableCloneMe (CompatibilityMode mode=CM_WITHOUT_REFS) const
 Make a copy of this object.
 
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

Static Protected Attributes

static const ChangeSet s_objectMovedChange
 
static const ChangeSet s_objectModifiedChange
 

Additional Inherited Members

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

Detailed Description

Base class for 2D-objects implementing interface i2d::IObject2d.

It contains simple or empty implementations.

Definition at line 22 of file CObject2dBase.h.

Constructor & Destructor Documentation

◆ CObject2dBase() [1/3]

i2d::CObject2dBase::CObject2dBase ( )

◆ CObject2dBase() [2/3]

i2d::CObject2dBase::CObject2dBase ( const CObject2dBase & object2d)

◆ CObject2dBase() [3/3]

i2d::CObject2dBase::CObject2dBase ( CObject2dBase && object2d)

Member Function Documentation

◆ CopyFrom()

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

Copy this object from another one.

Default implementation in istd::IChangeable does nothing. You may check, if this functionality is supported over GetSupportedOperations().

Reimplemented from istd::IChangeable.

Reimplemented in iimg::CScanlineMask, iser::TCopySerializedWrap< i2d::CCircle >, iser::TCopySerializedWrap< i2d::CLine2d >, and iser::TCopySerializedWrap< iimg::CBitmap >.

Referenced by i2d::TDataNodePolyline< NodeData >::CopyFrom().

◆ GetCalibration()

const ICalibration2d * i2d::CObject2dBase::GetCalibration ( ) const
overridevirtual

Get access to transformation object, which transforms a local logical coordinate system to global one.

Returns
Pointer to transformation if it is accessible, or nullptr.

Implements i2d::ICalibration2dProvider.

◆ GetInvTransformed()

bool i2d::CObject2dBase::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.

Reimplemented in i2d::CParallelogram, i2d::CPolypoint, i2d::CPosition2d, i2d::CQuadrangle, i2d::CRectangle, and icmpstr::CVisualRegistryElement.

◆ GetTransformed()

bool i2d::CObject2dBase::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.

Reimplemented in i2d::CParallelogram, i2d::CPolypoint, i2d::CPosition2d, i2d::CQuadrangle, i2d::CRectangle, and icmpstr::CVisualRegistryElement.

◆ InvTransform()

bool i2d::CObject2dBase::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::CParallelogram, i2d::CPolypoint, i2d::CPosition2d, i2d::CQuadrangle, i2d::CRectangle, and icmpstr::CVisualRegistryElement.

◆ operator=() [1/2]

CObject2dBase & i2d::CObject2dBase::operator= ( CObject2dBase && object2d)

◆ operator=() [2/2]

CObject2dBase & i2d::CObject2dBase::operator= ( const CObject2dBase & object2d)

◆ ResetData()

bool i2d::CObject2dBase::ResetData ( CompatibilityMode mode = CM_WITHOUT_REFS)
overridevirtual

Reset data to its default state.

Default implementation in istd::IChangeable does nothing. You may check, if this functionality is supported over GetSupportedOperations().

Returns
true if the operation was successful, and false otherwise.

Reimplemented from istd::IChangeable.

Reimplemented in iimg::CScanlineMask, iipr::TWeightedFeatureWrap< i2d::CLine2d >, and iipr::TWeightedFeatureWrap< i2d::CPosition2d >.

◆ SetCalibration()

void i2d::CObject2dBase::SetCalibration ( istd::TOptDelPtr< const ICalibration2d > && calibrationPtr)
overridevirtual

Set calibration of this object.

Parameters
calibrationPtrpointer to calibration object, ownership will be transfered.

Implements i2d::IObject2d.

◆ Transform()

bool i2d::CObject2dBase::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::CParallelogram, i2d::CPolypoint, i2d::CPosition2d, i2d::CQuadrangle, i2d::CRectangle, i2d::CTubePolyline, and icmpstr::CVisualRegistryElement.

Member Data Documentation

◆ s_objectModifiedChange

const ChangeSet i2d::CObject2dBase::s_objectModifiedChange
staticprotected

Definition at line 63 of file CObject2dBase.h.

◆ s_objectMovedChange

const ChangeSet i2d::CObject2dBase::s_objectMovedChange
staticprotected

Definition at line 62 of file CObject2dBase.h.


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

© Witold Gantzke and Kirill Lepskiy