QCAD
Open Source 2D CAD
RPolyline Class Reference

Low-level mathematical representation of an open polyline or closed polyline (= polygon). More...

#include <RPolyline.h>

Inheritance diagram for RPolyline:
RShape RExplodable RDirected RLeaderData RPolylineData RSolidData RTraceData

Public Member Functions

void appendShape (const RShape &shape, bool prepend=false)
 
void appendVertex (const RVector &vertex, double bulge=0.0)
 
void clear ()
 
virtual RPolylineclone () const
 
bool contains (const RVector &point, bool borderIsInside=false, double tolerance=RS::PointTolerance) const
 Checks if the given point is inside this closed polygon. More...
 
int countSegments () const
 
int countVertices () const
 
virtual double getAngleAt (double distance, RS::From from=RS::FromStart) const
 
virtual RBox getBoundingBox () const
 
double getBulgeAt (int i) const
 
QList< double > getBulges () const
 
virtual QList< RVectorgetCenterPoints () const
 
virtual double getDirection1 () const
 
virtual double getDirection2 () const
 
virtual RVector getEndPoint () const
 
virtual QList< RVectorgetEndPoints () const
 
virtual QList< QSharedPointer< RShape > > getExploded (int segments=RDEFAULT_MIN1) const
 
RVector getLastVertex () const
 
virtual double getLength () const
 
virtual QList< RVectorgetMiddlePoints () const
 
RS::Orientation getOrientation () const
 
virtual QList< RVectorgetPointsWithDistanceToEnd (double distance, RS::From from=RS::FromAny) const
 
QSharedPointer< RShapegetSegmentAt (int i) const
 
virtual RVector getStartPoint () const
 
virtual QSharedPointer< RShapegetTransformed (const QTransform &transform) const
 
virtual RS::Ending getTrimEnd (const RVector &coord, const RVector &trimPoint)
 
virtual RVector getVectorTo (const RVector &point, bool limited=true, double strictRange=RMAXDOUBLE) const
 
RVector getVertexAt (int i) const
 
int getVertexIndex (const RVector &v, double tolerance=RS::PointTolerance) const
 
QList< RVectorgetVertices () const
 
bool hasArcSegments () const
 
void insertVertex (int index, const RVector &vertex)
 
bool isClosed () const
 
bool isGeometricallyClosed (double tolerance=RS::PointTolerance) 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 mirror (const RLine &axis)
 
virtual bool move (const RVector &offset)
 
void normalize ()
 
void prependShape (const RShape &shape)
 
void prependVertex (const RVector &vertex, double bulge=0.0)
 
void removeLastVertex ()
 
void removeVertex (int index)
 
virtual bool reverse ()
 
virtual bool rotate (double rotation, const RVector &center=RDEFAULT_RVECTOR)
 
 RPolyline ()
 Copyright (c) 2011-2015 by Andrew Mustun. More...
 
 RPolyline (const QList< RVector > &vertices, bool closed)
 Creates a polyline object with the given points. More...
 
 RPolyline (const QList< QSharedPointer< RShape > > &segments)
 Creates a polyline from segments (lines or arcs). More...
 
virtual bool scale (double scaleFactor, const RVector &center=RDEFAULT_RVECTOR)
 
virtual bool scale (const RVector &scaleFactors, const RVector &center=RDEFAULT_RVECTOR)
 
void setBulgeAt (int i, double b)
 
void setBulges (const QList< double > &b)
 
void setClosed (bool on)
 
void setVertexAt (int i, const RVector &v)
 
void setVertices (const QList< RVector > &vertices)
 
bool simplify (double angleTolerance=RS::AngleTolerance)
 
virtual bool stretch (const RPolyline &area, const RVector &offset)
 
virtual void to2D ()
 Flattens this shape to the X/Y plane. More...
 
RPainterPath toPainterPath () const
 
virtual void trimEndPoint (const RVector &p)
 
virtual void trimStartPoint (const RVector &p)
 
virtual ~RPolyline ()
 
- Public Member Functions inherited from RShape
void dump ()
 
