Inheritance diagram for BaseTool:

Signals
bool	isActiveChanged (ToolType, bool)

Public Member Functions
QString	typeName ()

void	initialize (Editor *editor)

virtual ToolType	type ()=0

virtual void	loadSettings ()=0

virtual QCursor	cursor ()

virtual void	pointerPressEvent (PointerEvent *)=0

virtual void	pointerMoveEvent (PointerEvent *)=0

virtual void	pointerReleaseEvent (PointerEvent *)=0

virtual void	pointerDoubleClickEvent (PointerEvent *)

virtual bool	keyPressEvent (QKeyEvent *)

virtual bool	keyReleaseEvent (QKeyEvent *)

virtual bool	startAdjusting (Qt::KeyboardModifiers modifiers, qreal argStep)

virtual void	stopAdjusting ()

virtual void	adjustCursor (Qt::KeyboardModifiers modifiers)

virtual void	clearToolData ()

virtual void	resetToDefault ()

QPixmap	quickSizeCursor (qreal scalingFac)
	precision circular cursor: used for drawing stroke size while adjusting

virtual bool	isActive ()
	Check if the tool is active.

virtual void	setWidth (const qreal width)

virtual void	setFeather (const qreal feather)

virtual void	setInvisibility (const bool invisibility)

virtual void	setBezier (const bool bezier_state)

virtual void	setPressure (const bool pressure)

virtual void	setUseFeather (const bool usingFeather)

virtual void	setPreserveAlpha (const bool preserveAlpha)

virtual void	setVectorMergeEnabled (const bool vectorMergeEnabled)

virtual void	setAA (const int useAA)

virtual void	setFillMode (const int mode)

virtual void	setStabilizerLevel (const int level)

virtual void	setTolerance (const int tolerance)

virtual void	setToleranceEnabled (const bool enabled)

virtual void	setFillExpand (const int fillExpandValue)

virtual void	setFillExpandEnabled (const bool enabled)

virtual void	setFillReferenceMode (int referenceMode)

virtual void	setUseFillContour (const bool useFillContour)

virtual void	setShowSelectionInfo (const bool b)

virtual void	setShowCameraPath (const bool showCameraPath)

virtual void	setPathDotColorType (const DotColorType dotColorType)

virtual void	resetCameraPath ()

virtual void	paint (QPainter &painter)

virtual bool	leavingThisTool ()

QPointF	getCurrentPressPixel () const

QPointF	getCurrentPressPoint () const

QPointF	getCurrentPixel () const

QPointF	getCurrentPoint () const

QPointF	getLastPixel () const

QPointF	getLastPoint () const

QPointF	getLastPressPixel () const

QPointF	getLastPressPoint () const

bool	isPropertyEnabled (ToolPropertyType t)

bool	isDrawingTool ()
	BaseTool::isDrawingTool - A drawing tool is anything that applies something to the canvas.

Public Member Functions inherited from QObject
virtual const QMetaObject *	metaObject () const const

	QObject (QObject *parent)

virtual bool	event (QEvent *e)

virtual bool	eventFilter (QObject watched, QEvent event)

QString	objectName () const const

void	setObjectName (const QString &name)

bool	isWidgetType () const const

bool	isWindowType () const const

bool	signalsBlocked () const const

bool	blockSignals (bool block)

QThread *	thread () const const

void	moveToThread (QThread *targetThread)

int	startTimer (int interval, Qt::TimerType timerType)

int	startTimer (std::chrono::milliseconds time, Qt::TimerType timerType)

void	killTimer (int id)

T	findChild (const QString &name, Qt::FindChildOptions options) const const

QList< T >	findChildren (const QString &name, Qt::FindChildOptions options) const const

QList< T >	findChildren (const QRegExp &regExp, Qt::FindChildOptions options) const const

QList< T >	findChildren (const QRegularExpression &re, Qt::FindChildOptions options) const const

const QObjectList &	children () const const

void	setParent (QObject *parent)

void	installEventFilter (QObject *filterObj)

void	removeEventFilter (QObject *obj)

QMetaObject::Connection	connect (const QObject sender, const char signal, const char *method, Qt::ConnectionType type) const const

bool	disconnect (const char signal, const QObject receiver, const char *method) const const

bool	disconnect (const QObject receiver, const char method) const const

void	dumpObjectTree ()

