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

#include <REllipse.h>

Inheritance diagram for REllipse:

Public Member Functions
double	angleToParam (double a) const
virtual REllipse *	clone () const
void	correctMajorMinor ()
double	getAngle () const
double	getAngleLength (bool allowForZeroLength=false) const
virtual RBox	getBoundingBox () const
QList< RVector >	getBoxCorners ()
RVector	getCenter () const
virtual QList< RVector >	getCenterPoints () const
double	getDirection1 () const
double	getDirection2 () const
double	getEndAngle () const
double	getEndParam () const
virtual RVector	getEndPoint () const
virtual QList< RVector >	getEndPoints () const
QList< RVector >	getFoci () const
double	getLength () const
RVector	getMajorPoint () const
double	getMajorRadius () const
virtual QList< RVector >	getMiddlePoints () const
RVector	getMinorPoint () const
double	getMinorRadius () const
double	getParamTo (const RVector &pos)
RVector	getPointAt (double angle)
virtual QList< RVector >	getPointsWithDistanceToEnd (double distance, RS::From from=RS::FromAny) const
double	getRadiusAt (double angle)
double	getRatio () const
double	getSimpsonLength (double f1, double f2) const
double	getStartAngle () const
double	getStartParam () const
virtual RVector	getStartPoint () const
double	getSweep () const
QList< RLine >	getTangents (const RVector &point) const
virtual RS::Ending	getTrimEnd (const RVector &coord, const RVector &trimPoint)
virtual RVector	getVectorTo (const RVector &point, bool limited=true) 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 ()
	Creates an ellipse shape with invalid.
	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
virtual bool	flipHorizontal ()
virtual bool	flipVertical ()
virtual RVector	getClosestPointOnShape (const RVector &p, bool limited=true) const
virtual double	getDistanceTo (const RVector &point, bool limited=true) const
QList< RVector >	getIntersectionPoints (const RShape &other, bool limited=true, bool same=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	~RDirected ()

Static Public Member Functions
static REllipse	createFromEquation (double a, double b, double c)
static REllipse	createInscribed (const QList< RVector > &quad)
Static Public Member Functions inherited from RShape
static QList< RVector >	getIntersectionPoints (const RShape &shape1, const RShape &shape2, bool limited=true, bool same=false)
static QList< RVector >	getIntersectionPointsAA (const RArc &arc1, const RArc &arc2, bool limited=true)
static QList< RVector >	getIntersectionPointsAC (const RArc &arc1, const RCircle &circle2, bool limited=true)
static QList< RVector >	getIntersectionPointsAE (const RArc &arc1, const REllipse &ellipse2, bool limited=true)
static QList< RVector >	getIntersectionPointsAX (const RArc &arc1, const RExplodable &explodable2, bool limited=true)
static QList< RVector >	getIntersectionPointsCC (const RCircle &circle1, const RCircle &circle2)
static QList< RVector >	getIntersectionPointsCE (const RCircle &circle1, const REllipse &ellipse2)
static QList< RVector >	getIntersectionPointsCX (const RCircle &circle1, const RExplodable &explodable2, bool limited=true)
static QList< RVector >	getIntersectionPointsEE (const REllipse &ellipse1, const REllipse &ellipse2)
static QList< RVector >	getIntersectionPointsEX (const REllipse &ellipse1, const RExplodable &explodable2, bool limited=true)
static QList< RVector >	getIntersectionPointsLA (const RLine &line1, const RArc &arc2, bool limited=true)
static QList< RVector >	getIntersectionPointsLC (const RLine &line1, const RCircle &circle2, bool limited=true)
static QList< RVector >	getIntersectionPointsLE (const RLine &line1, const REllipse &ellipse2, bool limited=true)
static QList< RVector >	getIntersectionPointsLL (const RLine &line1, const RLine &line2, bool limited=true)
static QList< RVector >	getIntersectionPointsLX (const RLine &line1, const RExplodable &explodable2, bool limited=true)
static QList< RVector >	getIntersectionPointsXX (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.

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

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

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

REllipse REllipse::createFromEquation	(	double	a,
		double	b,
		double	c
	)

static

REllipse REllipse::createInscribed ( const QList< RVector > & quad )

static

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.

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.

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 )

Reimplemented in REllipseData.

RVector REllipse::getPointAt ( double angle )

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

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.

QList< RLine > REllipse::getTangents ( const RVector & point ) const

RS::Ending REllipse::getTrimEnd	(	const RVector &	coord,
		const RVector &	trimPoint
	)

virtual

Parameters:

coord	Clicked coordiante
trimPoint	Trim start point or end point to this coordiante.

Implements RDirected.

RVector REllipse::getVectorTo	(	const RVector &	point,
		bool	limited = `true`
	)		const

virtual

Returns:: Shortest vector from this shape to the given point.

Parameters:

point	the given point
limited	If 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:

src/math/REllipse.h
src/math/REllipse.cpp

Public Member Functions

Static Public Member Functions

Public Attributes

Protected Member Functions

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation