#include <StarShape.h>

Inheritance diagram for StarShape:

Public Member Functions
qreal	baseRadius () const
	Returns the base radius.

KoShape *	cloneShape () const override
	creates a deep copy of the shape or shape's subtree

bool	convex () const
	Returns if the star represents a regular polygon.

uint	cornerCount () const
	Returns the number of corners.

QString	pathShapeId () const override
	reimplemented

void	setBaseRadius (qreal baseRadius)

void	setBaseRoundness (qreal baseRoundness)

void	setConvex (bool convex)

void	setCornerCount (uint cornerCount)

void	setSize (const QSizeF &newSize) override
	reimplemented

void	setTipRadius (qreal tipRadius)

void	setTipRoundness (qreal tipRoundness)

QPointF	starCenter () const

	StarShape ()

qreal	tipRadius () const
	Returns the tip radius.

	~StarShape () override

Public Member Functions inherited from KoParameterShape
int	handleCount () const
	return the number of handles set on the shape

int	handleIdAt (const QRectF &rect) const
	Get the id of the handle within the given rect.

QPointF	handlePosition (int handleId) const
	Get the handle position.

bool	isParametricShape () const
	Check if object is a parametric shape.

	KoParameterShape ()

void	moveHandle (int handleId, const QPointF &point, Qt::KeyboardModifiers modifiers=Qt::NoModifier)
	Move handle to point.

QPointF	normalize () override
	Normalizes the path data.

void	paintHandle (KisHandlePainterHelper &handlesHelper, int handleId)
	Paint the given handles.

void	paintHandles (KisHandlePainterHelper &handlesHelper)
	Paint the handles.

	Private ()

	Private (const KoParameterShape::Private &rhs)

void	setParametricShape (bool parametric)
	Set if the shape can be modified using parameters.

	~KoParameterShape () override

virtual	~Private ()=default

Public Member Functions inherited from KoPathShape
bool	addSubpath (KoSubpath *subpath, int subpathIndex)
	Adds a subpath at the given index to the path.

KoPathPoint *	arcTo (qreal rx, qreal ry, qreal startAngle, qreal sweepAngle)
	Add an arc.

bool	autoFillMarkers () const

QRectF	boundingRect () const override
	reimplemented

bool	breakAfter (const KoPathPointIndex &pointIndex)
	Breaks the path after the point index.

void	clear ()
	Removes all subpaths and their points from the path.

void	close ()
	Closes the current subpath.

void	closeMerge ()
	Closes the current subpath.

KoPathPointIndex	closeSubpath (const KoPathPointIndex &pointIndex)
	Close a open subpath.

int	combine (KoPathShape *path)
	Combines two path shapes by appending the data of the specified path.

KoPathPoint *	curveTo (const QPointF &c, const QPointF &p)
	Adds a new quadratic Bezier curve segment.

KoPathPoint *	curveTo (const QPointF &c1, const QPointF &c2, const QPointF &p)
	Adds a new cubic Bezier curve segment.

Qt::FillRule	fillRule () const
	Returns the fill rule for the path object.

bool	hasMarkers () const

bool	hitTest (const QPointF &position) const override
	reimplemented

bool	insertPoint (KoPathPoint *point, const KoPathPointIndex &pointIndex)
	Inserts a new point into the given subpath at the specified position.

bool	isClosedSubpath (int subpathIndex) const
	Checks if a subpath is closed.

bool	join (int subpathIndex)
	Joins the given subpath with the following one.

	KoPathShape ()
	constructor

KoPathPoint *	lineTo (const QPointF &p)
	Adds a new line segment.

void	loadNodeTypes (const QString &nodeTypes)
	Loads node types.

KoMarker *	marker (KoFlake::MarkerPosition pos) const

bool	moveSubpath (int oldSubpathIndex, int newSubpathIndex)
	Moves the position of a subpath within a path.

KoPathPoint *	moveTo (const QPointF &p)
	Starts a new Subpath.

QString	nodeTypes () const
	Saves the node types.

KoPathPointIndex	openSubpath (const KoPathPointIndex &pointIndex)
	Opens a closed subpath.

QPainterPath	outline () const override
	reimplemented

QRectF	outlineRect () const override
	reimplemented

void	paint (QPainter &painter) const override
	reimplemented

virtual void	paintPoints (KisHandlePainterHelper &handlesHelper)

KoPathPointIndex	pathPointIndex (const KoPathPoint *point) const
	Returns the path point index of a given path point.

QPainterPath	pathStroke (const QPen &pen) const

KoPathPoint *	pointByIndex (const KoPathPointIndex &pointIndex) const
	Returns the path point specified by a path point index.

int	pointCount () const
	Returns the number of points in the path.