void	dumpObjectInfo ()

void	dumpObjectTree () const const

void	dumpObjectInfo () const const

bool	setProperty (const char *name, const QVariant &value)

QVariant	property (const char *name) const const

QList< QByteArray >	dynamicPropertyNames () const const

void	destroyed (QObject *obj)

void	objectNameChanged (const QString &objectName)

QObject *	parent () const const

bool	inherits (const char *className) const const

void	deleteLater ()

	Q_DISABLE_COPY (Class)

	Q_DISABLE_MOVE (Class)

	Q_DISABLE_COPY_MOVE (Class)

T	qobject_cast (QObject *object)

T	qobject_cast (const QObject *object)

T	qFindChild (const QObject *obj, const QString &name)

QList< T >	qFindChildren (const QObject *obj, const QString &name)

QList< T >	qFindChildren (const QObject *obj, const QRegExp &regExp)

	Q_CLASSINFO (Name, Value)

	Q_INTERFACES (...)

	Q_PROPERTY (...)

	Q_ENUMS (...)

	Q_FLAGS (...)

	Q_ENUM (...)

	Q_FLAG (...)

	Q_ENUM_NS (...)

	Q_FLAG_NS (...)

	Q_OBJECT Q_OBJECT

	Q_GADGET Q_GADGET

	Q_NAMESPACE Q_NAMESPACE

	Q_NAMESPACE_EXPORT (EXPORT_MACRO)

	Q_SIGNALS Q_SIGNALS

	Q_SIGNAL Q_SIGNAL

	Q_SLOTS Q_SLOTS

	Q_SLOT Q_SLOT

	Q_EMIT Q_EMIT

	Q_INVOKABLE Q_INVOKABLE

	Q_REVISION Q_REVISION

	Q_SET_OBJECT_NAME (Object)

	QT_NO_NARROWING_CONVERSIONS_IN_CONNECT QT_NO_NARROWING_CONVERSIONS_IN_CONNECT

Static Public Member Functions
static QString	TypeName (ToolType)

static QPixmap	canvasCursor (float brushWidth, float brushFeather, bool useFeather, float scalingFac, int windowWidth)
	precision circular cursor: used for drawing a cursor within scribble area.

static bool	isAdjusting ()

Static Public Member Functions inherited from QObject
QString	tr (const char sourceText, const char disambiguation, int n)

QString	trUtf8 (const char sourceText, const char disambiguation, int n)

QMetaObject::Connection	connect (const QObject sender, const char signal, const QObject receiver, const char method, Qt::ConnectionType type)

QMetaObject::Connection	connect (const QObject sender, const QMetaMethod &signal, const QObject receiver, const QMetaMethod &method, Qt::ConnectionType type)

QMetaObject::Connection	connect (const QObject sender, PointerToMemberFunction signal, const QObject receiver, PointerToMemberFunction method, Qt::ConnectionType type)

QMetaObject::Connection	connect (const QObject *sender, PointerToMemberFunction signal, Functor functor)

QMetaObject::Connection	connect (const QObject sender, PointerToMemberFunction signal, const QObject context, Functor functor, Qt::ConnectionType type)

bool	disconnect (const QObject sender, const char signal, const QObject receiver, const char method)

bool	disconnect (const QObject sender, const QMetaMethod &signal, const QObject receiver, const QMetaMethod &method)

bool	disconnect (const QMetaObject::Connection &connection)

bool	disconnect (const QObject sender, PointerToMemberFunction signal, const QObject receiver, PointerToMemberFunction method)

Public Attributes
Properties	properties

Public Attributes inherited from QObject
typedef	QObjectList

Protected Member Functions
	BaseTool (QObject *parent)

StrokeManager *	strokeManager () const

Editor *	editor ()

Protected Member Functions inherited from QObject
QObject *	sender () const const

int	senderSignalIndex () const const

int	receivers (const char *signal) const const

bool	isSignalConnected (const QMetaMethod &signal) const const

virtual void	timerEvent (QTimerEvent *event)

virtual void	childEvent (QChildEvent *event)

virtual void	customEvent (QEvent *event)

virtual void	connectNotify (const QMetaMethod &signal)

virtual void	disconnectNotify (const QMetaMethod &signal)

Protected Attributes
QHash< ToolPropertyType, bool >	mPropertyEnabled

