#include <EnhancedPathHandle.h>

Public Member Functions
void	changePosition (const QPointF &position)

	EnhancedPathHandle (EnhancedPathShape *parent)

bool	hasPosition () const
	Returns if the handle has valid positional parameters.S.

QPointF	position ()

void	setPolarCenter (EnhancedPathParameter polarX, EnhancedPathParameter polarY)

void	setPosition (EnhancedPathParameter positionX, EnhancedPathParameter positionY)

void	setRadiusRange (EnhancedPathParameter minRadius, EnhancedPathParameter maxRadius)

void	setRangeX (EnhancedPathParameter minX, EnhancedPathParameter maxX)

void	setRangeY (EnhancedPathParameter minY, EnhancedPathParameter maxY)

	~EnhancedPathHandle ()
	Destroys the handle.

Private Member Functions
bool	isPolar () const
	Returns if handle is polar.

Private Attributes
EnhancedPathParameter *	m_maximumX
	the maximum x-coordinate

EnhancedPathParameter *	m_maximumY
	the maximum y-coordinate

EnhancedPathParameter *	m_maxRadius
	the maximum polar radius

EnhancedPathParameter *	m_minimumX
	the minimum x-coordinate

EnhancedPathParameter *	m_minimumY
	the minimum y-coordinate

EnhancedPathParameter *	m_minRadius
	the minimum polar radius

EnhancedPathShape *	m_parent
	the enhanced path shape owning this handle

EnhancedPathParameter *	m_polarX
	the polar center x-coordinate

EnhancedPathParameter *	m_polarY
	the polar center y-coordinate

EnhancedPathParameter *	m_positionX
	the position x-coordinate

EnhancedPathParameter *	m_positionY
	the position y-coordinate

Detailed Description

An interaction handle used by the EnhancedPathShape for changing the shape interactively.

Definition at line 22 of file EnhancedPathHandle.h.

Constructor & Destructor Documentation

◆ EnhancedPathHandle()

EnhancedPathHandle::EnhancedPathHandle ( EnhancedPathShape * parent )

explicit

Constructs a new empty handle;

Note that an empty handle is not valid, as long as there are no positional parameters set with setPosition.

Definition at line 17 of file EnhancedPathHandle.cpp.

    : m_parent(parent)
    , m_positionX(0)
    , m_positionY(0)
    , m_minimumX(0)
    , m_minimumY(0)
    , m_maximumX(0)
    , m_maximumY(0)
    , m_polarX(0)
    , m_polarY(0)
    , m_minRadius(0)
    , m_maxRadius(0)
{
    Q_ASSERT(m_parent);
}

References m_parent.

◆ ~EnhancedPathHandle()

EnhancedPathHandle::~EnhancedPathHandle ( )

Destroys the handle.

Definition at line 33 of file EnhancedPathHandle.cpp.

34{

35}

Member Function Documentation

◆ changePosition()

void EnhancedPathHandle::changePosition ( const QPointF & position )

Attempts to changes the position of the handle. Only the coordinates of the handle which reference a modifier can be changed. The new position is automatically stored into the modifier of the given enhanced path.

Parameters

position	the new position the handle to set
path	the enhanced path the handle is referenced from

Definition at line 65 of file EnhancedPathHandle.cpp.

{
    if (!hasPosition()) {
        return;
    }
 
    QPointF constrainedPosition(position);
 
    if (isPolar()) {
        // convert cartesian coordinates into polar coordinates
        QPointF polarCenter(m_polarX->evaluate(), m_polarY->evaluate());
        QPointF diff = constrainedPosition - polarCenter;
        // compute the polar radius
        qreal radius = sqrt(diff.x() * diff.x() + diff.y() * diff.y());
        // compute the polar angle
        qreal angle = atan2(diff.y(), diff.x());
        if (angle < 0.0) {
            angle += 2 * M_PI;
        }
 
        // constrain the radius
        if (m_minRadius) {
            radius = qMax(m_minRadius->evaluate(), radius);
        }
        if (m_maxRadius) {
            radius = qMin(m_maxRadius->evaluate(), radius);
        }
 
        constrainedPosition.setX(angle * 180.0 / M_PI);
        constrainedPosition.setY(radius);
    } else {
        // constrain x coordinate
        if (m_minimumX) {
            constrainedPosition.setX(qMax(m_minimumX->evaluate(), constrainedPosition.x()));
        }
        if (m_maximumX) {
            constrainedPosition.setX(qMin(m_maximumX->evaluate(), constrainedPosition.x()));
        }
 
        // constrain y coordinate
        if (m_minimumY) {
            constrainedPosition.setY(qMax(m_minimumY->evaluate(), constrainedPosition.y()));
        }
        if (m_maximumY) {
            constrainedPosition.setY(qMin(m_maximumY->evaluate(), constrainedPosition.y()));
        }
    }
 
    m_positionX->modify(constrainedPosition.x());
    m_positionY->modify(constrainedPosition.y());
}

