Public Types | Public Member Functions | List of all members
i2d::ICalibration2d Class Referenceabstract

#include <ICalibration2d.h>

Inheritance diagram for i2d::ICalibration2d:
i2d::ITransformation2d imath::TISurjectFunction< CVector2d, CVector2d > iser::ISerializable imath::TIMathFunction< CVector2d, CVector2d > istd::IChangeable istd::IPolymorphic istd::IPolymorphic

Public Types

enum  ChangeFlags { CF_CALIBRATION_CHANGED = 0x8d89e2, CF_AREA_CHANGED, CF_UNITS_CHANGED }
 
enum  TransformationFlags { TF_SUPPORT_COMBINE = 1 << 10 }
 Extension of i2d::ITransformation2d::TransformationFlags. More...
 
- Public Types inherited from i2d::ITransformation2d
enum  ExactnessMode { EM_NONE, EM_EXACT, EM_VISUAL, EM_ANY }
 
enum  TransformationFlags {
  TF_FORWARD = 1 << 0, TF_INVERTED = 1 << 1, TF_INJECTIVE = 1 << 2, TF_SURJECTIVE = 1 << 3,
  TF_PRESERVE_NULL = 1 << 4, TF_PRESERVE_DISTANCE = 1 << 5, TF_PRESERVE_ANGLE = 1 << 6, TF_AFFINE = 1 << 7,
  TF_CONTINUES = 1 << 8
}
 Flags indication type of this transformation and supported operations. More...
 
- Public Types inherited from imath::TIMathFunction< CVector2d, CVector2d >
typedef CVector2d ArgumentType
 
typedef CVector2d ResultType
 
- 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

virtual const CRectangleGetArgumentArea () const =0
 Get optional area where arguments are defined properly. More...
 
virtual const CRectangleGetResultArea () const =0
 Get optional area where results are defined properly. More...
 
virtual const imath::IUnitInfoGetArgumentUnitInfo () const =0
 Get unit description of calibration input (transformation function argument). More...
 
virtual const imath::IUnitInfoGetResultUnitInfo () const =0
 Get unit description of calibration output (transformation function result). More...
 
virtual const ICalibration2dCreateCombinedCalibration (const ITransformation2d &transformation) const =0
 Create new calibration being combination of this calibration and the second one. More...
 
- Public Member Functions inherited from i2d::ITransformation2d
virtual int GetTransformationFlags () const =0
 Get flags of describing type of this transformation. More...
 
virtual bool GetDistance (const CVector2d &origPos1, const CVector2d &origPos2, double &result, ExactnessMode mode=EM_NONE) const =0
 Compute a shortness distance in transformed coordinations. More...
 
virtual bool GetPositionAt (const CVector2d &origPosition, CVector2d &result, ExactnessMode mode=EM_NONE) const =0
 Get position after transformation. More...
 
virtual bool GetInvPositionAt (const CVector2d &transfPosition, CVector2d &result, ExactnessMode mode=EM_NONE) const =0
 Get position after transformation. More...
 
virtual bool GetLocalTransform (const CVector2d &origPosition, CAffine2d &result, ExactnessMode mode=EM_NONE) const =0
 Get local transformation (from original to transformed coordinate system) at some original position. More...
 
virtual bool GetLocalInvTransform (const CVector2d &transfPosition, CAffine2d &result, ExactnessMode mode=EM_NONE) const =0
 Get local transformation (from transformed to original coordinate system) at some transformed position. More...
 
- Public Member Functions inherited from imath::TISurjectFunction< CVector2d, CVector2d >
virtual bool GetInvValueAt (const CVector2d &argument, CVector2d &result) const =0
 Get inverted function value. More...
 
virtual CVector2d GetInvValueAt (const CVector2d &argument) const =0
 Get inverted function value. More...
 
- Public Member Functions inherited from imath::TIMathFunction< CVector2d, CVector2d >
virtual bool GetValueAt (const CVector2d &argument, CVector2d &result) const =0
 Get function value for specified argument value. More...
 
virtual CVector2d GetValueAt (const CVector2d &argument) const =0
 Get function value for specified argument value. More...
 
- Public Member Functions inherited from istd::IPolymorphic
virtual ~IPolymorphic ()
 
- Public Member Functions inherited from iser::ISerializable
virtual bool Serialize (IArchive &archive)=0
 Load or store state of this object as a archive stream. More...
 
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 int GetSupportedOperations () const
 Get set of flags for supported operations. More...
 
virtual bool CopyFrom (const IChangeable &object, CompatibilityMode mode=CM_WITHOUT_REFS)
 Copy this object from another one. More...
 
virtual bool IsEqual (const IChangeable &object) const
 Compare this object with another object. More...
 
virtual IChangeableCloneMe (CompatibilityMode mode=CM_WITHOUT_REFS) const
 Make a copy of this object. More...
 
virtual bool ResetData (CompatibilityMode mode=CM_WITHOUT_REFS)
 Reset data to its default state. More...
 
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...
 

Additional Inherited Members

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

Detailed Description

Definition at line 17 of file ICalibration2d.h.

Member Enumeration Documentation

Enumerator
CF_CALIBRATION_CHANGED 
CF_AREA_CHANGED 
CF_UNITS_CHANGED 

Definition at line 20 of file ICalibration2d.h.

Extension of i2d::ITransformation2d::TransformationFlags.

Enumerator
TF_SUPPORT_COMBINE 

This calibration supports combinating with other calibrations, at least of the same type.

Definition at line 30 of file ICalibration2d.h.

Member Function Documentation

virtual const ICalibration2d* i2d::ICalibration2d::CreateCombinedCalibration ( const ITransformation2d transformation) const
pure virtual

Create new calibration being combination of this calibration and the second one.

Please note, that created object is owned by the caller and the caller must remove them.

Returns
new calibration object (owned by the caller) or NULL if creation was impossible.
virtual const CRectangle* i2d::ICalibration2d::GetArgumentArea ( ) const
pure virtual

Get optional area where arguments are defined properly.

Returns
pointer to restriction area object or NULL if there is no defined restrictions.
virtual const imath::IUnitInfo* i2d::ICalibration2d::GetArgumentUnitInfo ( ) const
pure virtual

Get unit description of calibration input (transformation function argument).

Returns
unit description of function argument or NULL, if this information is unsupported.

Referenced by iqt2d::TShapeParamsGuiCompBase< Ui, Shape, ShapeModel >::GetUnitName().

virtual const CRectangle* i2d::ICalibration2d::GetResultArea ( ) const
pure virtual

Get optional area where results are defined properly.

Returns
pointer to restriction area object or NULL if there is no defined restrictions.
virtual const imath::IUnitInfo* i2d::ICalibration2d::GetResultUnitInfo ( ) const
pure virtual

Get unit description of calibration output (transformation function result).

Returns
unit description of function result or NULL, if this information is unsupported.

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

© 2007-2017 Witold Gantzke and Kirill Lepskiy