Editor *	mEditor = nullptr

ScribbleArea *	mScribbleArea = nullptr

QHash< Qt::KeyboardModifiers, ToolPropertyType >	mQuickSizingProperties

Private Attributes
StrokeManager *	mStrokeManager = nullptr

qreal	mAdjustmentStep = 0.0f

Static Private Attributes
static bool	msIsAdjusting = false

static qreal	msOriginalPropertyValue

Additional Inherited Members
Properties inherited from QObject
	objectName

Detailed Description

Definition at line 68 of file basetool.h.

Constructor & Destructor Documentation

◆ BaseTool()

BaseTool::BaseTool ( QObject * parent )

explicitprotected

Definition at line 56 of file basetool.cpp.

Member Function Documentation

◆ adjustCursor()

void BaseTool::adjustCursor ( Qt::KeyboardModifiers modifiers )

virtual

Definition at line 287 of file basetool.cpp.

◆ canvasCursor()

QPixmap BaseTool::canvasCursor	(	float	width,
		float	feather,
		bool	useFeather,
		float	scalingFac,
		int	windowWidth
	)

static

precision circular cursor: used for drawing a cursor within scribble area.

Returns: QPixmap

Definition at line 125 of file basetool.cpp.

◆ clearToolData()

virtual void BaseTool::clearToolData ( )

inlinevirtual

Definition at line 98 of file basetool.h.

◆ cursor()

QCursor BaseTool::cursor ( )

virtual

Definition at line 71 of file basetool.cpp.

◆ editor()

Editor * BaseTool::editor ( )

inlineprotected

Definition at line 159 of file basetool.h.

◆ getCurrentPixel()

QPointF BaseTool::getCurrentPixel ( ) const

Definition at line 332 of file basetool.cpp.

◆ getCurrentPoint()

QPointF BaseTool::getCurrentPoint ( ) const

Definition at line 337 of file basetool.cpp.

◆ getCurrentPressPixel()

QPointF BaseTool::getCurrentPressPixel ( ) const

Definition at line 322 of file basetool.cpp.

◆ getCurrentPressPoint()

QPointF BaseTool::getCurrentPressPoint ( ) const

Definition at line 327 of file basetool.cpp.

◆ getLastPixel()

QPointF BaseTool::getLastPixel ( ) const

Definition at line 342 of file basetool.cpp.

◆ getLastPoint()

QPointF BaseTool::getLastPoint ( ) const

Definition at line 347 of file basetool.cpp.

◆ getLastPressPixel()

QPointF BaseTool::getLastPressPixel ( ) const

Definition at line 352 of file basetool.cpp.

◆ getLastPressPoint()

QPointF BaseTool::getLastPressPoint ( ) const

Definition at line 357 of file basetool.cpp.

◆ initialize()

void BaseTool::initialize ( Editor * editor )

Definition at line 76 of file basetool.cpp.

◆ isActive()

bool BaseTool::isActive ( )

virtual

Check if the tool is active.

An active tool is definied as one which is actively modifying the buffer. This is used to check if an full frame cache can be used instead of redrawing with CanvasPainter.

Returns: Returns true if the tool is currently active, else returns false.

Reimplemented in HandTool, and PolylineTool.

Definition at line 204 of file basetool.cpp.

◆ isAdjusting()

static bool BaseTool::isAdjusting ( )

inlinestatic

Definition at line 103 of file basetool.h.

◆ isDrawingTool()

bool BaseTool::isDrawingTool ( )

BaseTool::isDrawingTool - A drawing tool is anything that applies something to the canvas.

SELECT and MOVE does not count here because they modify already applied content.

Returns: true if not a drawing tool and false otherwise

Definition at line 112 of file basetool.cpp.

◆ isPropertyEnabled()

bool BaseTool::isPropertyEnabled ( ToolPropertyType t )

inline

Definition at line 151 of file basetool.h.

◆ keyPressEvent()

virtual bool BaseTool::keyPressEvent ( QKeyEvent * )

inlinevirtual

Definition at line 90 of file basetool.h.

◆ keyReleaseEvent()

virtual bool BaseTool::keyReleaseEvent ( QKeyEvent * )

inlinevirtual

Definition at line 91 of file basetool.h.

◆ leavingThisTool()

virtual bool BaseTool::leavingThisTool ( )

inlinevirtual

