ACF $AcfVersion:0$
Public Types | Public Member Functions | Protected Member Functions | List of all members
iview::CInteractiveShapeBase Class Referenceabstract

#include <CInteractiveShapeBase.h>

Inheritance diagram for iview::CInteractiveShapeBase:
iview::CShapeBase iview::IInteractiveShape iview::IDraggable imod::CSingleModelObserverBase iview::IShape iview::IShape iview::IMouseActionObserver istd::IPolymorphic istd::IPolymorphic iview::ITouchable iview::IVisualizable imod::IObserver iview::ITouchable iview::IVisualizable imod::IObserver imod::IObserver iview::CAffineTransformation2dShape iview::CLineShape iview::CParallelogramShape iview::CPinShape iview::CRectControlledShapeBase iview::CRectangleShape iview::CAnnulusShape iview::CArcShape iview::CCenterPinShape iview::CCircleShape iview::CLabelShape iview::CStarShape iview::CGraphPlotShape iview::CPolygonShape

Public Types

typedef CShapeBase BaseClass
 
- Public Types inherited from iview::CShapeBase
enum  ShapeTransformMode { STM_VIEW , STM_SHAPE , STM_COMBINE }
 Describe how shape tranformation is interpreted. More...
 
typedef imod::CSingleModelObserverBase BaseClass
 
- Public Types inherited from imod::CSingleModelObserverBase
typedef imod::IModel ModelType
 
- Public Types inherited from iview::IShape
enum  ChangeFlags { CF_CALIB = 0x3663adf }
 Data model change notification flags. More...
 
- Public Types inherited from iview::ITouchable
enum  TouchState {
  TS_NONE , TS_INACTIVE , TS_TICKER , TS_DRAGGABLE ,
  TS_AREA , TS_OTHER , TS_LAST = TS_OTHER
}
 Enumeration for possible shape touch states. More...
 

Public Member Functions

 CInteractiveShapeBase ()
 
 CInteractiveShapeBase (const CInteractiveShapeBase &shape)
 
virtual ~CInteractiveShapeBase ()
 
virtual bool IsEditablePosition () const
 
virtual void SetEditablePosition (bool state=true)
 
virtual bool IsSelected () const override
 Check, if this shape is selected.
 
virtual void SetSelected (bool selectFlag=true) override
 Inform that this object was selected or deselected.
 
virtual bool OnMouseButton (istd::CIndex2d position, Qt::MouseButton buttonType, bool downFlag) override
 It is called, when mouse button is pushed down or up on this object.
 
virtual bool OnMouseMove (istd::CIndex2d position) override
 It is called, when mouse is moved.
 
virtual bool IsDraggable () const override
 Check if drag is enabled.
 
virtual void BeginDrag (const istd::CIndex2d &position) override
 Called before dragging is begin.
 
virtual void SetDragPosition (const istd::CIndex2d &position) override
 Set new drag position.
 
virtual void EndDrag () override
 Called after dragging.
 
virtual bool OnModelAttached (imod::IModel *modelPtr, istd::IChangeable::ChangeSet &changeMask) override
 Callback invoked when an observable model is about to be attached to this observer.
 
virtual bool OnModelDetached (imod::IModel *modelPtr) override
 Callback invoked when an observable model is about to be detached from this observer.
 
- Public Member Functions inherited from iview::CShapeBase
 CShapeBase ()
 
 CShapeBase (const CShapeBase &shape)
 
virtual ~CShapeBase ()
 
virtual bool AssignToLayer (int layerType)
 Assign this shape to same layer.
 
virtual void Invalidate ()
 
iview::IDisplayGetDisplayPtr () const
 Get access to currently connected display.
 
ShapeTransformMode GetTransformMode () const
 Get shape transformation mode.
 
void SetTransformMode (ShapeTransformMode mode)
 Set shape transformation mode.
 