virtual QList< RVectorfilterOnShape (const QList< RVector > &pointList, bool limited=true, double tolerance=RDEFAULT_TOLERANCE_1E_MIN4) const
 
virtual bool flipHorizontal ()
 
virtual bool flipVertical ()
 
virtual RVector getClosestPointOnShape (const RVector &p, bool limited=true, double strictRange=RMAXDOUBLE) const
 
virtual double getDistanceTo (const RVector &point, bool limited=true, double strictRange=RMAXDOUBLE) const
 
QList< RVectorgetIntersectionPoints (const RShape &other, bool limited=true, bool same=false, bool force=false) const
 
virtual RVector getPointAtPercent (double p) const
 
virtual RVector getVectorFromEndpointTo (const RVector &point) const
 
virtual bool intersectsWith (const RShape &other, bool limited=true) const
 
virtual bool isOnShape (const RVector &point, bool limited=true, double tolerance=RDEFAULT_TOLERANCE_1E_MIN4) const
 
 RShape ()
 
virtual bool stretch (const RBox &area, const RVector &offset)
 
virtual ~RShape ()
 
- Public Member Functions inherited from RExplodable
virtual ~RExplodable ()
 
- Public Member Functions inherited from RDirected
virtual double getDistanceFromStart (const RVector &p) const
 
virtual ~RDirected ()
 

Static Public Member Functions

static bool isStraight (double bulge)
 
- Static Public Member Functions inherited from RShape
static const RExplodablecastToExplodable (const RShape *shape)
 
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< RVectorgetIntersectionPointsXX (const RExplodable &explodable1, const RExplodable &explodable2, bool limited=true, bool same=false)
 
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...
 

Protected Member Functions

bool isLineSegment (int i) const
 
void print (QDebug dbg) const
 

Protected Attributes

QList< double > bulges
 
bool closed
 Getter function for this property: isClosed. More...
 
QList< RVectorvertices
 Getter function for this property: getVertices. More...
 

Detailed Description

Low-level mathematical representation of an open polyline or closed polyline (= polygon).

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

RPolyline::RPolyline ( )

Copyright (c) 2011-2015 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 polyline object without points.

RPolyline::RPolyline ( const QList< RVector > &  vertices,
bool  closed 
)

Creates a polyline object with the given points.

RPolyline::RPolyline ( const QList< QSharedPointer< RShape > > &  segments)

Creates a polyline from segments (lines or arcs).

RPolyline::~RPolyline ( )
virtual

Member Function Documentation

void RPolyline::appendShape ( const RShape shape,
bool  prepend = false 
)
void RPolyline::appendVertex ( const RVector vertex,
double  bulge = 0.0 
)
void RPolyline::clear ( )
virtual RPolyline* RPolyline::clone ( ) const
inlinevirtual

Implements RShape.

bool RPolyline::contains ( const RVector point,
bool  borderIsInside = false,
double  tolerance = RS::PointTolerance 
) const

Checks if the given point is inside this closed polygon.

If this polyline is not closed (

See also
setClosed), false is returned.
int RPolyline::countSegments ( ) const
Returns
Number of segments. The number of segments equals the number of vertices for a closed polyline and one less for an open polyline.
int RPolyline::countVertices ( ) const
double RPolyline::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 RPolyline::getBoundingBox ( ) const
virtual
Returns
The bounding box of this shape.

Implements RShape.

double RPolyline::getBulgeAt ( int  i) const
QList< double > RPolyline::getBulges ( ) const
QList< RVector > RPolyline::getCenterPoints ( ) const
virtual
Returns
The center point(s) of this shape.

Implements RShape.

double RPolyline::getDirection1 ( ) const
virtual

Implements RDirected.

Reimplemented in RPolylineData, and RSolidData.

double RPolyline::getDirection2 ( ) const
virtual

Implements RDirected.

Reimplemented in RPolylineData, and RSolidData.

RVector RPolyline::getEndPoint ( ) const
virtual

Implements RDirected.

Reimplemented in RPolylineData, RLeaderData, and RSolidData.

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

Implements RShape.

QList< QSharedPointer< RShape > > RPolyline::getExploded ( int  segments = RDEFAULT_MIN1) const
virtual
Returns
List of RLines and RArcs describing this polyline.

Implements RExplodable.

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

Implements RShape.

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

Implements RShape.

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

Implements RShape.

QSharedPointer< RShape > RPolyline::getSegmentAt ( int  i) const
Returns
Shape of segment at given position.
RVector RPolyline::getStartPoint ( ) const
virtual

Implements RDirected.

Reimplemented in RPolylineData, RLeaderData, and RSolidData.

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

Implements RShape.

RS::Ending RPolyline::getTrimEnd ( const RVector coord,
const RVector trimPoint 
)
virtual
Parameters
coordClicked coordinate
trimPointTrim start point or end point to this coordinate.

Implements RDirected.

Reimplemented in RSolidData.

RVector RPolyline::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.

RVector RPolyline::getVertexAt ( int  i) const
int RPolyline::getVertexIndex ( const RVector v,
double  tolerance = RS::PointTolerance 
) const
QList< RVector > RPolyline::getVertices ( ) const
bool RPolyline::hasArcSegments ( ) const
void RPolyline::insertVertex ( int  index,
const RVector vertex 
)
bool RPolyline::isClosed ( ) const
bool RPolyline::isGeometricallyClosed ( double  tolerance = RS::PointTolerance) const
virtual bool RPolyline::isInterpolated ( ) const
inlinevirtual

Reimplement and return true if this shape relies on interpolation for geometrical operations such as finding intersection points.

E.g. splines.

Reimplemented from RShape.

bool RPolyline::isLineSegment ( int  i) const
protected
Returns
True if the segment at the given position is a line.
bool RPolyline::isStraight ( double  bulge)
static
Returns
True if the given bulge indicates a straight line segment (i.e. is 0.0).
bool RPolyline::mirror ( const RLine axis)
virtual

Implements RShape.

bool RPolyline::move ( const RVector offset)
virtual

Implements RShape.

void RPolyline::normalize ( )
void RPolyline::prependShape ( const RShape shape)
void RPolyline::prependVertex ( const RVector vertex,
double  bulge = 0.0 
)
void RPolyline::print ( QDebug  dbg) const
protectedvirtual

Reimplemented from RShape.

void RPolyline::removeLastVertex ( )
void RPolyline::removeVertex ( int  index)
bool RPolyline::reverse ( )
virtual

Implements RDirected.

Reimplemented in RPolylineData, and RSolidData.

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

Implements RShape.

bool RPolyline::scale ( double  scaleFactor,
const RVector center = RDEFAULT_RVECTOR 
)
virtual

Reimplemented from RShape.

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

Implements RShape.

Reimplemented in RLeaderData.

void RPolyline::setBulgeAt ( int  i,
double  b 
)
void RPolyline::setBulges ( const QList< double > &  b)
void RPolyline::setClosed ( bool  on)
void RPolyline::setVertexAt ( int  i,
const RVector v 
)
void RPolyline::setVertices ( const QList< RVector > &  vertices)
bool RPolyline::simplify ( double  angleTolerance = RS::AngleTolerance)
bool RPolyline::stretch ( const RPolyline area,
const RVector offset 
)
virtual

Reimplemented from RShape.

Reimplemented in RLeaderData.

void RPolyline::to2D ( )
virtual

Flattens this shape to the X/Y plane.

Implements RShape.

RPainterPath RPolyline::toPainterPath ( ) const
Returns
A QPainterPath object that represents this polyline.
void RPolyline::trimEndPoint ( const RVector p)
virtual

Implements RDirected.

Reimplemented in RSolidData.

void RPolyline::trimStartPoint ( const RVector p)
virtual

Implements RDirected.

Reimplemented in RSolidData.

Member Data Documentation

QList<double> RPolyline::bulges
protected
bool RPolyline::closed
protected

Getter function for this property: isClosed.

Setter function for this property: setClosed

QList<RVector> RPolyline::vertices
protected

Getter function for this property: getVertices.

Setter function for this property: setVertices


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