QList< KoPathPoint * >	pointsAt (const QRectF &rect, const bool useControlPoints=false) const
	Returns the path points within the given rectangle.

void	recommendPointSelectionChange (const QList< KoPathPointIndex > &newSelection)

KoPathPoint *	removePoint (const KoPathPointIndex &pointIndex)
	Removes a point from the path.

KoSubpath *	removeSubpath (int subpathIndex)
	Removes subpath from the path.

bool	reverseSubpath (int subpathIndex)
	Reverse subpath.

KoPathSegment	segmentByIndex (const KoPathPointIndex &pointIndex) const
	Returns the segment specified by a path point index.

QList< KoPathSegment >	segmentsAt (const QRectF &rect) const
	Returns the list of path segments within the given rectangle.

bool	separate (QList< KoPathShape * > &separatedPaths)
	Creates separate path shapes, one for each existing subpath.

void	setAutoFillMarkers (bool value)

void	setFillRule (Qt::FillRule fillRule)
	Sets the fill rule to be used for painting the background.

void	setMarker (KoMarker *marker, KoFlake::MarkerPosition pos)

QSizeF	size () const override
	reimplemented

int	subpathCount () const
	Returns the number of subpaths in the path.

int	subpathPointCount (int subpathIndex) const
	Returns the number of points in a subpath.

QString	toString (const QTransform &matrix=QTransform()) const
	Returns a odf/svg string representation of the path data with the given matrix applied.

	~KoPathShape () override

Public Member Functions inherited from KoTosContainer
KoShape *	createTextShape (KoDocumentResourceManager *documentResources=0)

	KoTosContainer ()

virtual bool	loadText (const QDomElement &element)

void	paintComponent (QPainter &painter) const override
	Paint the component Implement this method to allow the shape to paint itself, just like the KoShape::paint() method does.

ResizeBehavior	resizeBehavior () const

void	setPlainText (const QString &text)

void	setResizeBehavior (ResizeBehavior resizeBehavior)

void	setRunThrough (short int runThrough) override

void	setTextAlignment (Qt::Alignment alignment)

Qt::Alignment	textAlignment () const

	~KoTosContainer () override

Public Member Functions inherited from KoShapeContainer
void	addShape (KoShape *shape)

bool	inheritsTransform (const KoShape *shape) const

bool	isClipped (const KoShape *child) const

	KoShapeContainer (KoShapeContainerModel *model=0)

KoShapeContainerModel *	model () const

void	paint (QPainter &painter) const override
	reimplemented

	Private (const Private &rhs, KoShapeContainer *q)

	Private (KoShapeContainer *q)

void	removeShape (KoShape *shape)

void	setClipped (const KoShape *child, bool clipping)

void	setInheritsTransform (const KoShape *shape, bool inherit)

int	shapeCount () const

ShapeInterface *	shapeInterface ()

QList< KoShape * >	shapes () const

virtual void	update () const

void	update () const override
	reimplemented

	~KoShapeContainer () override

Public Member Functions inherited from KoShape
QRectF	absoluteOutlineRect () const

QPointF	absolutePosition (KoFlake::AnchorPosition anchor=KoFlake::Center) const

QTransform	absoluteTransformation () const

bool	addDependee (KoShape *shape)

QString	additionalAttribute (const QString &name) const

void	addShapeChangeListener (ShapeChangeListener *listener)

KoShapeAnchor *	anchor () const

void	applyAbsoluteTransformation (const QTransform &matrix)

void	applyTransformation (const QTransform &matrix)

virtual QSharedPointer< KoShapeBackground >	background () const

virtual ChildZOrderPolicy	childZOrderPolicy ()

KoClipMask *	clipMask () const
	Returns the currently set clip mask or 0 if there is no clip mask set.

KoClipPath *	clipPath () const
	Returns the currently set clip path or 0 if there is no clip path set.

KoShape *	cloneShapeAndBakeAbsoluteTransform () const
	creates a deep copy of the shape/shapes tree and bakes the absolute transform of `this` into the resulting shape.

void	copySettings (const KoShape *shape)

QList< KoShape * >	dependees () const
	Returns list of shapes depending on this shape.

QPointF	documentToShape (const QPointF &point) const
	Transforms point from document coordinates to shape coordinates.

QRectF	documentToShape (const QRectF &rect) const
	Transform rect from document coordinates to shape coordinates.

KoFilterEffectStack *	filterEffectStack () const

bool	hasAdditionalAttribute (const QString &name) const

bool	hasCommonParent (const KoShape *shape) const

bool	hasDependee (KoShape *shape) const
	Returns if the given shape is dependent on this shape.

virtual bool	hasTransparency () const

QString	hyperLink () const

bool	inheritBackground () const
	inheritBackground shows if the shape inherits background from its parent