References EnhancedPathParameter::evaluate(), hasPosition(), isPolar(), m_maximumX, m_maximumY, m_maxRadius, m_minimumX, m_minimumY, m_minRadius, M_PI, m_polarX, m_polarY, m_positionX, m_positionY, EnhancedPathParameter::modify(), and position().

◆ hasPosition()

bool EnhancedPathHandle::hasPosition ( ) const

Returns if the handle has valid positional parameters.S.

Definition at line 37 of file EnhancedPathHandle.cpp.

{
    return m_positionX && m_positionY;
}

References m_positionX, and m_positionY.

◆ isPolar()

bool EnhancedPathHandle::isPolar ( ) const

private

Returns if handle is polar.

Definition at line 141 of file EnhancedPathHandle.cpp.

{
    return m_polarX && m_polarY;
}

References m_polarX, and m_polarY.

◆ position()

QPointF EnhancedPathHandle::position ( )

Evaluates the position of the handle.

Returns: the actual handle position

Definition at line 48 of file EnhancedPathHandle.cpp.

{
    if (!hasPosition()) {
        return QPointF();
    }
 
    QPointF position(m_positionX->evaluate(), m_positionY->evaluate());
    if (isPolar()) {
        // convert polar coordinates into cartesian coordinates
        QPointF center(m_polarX->evaluate(), m_polarY->evaluate());
        qreal angleInRadian = position.x() * M_PI / 180.0;
        position = center + position.y() * QPointF(cos(angleInRadian), sin(angleInRadian));
    }
 
    return position;
}

References EnhancedPathParameter::evaluate(), hasPosition(), isPolar(), M_PI, m_polarX, m_polarY, m_positionX, m_positionY, and position().

◆ setPolarCenter()

void EnhancedPathHandle::setPolarCenter	(	EnhancedPathParameter *	polarX,
		EnhancedPathParameter *	polarY )

Sets the center of a polar handle.

If both parameters are valid pointers, then the handle behaves like a polar handle. This means the x-coordinate of the position represents an angle in degree and the y-coordinate a radius.

Parameters

polarX	the polar center x-coordinate
polarY	the polar center y-coordinate

Definition at line 129 of file EnhancedPathHandle.cpp.

{
    m_polarX = polarX;
    m_polarY = polarY;
}

References m_polarX, and m_polarY.

◆ setPosition()

void EnhancedPathHandle::setPosition	(	EnhancedPathParameter *	positionX,
		EnhancedPathParameter *	positionY )

Sets the positional parameters, making the handle valid.

It replaces the actual positional parameters.

Parameters

positionX	the x-coordinate of the handle position
positionY	the y-coordinate of the handle position

Definition at line 42 of file EnhancedPathHandle.cpp.

{
    m_positionX = positionX;
    m_positionY = positionY;
}

References m_positionX, and m_positionY.

◆ setRadiusRange()

void EnhancedPathHandle::setRadiusRange	(	EnhancedPathParameter *	minRadius,
		EnhancedPathParameter *	maxRadius )

Sets the range of the radius for polar handles.

Parameters

minRadius	the minimum polar radius
maxRadius	the maximum polar radius

Definition at line 135 of file EnhancedPathHandle.cpp.

{
    m_minRadius = minRadius;
    m_maxRadius = maxRadius;
}

