QCAD
Open Source 2D CAD
RLine Class Reference

Low-level mathematical representation of a line. More...

#include <RLine.h>

Inheritance diagram for RLine:
RShape RLineData

Public Member Functions

void clipToXY (const RBox &box)
 
virtual RLineclone () const
 
virtual bool flipHorizontal ()
 
virtual bool flipVertical ()
 
double getAngle () const
 
virtual double getAngleAt (double distance, RS::From from=RS::FromStart) const
 
virtual RBox getBoundingBox () const
 
virtual QList< RVectorgetCenterPoints () const
 
virtual double getDirection1 () const
 
virtual double getDirection2 () const
 
virtual double getDistanceFromStart (const RVector &p) const
 
virtual RVector getEndPoint () const
 
virtual QList< RVectorgetEndPoints () const
 
double getLength () const
 
virtual RVector getMiddlePoint () const
 
virtual QList< RVectorgetMiddlePoints () const
 
virtual QList< QSharedPointer< RShape > > getOffsetShapes (double distance, int number, RS::Side side, const RVector &position=RVector::invalid)
 
virtual QList< RVectorgetPointsWithDistanceToEnd (double distance, int from=RS::FromAny) const
 
virtual RS::Side getSideOfPoint (const RVector &point) const
 
virtual RVector getStartPoint () const
 
virtual QSharedPointer< RShapegetTransformed (const QTransform &transform) const
 
virtual RS::Ending getTrimEnd (const RVector &trimPoint, const RVector &clickPoint)
 
virtual RShape::Type getType () const
 
virtual QList< RVectorgetVectorProperties () const
 
virtual RVector getVectorTo (const RVector &point, bool limited=true, double strictRange=RMAXDOUBLE) const
 
virtual bool isDirected () const
 
bool isHorizontal (double tolerance=RS::PointTolerance) const
 
bool isValid () const
 
bool isVertical (double tolerance=RS::PointTolerance) const
 
virtual bool mirror (const RLine &axis)
 
virtual bool move (const RVector &offset)
 
virtual bool reverse ()
 
 RLine ()
 Copyright (c) 2011-2016 by Andrew Mustun. More...
 
 RLine (double x1, double y1, double x2, double y2)
 
 RLine (const RVector &startPoint, const RVector &endPoint)
 Creates a line object with the given start and end point. More...
 
 RLine (const RVector &startPoint, double angle, double distance)
 
virtual bool rotate (double rotation, const RVector &center=RDEFAULT_RVECTOR)
 
virtual bool scale (const RVector &scaleFactors, const RVector &center=RDEFAULT_RVECTOR)
 
void setAngle (double a)
 
void setEndPoint (const RVector &vector)
 
void setLength (double l)
 
void setStartPoint (const RVector &vector)
 
virtual QList< QSharedPointer< RShape > > splitAt (const QList< RVector > &points) const
 
virtual bool stretch (const RPolyline &area, const RVector &offset)
 
virtual void to2D ()
 Flattens this shape to the X/Y plane. More...
 
virtual bool trimEndPoint (const RVector &trimPoint, const RVector &clickPoint=RVector::invalid, bool extend=false)
 
virtual bool trimEndPoint (double trimDist)
 
virtual bool trimStartPoint (const RVector &trimPoint, const RVector &clickPoint=RVector::invalid, bool extend=false)
 
virtual bool trimStartPoint (double trimDist)
 
virtual ~RLine ()
 
- Public Member Functions inherited from RShape
void dump ()
 
virtual bool equals (const RShape &other, double tolerance=RS::PointTolerance) const
 
virtual QList< RVectorfilterOnShape (const QList< RVector > &pointList, bool limited=true, double tolerance=RDEFAULT_TOLERANCE_1E_MIN4) const
 
virtual QList< bool > getBoolProperties () const
 
virtual RVector getClosestPointOnShape (const RVector &p, bool limited=true, double strictRange=RMAXDOUBLE) const
 
virtual QList< double > getDistancesFromStart (const RVector &p) const
 
virtual double getDistanceTo (const RVector &point, bool limited=true, double strictRange=RMAXDOUBLE) const
 
virtual QList< double > getDoubleProperties () const
 
QList< RVectorgetIntersectionPoints (const RShape &other, bool limited=true, bool same=false, bool force=false) const
 
virtual QList< int > getIntProperties () const
 
virtual RVector getPointAtPercent (double p) const
 
virtual RVector getPointWithDistanceToEnd (double distance)
 
virtual RVector getPointWithDistanceToStart (double distance)
 
virtual QList< RVectorgetSelfIntersectionPoints () const
 
virtual RVector getVectorFromEndpointTo (const RVector &point) const
 