bool	inheritPaintOrder () const
	inheritPaintOrder

bool	inheritsTransformFromAny (const QList< KoShape * > ancestorsInQuestion) const
	inheritsTransformFromAny checks if the shape inherits transformation from any of the shapes listed in `ancestorsInQuestion`. The inheritance is checked in recursive way.

bool	inheritStroke () const
	inheritStroke shows if the shape inherits the stroke from its parent

bool	isContentProtected () const

bool	isGeometryProtected () const

bool	isPrintable () const

bool	isSelectable () const

virtual bool	isShapeEditable (bool recursive=true) const
	checks recursively if the shape or one of its parents is not visible or locked

bool	isVisible (bool recursive=true) const

bool	keepAspectRatio () const

	KoShape ()
	Constructor.

qreal	minimumHeight () const

QString	name () const

void	notifyChanged ()

virtual void	paintMarkers (QPainter &painter) const
	paintStroke paints the shape's markers

virtual QVector< PaintOrder >	paintOrder () const
	paintOrder

virtual void	paintStroke (QPainter &painter) const
	paintStroke paints the shape's stroked outline

KoShapeContainer *	parent () const

QPointF	position () const
	Get the position of the shape in pt.

void	removeAdditionalAttribute (const QString &name)

void	removeAdditionalStyleAttribute (const char *name)

void	removeDependee (KoShape *shape)

void	removeShapeChangeListener (ShapeChangeListener *listener)

void	rotate (qreal angle)
	Rotate the shape (relative)

qreal	rotation () const

int	runThrough () const

void	scale (qreal sx, qreal sy)
	Scale the shape using the zero-point which is the top-left corner.

void	setAbsolutePosition (const QPointF &newPosition, KoFlake::AnchorPosition anchor=KoFlake::Center)

void	setAdditionalAttribute (const QString &name, const QString &value)

void	setAdditionalStyleAttribute (const char *name, const QString &value)

void	setAnchor (KoShapeAnchor *anchor)

virtual void	setBackground (QSharedPointer< KoShapeBackground > background)

void	setClipMask (KoClipMask *clipMask)
	Sets a new clip mask, removing the old one. The mask is owned by the shape.

void	setClipPath (KoClipPath *clipPath)
	Sets a new clip path, removing the old one.

void	setContentProtected (bool protect)

void	setFilterEffectStack (KoFilterEffectStack *filterEffectStack)
	Sets the new filter effect stack, removing the old one.

void	setGeometryProtected (bool on)

void	setHyperLink (const QString &hyperLink)

void	setInheritBackground (bool value)
	setInheritBackground marks a shape as inheriting the background from the parent shape. NOTE: The currently selected background is destroyed.

void	setInheritPaintOrder (bool value)
	setInheritPaintOrder set inherit paint order.

void	setInheritStroke (bool value)
	setInheritStroke marks a shape as inheriting the stroke from the parent shape. NOTE: The currently selected stroke is destroyed.

void	setKeepAspectRatio (bool keepAspect)

void	setMinimumHeight (qreal height)

void	setName (const QString &name)

virtual void	setPaintOrder (PaintOrder first, PaintOrder second)
	setPaintOrder set the paint order. As there's only three entries in any given paintorder, you only need to have the first and second entry to set it.

void	setParent (KoShapeContainer *parent)

virtual void	setPosition (const QPointF &position)
	Set the position of the shape in pt.

void	setPrintable (bool on)

virtual void	setResolution (qreal xRes, qreal yRes)

void	setSelectable (bool selectable)

void	setShadow (KoShapeShadow *shadow)
	Sets the new shadow, removing the old one.

void	setShapeId (const QString &id)

virtual void	setStroke (KoShapeStrokeModelSP stroke)

void	setTextRunAroundContour (TextRunAroundContour contour)

void	setTextRunAroundDistanceBottom (qreal distance)

void	setTextRunAroundDistanceLeft (qreal distance)

void	setTextRunAroundDistanceRight (qreal distance)

void	setTextRunAroundDistanceTop (qreal distance)

void	setTextRunAroundSide (TextRunAroundSide side, RunThroughLevel runThrough=Background)

void	setTextRunAroundThreshold (qreal threshold)

void	setToolDelegates (const QSet< KoShape * > &delegates)

void	setTransformation (const QTransform &matrix)

void	setTransparency (qreal transparency)

void	setUserData (KoShapeUserData *userData)

void	setVisible (bool on)

void	setZIndex (qint16 zIndex)

KoShapeShadow *	shadow () const
	Returns the currently set shadow or 0 if there is no shadow set.

virtual QPainterPath	shadowOutline () const

QString	shapeId () const

QPointF	shapeToDocument (const QPointF &point) const
	Transforms point from shape coordinates to document coordinates.

QRectF	shapeToDocument (const QRectF &rect) const
	Transforms rect from shape coordinates to document coordinates.

void	shear (qreal sx, qreal sy)
	Shear the shape The shape will be sheared using the zero-point which is the top-left corner.

virtual KoSnapData	snapData () const
	Returns additional snap data the shape wants to have snapping to.

virtual KoShapeStrokeModelSP	stroke () const

KoInsets	strokeInsets () const

TextRunAroundContour	textRunAroundContour () const

qreal	textRunAroundDistanceBottom () const

qreal	textRunAroundDistanceLeft () const

qreal	textRunAroundDistanceRight () const

qreal	textRunAroundDistanceTop () const

TextRunAroundSide	textRunAroundSide () const

qreal	textRunAroundThreshold () const

QSet< KoShape * >	toolDelegates () const

QTransform	transformation () const
	Returns the shapes local transformation matrix.

qreal	transparency (bool recursive=false) const

virtual void	updateAbsolute (const QRectF &rect) const

KoShapeUserData *	userData () const

virtual void	waitUntilReady (bool asynchronous=true) const

qint16	zIndex () const

virtual	~KoShape ()
	Destructor.

Protected Member Functions
void	createPoints (int requiredPointCount)
	recreates the path points when the corner count or convexity changes

void	moveHandleAction (int handleId, const QPointF &point, Qt::KeyboardModifiers modifiers=Qt::NoModifier) override
	Updates the internal state of a KoParameterShape.

	StarShape (const StarShape &rhs)

void	updatePath (const QSizeF &size) override
	Update the path of the parameter shape.

Protected Member Functions inherited from KoParameterShape
QList< QPointF >	handles () const

	KoParameterShape (const KoParameterShape &rhs)
	constructor

void	setHandles (const QList< QPointF > &handles)

Protected Member Functions inherited from KoPathShape
int	arcToCurve (qreal rx, qreal ry, qreal startAngle, qreal sweepAngle, const QPointF &offset, QPointF *curvePoints) const
	Add an arc.

	KoPathShape (const KoPathShape &rhs)

void	map (const QTransform &matrix)

void	notifyPointsChanged ()

QTransform	resizeMatrix (const QSizeF &newSize) const

KoSubpathList &	subpaths ()
	XXX: refactor this using setter?

const KoSubpathList &	subpaths () const

Protected Member Functions inherited from KoTosContainer
	KoTosContainer (const KoTosContainer &rhs)

QRectF	preferredTextRect () const

void	setPreferredTextRect (const QRectF &rect)

void	shapeChanged (ChangeType type, KoShape *shape=0) override

KoShape *	textShape () const

Protected Member Functions inherited from KoShapeContainer
	KoShapeContainer (const KoShapeContainer &rhs)

void	setModel (KoShapeContainerModel *model)

void	setModelInit (KoShapeContainerModel *model)

virtual void	shapeCountChanged ()

Protected Member Functions inherited from KoShape
	KoShape (const KoShape &rhs)

QList< ShapeChangeListener * >	listeners () const

void	setSizeImpl (const QSizeF &size) const

void	shapeChangedPriv (KoShape::ChangeType type)

QTransform	transform () const
	return the current matrix that contains the rotation/scale/position of this shape

Private Types
enum	Handles { tip = 0 , base = 1 }
	the handle types More...

Private Member Functions
QPointF	computeCenter () const
	Computes the star center point from the inner points.

double	defaultAngleRadian () const
	Returns the default offset angle in radian.

Private Attributes
std::array< qreal, 2 >	m_angles
	the offset angles

QPointF	m_center
	the star center point

bool	m_convex
	controls if the star is convex

uint	m_cornerCount
	number of corners

std::array< qreal, 2 >	m_radius
	the different radii

std::array< qreal, 2 >	m_roundness
	the roundness at the handles

qreal	m_zoomX
	scaling in x

qreal	m_zoomY
	scaling in y

Additional Inherited Members
Public Types inherited from KoTosContainer
enum	ResizeBehavior { TextFollowsSize , FollowTextSize , IndependentSizes , TextFollowsPreferredTextRect }
	different kinds of resizing behavior to determine how to treat text overflow More...

Public Types inherited from KoShape
enum	ChangeType { PositionChanged , RotationChanged , ScaleChanged , ShearChanged , SizeChanged , GenericMatrixChange , KeepAspectRatioChange , ParentChanged , Deleted , StrokeChanged , BackgroundChanged , ShadowChanged , BorderChanged , ParameterChanged , ContentChanged , TextRunAroundChanged , ChildChanged , ConnectionPointChanged , ClipPathChanged , ClipMaskChanged , TransparencyChanged }
	Used by shapeChanged() to select which change was made. More...

enum	ChildZOrderPolicy { ChildZDefault , ChildZParentChild = ChildZDefault , ChildZPassThrough }
	Used by compareShapeZIndex() to order shapes. More...

enum	PaintOrder { Fill , Stroke , Markers }

enum	RunThroughLevel { Background , Foreground }

enum	TextRunAroundContour { ContourBox , ContourFull , ContourOutside }
	The behavior text should do when intersecting this shape. More...

enum	TextRunAroundSide { BiggestRunAroundSide , LeftRunAroundSide , RightRunAroundSide , EnoughRunAroundSide , BothRunAroundSide , NoRunAround , RunThrough }
	The behavior text should do when intersecting this shape. More...

Static Public Member Functions inherited from KoPathShape
static KoPathShape *	createShapeFromPainterPath (const QPainterPath &path)
	Creates path shape from given QPainterPath.

Static Public Member Functions inherited from KoShape
static QRectF	absoluteOutlineRect (const QList< KoShape * > &shapes)

static QRectF	boundingRect (const QList< KoShape * > &shapes)

static bool	compareShapeZIndex (KoShape s1, KoShape s2)

static KisHandlePainterHelper	createHandlePainterHelperDocument (QPainter painter, KoShape shape, qreal handleRadius, int decorationThickness)

static KisHandlePainterHelper	createHandlePainterHelperView (QPainter painter, KoShape shape, const KoViewConverter &converter, qreal handleRadius=0.0, int decorationThickness=1)

static QVector< PaintOrder >	defaultPaintOrder ()
	default paint order as per SVG specification

static QList< KoShape * >	linearizeSubtree (const QList< KoShape * > &shapes)

static QList< KoShape * >	linearizeSubtreeSorted (const QList< KoShape * > &shapes)

Public Attributes inherited from KoParameterShape
QList< QPointF >	handles
	the handles that the user can grab and change

bool	parametric

Public Attributes inherited from KoShapeContainer
KoShapeContainerModel *	model

KoShapeContainer::ShapeInterface	shapeInterface

Static Public Attributes inherited from KoShape
static const qint16	maxZIndex = std::numeric_limits<qint16>::max()

static const qint16	minZIndex = std::numeric_limits<qint16>::min()

Detailed Description

The star shape is a shape that can represent a star or a regular polygon. There a some properties which can be changed to control the appearance of the shape like the number of corners, the inner/outer radius and the corner roundness.

Definition at line 22 of file StarShape.h.

Member Enumeration Documentation

◆ Handles

enum StarShape::Handles

private

the handle types

Enumerator
tip
base

Definition at line 120 of file StarShape.h.

120{ tip = 0, base = 1 };

StarShape::base

@ base

Definition StarShape.h:120

StarShape::tip

@ tip

Definition StarShape.h:120

Constructor & Destructor Documentation

◆ StarShape() [1/2]

StarShape::StarShape ( )

Definition at line 19 of file StarShape.cpp.

    : m_cornerCount(5)
    , m_zoomX(1.0)
    , m_zoomY(1.0)
    , m_convex(false)
{
    m_radius[base] = 25.0;
    m_radius[tip] = 50.0;
    m_angles[base] = m_angles[tip] = defaultAngleRadian();
    m_roundness[base] = m_roundness[tip] = 0.0f;
 
    m_center = QPointF(50, 50);
    updatePath(QSize(100, 100));
}

References base, defaultAngleRadian(), m_angles, m_center, m_radius, m_roundness, tip, and updatePath().

◆ ~StarShape()

StarShape::~StarShape ( )

override

Definition at line 47 of file StarShape.cpp.

48{

49}

◆ StarShape() [2/2]

StarShape::StarShape ( const StarShape & rhs )

protected

Definition at line 34 of file StarShape.cpp.

    : KoParameterShape(rhs),
      m_cornerCount(rhs.m_cornerCount),
      m_radius(rhs.m_radius),
      m_angles(rhs.m_angles),
      m_zoomX(rhs.m_zoomX),
      m_zoomY(rhs.m_zoomY),
      m_roundness(rhs.m_roundness),
      m_center(rhs.m_center),
      m_convex(rhs.m_convex)
{
}

Member Function Documentation

◆ baseRadius()

qreal StarShape::baseRadius ( ) const

Returns the base radius.

Definition at line 81 of file StarShape.cpp.

{
    return m_radius[base];
}

References base, and m_radius.

◆ cloneShape()

KoShape * StarShape::cloneShape ( ) const

overridevirtual

creates a deep copy of the shape or shape's subtree

Returns: a cloned shape

Reimplemented from KoPathShape.

Definition at line 51 of file StarShape.cpp.

{
    return new StarShape(*this);
}

References StarShape().