i2d::CVector2d GetScreenPosition (const i2d::CVector2d &logPosition) const
 Get screen position based on logical position.
 
i2d::CVector2d GetLogPosition (const i2d::CVector2d &screenPosition) const
 Get logical position based on screen position.
 
virtual int GetLayerType () const override
 Get layer type of this shape object.
 
virtual i2d::CRect GetBoundingBox () const override
 Return bounding box in client window coordinates.
 
virtual void SetVisible (bool state=true) override
 Make shape to be visible or not.
 
virtual const IColorSchemaGetUserColorSchema () const override
 Get color schema from view or user defined.
 
virtual void SetUserColorSchema (const IColorSchema *schemaPtr) override
 Set color schema to draw shape.
 
virtual void SetDefaultDescription (const QString &description) override
 Set default description will be used to display on console.
 
virtual void SetToolTip (const QString &toolTip) override
 
virtual bool IsInside (const istd::CIndex2d &screenPosition) const override
 
virtual bool IsVisible () const override
 Check, if this object is visible.
 
virtual bool IsDisplayAccepted (const IDisplay &display) const override
 Check if this object can be connected to this display.
 
virtual void OnConnectDisplay (IDisplay *displayPtr) override
 Called after display is connected.
 
virtual void OnDisconnectDisplay (IDisplay *displayPtr) override
 Called after display is disconnected.
 
virtual bool OnDisplayChange (const istd::IChangeable::ChangeSet &changeSet) override
 It informs about changes in display.
 
virtual ITouchable::TouchState IsTouched (istd::CIndex2d position) const override
 Check, if any shape is touched.
 
virtual QString GetShapeDescriptionAt (istd::CIndex2d position) const override
 Get description to shape at specified position.
 
virtual QString GetToolTipAt (istd::CIndex2d position) const override
 Get tooltip at specified position.
 
virtual void OnUpdate (const istd::IChangeable::ChangeSet &changeSet) override
 Called on update of observed model.
 
- Public Member Functions inherited from imod::CSingleModelObserverBase
 CSingleModelObserverBase ()
 
virtual ~CSingleModelObserverBase ()
 
imod::IModelGetObservedModel () const
 Get access to observed model.
 
imod::IModelGetModelPtr () const
 Get access to observed model.
 
void EnsureModelDetached ()
 Make sure this observer is detached.
 
void SetObservedIds (const istd::IChangeable::ChangeSet &changeMask)
 Set list of ID's beeing observed.
 
virtual bool IsModelAttached (const imod::IModel *modelPtr=NULL) const override
 Checks if the specified model is currently attached to this observer.
 
virtual void BeforeUpdate (imod::IModel *modelPtr) override
 Callback invoked before an update of the observer's content occurs.
 
virtual void AfterUpdate (imod::IModel *modelPtr, const istd::IChangeable::ChangeSet &changeSet) override
 Callback invoked after an update of the observer's content occurs.
 
- Public Member Functions inherited from istd::IPolymorphic
virtual ~IPolymorphic ()
 
- Public Member Functions inherited from iview::IShape
virtual bool IsAreaTouchAllowed () const
 
virtual void SetAreaTouchAllowed (bool=true)
 
virtual iview::ISelectable::MousePointerMode UpdateMousePointer (iview::ISelectable::MousePointerMode defaultPointer, ITouchable::TouchState, const istd::CIndex2d &) const
 
- Public Member Functions inherited from iview::IVisualizable
virtual void Draw (QPainter &drawContext) const =0
 Draw this shape using draw context.
 

Protected Member Functions

void BeginTickerDrag ()
 
void EndTickerDrag ()
 
void UpdateModelChanges ()
 
int GetKeysState () const
 Get actual keys state.
 
int GetEditMode () const
 Get actual edit mode.
 
int GetDisplayMode () const
 Get actual display mode.
 
void DrawText (QPainter &drawContext, istd::CIndex2d point, const QString &text) const
 Draw text on a given position.
 
