#include <CLineShape.h>

Inheritance diagram for iview::CLineShape:

Public Types
enum	LineDisplayMode { LDM_SIMPLE , LDM_ARROW }

typedef CInteractiveShapeBase	BaseClass

Public Types inherited from iview::CInteractiveShapeBase
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
	CLineShape ()

int	GetLineDisplayMode () const
	Get displayed of line.

void	SetLineDisplayMode (int mode)
	Set display mode of this line.

double	GetArrowLinesProportion () const
	Get proportion of arrow side lines to line length.

void	SetArrowLinesProportion (double value)
	Set proportion of arrow side lines to line length.

double	GetMaxArrowLineLength () const
	Get maximal length of arrow lines.

void	SetMaxArrowLineLength (double value)
	Set maximal length of arrow lines.

virtual void	InvalidateBoundingBox () override
	Invalidate bounding box.

virtual TouchState	IsTouched (istd::CIndex2d position) const override
	Check, if any shape is touched.

virtual void	Draw (QPainter &drawContext) const override
	Draw this shape using draw context.

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

Public Member Functions inherited from iview::CInteractiveShapeBase
	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	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	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::IDisplay *	GetDisplayPtr () 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 IColorSchema *	GetUserColorSchema () 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 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::IModel *	GetObservedModel () const
	Get access to observed model.

imod::IModel *	GetModelPtr () 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

Protected Member Functions
void	EnsurePointsAreValid () const

void	EnsurePointsAreValid (const i2d::CLine2d &line) const

void	CalcPoints (const i2d::CLine2d &line) const

void	ResetPoints () const

virtual i2d::CRect	CalcBoundingBox () const override
	Calculate bounding box.

virtual void	BeginLogDrag (const i2d::CVector2d &reference) override

virtual void	SetLogDragPosition (const i2d::CVector2d &position) override

Protected Member Functions inherited from iview::CInteractiveShapeBase
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.

Protected Member Functions inherited from iview::CShapeBase
double	GetLocalLineWidth (const i2d::CVector2d &screenPosition) const
	Get line with (in logical coordinates) for single screen position.

bool	IsDisplayConnected () const
	Check if display is connected.

const IColorSchema &	GetColorSchema () const
	Get color schema for this shape.

i2d::CRect	GetClientRect () const
	Get display client rectangle.

bool	IsBoundingBoxValid () const

void	DisconnectDisplay ()

virtual const iview::CScreenTransform &	GetViewToScreenTransform () const

Protected Member Functions inherited from imod::CSingleModelObserverBase
void	SetModelPtr (imod::IModel *modelPtr)
	Set internal model pointer to specified value.

Static Protected Member Functions
static bool	CheckLine (const istd::CIndex2d &firstPoint, const istd::CIndex2d &secondPoint, const istd::CIndex2d &point, double maxDistance)

Protected Attributes
int	m_lineDisplayMode

double	m_arrowLinesProportion

double	m_maxArrowLineLength

i2d::CVector2d	m_referencePosition

int	m_referenceIndex

istd::CIndex2d	m_points [4]

bool	m_arePointsValid

Additional Inherited Members
Static Protected Attributes inherited from imod::CSingleModelObserverBase
static const istd::IChangeable::ChangeSet	s_undoChanges

Detailed Description

Definition at line 15 of file CLineShape.h.

Member Typedef Documentation

◆ BaseClass

typedef CInteractiveShapeBase iview::CLineShape::BaseClass

Definition at line 18 of file CLineShape.h.

Member Enumeration Documentation

◆ LineDisplayMode

enum iview::CLineShape::LineDisplayMode

Enumerator
LDM_SIMPLE
LDM_ARROW

Definition at line 22 of file CLineShape.h.

Constructor & Destructor Documentation

◆ CLineShape()

iview::CLineShape::CLineShape ( )

Member Function Documentation

◆ BeginLogDrag()

virtual void iview::CLineShape::BeginLogDrag ( const i2d::CVector2d & reference )

overrideprotectedvirtual

Implements iview::CInteractiveShapeBase.

◆ CalcBoundingBox()

virtual i2d::CRect iview::CLineShape::CalcBoundingBox ( ) const

overrideprotectedvirtual

Calculate bounding box.

You have to implement this method in your shapes implementations.

Implements iview::CShapeBase.

◆ CalcPoints()

void iview::CLineShape::CalcPoints ( const i2d::CLine2d & line ) const

protected

Referenced by EnsurePointsAreValid(), and EnsurePointsAreValid().

◆ CheckLine()

static bool iview::CLineShape::CheckLine	(	const istd::CIndex2d &	firstPoint,
		const istd::CIndex2d &	secondPoint,
		const istd::CIndex2d &	point,
		double	maxDistance
	)

staticprotected

◆ Draw()

virtual void iview::CLineShape::Draw ( QPainter & drawContext ) const

overridevirtual

Draw this shape using draw context.

Implements iview::IVisualizable.

◆ EnsurePointsAreValid() [1/2]

void iview::CLineShape::EnsurePointsAreValid ( ) const

inlineprotected

Definition at line 108 of file CLineShape.h.

References CalcPoints(), imod::CSingleModelObserverBase::GetObservedModel(), m_arePointsValid, NULL, and ResetPoints().

◆ EnsurePointsAreValid() [2/2]

void iview::CLineShape::EnsurePointsAreValid ( const i2d::CLine2d & line ) const

inlineprotected