◆ computeCenter()

QPointF StarShape::computeCenter ( ) const

private

Computes the star center point from the inner points.

Definition at line 259 of file StarShape.cpp.

{
    KoSubpath &points = *subpaths()[0];
 
    QPointF center(0, 0);
    for (uint i = 0; i < m_cornerCount; ++i) {
        if (m_convex) {
            center += points[i]->point();
        } else {
            center += points[2 * i]->point();
        }
    }
    if (m_cornerCount > 0) {
        return center / static_cast<qreal>(m_cornerCount);
    }
    return center;
 
}

References m_convex, m_cornerCount, and KoPathShape::subpaths().

◆ convex()

bool StarShape::convex ( ) const

Returns if the star represents a regular polygon.

Definition at line 115 of file StarShape.cpp.

{
    return m_convex;
}

References m_convex.

◆ cornerCount()

uint StarShape::cornerCount ( ) const

Returns the number of corners.

Definition at line 70 of file StarShape.cpp.

{
    return m_cornerCount;
}

References m_cornerCount.

◆ createPoints()

void StarShape::createPoints ( int requiredPointCount )

protected

recreates the path points when the corner count or convexity changes

Definition at line 226 of file StarShape.cpp.

{
    if (subpaths().count() != 1) {
        clear();
        subpaths().append(new KoSubpath());
    }
    int currentPointCount = subpaths()[0]->count();
    if (currentPointCount > requiredPointCount) {
        for (int i = 0; i < currentPointCount - requiredPointCount; ++i) {
            delete subpaths()[0]->front();
            subpaths()[0]->pop_front();
        }
    } else if (requiredPointCount > currentPointCount) {
        for (int i = 0; i < requiredPointCount - currentPointCount; ++i) {
            subpaths()[0]->append(new KoPathPoint(this, QPointF()));
        }
    }
 
    notifyPointsChanged();
}

References KoPathShape::clear(), KoPathShape::notifyPointsChanged(), and KoPathShape::subpaths().

◆ defaultAngleRadian()

double StarShape::defaultAngleRadian ( ) const

private

Returns the default offset angle in radian.

Definition at line 283 of file StarShape.cpp.

{
    qreal radianStep = M_PI / static_cast<qreal>(m_cornerCount);
 
    return M_PI_2 - 2 * radianStep;
}

References m_cornerCount, and M_PI.

◆ moveHandleAction()

void StarShape::moveHandleAction	(	int	handleId,
		const QPointF &	point,
		Qt::KeyboardModifiers	modifiers = Qt::NoModifier )

overrideprotectedvirtual

Updates the internal state of a KoParameterShape.

This method is called from moveHandle.

Parameters

handleId	of the handle
point	to move the handle to in shape coordinates
modifiers	used during move to point

Implements KoParameterShape.

Definition at line 125 of file StarShape.cpp.

{
    if (modifiers & Qt::ShiftModifier) {
        QPointF handle = handles()[handleId];
        QPointF tangentVector = point - handle;
        qreal distance = sqrt(tangentVector.x() * tangentVector.x() + tangentVector.y() * tangentVector.y());
        QPointF radialVector = handle - m_center;
        // cross product to determine in which direction the user is dragging
        qreal moveDirection = radialVector.x() * tangentVector.y() - radialVector.y() * tangentVector.x();
        // make the roundness stick to zero if distance is under a certain value
        float snapDistance = 3.0;
        if (distance >= 0.0) {
            distance = distance < snapDistance ? 0.0 : distance - snapDistance;
        } else {
            distance = distance > -snapDistance ? 0.0 : distance + snapDistance;
        }
        // control changes roundness on both handles, else only the actual handle roundness is changed
        if (modifiers & Qt::ControlModifier) {
            m_roundness[handleId] = moveDirection < 0.0f ? distance : -distance;
        } else {
            m_roundness[base] = m_roundness[tip] = moveDirection < 0.0f ? distance : -distance;
        }
    } else {
        QPointF distVector = point - m_center;
        // unapply scaling
        distVector.rx() /= m_zoomX;
        distVector.ry() /= m_zoomY;
        m_radius[handleId] = sqrt(distVector.x() * distVector.x() + distVector.y() * distVector.y());
 
        qreal angle = atan2(distVector.y(), distVector.x());
        if (angle < 0.0) {
            angle += 2.0 * M_PI;
        }
        qreal diffAngle = angle - m_angles[handleId];
        qreal radianStep = M_PI / static_cast<qreal>(m_cornerCount);
        if (handleId == tip) {
            m_angles[tip] += diffAngle - radianStep;
            m_angles[base] += diffAngle - radianStep;
        } else {
            // control make the base point move freely
            if (modifiers & Qt::ControlModifier) {
                m_angles[base] += diffAngle - 2 * radianStep;
            } else {
                m_angles[base] = m_angles[tip];
            }
        }
    }
}

