QCAD
Open Source 2D CAD
REllipse Class Reference

Low-level mathematical representation of an ellipse or ellipse arc. More...

#include <REllipse.h>

Inheritance diagram for REllipse:
RShape RDirected REllipseData

Public Member Functions

double angleToParam (double a) const
 
QList< RSplineapproximateWithSplines () const
 
virtual REllipseclone () const
 
bool contains (const RVector &p) const
 
void correctMajorMinor ()
 
double getAngle () const
 
virtual double getAngleAt (double distance, RS::From from=RS::FromStart) const
 
double getAngleAtPoint (const RVector &pos) const
 
double getAngleLength (bool allowForZeroLength=false) const
 
virtual RBox getBoundingBox () const
 
QList< RVectorgetBoxCorners ()
 
RVector getCenter () const
 
virtual QList< RVectorgetCenterPoints () const
 
virtual double getDirection1 () const
 
virtual double getDirection2 () const
 
double getEndAngle () const
 
double getEndParam () const
 
virtual RVector getEndPoint () const
 
virtual QList< RVectorgetEndPoints () const
 
QList< RVectorgetFoci () const
 
double getLength () const
 
RVector getMajorPoint () const
 
double getMajorRadius () const
 
RVector getMiddlePoint () const
 
virtual QList< RVectorgetMiddlePoints () const
 
RVector getMinorPoint () const
 
double getMinorRadius () const
 
virtual QList< QSharedPointer< RShape > > getOffsetShapes (double distance, int number, RS::Side side, const RVector &position=RVector::invalid)
 
double getParamTo (const RVector &pos) const
 
RVector getPointAt (double param) const
 
virtual QList< RVectorgetPointsWithDistanceToEnd (double distance, RS::From from=RS::FromAny) const
 
double getRadiusAt (double param) const
 
double getRatio () const
 
virtual RS::Side getSideOfPoint (const RVector &point) const
 
double getSimpsonLength (double f1, double f2) const
 
double getStartAngle () const
 
double getStartParam () const
 
virtual RVector getStartPoint () const
 
double getSweep () const
 
QList< RLinegetTangents (const RVector &point) const
 
virtual QSharedPointer< RShapegetTransformed (const QTransform &transform) const
 
virtual RS::Ending getTrimEnd (const RVector &trimPoint, const RVector &clickPoint)
 
virtual RShape::Type getType () const
 
virtual RVector getVectorTo (const RVector &point, bool limited=true, double strictRange=RMAXDOUBLE) const
 
bool isAngleWithinArc (double a) const
 
bool isCircular () const
 
bool isFullEllipse () const
 
bool isParamWithinArc (double a) const
 
bool isReversed () const
 
bool isValid ()
 
virtual bool mirror (const RLine &axis)
 
virtual bool move (const RVector &offset)
 
void moveEndPoint (const RVector &pos, bool changeAngleOnly=false)
 
void moveStartPoint (const RVector &pos, bool changeAngleOnly=false)
 
 REllipse ()
 Creates an ellipse shape with invalid. More...
 
 REllipse (const RVector &center, const RVector &majorPoint, double ratio, double startParam, double endParam, bool reversed)
 
virtual bool reverse ()
 
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)
 Sets the rotation angle of this ellipse without changing the major radius. More...
 
void setCenter (const RVector &vector)
 
void setEndAngle (double a)
 
void setEndParam (double endParam)
 
void setMajorPoint (const RVector &vector)
 Sets the major point relative to the center point. More...
 
void setMinorPoint (const RVector &p)
 Sets the minor point relative to the center point. More...
 
void setRatio (double radius)
 
void setReversed (bool reversed)
 
void setStartAngle (double a)
 
void setStartParam (double startParam)
 
virtual QList< QSharedPointer< RShape > > splitAt (const QList< RVector > &points) const
 
bool switchMajorMinor ()
 
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 trimStartPoint (const RVector &trimPoint, const RVector &clickPoint=RVector::invalid, bool extend=false)
 
virtual ~REllipse ()
 