Definition at line 138 of file basetool.h.

◆ paint()

virtual void BaseTool::paint ( QPainter & painter )

inlinevirtual

Definition at line 136 of file basetool.h.

◆ pointerDoubleClickEvent()

void BaseTool::pointerDoubleClickEvent ( PointerEvent * event )

virtual

Definition at line 102 of file basetool.cpp.

◆ pointerMoveEvent()

void BaseTool::pointerMoveEvent ( PointerEvent * event )

pure virtual

Definition at line 92 of file basetool.cpp.

◆ pointerPressEvent()

void BaseTool::pointerPressEvent ( PointerEvent * event )

pure virtual

Definition at line 87 of file basetool.cpp.

◆ pointerReleaseEvent()

void BaseTool::pointerReleaseEvent ( PointerEvent * event )

pure virtual

Definition at line 97 of file basetool.cpp.

◆ quickSizeCursor()

QPixmap BaseTool::quickSizeCursor ( qreal scalingFac )

precision circular cursor: used for drawing stroke size while adjusting

Returns: QPixmap

Definition at line 213 of file basetool.cpp.

◆ resetCameraPath()

void BaseTool::resetCameraPath ( )

virtual

Definition at line 462 of file basetool.cpp.

◆ resetToDefault()

virtual void BaseTool::resetToDefault ( )

inlinevirtual

Definition at line 99 of file basetool.h.

◆ setAA()

void BaseTool::setAA ( const int useAA )

virtual

Definition at line 402 of file basetool.cpp.

◆ setBezier()

void BaseTool::setBezier ( const bool bezier_state )

virtual

Definition at line 382 of file basetool.cpp.

◆ setFeather()

void BaseTool::setFeather ( const qreal feather )

virtual

Definition at line 367 of file basetool.cpp.

◆ setFillExpand()

void BaseTool::setFillExpand ( const int fillExpandValue )

virtual

Definition at line 427 of file basetool.cpp.

◆ setFillExpandEnabled()

void BaseTool::setFillExpandEnabled ( const bool enabled )

virtual

Definition at line 437 of file basetool.cpp.

◆ setFillMode()

void BaseTool::setFillMode ( const int mode )

virtual

Definition at line 407 of file basetool.cpp.

◆ setFillReferenceMode()

void BaseTool::setFillReferenceMode ( int referenceMode )

virtual

Definition at line 432 of file basetool.cpp.

◆ setInvisibility()

void BaseTool::setInvisibility ( const bool invisibility )

virtual

Definition at line 377 of file basetool.cpp.

◆ setPathDotColorType()

void BaseTool::setPathDotColorType ( const DotColorType dotColorType )

virtual

Definition at line 457 of file basetool.cpp.

◆ setPreserveAlpha()

void BaseTool::setPreserveAlpha ( const bool preserveAlpha )

virtual

Definition at line 392 of file basetool.cpp.

◆ setPressure()

void BaseTool::setPressure ( const bool pressure )

virtual

Definition at line 387 of file basetool.cpp.

◆ setShowCameraPath()

void BaseTool::setShowCameraPath ( const bool showCameraPath )

virtual

Definition at line 452 of file basetool.cpp.

◆ setShowSelectionInfo()

void BaseTool::setShowSelectionInfo ( const bool b )

virtual

Definition at line 447 of file basetool.cpp.

◆ setStabilizerLevel()

void BaseTool::setStabilizerLevel ( const int level )

virtual

Definition at line 412 of file basetool.cpp.

◆ setTolerance()

void BaseTool::setTolerance ( const int tolerance )

virtual

Definition at line 417 of file basetool.cpp.

◆ setToleranceEnabled()

void BaseTool::setToleranceEnabled ( const bool enabled )

virtual

Definition at line 422 of file basetool.cpp.

◆ setUseFeather()

void BaseTool::setUseFeather ( const bool usingFeather )

virtual

Definition at line 372 of file basetool.cpp.

◆ setUseFillContour()

void BaseTool::setUseFillContour ( const bool useFillContour )

virtual

Definition at line 442 of file basetool.cpp.

◆ setVectorMergeEnabled()

void BaseTool::setVectorMergeEnabled ( const bool vectorMergeEnabled )

virtual

Definition at line 397 of file basetool.cpp.

◆ setWidth()

void BaseTool::setWidth ( const qreal width )

