QCAD
Open Source 2D CAD
 All Classes Files Functions Variables Typedefs Enumerations Enumerator Properties Friends Macros Groups Pages
REllipse Class Reference

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

#include <REllipse.h>

Inheritance diagram for REllipse:
RShape RDirected REllipseData

List of all members.

Public Member Functions

double angleToParam (double a) const
virtual REllipseclone () const
void correctMajorMinor ()
double getAngle () const
double getAngleLength (bool allowForZeroLength=false) const
virtual RBox getBoundingBox () const
QList< RVectorgetBoxCorners ()
RVector getCenter () const
virtual QList< RVectorgetCenterPoints () const
double getDirection1 () const
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
double getParamTo (const RVector &pos) const
RVector getPointAt (double angle) const
virtual QList< RVectorgetPointsWithDistanceToEnd (double distance, RS::From from=RS::FromAny) const
double getRadiusAt (double angle) const
double getRatio () 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 &coord, const RVector &trimPoint)
virtual RVector getVectorTo (const RVector &point, bool limited=true, double strictRange=RMAXDOUBLE) const
bool isCircular () const
bool isFullEllipse () 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 ()
 Copyright (c) 2011-2013 by Andrew Mustun.
 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.
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.
void setMinorPoint (const RVector &p)
 Sets the minor point relative to the center point.
void setRatio (double radius)
void setReversed (bool reversed)
void setStartAngle (double a)
void setStartParam (double startParam)
bool switchMajorMinor ()
virtual void to2D ()
 Flattens this shape to the X/Y plane.
virtual void trimEndPoint (const RVector &p)
virtual void trimStartPoint (const RVector &p)
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 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.
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 ()

Public Attributes

RVector center
 Getter function for this property: getCenter.
double endParam
 Getter function for this property: getEndParam.
RVector majorPoint
 Getter function for this property: getMajorPoint.
double ratio
 Getter function for this property: getRatio.
bool reversed
 Getter function for this property: isReversed.
double startParam
 Getter function for this property: getStartParam.

Protected Member Functions

virtual void print (QDebug dbg) const

Additional Inherited Members

- 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)
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.

Detailed Description

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

Scriptable:
This class is wrapped for script environments.
Shared Pointer Support:
Script wrappers of this class support wrapping in QSharedPointer.
Copyable:
Script wrappers of this class should pass objects by reference.
Stream Operator:
Script wrappers of this class use the stream operator for the output of toString().

Constructor & Destructor Documentation

REllipse::REllipse ( )

Copyright (c) 2011-2013 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 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
virtual REllipse* REllipse::clone ( ) const
inlinevirtual

Implements RShape.

void REllipse::correctMajorMinor ( )
double REllipse::getAngle ( ) const
Returns:
The rotation angle of this ellipse.

Reimplemented in REllipseData.

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

Reimplemented in REllipseData.

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.

double REllipse::getEndAngle ( ) const
double REllipse::getEndParam ( ) const

Reimplemented in REllipseData.

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

Reimplemented in REllipseData.

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.

Reimplemented in REllipseData.

double REllipse::getMajorRadius ( ) const
Returns:
The major radius of this ellipse.

Reimplemented in REllipseData.

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

Implements RShape.

RVector REllipse::getMinorPoint ( ) const
Returns:
Minor point relative to the center point.

Reimplemented in REllipseData.

double REllipse::getMinorRadius ( ) const
Returns:
The minor radius of this ellipse.
double REllipse::getParamTo ( const RVector pos) const
RVector REllipse::getPointAt ( double  angle) const
Returns:
Point on ellipse at given ellipse angle.

Reimplemented in REllipseData.

QList< RVector > REllipse::getPointsWithDistanceToEnd ( double  distance,
RS::From  from = RS::FromAny 
) const
virtual
Todo:
implement

Implements RShape.

double REllipse::getRadiusAt ( double  angle) const
Returns:
Radius of ellipse at given ellipse angle.
double REllipse::getRatio ( ) const

Reimplemented in REllipseData.

double REllipse::getSimpsonLength ( double  a1,
double  a2 
) const
Returns:
Length of the ellipse segment from angle a1 to angle a2.
double REllipse::getStartAngle ( ) const
double REllipse::getStartParam ( ) const

Reimplemented in REllipseData.

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.

Reimplemented in REllipseData.

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 coord,
const RVector trimPoint 
)
virtual
Parameters:
coordClicked coordinate
trimPointTrim start point or end point to this coordinate.

Implements RDirected.

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 treaded 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 REllipse::isCircular ( ) const
Returns:
True if minor radius and major radius are equal, i.e. ratio is 1.0.
bool REllipse::isFullEllipse ( ) const

Reimplemented in REllipseData.

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)
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.

Reimplemented in REllipseData.

void REllipse::setRatio ( double  radius)
void REllipse::setReversed ( bool  reversed)
void REllipse::setStartAngle ( double  a)
void REllipse::setStartParam ( double  startParam)
bool REllipse::switchMajorMinor ( )
void REllipse::to2D ( )
virtual

Flattens this shape to the X/Y plane.

Implements RShape.

void REllipse::trimEndPoint ( const RVector p)
virtual

Implements RDirected.

void REllipse::trimStartPoint ( const RVector p)
virtual

Implements RDirected.


Member Data Documentation

RVector REllipse::center

Getter function for this property: getCenter.

Setter function for this property: setCenter

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: