RLineData

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

Description

Stores and manages all data that defines the geometry and appearance of a line entity.

Scriptable: This class is available in script environments.

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

Public Functions

	RLineData()
	RLineData(const RLine &line)
	RLineData(const RVector &startPoint, const RVector &endPoint)
virtual RShape *	castToShape()
virtual bool	flipHorizontal()
virtual bool	flipVertical()
double	getAngle() const
virtual QList< RVector >	getArcReferencePoints(const RBox &queryBox=RDEFAULT_RBOX) const
virtual RBox	getBoundingBox(bool ignoreEmpty) const
virtual QList< RVector >	getCenterPoints(const RBox &queryBox=RDEFAULT_RBOX, QList< RObject::Id > *subEntityIds=NULL) const
virtual double	getDirection1() const
virtual double	getDirection2() 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 RPolyline	getHull(double offset) 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
RLine	getLine()
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 RS::Side	getSideOfPoint(const RVector &point) const
virtual RVector	getStartPoint() const
virtual RS::Ending	getTrimEnd(const RVector &trimPoint, const RVector &clickPoint)
virtual RS::EntityType	getType() const
virtual RVector	getVectorTo(const RVector &point, bool limited=true, double strictRange=RMAXDOUBLE) const
virtual bool	intersectsWith(const RShape &shape) 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() Swaps start and end point, reversing the line direction.
virtual bool	rotate(double rotation, const RVector &center=RDEFAULT_RVECTOR)
virtual bool	scale(const RVector &scaleFactors, const RVector &center=RDEFAULT_RVECTOR)
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 bool	trimEndPoint(const RVector &trimPoint, const RVector &clickPoint=RVector::invalid, bool extend=false) Moves the end point to the closest point on the line to trimPoint.
virtual bool	trimStartPoint(const RVector &trimPoint, const RVector &clickPoint=RVector::invalid, bool extend=false) Moves the start point to the closest point on the line to trimPoint.

Protected Functions

	RLineData(RDocument *document, const RLineData &data)

Friends

class	RLineEntity

Member Documentation

RLineData

RLineData::RLineData()

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.

RLineData

RLineData::RLineData(const RLine &line)

RLineData

RLineData::RLineData(const RVector &startPoint, const RVector &endPoint)

castToShape

virtual RShape * RLineData::castToShape()

virtual inline

Reimplemented from castToShape.

flipHorizontal

virtual bool RLineData::flipHorizontal()

virtual inline

Reimplemented from flipHorizontal.

flipVertical

virtual bool RLineData::flipVertical()

virtual inline

Reimplemented from flipVertical.

getAngle

double RLineData::getAngle() const

inline const

getArcReferencePoints

virtual QList< RVector > RLineData::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.

getBoundingBox

virtual RBox RLineData::getBoundingBox(bool ignoreEmpty) const

virtual const

Returns: The bounding box that contains this entity.

Reimplemented from getBoundingBox.

getCenterPoints

virtual QList< RVector > RLineData::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.

getDirection1

virtual double RLineData::getDirection1() const

virtual inline const

Returns: Direction angle at the start of the line (start towards end, in rad).

Reimplemented from getDirection1.

getDirection2

virtual double RLineData::getDirection2() const

virtual inline const

Returns: Direction angle at the end of the line (end towards start, in rad).

Reimplemented from getDirection2.

getDistanceTo

virtual double RLineData::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 RLineData::getEndPoint() const

virtual inline const

Returns: End point of the line.

Reimplemented from getEndPoint.

getEndPoints

virtual QList< RVector > RLineData::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.

getHull

virtual RPolyline RLineData::getHull(double offset) const

virtual const

Returns: A polygon that contains this entity. Default implementation returns a polygon around the bounding box.

Reimplemented from getHull.

getIntersectionPoints

virtual QList< RVector > RLineData::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 > RLineData::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.

getLine

RLine RLineData::getLine()

inline

getMiddlePoints

virtual QList< RVector > RLineData::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 > RLineData::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 > RLineData::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 > > RLineData::getShapes(const RBox &queryBox=RDEFAULT_RBOX, bool ignoreComplex=false, bool segment=false, QList< RObject::Id > *entityIds=NULL) const

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

getSideOfPoint

virtual RS::Side RLineData::getSideOfPoint(const RVector &point) const

virtual inline const

Returns: Which side of the line the given point is on (LeftHand or RightHand), relative to the direction from start to end.

Reimplemented from getSideOfPoint.

getStartPoint

virtual RVector RLineData::getStartPoint() const

virtual inline const

Returns: Start point of the line.

Reimplemented from getStartPoint.

getTrimEnd

virtual RS::Ending RLineData::getTrimEnd(const RVector &trimPoint, const RVector &clickPoint)

virtual inline

Returns: Which end of the line to trim, based on where the click point is relative to the trim point. Returns EndingStart if the click is closer to the start direction.

Reimplemented from getTrimEnd.

getType

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

virtual inline const

Reimplemented from getType.

getVectorTo

virtual RVector RLineData::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.

intersectsWith

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

virtual inline const

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

Reimplemented from intersectsWith.

isValid

virtual bool RLineData::isValid() const

virtual inline const

Reimplemented from isValid.

mirror

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

virtual inline

Reimplemented from mirror.

mirror

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

virtual inline

Reimplemented from mirror.

move

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

virtual inline

Moves this entity by the given offset.

Reimplemented from move.

moveReferencePoint

virtual bool RLineData::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 RLineData::reverse()

virtual inline

Swaps start and end point, reversing the line direction.

Reimplemented from reverse.

rotate

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

virtual inline

Reimplemented from rotate.

scale

virtual bool RLineData::scale(const RVector &scaleFactors, const RVector &center=RDEFAULT_RVECTOR)

virtual inline

Reimplemented from scale.

setZ

virtual void RLineData::setZ(double z)

virtual inline

Reimplemented from setZ.

stretch

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

virtual inline

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

Reimplemented from stretch.

to2D

virtual void RLineData::to2D()

virtual inline

Reimplemented from to2D.

trimEndPoint

virtual bool RLineData::trimEndPoint(const RVector &trimPoint, const RVector &clickPoint=RVector::invalid, bool extend=false)

virtual inline

Moves the end point to the closest point on the line to trimPoint.

Reimplemented from trimEndPoint.

trimStartPoint

virtual bool RLineData::trimStartPoint(const RVector &trimPoint, const RVector &clickPoint=RVector::invalid, bool extend=false)

virtual inline

Moves the start point to the closest point on the line to trimPoint.

Reimplemented from trimStartPoint.

RLineData

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

protected

RLineEntity

friend class RLineEntity

private