References base, distance(), KoParameterShape::handles, m_angles, m_center, m_cornerCount, M_PI, m_radius, m_roundness, m_zoomX, m_zoomY, and tip.

◆ pathShapeId()

QString StarShape::pathShapeId ( ) const

overridevirtual

reimplemented

Reimplemented from KoPathShape.

Definition at line 278 of file StarShape.cpp.

{
    return StarShapeId;
}

References StarShapeId.

◆ setBaseRadius()

void StarShape::setBaseRadius ( qreal baseRadius )

Sets the radius of the base points. The base radius has no meaning if the star is set convex.

Parameters

baseRadius the new base radius

Definition at line 75 of file StarShape.cpp.

{
    m_radius[base] = fabs(baseRadius);
    updatePath(QSize());
}

References base, baseRadius(), m_radius, and updatePath().

◆ setBaseRoundness()

void StarShape::setBaseRoundness ( qreal baseRoundness )

Sets the roundness at the base points.

A roundness value of zero disables the roundness.

Parameters

baseRoundness the new base roundness

Definition at line 97 of file StarShape.cpp.

{
    m_roundness[base] = baseRoundness;
    updatePath(QSize());
}

References base, m_roundness, and updatePath().

◆ setConvex()

void StarShape::setConvex ( bool convex )

Sets the star to be convex, looking like a polygon.

Parameters

convex if true makes shape behave like regular polygon

Definition at line 109 of file StarShape.cpp.

{
    m_convex = convex;
    updatePath(QSize());
}

References convex(), m_convex, and updatePath().

◆ setCornerCount()

void StarShape::setCornerCount ( uint cornerCount )

Sets the number of corners.

The minimum accepted number of corners is 3. If the star is set to be convex (like a regular polygon), the corner count equals the number of polygon points. For a real star it represents the number of legs the star has.

Parameters

cornerCount the new number of corners

Definition at line 57 of file StarShape.cpp.

{
    if (cornerCount >= 3) {
        double oldDefaultAngle = defaultAngleRadian();
        m_cornerCount = cornerCount;
        double newDefaultAngle = defaultAngleRadian();
        m_angles[base] += newDefaultAngle - oldDefaultAngle;
        m_angles[tip] += newDefaultAngle - oldDefaultAngle;
 
        updatePath(QSize());
    }
}

References base, cornerCount(), defaultAngleRadian(), m_angles, m_cornerCount, tip, and updatePath().

◆ setSize()

void StarShape::setSize ( const QSizeF & newSize )

overridevirtual

reimplemented

Reimplemented from KoParameterShape.

Definition at line 247 of file StarShape.cpp.

{
    QTransform matrix(resizeMatrix(newSize));
    m_zoomX *= matrix.m11();
    m_zoomY *= matrix.m22();
 
    // this transforms the handles
    KoParameterShape::setSize(newSize);
 
    m_center = computeCenter();
}

References computeCenter(), m_center, m_zoomX, m_zoomY, KoPathShape::resizeMatrix(), and KoParameterShape::setSize().

◆ setTipRadius()

void StarShape::setTipRadius ( qreal tipRadius )

Sets the radius of the tip points.

Parameters

tipRadius the new tip radius

Definition at line 86 of file StarShape.cpp.

{
    m_radius[tip] = fabs(tipRadius);
    updatePath(QSize());
}

References m_radius, tip, tipRadius(), and updatePath().

◆ setTipRoundness()

void StarShape::setTipRoundness ( qreal tipRoundness )

Sets the roundness at the tip points.

A roundness value of zero disables the roundness.

Parameters

tipRoundness the new base roundness

Definition at line 103 of file StarShape.cpp.

{
    m_roundness[tip] = tipRoundness;
    updatePath(QSize());
}

References m_roundness, tip, and updatePath().

◆ starCenter()

QPointF StarShape::starCenter ( ) const

Returns the star center point in shape coordinates.

The star center is the weight center of the star and not necessarily coincident with the shape center point.

Definition at line 120 of file StarShape.cpp.

{
    return m_center;
}

References m_center.

◆ tipRadius()

qreal StarShape::tipRadius ( ) const

Returns the tip radius.

Definition at line 92 of file StarShape.cpp.

{
    return m_radius[tip];
}

References m_radius, and tip.

◆ updatePath()

void StarShape::updatePath ( const QSizeF & size )

overrideprotectedvirtual

Update the path of the parameter shape.

Parameters

size	of the shape

Implements KoParameterShape.

Definition at line 174 of file StarShape.cpp.

