RLeaderData

Class in Entity Module
Header: #include <src/entity/RLeaderData.h>
Inherits: REntityData, RPolyline

Description

Leader entity data class.

Scriptable: This class is available in script environments.

Copyable: Objects are cleaned up automatically by the garbage collector of the script engine.

Public Functions

	RLeaderData()
	RLeaderData(const RPolyline &polyline, bool arrowHead)
void	appendVertex(const RVector &vertex)
bool	canHaveArrowHead() const
virtual RShape *	castToShape()
void	clearStyleOverrides()
int	countSegments() const
int	countVertices() const
virtual bool	flipHorizontal()
virtual bool	flipVertical()
virtual QList< RVector >	getArcReferencePoints(const RBox &queryBox=RDEFAULT_RBOX) const
RTriangle	getArrowShape() const
virtual RBox	getBoundingBox(bool ignoreEmpty=false) const
virtual QList< RVector >	getCenterPoints(const RBox &queryBox=RDEFAULT_RBOX, QList< RObject::Id > *subEntityIds=NULL) const
double	getDimasz(bool scale=true) const
RObject::Id	getDimLeaderBlockId() const
double	getDimscale() const
virtual double	getDistanceTo(const RVector &point, bool limited=true, double range=0.0, bool draft=false, double strictRange=RMAXDOUBLE) const
virtual RVector	getEndPoint() const
virtual QList< RVector >	getEndPoints(const RBox &queryBox=RDEFAULT_RBOX, QList< RObject::Id > *subEntityIds=NULL) const
virtual QList< QSharedPointer< RShape > >	getExploded(int segments=RDEFAULT_MIN1) const
virtual QList< RVector >	getIntersectionPoints(const REntityData &other, bool limited=true, bool same=false, const RBox &queryBox=RDEFAULT_RBOX, bool ignoreComplex=true, QList< QPair< RObject::Id, RObject::Id > > *entityIds=NULL) const
virtual QList< RVector >	getIntersectionPoints(const RShape &shape, bool limited=true, const RBox &queryBox=RDEFAULT_RBOX, bool ignoreComplex=true) const
virtual QList< RVector >	getMiddlePoints(const RBox &queryBox=RDEFAULT_RBOX, QList< RObject::Id > *subEntityIds=NULL) const
virtual QList< RVector >	getPointsWithDistanceToEnd(double distance, int from=RS::FromAny, const RBox &queryBox=RDEFAULT_RBOX, QList< RObject::Id > *subEntityIds=NULL) const
virtual QList< RRefPoint >	getReferencePoints(RS::ProjectionRenderingHint hint=RS::RenderTop) const
virtual QList< QSharedPointer< RShape > >	getShapes(const RBox &queryBox=RDEFAULT_RBOX, bool ignoreComplex=false, bool segment=false, QList< RObject::Id > *entityIds=NULL) const
virtual RVector	getStartPoint() const
virtual RS::EntityType	getType() const
virtual RVector	getVectorTo(const RVector &point, bool limited=true, double strictRange=RMAXDOUBLE) const
bool	hasArrowHead() const
virtual bool	intersectsWith(const RShape &shape) const
bool	isSplineShaped() const
virtual bool	isValid() const
virtual bool	mirror(const RLine &axis)
virtual bool	mirror(const RVector &axis1, const RVector &axis2)
virtual bool	move(const RVector &offset) Moves this entity by the given offset.
virtual bool	moveReferencePoint(const RVector &referencePoint, const RVector &targetPoint, Qt::KeyboardModifiers modifiers=Qt::NoModifier) Moves the given reference point to the given target point or does nothing if this entity has no reference point as the given location.
virtual bool	reverse()
virtual bool	rotate(double rotation, const RVector &center=RDEFAULT_RVECTOR)
virtual bool	scale(const RVector &scaleFactors, const RVector &center)
virtual void	scaleVisualProperties(double scaleFactor)
void	setArrowHead(bool on)
void	setDimasz(double v)
void	setDimLeaderBlockId(RObject::Id id)
void	setDimscale(double f)
void	setSplineShaped(bool on)
virtual void	setZ(double z)
virtual bool	stretch(const RPolyline &area, const RVector &offset) Stretches the end points of this entity that are inside area by offset.
virtual void	to2D()
virtual void	update() const Entities can reimplement this function to invalidate any internal cache (mark the entity as dirty).
bool	updateArrowHead() const

Protected Functions

	RLeaderData(RDocument *document, const RLeaderData &data)

Private Attributes

bool	arrowHead Arrow head on / off.
double	dimasz Arrow size.
RObject::Id	dimLeaderBlockId Block to use instead of arrow.
double	dimscale Dimension scale.
bool	splineShaped Spline shaped leader.

Friends

class	RLeaderEntity

Member Documentation

RLeaderData

RLeaderData::RLeaderData()

All rights reserved.

This file is part of the QCAD project.

QCAD is free software: you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation, either version 3 of the License, or (at your option) any later version.

QCAD is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details.