virtual bool IsDisplayChangeImportant (const istd::IChangeable::ChangeSet &changeSet) override
 Get display changes mask.
 
virtual void BeginLogDrag (const i2d::CVector2d &reference)=0
 
virtual void SetLogDragPosition (const i2d::CVector2d &position)=0
 
- Protected Member Functions inherited from iview::CShapeBase
double GetLocalLineWidth (const i2d::CVector2d &screenPosition) const
 Get line with (in logical coordinates) for single screen position.
 
virtual void InvalidateBoundingBox ()
 Invalidate bounding box.
 
bool IsDisplayConnected () const
 Check if display is connected.
 
const IColorSchemaGetColorSchema () const
 Get color schema for this shape.
 
i2d::CRect GetClientRect () const
 Get display client rectangle.
 
bool IsBoundingBoxValid () const
 
void DisconnectDisplay ()
 
virtual const iview::CScreenTransformGetViewToScreenTransform () const
 
virtual i2d::CRect CalcBoundingBox () const =0
 Calculate bounding box.
 
- Protected Member Functions inherited from imod::CSingleModelObserverBase
void SetModelPtr (imod::IModel *modelPtr)
 Set internal model pointer to specified value.
 

Additional Inherited Members

- Static Protected Attributes inherited from imod::CSingleModelObserverBase
static const istd::IChangeable::ChangeSet s_undoChanges
 

Detailed Description

Definition at line 22 of file CInteractiveShapeBase.h.

Member Typedef Documentation

◆ BaseClass

Definition at line 28 of file CInteractiveShapeBase.h.

Constructor & Destructor Documentation

◆ CInteractiveShapeBase() [1/2]

iview::CInteractiveShapeBase::CInteractiveShapeBase ( )

◆ CInteractiveShapeBase() [2/2]

iview::CInteractiveShapeBase::CInteractiveShapeBase ( const CInteractiveShapeBase shape)

◆ ~CInteractiveShapeBase()

virtual iview::CInteractiveShapeBase::~CInteractiveShapeBase ( )
virtual

Member Function Documentation

◆ BeginDrag()

virtual void iview::CInteractiveShapeBase::BeginDrag ( const istd::CIndex2d reference)
overridevirtual

Called before dragging is begin.

It set also reference value for dragging position.

Implements iview::IDraggable.

◆ BeginLogDrag()

virtual void iview::CInteractiveShapeBase::BeginLogDrag ( const i2d::CVector2d reference)
protectedpure virtual

◆ BeginTickerDrag()

void iview::CInteractiveShapeBase::BeginTickerDrag ( )
protected

◆ DrawText()

void iview::CInteractiveShapeBase::DrawText ( QPainter &  drawContext,
istd::CIndex2d  point,
const QString &  text 
) const
protected

Draw text on a given position.

◆ EndDrag()

virtual void iview::CInteractiveShapeBase::EndDrag ( )
overridevirtual

Called after dragging.

Implements iview::IDraggable.

◆ EndTickerDrag()

void iview::CInteractiveShapeBase::EndTickerDrag ( )
protected

◆ GetDisplayMode()

int iview::CInteractiveShapeBase::GetDisplayMode ( ) const
inlineprotected

Get actual display mode.

Note, that display must be connected to use this method.

Definition at line 139 of file CInteractiveShapeBase.h.

References iview::ISelectable::EM_NONE, iview::ISelectable::GetDisplayMode(), iview::CShapeBase::GetDisplayPtr(), and NULL.

◆ GetEditMode()

int iview::CInteractiveShapeBase::GetEditMode ( ) const
inlineprotected

Get actual edit mode.

Note, that display must be connected to use this method.

Definition at line 127 of file CInteractiveShapeBase.h.

References iview::ISelectable::EM_NONE, iview::CShapeBase::GetDisplayPtr(), iview::ISelectable::GetEditMode(), and NULL.