{
    Q_UNUSED(size);
    qreal radianStep = M_PI / static_cast<qreal>(m_cornerCount);
 
    createPoints(m_convex ? m_cornerCount : 2 * m_cornerCount);
 
    KoSubpath &points = *subpaths()[0];
 
    uint index = 0;
    for (uint i = 0; i < 2 * m_cornerCount; ++i) {
        uint cornerType = i % 2;
        if (cornerType == base && m_convex) {
            continue;
        }
        qreal radian = static_cast<qreal>((i + 1) * radianStep) + m_angles[cornerType];
        QPointF cornerPoint = QPointF(m_zoomX * m_radius[cornerType] * cos(radian), m_zoomY * m_radius[cornerType] * sin(radian));
 
        points[index]->setPoint(m_center + cornerPoint);
        points[index]->unsetProperty(KoPathPoint::StopSubpath);
        points[index]->unsetProperty(KoPathPoint::CloseSubpath);
        if (m_roundness[cornerType] > 1e-10 || m_roundness[cornerType] < -1e-10) {
            // normalized cross product to compute tangential vector for handle point
            QPointF tangentVector(cornerPoint.y() / m_radius[cornerType], -cornerPoint.x() / m_radius[cornerType]);
            points[index]->setControlPoint2(points[index]->point() - m_roundness[cornerType] * tangentVector);
            points[index]->setControlPoint1(points[index]->point() + m_roundness[cornerType] * tangentVector);
        } else {
            points[index]->removeControlPoint1();
            points[index]->removeControlPoint2();
        }
        index++;
    }
 
    // first path starts and closes path
    points[0]->setProperty(KoPathPoint::StartSubpath);
    points[0]->setProperty(KoPathPoint::CloseSubpath);
    // last point stops and closes path
    points.last()->setProperty(KoPathPoint::StopSubpath);
    points.last()->setProperty(KoPathPoint::CloseSubpath);
 
    normalize();
 
    QList<QPointF> handles;
    handles.push_back(points.at(tip)->point());
    if (!m_convex) {
        handles.push_back(points.at(base)->point());
    }
    setHandles(handles);
 
    m_center = computeCenter();
}

References base, KoPathPoint::CloseSubpath, computeCenter(), createPoints(), KoParameterShape::handles, m_angles, m_center, m_convex, m_cornerCount, M_PI, m_radius, m_roundness, m_zoomX, m_zoomY, KoParameterShape::normalize(), KoParameterShape::setHandles(), KoPathShape::size(), KoPathPoint::StartSubpath, KoPathPoint::StopSubpath, KoPathShape::subpaths(), and tip.

Member Data Documentation

◆ m_angles

std::array<qreal, 2> StarShape::m_angles

private

the offset angles

Definition at line 124 of file StarShape.h.

◆ m_center

QPointF StarShape::m_center

private

the star center point

Definition at line 128 of file StarShape.h.

◆ m_convex

bool StarShape::m_convex

private

controls if the star is convex

Definition at line 129 of file StarShape.h.

◆ m_cornerCount

uint StarShape::m_cornerCount

private

number of corners

Definition at line 122 of file StarShape.h.

◆ m_radius

std::array<qreal, 2> StarShape::m_radius

private

the different radii

Definition at line 123 of file StarShape.h.

◆ m_roundness

std::array<qreal, 2> StarShape::m_roundness

private

the roundness at the handles

Definition at line 127 of file StarShape.h.

◆ m_zoomX

qreal StarShape::m_zoomX

private

scaling in x

Definition at line 125 of file StarShape.h.

◆ m_zoomY

qreal StarShape::m_zoomY

private

scaling in y

Definition at line 126 of file StarShape.h.

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

plugins/flake/pathshapes/star/StarShape.h
plugins/flake/pathshapes/star/StarShape.cpp

Public Member Functions

Protected Member Functions

Private Types

Private Member Functions

Private Attributes

Additional Inherited Members

Detailed Description

Member Enumeration Documentation

◆ Handles

Constructor & Destructor Documentation

◆ StarShape() [1/2]

◆ ~StarShape()

◆ StarShape() [2/2]

Member Function Documentation

◆ baseRadius()

◆ cloneShape()

◆ computeCenter()

◆ convex()

◆ cornerCount()

◆ createPoints()

◆ defaultAngleRadian()

◆ moveHandleAction()

◆ pathShapeId()

◆ setBaseRadius()

◆ setBaseRoundness()

◆ setConvex()

◆ setCornerCount()

◆ setSize()

◆ setTipRadius()

◆ setTipRoundness()

◆ starCenter()

◆ tipRadius()

◆ updatePath()

Member Data Documentation

◆ m_angles

◆ m_center

◆ m_convex

◆ m_cornerCount

◆ m_radius

◆ m_roundness

◆ m_zoomX

◆ m_zoomY