virtual

Reimplemented in BucketTool.

Definition at line 362 of file basetool.cpp.

◆ startAdjusting()

bool BaseTool::startAdjusting	(	Qt::KeyboardModifiers	modifiers,
		qreal	argStep
	)

virtual

Definition at line 251 of file basetool.cpp.

◆ stopAdjusting()

void BaseTool::stopAdjusting ( )

virtual

Definition at line 279 of file basetool.cpp.

◆ strokeManager()

StrokeManager * BaseTool::strokeManager ( ) const

inlineprotected

Definition at line 158 of file basetool.h.

◆ typeName()

QString BaseTool::typeName ( )

inline

Definition at line 76 of file basetool.h.

◆ TypeName()

QString BaseTool::TypeName ( ToolType type )

static

Definition at line 35 of file basetool.cpp.

Member Data Documentation

◆ mAdjustmentStep

qreal BaseTool::mAdjustmentStep = 0.0f

private

Definition at line 170 of file basetool.h.

◆ mEditor

Editor* BaseTool::mEditor = nullptr

protected

Definition at line 163 of file basetool.h.

◆ mPropertyEnabled

QHash<ToolPropertyType, bool> BaseTool::mPropertyEnabled

protected

Definition at line 161 of file basetool.h.

◆ mQuickSizingProperties

QHash<Qt::KeyboardModifiers, ToolPropertyType> BaseTool::mQuickSizingProperties

protected

Definition at line 166 of file basetool.h.

◆ mScribbleArea

ScribbleArea* BaseTool::mScribbleArea = nullptr

protected

Definition at line 164 of file basetool.h.

◆ msIsAdjusting

bool BaseTool::msIsAdjusting = false

staticprivate

Definition at line 172 of file basetool.h.

◆ msOriginalPropertyValue

qreal BaseTool::msOriginalPropertyValue

staticprivate

Definition at line 173 of file basetool.h.

◆ mStrokeManager

StrokeManager* BaseTool::mStrokeManager = nullptr

private

Definition at line 169 of file basetool.h.

◆ properties

Properties BaseTool::properties

Definition at line 140 of file basetool.h.

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

core_lib/src/tool/basetool.h
core_lib/src/tool/basetool.cpp

BaseTool Class Reference

Signals

Public Member Functions

Static Public Member Functions

Public Attributes

Protected Member Functions

Protected Attributes

Private Attributes

Static Private Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ BaseTool()

Member Function Documentation

◆ adjustCursor()

◆ canvasCursor()

◆ clearToolData()

◆ cursor()

◆ editor()

◆ getCurrentPixel()

◆ getCurrentPoint()

◆ getCurrentPressPixel()

◆ getCurrentPressPoint()

◆ getLastPixel()

◆ getLastPoint()

◆ getLastPressPixel()

◆ getLastPressPoint()

◆ initialize()

◆ isActive()

◆ isAdjusting()

◆ isDrawingTool()

◆ isPropertyEnabled()

◆ keyPressEvent()

◆ keyReleaseEvent()

◆ leavingThisTool()

◆ paint()

◆ pointerDoubleClickEvent()

◆ pointerMoveEvent()

◆ pointerPressEvent()

◆ pointerReleaseEvent()

◆ quickSizeCursor()

◆ resetCameraPath()

◆ resetToDefault()

◆ setAA()

◆ setBezier()

◆ setFeather()

◆ setFillExpand()

◆ setFillExpandEnabled()

◆ setFillMode()

◆ setFillReferenceMode()

◆ setInvisibility()

◆ setPathDotColorType()

◆ setPreserveAlpha()

◆ setPressure()

◆ setShowCameraPath()

◆ setShowSelectionInfo()

◆ setStabilizerLevel()

◆ setTolerance()

◆ setToleranceEnabled()

◆ setUseFeather()

◆ setUseFillContour()

◆ setVectorMergeEnabled()

◆ setWidth()

◆ startAdjusting()

◆ stopAdjusting()

◆ strokeManager()

◆ typeName()

◆ TypeName()

Member Data Documentation

◆ mAdjustmentStep

◆ mEditor

◆ mPropertyEnabled

◆ mQuickSizingProperties

◆ mScribbleArea

◆ msIsAdjusting

◆ msOriginalPropertyValue

◆ mStrokeManager

◆ properties