◆ GetKeysState()

int iview::CInteractiveShapeBase::GetKeysState ( ) const
inlineprotected

Get actual keys state.

Note, that display must be connected to use this method.

Definition at line 115 of file CInteractiveShapeBase.h.

References iview::CShapeBase::GetDisplayPtr(), iview::ISelectable::GetKeysState(), and NULL.

◆ IsDisplayChangeImportant()

bool iview::CInteractiveShapeBase::IsDisplayChangeImportant ( const istd::IChangeable::ChangeSet changeSet)
inlineoverrideprotectedvirtual

Get display changes mask.

Only changes there are in mask will be accepted, rest will be ignored.

Reimplemented from iview::CShapeBase.

Definition at line 153 of file CInteractiveShapeBase.h.

References iview::IDisplay::CF_DISPLAY_MODE, iview::IDisplay::CF_EDIT_MODE, istd::IChangeable::ChangeSet::Contains(), and iview::CShapeBase::IsDisplayChangeImportant().

◆ IsDraggable()

virtual bool iview::CInteractiveShapeBase::IsDraggable ( ) const
overridevirtual

Check if drag is enabled.

Implements iview::IDraggable.

Reimplemented in iview::CPolygonShape.

◆ IsEditablePosition()

bool iview::CInteractiveShapeBase::IsEditablePosition ( ) const
inlinevirtual

Definition at line 101 of file CInteractiveShapeBase.h.

◆ IsSelected()

virtual bool iview::CInteractiveShapeBase::IsSelected ( ) const
overridevirtual

Check, if this shape is selected.

Implements iview::IInteractiveShape.

◆ OnModelAttached()

virtual bool iview::CInteractiveShapeBase::OnModelAttached ( imod::IModel modelPtr,
istd::IChangeable::ChangeSet changeMask 
)
overridevirtual

Callback invoked when an observable model is about to be attached to this observer.

This method is called by the model when attempting to establish an observer relationship. The implementation should:

  1. Validate that the model is of an acceptable type
  2. Set the changeMask to specify which changes to monitor
  3. Return true to accept the attachment, or false to reject it
Parameters
modelPtrPointer to the model object being attached. Never nullptr.
changeMaskOutput parameter where the observer specifies which change types it wants to be notified about. Set the appropriate change flags using changeMask.Set(changeId). An empty mask means the observer wants all changes.
Returns
true if the model is accepted and attachment succeeds, false to reject the attachment (e.g., if the model is of incompatible type).
Note
After successful attachment, the observer should initialize its state based on the current model data.
The changeMask allows filtering notifications for better performance. Only changes matching the mask will trigger AfterUpdate() calls.
virtual bool OnModelAttached(IModel* modelPtr,
{
// Type check
CMyModel* model = dynamic_cast<CMyModel*>(modelPtr);
if (!model) return false;
// Set up change filtering
changeMask.Set(CMyModel::CF_DATA_CHANGED);
changeMask.Set(CMyModel::CF_STATUS_CHANGED);
// Don't set CF_INTERNAL_CHANGED - we don't care about those
// Initialize view from current model state
UpdateViewFromModel(model);
return true;
}
Set of change flags (its IDs).
Definition IChangeable.h:36
virtual bool OnModelAttached(imod::IModel *modelPtr, istd::IChangeable::ChangeSet &changeMask) override
Callback invoked when an observable model is about to be attached to this observer.
See also
OnModelDetached(), IsModelAttached(), AfterUpdate()

Reimplemented from iview::CShapeBase.

Reimplemented in iview::CAffineTransformation2dShape, iview::CAnnulusSegmentShape, iview::CAnnulusShape, iview::CArcShape, iview::CCircleShape, iview::CGraphPlotShape, iview::CLabelShape, iview::CLineShape, iview::COrientedCircleShape, iview::CParallelogramShape, iview::CPinShape, iview::CPolygonShape, iview::CPolylineShape, iview::CRectangleShape, and iview::CSplineShape.

◆ OnModelDetached()

virtual bool iview::CInteractiveShapeBase::OnModelDetached ( imod::IModel modelPtr)
overridevirtual

Callback invoked when an observable model is about to be detached from this observer.

This method is called when the observer-model relationship is being terminated, either explicitly or because the model is being destroyed. The implementation should clean up any state or resources related to this model.

Parameters
modelPtrPointer to the model object being detached
Returns
true if the detachment was handled successfully, false otherwise
Note
After this call, the observer should not access the model pointer anymore.
This method may be called even if OnModelAttached() previously returned false.
Clean up any cached data or references to this model.
virtual bool OnModelDetached(IModel* modelPtr)
{
if (m_currentModel == modelPtr) {
// Clear any cached data
m_cachedData.clear();
m_currentModel = nullptr;
// Update UI to show no model is attached
ClearDisplay();
return true;
}
return false;
}
virtual bool OnModelDetached(imod::IModel *modelPtr) override
Callback invoked when an observable model is about to be detached from this observer.
See also
OnModelAttached(), IsModelAttached()

Reimplemented from iview::CShapeBase.

◆ OnMouseButton()

virtual bool iview::CInteractiveShapeBase::OnMouseButton ( istd::CIndex2d  position,
Qt::MouseButton  buttonType,
bool  downFlag 
)
overridevirtual

It is called, when mouse button is pushed down or up on this object.

Parameters
position- position of mouse pointer on client area (picture coords).
downFlag- true, if mouse button is pushed down, false if pushed up.
Returns
true if this shape should get focus to catch all mouse movements.

Implements iview::IMouseActionObserver.

Reimplemented in iview::CAnnulusSegmentShape, iview::CAnnulusShape, iview::CArcShape, iview::CCenterPinShape, iview::CCircleShape, iview::CLabelShape, iview::CLineShape, iview::CParallelogramShape, iview::CPinShape, iview::CPolygonShape, iview::CPolylineShape, iview::CRectangleShape, iview::CRectControlledShapeBase, and iview::CTubePolylineShape.

◆ OnMouseMove()

virtual bool iview::CInteractiveShapeBase::OnMouseMove ( istd::CIndex2d  position)
overridevirtual

It is called, when mouse is moved.

Only objects with focus receive this event.

Parameters
position- position of mouse pointer on client area (picture coords).
Returns
true if this shape should hold focus to catch longer all mouse movements.

Implements iview::IMouseActionObserver.

Reimplemented in iview::CAnnulusSegmentShape, iview::CAnnulusShape, iview::CArcShape, iview::CCenterPinShape, iview::CCircleShape, iview::CLabelShape, iview::CLineShape, iview::CParallelogramShape, iview::CPinShape, iview::CPolygonShape, iview::CRectangleShape, and iview::CTubePolylineShape.

◆ SetDragPosition()

virtual void iview::CInteractiveShapeBase::SetDragPosition ( const istd::CIndex2d position)
overridevirtual

Set new drag position.

It must be enclosed using BeginDrag() and EndDrag() methods.

Implements iview::IDraggable.

◆ SetEditablePosition()

void iview::CInteractiveShapeBase::SetEditablePosition ( bool  state = true)
inlinevirtual

◆ SetLogDragPosition()

virtual void iview::CInteractiveShapeBase::SetLogDragPosition ( const i2d::CVector2d position)
protectedpure virtual

◆ SetSelected()

virtual void iview::CInteractiveShapeBase::SetSelected ( bool  selectFlag = true)
overridevirtual

Inform that this object was selected or deselected.

Parameters
selectFlagif true - selection, else deselection.

Implements iview::IInteractiveShape.

◆ UpdateModelChanges()

void iview::CInteractiveShapeBase::UpdateModelChanges ( )
protected

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