Definition at line 123 of file CLineShape.h.

References CalcPoints(), and m_arePointsValid.

◆ GetArrowLinesProportion()

double iview::CLineShape::GetArrowLinesProportion ( ) const

Get proportion of arrow side lines to line length.

If there is no arrow display mode, this value has no effect.

◆ GetLineDisplayMode()

int iview::CLineShape::GetLineDisplayMode ( ) const

Get displayed of line.

◆ GetMaxArrowLineLength()

double iview::CLineShape::GetMaxArrowLineLength ( ) const

Get maximal length of arrow lines.

If there is no arrow display mode, this value has no effect.

◆ InvalidateBoundingBox()

virtual void iview::CLineShape::InvalidateBoundingBox ( )

overridevirtual

Invalidate bounding box.

You can overload this method to provide validation of your internal attributes, because this method is called from Invalidate and OnDisplayChange methods. Please don't forget base method call in your implementations.

Reimplemented from iview::CShapeBase.

◆ IsTouched()

virtual TouchState iview::CLineShape::IsTouched ( istd::CIndex2d position ) const

overridevirtual

Check, if any shape is touched.

When shape is touched, it return also pointer to this shape.

Returns: touch state for the shape, or iview::IInteractiveShape::TS_NONE, when nothing found.

Reimplemented from iview::CShapeBase.

◆ OnModelAttached()

virtual bool iview::CLineShape::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:

Validate that the model is of an acceptable type
Set the changeMask to specify which changes to monitor
Return true to accept the attachment, or false to reject it

Parameters

modelPtr	Pointer to the model object being attached. Never nullptr.
changeMask	Output 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, 
                            istd::IChangeable::ChangeSet& changeMask)
{
       // 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;
}

See also: OnModelDetached(), IsModelAttached(), AfterUpdate()

Reimplemented from iview::CInteractiveShapeBase.

◆ OnMouseButton()

virtual bool iview::CLineShape::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.

Reimplemented from iview::CInteractiveShapeBase.

◆ OnMouseMove()

virtual bool iview::CLineShape::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.

Reimplemented from iview::CInteractiveShapeBase.

◆ ResetPoints()

void iview::CLineShape::ResetPoints ( ) const

protected

Referenced by EnsurePointsAreValid().

◆ SetArrowLinesProportion()

void iview::CLineShape::SetArrowLinesProportion ( double value )

Set proportion of arrow side lines to line length.

If there is no arrow display mode, this value has no effect.

◆ SetLineDisplayMode()

void iview::CLineShape::SetLineDisplayMode ( int mode )

Set display mode of this line.

◆ SetLogDragPosition()

virtual void iview::CLineShape::SetLogDragPosition ( const i2d::CVector2d & position )

overrideprotectedvirtual

Implements iview::CInteractiveShapeBase.

◆ SetMaxArrowLineLength()

void iview::CLineShape::SetMaxArrowLineLength ( double value )

Set maximal length of arrow lines.

If there is no arrow display mode, this value has no effect.

Member Data Documentation

◆ m_arePointsValid

bool iview::CLineShape::m_arePointsValid

mutableprotected

Definition at line 102 of file CLineShape.h.

Referenced by EnsurePointsAreValid(), and EnsurePointsAreValid().

◆ m_arrowLinesProportion

double iview::CLineShape::m_arrowLinesProportion

protected

Definition at line 96 of file CLineShape.h.

◆ m_lineDisplayMode

int iview::CLineShape::m_lineDisplayMode

protected

Definition at line 95 of file CLineShape.h.

◆ m_maxArrowLineLength

double iview::CLineShape::m_maxArrowLineLength

protected

Definition at line 97 of file CLineShape.h.

◆ m_points

istd::CIndex2d iview::CLineShape::m_points[4]

mutableprotected

Definition at line 101 of file CLineShape.h.

◆ m_referenceIndex

int iview::CLineShape::m_referenceIndex

protected

Definition at line 100 of file CLineShape.h.

◆ m_referencePosition

i2d::CVector2d iview::CLineShape::m_referencePosition

protected

Definition at line 99 of file CLineShape.h.

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

Acf/Include/iview/CLineShape.h

Public Types

Public Member Functions

Protected Member Functions

Static Protected Member Functions

Protected Attributes

Additional Inherited Members

Detailed Description

Member Typedef Documentation

◆ BaseClass

Member Enumeration Documentation

◆ LineDisplayMode

Constructor & Destructor Documentation

◆ CLineShape()

Member Function Documentation

◆ BeginLogDrag()

◆ CalcBoundingBox()

◆ CalcPoints()

◆ CheckLine()

◆ Draw()

◆ EnsurePointsAreValid() [1/2]

◆ EnsurePointsAreValid() [2/2]

◆ GetArrowLinesProportion()

◆ GetLineDisplayMode()

◆ GetMaxArrowLineLength()

◆ InvalidateBoundingBox()

◆ IsTouched()

◆ OnModelAttached()

◆ OnMouseButton()

◆ OnMouseMove()

◆ ResetPoints()

◆ SetArrowLinesProportion()

◆ SetLineDisplayMode()

◆ SetLogDragPosition()

◆ SetMaxArrowLineLength()

Member Data Documentation

◆ m_arePointsValid

◆ m_arrowLinesProportion

◆ m_lineDisplayMode

◆ m_maxArrowLineLength

◆ m_points

◆ m_referenceIndex

◆ m_referencePosition