- 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 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 ()
 
- Public Member Functions inherited from RDirected
virtual double getDistanceFromStart (const RVector &p) const
 
virtual ~RDirected ()
 

Static Public Member Functions

static REllipseProxygetEllipseProxy ()
 
static bool hasProxy ()
 
static void setEllipseProxy (REllipseProxy *p)
 
- 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 endParam
 Getter function for this property: getEndParam. More...
 
RVector majorPoint
 Getter function for this property: getMajorPoint. More...
 
double ratio
 Getter function for this property: getRatio. More...
 
bool reversed
 Getter function for this property: isReversed. More...
 
double startParam
 Getter function for this property: getStartParam. More...
 

Protected Member Functions

virtual void print (QDebug dbg) const
 

Static Private Attributes

static REllipseProxyellipseProxy = NULL
 Copyright (c) 2011-2016 by Andrew Mustun. More...
 

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 an ellipse or ellipse arc.

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

REllipse::REllipse ( )

Creates an ellipse shape with invalid.

REllipse::REllipse ( const RVector center,
const RVector majorPoint,
double  ratio,
double  startParam,
double  endParam,
bool  reversed 
)
REllipse::~REllipse ( )
virtual

Member Function Documentation

double REllipse::angleToParam ( double  a) const
QList< RSpline > REllipse::approximateWithSplines ( ) const
virtual REllipse* REllipse::clone ( ) const
inlinevirtual

Implements RShape.

bool REllipse::contains ( const RVector p) const
void REllipse::correctMajorMinor ( )
double REllipse::getAngle ( ) const
Returns
The rotation angle of this ellipse.
double REllipse::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 REllipse::getAngleAtPoint ( const RVector pos) const
double REllipse::getAngleLength ( bool  allowForZeroLength = false) const
Returns
Angle length in rad.
RBox REllipse::getBoundingBox ( ) const
virtual
Returns
The bounding box of this shape.

Implements RShape.

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

Implements RShape.

double REllipse::getDirection1 ( ) const
virtual

Implements RDirected.

double REllipse::getDirection2 ( ) const
virtual

Implements RDirected.

static REllipseProxy* REllipse::getEllipseProxy ( )
inlinestatic
Non-Scriptable:
This function is not available in script environments.
double REllipse::getEndAngle ( ) const
Returns
End angle: the angle from the ellipse arc center to the ellipse arc end point.
double REllipse::getEndParam ( ) const
Returns
End parameter: the end angle of the circular arc resulting from transforming the ellipse into a circle.
RVector REllipse::getEndPoint ( ) const
virtual

Implements RDirected.

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

Implements RShape.

QList< RVector > REllipse::getFoci ( ) const
double REllipse::getLength ( ) const
virtual
Returns
Approximation for ellipse arc length.

Implements RShape.

Reimplemented in REllipseData.

RVector REllipse::getMajorPoint ( ) const
Returns
Major point relative to the center point.
double REllipse::getMajorRadius ( ) const
Returns
The major radius of this ellipse.
RVector REllipse::getMiddlePoint ( ) const
virtual

Implements RDirected.

QList< RVector > REllipse::getMiddlePoints ( ) const
virtual
Todo:
implement

Implements RShape.

RVector REllipse::getMinorPoint ( ) const
Returns
Minor point relative to the center point.
double REllipse::getMinorRadius ( ) const
Returns
The minor radius of this ellipse.
QList< QSharedPointer< RShape > > REllipse::getOffsetShapes ( double  distance,
int  number,
RS::Side  side,
const RVector position = RVector::invalid 
)
virtual
Returns
Array of spline shapes representing the parallel curves to this ellipse shape.

Reimplemented from RShape.

double REllipse::getParamTo ( const RVector pos) const
RVector REllipse::getPointAt ( double  param) const
Returns
Point on ellipse at given ellipse angle.
QList< RVector > REllipse::getPointsWithDistanceToEnd ( double  distance,
RS::From  from = RS::FromAny 
) const
virtual
Todo:
implement

