QCAD
Open Source 2D CAD
RCircle Class Reference

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

#include <RCircle.h>

Inheritance diagram for RCircle:
RShape RCircleData

Public Member Functions

virtual RCircleclone () const
 
bool contains (const RVector &p) const
 
virtual bool flipHorizontal ()
 
virtual bool flipVertical ()
 
virtual double getAngleAt (double distance, RS::From from=RS::FromStart) const
 
double getArea () const
 
virtual RBox getBoundingBox () const
 
RVector getCenter () const
 
virtual QList< RVectorgetCenterPoints () const
 
double getCircumference () const
 
double getDiameter () const
 
virtual QList< RVectorgetEndPoints () const
 
virtual double getLength () const
 
virtual QList< RVectorgetMiddlePoints () const
 
virtual QList< QSharedPointer< RShape > > getOffsetShapes (double distance, int number, RS::Side side, const RVector &position=RVector::invalid)
 
RVector getPointAtAngle (double a) const
 
virtual QList< RVectorgetPointsWithDistanceToEnd (double distance, RS::From from=RS::FromAny) const
 
double getRadius () const
 
QList< RLinegetTangents (const RVector &point) const
 
virtual QSharedPointer< RShapegetTransformed (const QTransform &transform) const
 
virtual RShape::Type getType () const
 
virtual RVector getVectorTo (const RVector &point, bool limited=true, double strictRange=RMAXDOUBLE) const
 
bool isValid () const
 
virtual bool mirror (const RLine &axis)
 
virtual bool move (const RVector &offset)
 
 RCircle ()
 Copyright (c) 2011-2016 by Andrew Mustun. More...
 
 RCircle (double cx, double cy, const double radius)
 
 RCircle (const RVector &center, const double radius)
 
virtual bool rotate (double rotation, const RVector &center=RDEFAULT_RVECTOR)
 
virtual bool scale (const RVector &scaleFactors, const RVector &center=RDEFAULT_RVECTOR)
 
void setArea (double a)
 
void setCenter (const RVector &vector)
 
void setCircumference (double c)
 
void setDiameter (double d)
 
void setRadius (double radius)
 
virtual QList< QSharedPointer< RShape > > splitAt (const QList< RVector > &points) const
 
virtual void to2D ()
 Flattens this shape to the X/Y plane. More...
 
virtual ~RCircle ()
 
- 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 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 getPointWithDistanceToEnd (double distance)
 
virtual RVector getPointWithDistanceToStart (double distance)
 
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 bool stretch (const RPolyline &area, const RVector &offset)
 
virtual ~RShape ()
 

Static Public Member Functions

static RCircle createFrom2Points (const RVector &p1, const RVector &p2)
 
static RCircle createFrom3Points (const RVector &p1, const RVector &p2, const RVector &p3)
 
- 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...
 

Public Attributes

RVector center
 Getter function for this property: getCenter. More...
 
double radius
 Getter function for this property: getRadius. 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 Protected Attributes inherited from RShape
static int errorCode = 0
 

Detailed Description

Low-level mathematical representation of a circle.

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

RCircle::RCircle ( )

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 circle object with invalid center and 0 radius.

RCircle::RCircle ( double  cx,
double  cy,
const double  radius 
)
RCircle::RCircle ( const RVector center,
const double  radius 
)
RCircle::~RCircle ( )
virtual

Member Function Documentation

virtual RCircle* RCircle::clone ( ) const
inlinevirtual

Implements RShape.

bool RCircle::contains ( const RVector p) const
RCircle RCircle::createFrom2Points ( const RVector p1,
const RVector p2 
)
static
RCircle RCircle::createFrom3Points ( const RVector p1,
const RVector p2,
const RVector p3 
)
static
bool RCircle::flipHorizontal ( )
virtual

Reimplemented from RShape.

bool RCircle::flipVertical ( )
virtual

Reimplemented from RShape.

double RCircle::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.

double RCircle::getArea ( ) const
RBox RCircle::getBoundingBox ( ) const
virtual
Returns
The bounding box of this shape.

Implements RShape.

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

Implements RShape.

double RCircle::getCircumference ( ) const
double RCircle::getDiameter ( ) const
QList< RVector > RCircle::getEndPoints ( ) const
virtual
Returns
The end point(s) of this shape.

Implements RShape.

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

Implements RShape.

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

Implements RShape.

virtual QList<QSharedPointer<RShape> > RCircle::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.

RVector RCircle::getPointAtAngle ( double  a) const
QList< RVector > RCircle::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.

double RCircle::getRadius ( ) const
QList< RLine > RCircle::getTangents ( const RVector point) const
QSharedPointer< RShape > RCircle::getTransformed ( const QTransform &  transform) const
virtual

Implements RShape.

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

Reimplemented from RShape.

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

bool RCircle::isValid ( ) const
inline
bool RCircle::mirror ( const RLine axis)
virtual

Implements RShape.

bool RCircle::move ( const RVector offset)
virtual

Implements RShape.

void RCircle::print ( QDebug  dbg) const
protectedvirtual

Reimplemented from RShape.

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

Implements RShape.

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

Implements RShape.

void RCircle::setArea ( double  a)
void RCircle::setCenter ( const RVector vector)
void RCircle::setCircumference ( double  c)
void RCircle::setDiameter ( double  d)
void RCircle::setRadius ( double  radius)
QList< QSharedPointer< RShape > > RCircle::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.

void RCircle::to2D ( )
virtual

Flattens this shape to the X/Y plane.

Implements RShape.

Member Data Documentation

RVector RCircle::center

Getter function for this property: getCenter.

Setter function for this property: setCenter

double RCircle::radius

Getter function for this property: getRadius.

Setter function for this property: setRadius


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