You should have received a copy of the GNU General Public License along with QCAD.

RLeaderData

RLeaderData::RLeaderData(const RPolyline &polyline, bool arrowHead)

appendVertex

void RLeaderData::appendVertex(const RVector &vertex)

inline

canHaveArrowHead

bool RLeaderData::canHaveArrowHead() const

const

Returns: true if this leader can have an arrow head (i.e. first segment is >= DIMASZ * DIMSCALE * 2.

castToShape

virtual RShape * RLeaderData::castToShape()

virtual inline

Reimplemented from castToShape.

clearStyleOverrides

void RLeaderData::clearStyleOverrides()

inline

countSegments

int RLeaderData::countSegments() const

inline const

countVertices

int RLeaderData::countVertices() const

inline const

flipHorizontal

virtual bool RLeaderData::flipHorizontal()

virtual inline

Reimplemented from flipHorizontal.

flipVertical

virtual bool RLeaderData::flipVertical()

virtual inline

Reimplemented from flipVertical.

getArcReferencePoints

virtual QList< RVector > RLeaderData::getArcReferencePoints(const RBox &queryBox=RDEFAULT_RBOX) const

virtual inline const

Returns: Vector of reference points of this entity. Used for snap to reference points.

Reimplemented from getArcReferencePoints.

getArrowShape

RTriangle RLeaderData::getArrowShape() const

const

getBoundingBox

virtual RBox RLeaderData::getBoundingBox(bool ignoreEmpty=false) const

virtual inline const

Returns: The bounding box that contains this entity.

Reimplemented from getBoundingBox.

getCenterPoints

virtual QList< RVector > RLeaderData::getCenterPoints(const RBox &queryBox=RDEFAULT_RBOX, QList< RObject::Id > *subEntityIds=NULL) const

virtual inline const

Returns: Vector of center points of this entity. Used for snap to center points.

Reimplemented from getCenterPoints.

getDimasz

double RLeaderData::getDimasz(bool scale=true) const

const

getDimLeaderBlockId

RObject::Id RLeaderData::getDimLeaderBlockId() const

const

getDimscale

double RLeaderData::getDimscale() const

const

getDistanceTo

virtual double RLeaderData::getDistanceTo(const RVector &point, bool limited=true, double range=0.0, bool draft=false, double strictRange=RMAXDOUBLE) const

virtual inline const

Returns: The shortest distance from this entity to the given point.

Parameters:

• limited: Limit lines, arcs at end points, otherwise the orthogonal distance to the unlimited line / circle is returned.
• range: This is returned for solid filled entities (solid filled or dense hatches, text entities) if the point is on the entity and the distance would be zero.
• draft: Calculate based on draft mode representation of the entity.
• strictRange: If limited, this is the maximum range from either end point of the entity. Zero to only return distances that are strictly orthogonal to the entity.

Reimplemented from getDistanceTo.

getEndPoint

virtual RVector RLeaderData::getEndPoint() const

virtual inline const

Reimplemented from getEndPoint.

getEndPoints

virtual QList< RVector > RLeaderData::getEndPoints(const RBox &queryBox=RDEFAULT_RBOX, QList< RObject::Id > *subEntityIds=NULL) const

virtual inline const

Returns: Vector of end points of this entity. Used for snap to end points.

Reimplemented from getEndPoints.

getExploded

virtual QList< QSharedPointer< RShape > > RLeaderData::getExploded(int segments=RDEFAULT_MIN1) const

virtual inline const

Returns: List of RLines and RArcs describing this polyline.

Reimplemented from getExploded.

getIntersectionPoints

virtual QList< RVector > RLeaderData::getIntersectionPoints(const REntityData &other, bool limited=true, bool same=false, const RBox &queryBox=RDEFAULT_RBOX, bool ignoreComplex=true, QList< QPair< RObject::Id, RObject::Id > > *entityIds=NULL) const

virtual inline const

Returns: Points on entity which are intersection points with the given other entity. If same is true, the two datas originate from the same entity.

Reimplemented from getIntersectionPoints.

getIntersectionPoints

virtual QList< RVector > RLeaderData::getIntersectionPoints(const RShape &shape, bool limited=true, const RBox &queryBox=RDEFAULT_RBOX, bool ignoreComplex=true) const

virtual inline const

Returns: Points on entity which are intersection points with the given shape.

Reimplemented from getIntersectionPoints.

getMiddlePoints

virtual QList< RVector > RLeaderData::getMiddlePoints(const RBox &queryBox=RDEFAULT_RBOX, QList< RObject::Id > *subEntityIds=NULL) const

virtual inline const

Returns: Vector of middle points of this entity. Used for snap to middle points.

Reimplemented from getMiddlePoints.

getPointsWithDistanceToEnd

virtual QList< RVector > RLeaderData::getPointsWithDistanceToEnd(double distance, int from=RS::FromAny, const RBox &queryBox=RDEFAULT_RBOX, QList< RObject::Id > *subEntityIds=NULL) const

virtual inline const

Returns: Points on entity with given distance to either endpoint. Used for snap to points with distance on entity.

Reimplemented from getPointsWithDistanceToEnd.

getReferencePoints

virtual QList< RRefPoint > RLeaderData::getReferencePoints(RS::ProjectionRenderingHint hint=RS::RenderTop) const

virtual const

Returns: Vector of reference points of this entity. Reference points can usually be moved around by the user to change the geometry of the entity.

Reimplemented from getReferencePoints.

getShapes

virtual QList< QSharedPointer< RShape > > RLeaderData::getShapes(const RBox &queryBox=RDEFAULT_RBOX, bool ignoreComplex=false, bool segment=false, QList< RObject::Id > *entityIds=NULL) const

virtual const

Returns: Shapes that represent the geometry of this entity.

Parameters:

• queryBox: Limit returned shapes to query box
• ignoreComplex: Ignore complex shapes and explode those into simple shapes
• segment: Split up splines into spline segments

Reimplemented from getShapes.

getStartPoint

virtual RVector RLeaderData::getStartPoint() const

virtual inline const

Reimplemented from getStartPoint.

getType

virtual RS::EntityType RLeaderData::getType() const

virtual inline const

Reimplemented from getType.

getVectorTo

virtual RVector RLeaderData::getVectorTo(const RVector &point, bool limited=true, double strictRange=RMAXDOUBLE) const

virtual inline const

Returns: The distance vector from this entity to the given point.

Parameters:

• point: the point to which the distance was measured
• limited: If true, an invalid vector is returned if the closest point on the entity is outside of the entity (e.g. in the extension line of a line or outside the start / end angle of an arc).

Reimplemented from getVectorTo.

hasArrowHead

bool RLeaderData::hasArrowHead() const

inline const

intersectsWith

virtual bool RLeaderData::intersectsWith(const RShape &shape) const

virtual inline const

Returns: True if this entity intersects with the given shape, false otherwise.

Reimplemented from intersectsWith.

isSplineShaped

bool RLeaderData::isSplineShaped() const

inline const

isValid

virtual bool RLeaderData::isValid() const

virtual inline const

Reimplemented from isValid.

mirror

virtual bool RLeaderData::mirror(const RLine &axis)

virtual inline

Reimplemented from mirror.

mirror

virtual bool RLeaderData::mirror(const RVector &axis1, const RVector &axis2)

virtual inline

Reimplemented from mirror.

move

virtual bool RLeaderData::move(const RVector &offset)

virtual inline

Moves this entity by the given offset.

Reimplemented from move.

moveReferencePoint

virtual bool RLeaderData::moveReferencePoint(const RVector &referencePoint, const RVector &targetPoint, Qt::KeyboardModifiers modifiers=Qt::NoModifier)

virtual

Moves the given reference point to the given target point or does nothing if this entity has no reference point as the given location.

Returns: True if a reference point has been moved successfully, false otherwise.

Reimplemented from moveReferencePoint.

reverse

virtual bool RLeaderData::reverse()

virtual inline

Reimplemented from reverse.

rotate

virtual bool RLeaderData::rotate(double rotation, const RVector &center=RDEFAULT_RVECTOR)

virtual inline

Reimplemented from rotate.

scale

virtual bool RLeaderData::scale(const RVector &scaleFactors, const RVector &center)

virtual

Reimplemented from scale.

scaleVisualProperties

virtual void RLeaderData::scaleVisualProperties(double scaleFactor)

virtual

Reimplemented from scaleVisualProperties.

setArrowHead

void RLeaderData::setArrowHead(bool on)

setDimasz

void RLeaderData::setDimasz(double v)

setDimLeaderBlockId

void RLeaderData::setDimLeaderBlockId(RObject::Id id)

setDimscale

void RLeaderData::setDimscale(double f)

setSplineShaped

void RLeaderData::setSplineShaped(bool on)

inline

setZ

virtual void RLeaderData::setZ(double z)

virtual inline

Reimplemented from setZ.

stretch

virtual bool RLeaderData::stretch(const RPolyline &area, const RVector &offset)

virtual

Stretches the end points of this entity that are inside area by offset.

Reimplemented from stretch.

to2D

virtual void RLeaderData::to2D()

virtual inline

Reimplemented from to2D.

update

virtual void RLeaderData::update() const

virtual const

Entities can reimplement this function to invalidate any internal cache (mark the entity as dirty).

Reimplemented from update.

updateArrowHead

bool RLeaderData::updateArrowHead() const

const

RLeaderData

RLeaderData::RLeaderData(RDocument *document, const RLeaderData &data)

protected

arrowHead

bool RLeaderData::arrowHead

private

Arrow head on / off.

dimasz

double RLeaderData::dimasz

private

Arrow size.

dimLeaderBlockId

RObject::Id RLeaderData::dimLeaderBlockId

private

Block to use instead of arrow.

dimscale

double RLeaderData::dimscale

private

Dimension scale.

splineShaped

bool RLeaderData::splineShaped

private

Spline shaped leader.

RLeaderEntity

friend class RLeaderEntity

private