References m_maxRadius, and m_minRadius.

◆ setRangeX()

void EnhancedPathHandle::setRangeX	(	EnhancedPathParameter *	minX,
		EnhancedPathParameter *	maxX )

Sets the range of the handles x-coordinate.

A zero pointer has the effect of no maximum/minimum value.

Parameters

minX	the minimum x-coordinate
maxX	the maximum x-coordinate

Definition at line 117 of file EnhancedPathHandle.cpp.

{
    m_minimumX = minX;
    m_maximumX = maxX;
}

References m_maximumX, and m_minimumX.

◆ setRangeY()

void EnhancedPathHandle::setRangeY	(	EnhancedPathParameter *	minY,
		EnhancedPathParameter *	maxY )

Sets the range of the handles y-coordinate.

A zero pointer has the effect of no maximum/minimum value.

Parameters

minY	the minimum y-coordinate
maxY	the maximum y-coordinate

Definition at line 123 of file EnhancedPathHandle.cpp.

{
    m_minimumY = minY;
    m_maximumY = maxY;
}

References m_maximumY, and m_minimumY.

Member Data Documentation

◆ m_maximumX

EnhancedPathParameter* EnhancedPathHandle::m_maximumX

private

the maximum x-coordinate

Definition at line 113 of file EnhancedPathHandle.h.

◆ m_maximumY

EnhancedPathParameter* EnhancedPathHandle::m_maximumY

private

the maximum y-coordinate

Definition at line 114 of file EnhancedPathHandle.h.

◆ m_maxRadius

EnhancedPathParameter* EnhancedPathHandle::m_maxRadius

private

the maximum polar radius

Definition at line 118 of file EnhancedPathHandle.h.

◆ m_minimumX

EnhancedPathParameter* EnhancedPathHandle::m_minimumX

private

the minimum x-coordinate

Definition at line 111 of file EnhancedPathHandle.h.

◆ m_minimumY

EnhancedPathParameter* EnhancedPathHandle::m_minimumY

private

the minimum y-coordinate

Definition at line 112 of file EnhancedPathHandle.h.

◆ m_minRadius

EnhancedPathParameter* EnhancedPathHandle::m_minRadius

private

the minimum polar radius

Definition at line 117 of file EnhancedPathHandle.h.

◆ m_parent

EnhancedPathShape* EnhancedPathHandle::m_parent

private

the enhanced path shape owning this handle

Definition at line 108 of file EnhancedPathHandle.h.

◆ m_polarX

EnhancedPathParameter* EnhancedPathHandle::m_polarX

private

the polar center x-coordinate

Definition at line 115 of file EnhancedPathHandle.h.

◆ m_polarY

EnhancedPathParameter* EnhancedPathHandle::m_polarY

private

the polar center y-coordinate

Definition at line 116 of file EnhancedPathHandle.h.

◆ m_positionX

EnhancedPathParameter* EnhancedPathHandle::m_positionX

private

the position x-coordinate

Definition at line 109 of file EnhancedPathHandle.h.

◆ m_positionY

EnhancedPathParameter* EnhancedPathHandle::m_positionY

private

the position y-coordinate

Definition at line 110 of file EnhancedPathHandle.h.

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

plugins/flake/pathshapes/enhancedpath/EnhancedPathHandle.h
plugins/flake/pathshapes/enhancedpath/EnhancedPathHandle.cpp

Public Member Functions

Private Member Functions

Private Attributes

Detailed Description

Constructor & Destructor Documentation

◆ EnhancedPathHandle()

◆ ~EnhancedPathHandle()

Member Function Documentation

◆ changePosition()

◆ hasPosition()

◆ isPolar()

◆ position()

◆ setPolarCenter()

◆ setPosition()

◆ setRadiusRange()

◆ setRangeX()

◆ setRangeY()

Member Data Documentation

◆ m_maximumX

◆ m_maximumY

◆ m_maxRadius

◆ m_minimumX

◆ m_minimumY

◆ m_minRadius

◆ m_parent

◆ m_polarX

◆ m_polarY

◆ m_positionX

◆ m_positionY