virtual bool intersectsWith (const RShape &other, bool limited=true) const
 
virtual bool isInterpolated () const
 Reimplement and return true if this shape relies on interpolation for geometrical operations such as finding intersection points. More...
 
virtual bool isOnShape (const RVector &point, bool limited=true, double tolerance=RDEFAULT_TOLERANCE_1E_MIN4) const
 
 RShape ()
 
virtual bool scale (double scaleFactor, const RVector &center=RVector())
 
virtual bool stretch (const RBox &area, const RVector &offset)
 
virtual ~RShape ()
 

Public Attributes

RVector endPoint
 Getter function for this property: getEndPoint. More...
 
RVector startPoint
 Getter function for this property: getStartPoint. More...
 

Protected Member Functions

virtual void print (QDebug dbg) const
 

Additional Inherited Members

- Public Types inherited from RShape
enum  Type {
  Unknown = -1, Point = 0, Line = 1, Arc = 2,
  Circle = 3, Ellipse = 4, Polyline = 5, Spline = 6,
  Triangle = 7, XLine = 8, Ray = 9
}
 
- Static Public Member Functions inherited from RShape
static const RExplodablecastToExplodable (const RShape *shape)
 
static int getErrorCode ()
 
static QList< RVectorgetIntersectionPoints (const RShape &shape1, const RShape &shape2, bool limited=true, bool same=false, bool force=false)
 
static QList< RVectorgetIntersectionPointsAA (const RArc &arc1, const RArc &arc2, bool limited=true)
 
static QList< RVectorgetIntersectionPointsAC (const RArc &arc1, const RCircle &circle2, bool limited=true)
 
static QList< RVectorgetIntersectionPointsAE (const RArc &arc1, const REllipse &ellipse2, bool limited=true)
 
static QList< RVectorgetIntersectionPointsAS (const RArc &arc1, const RSpline &spline2, bool limited=true)
 
static QList< RVectorgetIntersectionPointsAT (const RArc &arc1, const RTriangle &triangle2, bool limited=true)
 
static QList< RVectorgetIntersectionPointsAX (const RArc &arc1, const RExplodable &explodable2, bool limited=true)
 
static QList< RVectorgetIntersectionPointsCC (const RCircle &circle1, const RCircle &circle2)
 
static QList< RVectorgetIntersectionPointsCE (const RCircle &circle1, const REllipse &ellipse2)
 
static QList< RVectorgetIntersectionPointsCS (const RCircle &circle1, const RSpline &spline2, bool limited=true)
 
static QList< RVectorgetIntersectionPointsCX (const RCircle &circle1, const RExplodable &explodable2, bool limited=true)
 
static QList< RVectorgetIntersectionPointsEE (const REllipse &ellipse1, const REllipse &ellipse2)
 Based on "Hughes and Chraibi (2011-2012), Calculating Ellipse Overlap Areas". More...
 
static QList< RVectorgetIntersectionPointsEE (const REllipse &ellipse1, const REllipse &ellipse2, bool limited)
 
static QList< RVectorgetIntersectionPointsES (const REllipse &ellipse1, const RSpline &spline2, bool limited=true)
 
static QList< RVectorgetIntersectionPointsEX (const REllipse &ellipse1, const RExplodable &explodable2, bool limited=true)
 
static QList< RVectorgetIntersectionPointsLA (const RLine &line1, const RArc &arc2, bool limited=true)
 
static QList< RVectorgetIntersectionPointsLA (const RLine &line1, const RArc &arc2, bool limited1, bool limited2)
 
static QList< RVectorgetIntersectionPointsLC (const RLine &line1, const RCircle &circle2, bool limited=true)
 
static QList< RVectorgetIntersectionPointsLE (const RLine &line1, const REllipse &ellipse2, bool limited=true)
 
static QList< RVectorgetIntersectionPointsLE (const RLine &line1, const REllipse &ellipse2, bool limited1, bool limited2)
 
static QList< RVectorgetIntersectionPointsLL (const RLine &line1, const RLine &line2, bool limited=true)
 
static QList< RVectorgetIntersectionPointsLL (const RLine &line1, const RLine &line2, bool limited1, bool limited2)
 
static QList< RVectorgetIntersectionPointsLS (const RLine &line1, const RSpline &spline2, bool limited=true)
 
static QList< RVectorgetIntersectionPointsLT (const RLine &line1, const RTriangle &triangle2, bool limited=true)
 
static QList< RVectorgetIntersectionPointsLT (const RLine &line1, const RTriangle &triangle2, bool limited1, bool limited2)
 
static QList< RVectorgetIntersectionPointsLX (const RLine &line1, const RExplodable &explodable2, bool limited=true)
 
static QList< RVectorgetIntersectionPointsSS (const RSpline &spline1, const RSpline &spline2, bool limited=true, bool same=false)
 
static QList< RVectorgetIntersectionPointsSX (const RSpline &spline1, const RExplodable &explodable2, bool limited)
 
static QList< RVectorgetIntersectionPointsXX (const RExplodable &explodable1, const RExplodable &explodable2, bool limited=true, bool same=false)
 
static QList< QSharedPointer< RShape > > getOffsetArcs (const RShape &shape, double distance, int number, RS::Side side, const RVector &position=RVector::invalid)
 
static QList< QSharedPointer< RShape > > getOffsetLines (const RShape &shape, double distance, int number, RS::Side side, const RVector &position=RVector::invalid)
 
static QList< QSharedPointer< RShape > > getReversedShapeList (const QList< QSharedPointer< RShape > > &shapes)
 
static bool isArcShape (const RShape &s)
 
static bool isCircleShape (const RShape &s)
 
static bool isEllipseShape (const RShape &s)
 
static bool isFullEllipseShape (const RShape &s)
 
static bool isLineShape (const RShape &s)
 
static bool isPointShape (const RShape &s)
 
static bool isPolylineShape (const RShape &s)
 
static bool isRayShape (const RShape &s)
 
static bool isSplineShape (const RShape &s)
 
static bool isTriangleShape (const RShape &s)
 
static bool isXLineShape (const RShape &s)
 
static bool order (QList< QList< QSharedPointer< RShape > > > &boundary)
 Orders the given list of loops into a list of closed loops in which all shapes are connected end to start point. More...
 
static QList< QSharedPointer< RShape > > trim (const RShape &trimShape, const RVector &trimClickPos, const RShape &limitingShape, const RVector &limitingClickPos, bool trimBoth, bool samePolyline)
 Trims a shape to another or two shapes to each other. More...
 
- Static Protected Attributes inherited from RShape
static int errorCode = 0
 

Detailed Description

Low-level mathematical representation of a line.

Scriptable:
This class is available in script environments.
Shared Pointer Support:
Objects can be used in QSharedPointer.
Copyable:
Objects are cleaned up automatically by the garbage collector of the script engine.
Stream Operator:
Object has a stream operator to present itself as string, for example when using toString() in a script.

Constructor & Destructor Documentation

RLine::RLine ( )

Copyright (c) 2011-2016 by Andrew Mustun.

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. Creates a line object with invalid start and end points.

RLine::RLine ( double  x1,
double  y1,
double  x2,
double  y2 
)
RLine::RLine ( const RVector startPoint,
const RVector endPoint 
)

Creates a line object with the given start and end point.

RLine::RLine ( const RVector startPoint,
double  angle,
double  distance 
)
RLine::~RLine ( )
virtual

Member Function Documentation

void RLine::clipToXY ( const RBox box)
virtual RLine* RLine::clone ( ) const
inlinevirtual

Implements RShape.

bool RLine::flipHorizontal ( )
virtual

Reimplemented from RShape.

bool RLine::flipVertical ( )
virtual

Reimplemented from RShape.

double RLine::getAngle ( ) const
double RLine::getAngleAt ( double  distance,
RS::From  from = RS::FromStart 
) const
virtual
Returns
Angle on the entity at the given distance from the start point.

Reimplemented from RShape.

RBox RLine::getBoundingBox ( ) const
virtual
Returns
The bounding box of this shape.

Implements RShape.

QList< RVector > RLine::getCenterPoints ( ) const
virtual
Returns
The center point(s) of this shape.

Implements RShape.

double RLine::getDirection1 ( ) const
virtual

Reimplemented from RShape.

Reimplemented in RLineData.

double RLine::getDirection2 ( ) const
virtual

Reimplemented from RShape.

Reimplemented in RLineData.

double RLine::getDistanceFromStart ( const RVector p) const
virtual
Returns
Distance of given point to start point of shape along shape.
Parameters
pPoint (assumed to be on shape).

Reimplemented from RShape.

RVector RLine::getEndPoint ( ) const
virtual

Reimplemented from RShape.

Reimplemented in RLineData.

QList< RVector > RLine::getEndPoints ( ) const
virtual
Returns
The end point(s) of this shape.

Implements RShape.

double RLine::getLength ( ) const
virtual
Returns
The total length of this shape if applicable or NaN if not.

Implements RShape.

RVector RLine::getMiddlePoint ( ) const
virtual

Reimplemented from RShape.

QList< RVector > RLine::getMiddlePoints ( ) const
virtual
Returns
The middle point(s) of this shape.

Implements RShape.

virtual QList<QSharedPointer<RShape> > RLine::getOffsetShapes ( double  distance,
int  number,
RS::Side  side,
const RVector position = RVector::invalid 
)
inlinevirtual
Returns
Parallels to this shape.
Parameters
distanceDistance of first parallel or concentric arc or circle.
numberNumber of offset shapes to generate.
sideSide, should be RS.LeftHand or RS.RightHand or RS.BothSides.
sidePositionPosition indicating what side of the shape the parallels should be.

Reimplemented from RShape.

QList< RVector > RLine::getPointsWithDistanceToEnd ( double  distance,
int  from = RS::FromAny 
) const
virtual
Returns
All points on this shape with the given distance to an endpoint.

Implements RShape.

RS::Side RLine::getSideOfPoint ( const RVector point) const
virtual

Reimplemented from RShape.

Reimplemented in RLineData.

RVector RLine::getStartPoint ( ) const
virtual

Reimplemented from RShape.

Reimplemented in RLineData.

QSharedPointer< RShape > RLine::getTransformed ( const QTransform &  transform) const
virtual

Implements RShape.

RS::Ending RLine::getTrimEnd ( const RVector trimPoint,
const RVector clickPoint 
)
virtual
Parameters
trimPointTrim start point or end point to this coordinate.
clickPointPoint that was clicked by user.

Reimplemented from RShape.

Reimplemented in RLineData.

virtual RShape::Type RLine::getType ( ) const
inlinevirtual

Reimplemented from RShape.

QList< RVector > RLine::getVectorProperties ( ) const
virtual

Reimplemented from RShape.

RVector RLine::getVectorTo ( const RVector point,
bool  limited = true,
double  strictRange = RMAXDOUBLE 
) const
virtual
Returns
Shortest vector from this shape to the given point.
Parameters
pointthe given point
limitedIf false, the shape is treated as an unlimited shape that extends in a logical way. For example an unlimited line for a line, full circle for an arc or a plane for a triangle.

Implements RShape.

virtual bool RLine::isDirected ( ) const
inlinevirtual

Reimplemented from RShape.

bool RLine::isHorizontal ( double  tolerance = RS::PointTolerance) const
Returns
True if the line is horizontal. If the start and end points of the line are identical, the line is both vertical and horizontal.
bool RLine::isValid ( ) const
bool RLine::isVertical ( double  tolerance = RS::PointTolerance) const
Returns
True if the line is vertical. If the start and end points of the line are identical, the line is both vertical and horizontal.
bool RLine::mirror ( const RLine axis)
virtual

Implements RShape.

bool RLine::move ( const RVector offset)
virtual

Implements RShape.

void RLine::print ( QDebug  dbg) const
protectedvirtual

Reimplemented from RShape.

bool RLine::reverse ( )
virtual

Reimplemented from RShape.

Reimplemented in RLineData.

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

Implements RShape.

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

Implements RShape.

void RLine::setAngle ( double  a)
void RLine::setEndPoint ( const RVector vector)
void RLine::setLength ( double  l)
void RLine::setStartPoint ( const RVector vector)
QList< QSharedPointer< RShape > > RLine::splitAt ( const QList< RVector > &  points) const
virtual
Returns
Array of shapes which represent the given shape split up at the given points.
Parameters
pointsArray of RVector, assumed to be on shape.

Reimplemented from RShape.

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

Reimplemented from RShape.

void RLine::to2D ( )
virtual

Flattens this shape to the X/Y plane.

Implements RShape.

bool RLine::trimEndPoint ( const RVector trimPoint,
const RVector clickPoint = RVector::invalid,
bool  extend = false 
)
virtual
Parameters
trimPointTrim start point or end point to this coordinate.
clickPointPoint that was clicked by user.
extendTrue if the shape is to be extended. Used for polylines to determine that the last segment has to be trimmed even if another segment was clicked.

Reimplemented from RShape.

Reimplemented in RLineData.

virtual bool RLine::trimEndPoint ( double  trimDist)
inlinevirtual

Reimplemented from RShape.

bool RLine::trimStartPoint ( const RVector trimPoint,
const RVector clickPoint = RVector::invalid,
bool  extend = false 
)
virtual
Parameters
trimPointTrim start point or end point to this coordinate.
clickPointPoint that was clicked by user.
extendTrue if the shape is to be extended. Used for polylines to determine that the first segment has to be trimmed even if another segment was clicked.

Reimplemented from RShape.

Reimplemented in RLineData.

virtual bool RLine::trimStartPoint ( double  trimDist)
inlinevirtual

Reimplemented from RShape.

Member Data Documentation

RVector RLine::endPoint

Getter function for this property: getEndPoint.

Setter function for this property: setEndPoint

RVector RLine::startPoint

Getter function for this property: getStartPoint.

Setter function for this property: setStartPoint


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