Implements RShape.

double REllipse::getRadiusAt ( double  param) const
Returns
Radius of ellipse at given ellipse angle.
double REllipse::getRatio ( ) const
RS::Side REllipse::getSideOfPoint ( const RVector point) const
virtual

Implements RDirected.

double REllipse::getSimpsonLength ( double  a1,
double  a2 
) const
Returns
Length of the ellipse segment from angle a1 to angle a2.
double REllipse::getStartAngle ( ) const
Returns
Start angle: the angle from the ellipse arc center to the ellipse arc start point.
double REllipse::getStartParam ( ) const
Returns
Start parameter: the start angle of the circular arc resulting from transforming the ellipse into a circle.
RVector REllipse::getStartPoint ( ) const
virtual

Implements RDirected.

double REllipse::getSweep ( ) const
Returns
Arc sweep in rad. The sweep is the angle covered by this arc. Positive for ccw, negative for cw.
QList< RLine > REllipse::getTangents ( const RVector point) const
QSharedPointer< RShape > REllipse::getTransformed ( const QTransform &  transform) const
virtual

Implements RShape.

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

Implements RDirected.

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

Reimplemented from RShape.

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

static bool REllipse::hasProxy ( )
inlinestatic
bool REllipse::isAngleWithinArc ( double  a) const
inline
bool REllipse::isCircular ( ) const
Returns
True if minor radius and major radius are equal, i.e. ratio is 1.0.
bool REllipse::isFullEllipse ( ) const
bool REllipse::isParamWithinArc ( double  a) const
inline
bool REllipse::isReversed ( ) const
bool REllipse::isValid ( )
bool REllipse::mirror ( const RLine axis)
virtual

Implements RShape.

bool REllipse::move ( const RVector offset)
virtual

Implements RShape.

void REllipse::moveEndPoint ( const RVector pos,
bool  changeAngleOnly = false 
)
void REllipse::moveStartPoint ( const RVector pos,
bool  changeAngleOnly = false 
)
void REllipse::print ( QDebug  dbg) const
protectedvirtual

Reimplemented from RShape.

bool REllipse::reverse ( )
virtual

Implements RDirected.

Reimplemented in REllipseData.

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

Implements RShape.

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

Implements RShape.

void REllipse::setAngle ( double  a)

Sets the rotation angle of this ellipse without changing the major radius.

void REllipse::setCenter ( const RVector vector)
static void REllipse::setEllipseProxy ( REllipseProxy p)
inlinestatic
Non-Scriptable:
This function is not available in script environments.
void REllipse::setEndAngle ( double  a)
void REllipse::setEndParam ( double  endParam)
void REllipse::setMajorPoint ( const RVector vector)

Sets the major point relative to the center point.

void REllipse::setMinorPoint ( const RVector p)

Sets the minor point relative to the center point.

void REllipse::setRatio ( double  radius)
void REllipse::setReversed ( bool  reversed)
void REllipse::setStartAngle ( double  a)
void REllipse::setStartParam ( double  startParam)
QList< QSharedPointer< RShape > > REllipse::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 REllipse::switchMajorMinor ( )
void REllipse::to2D ( )
virtual

Flattens this shape to the X/Y plane.

Implements RShape.

bool REllipse::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.

Implements RDirected.

bool REllipse::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.

Implements RDirected.

Member Data Documentation

RVector REllipse::center

Getter function for this property: getCenter.

Setter function for this property: setCenter

REllipseProxy * REllipse::ellipseProxy = NULL
staticprivate

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.

double REllipse::endParam

Getter function for this property: getEndParam.

Setter function for this property: setEndParam

RVector REllipse::majorPoint

Getter function for this property: getMajorPoint.

Setter function for this property: setMajorPoint

double REllipse::ratio

Getter function for this property: getRatio.

Setter function for this property: setRatio

bool REllipse::reversed

Getter function for this property: isReversed.

Setter function for this property: setReversed

double REllipse::startParam

Getter function for this property: getStartParam.

Setter function for this property: setStartParam


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