RPolyline Class Reference

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

#include <RPolyline.h>

Inheritance diagram for RPolyline:

List of all members.

Public Member Functions
void	appendShape (const RShape &shape)
void	appendVertex (const RVector &vertex, double bulge=0.0)
void	clear ()
virtual RPolyline *	clone () const
bool	contains (const RVector &point) const
	Checks if the given point is inside this closed polygon.
int	countSegments () const
int	countVertices () const
virtual bool	flipHorizontal ()
virtual bool	flipVertical ()
virtual RBox	getBoundingBox () const
double	getBulgeAt (int i) const
QList< double >	getBulges () const
virtual QList< RVector >	getCenterPoints () const
virtual double	getDirection1 () const
virtual double	getDirection2 () const
virtual RVector	getEndPoint () const
virtual QList< RVector >	getEndPoints () const
virtual QList< QSharedPointer < RShape > >	getExploded () const
RVector	getLastVertex () const
virtual double	getLength () const
virtual QList< RVector >	getMiddlePoints () const
virtual QList< RVector >	getPointsWithDistanceToEnd (double distance, RS::From from=RS::FromAny) const
QSharedPointer< RShape >	getSegmentAt (int i) const
virtual RVector	getStartPoint () const
virtual RS::Ending	getTrimEnd (const RVector &coord, const RVector &trimPoint)
virtual RVector	getVectorTo (const RVector &point, bool limited=true) const
RVector	getVertexAt (int i) const
QList< RVector >	getVertices () const
bool	hasArcSegments () const
void	insertVertex (int index, const RVector &vertex)
bool	isClosed () const
virtual bool	isInterpolated () const
	Reimplement and return true if this shape relies on interpolation for geometrical operations such as finding intersection points.
bool	isLogicallyClosed () const
virtual bool	mirror (const RLine &axis)
virtual bool	move (const RVector &offset)
void	normalize ()
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 ()
	Creates a polyline object without points.
	RPolyline (const QList< RVector > &vertices, bool closed)
	Creates a polyline object with the given points.
	RPolyline (const QList< QSharedPointer< RShape > > &segments)
	Creates a polyline from segments (lines or arcs).
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)
virtual bool	stretch (const RPolyline &area, const RVector &offset)
virtual void	to2D ()
	Flattens this shape to the X/Y plane.
QPainterPath	toPainterPath () const
virtual void	trimEndPoint (const RVector &p)
virtual void	trimStartPoint (const RVector &p)
virtual	~RPolyline ()
Public Member Functions inherited from RShape
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	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	~RDirected ()

Static Public Member Functions
static bool	isStraight (double bulge)
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.

Protected Member Functions
void	addToPainterPath (QPainterPath &pp, QSharedPointer< RShape > shape) const
bool	isLineSegment (int i) const
void	print (QDebug dbg) const

Protected Attributes
QList< double >	bulges
bool	closed
	Getter function for this property: isClosed.
QList< RVector >	vertices
	Getter function for this property: getVertices.

---

Detailed Description

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

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

RPolyline::RPolyline

(

)

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::addToPainterPath ( QPainterPath &  pp, QSharedPointer< RShape >  shape  ) const

protected

void RPolyline::appendShape

(

const RShape &

shape

)

void RPolyline::appendVertex	(	const RVector &	vertex,
		double	bulge = 0.0
	)

Reimplemented in RPolylineData.

void RPolyline::clear

(

)

Reimplemented in RPolylineData.

virtual RPolyline* RPolyline::clone ( ) const

inlinevirtual

Implements RShape.

bool RPolyline::contains

(

const RVector &

point

)

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.

Reimplemented in RPolylineData.

int RPolyline::countVertices

(

)

const

Reimplemented in RSolidData.

bool RPolyline::flipHorizontal ( )

virtual

Reimplemented from RShape.

bool RPolyline::flipVertical ( )

virtual

Reimplemented from RShape.

RBox RPolyline::getBoundingBox ( ) const

virtual

Returns:

The bounding box of this shape.

Implements RShape.

double RPolyline::getBulgeAt

(

int

i

)

const

Reimplemented in RPolylineData.

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

virtual

Returns:

List of RLines and RArcs describing this polyline.

Implements RExplodable.

Reimplemented in RPolylineData, and RLeaderData.

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.

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.

Reimplemented in RPolylineData.

RVector RPolyline::getStartPoint ( ) const

virtual

Implements RDirected.

Reimplemented in RPolylineData, RLeaderData, and RSolidData.

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

virtual

Parameters:

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

Implements RDirected.

Reimplemented in RSolidData.

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

RVector RPolyline::getVertexAt

(

int

i

)

const

Reimplemented in RPolylineData, and RSolidData.

QList< RVector > RPolyline::getVertices

(

)

const

Reimplemented in RPolylineData.

bool RPolyline::hasArcSegments

(

)

const

void RPolyline::insertVertex	(	int	index,
		const RVector &	vertex
	)

Reimplemented in RPolylineData.

bool RPolyline::isClosed

(

)

const

Reimplemented in RPolylineData.

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::isLogicallyClosed

(

)

const

Reimplemented in RPolylineData.

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

(

)

Reimplemented in RPolylineData.

void RPolyline::prependVertex	(	const RVector &	vertex,
		double	bulge = 0.0
	)

Reimplemented in RPolylineData.

void RPolyline::print ( QDebug  dbg ) const

protectedvirtual

Reimplemented from RShape.

void RPolyline::removeLastVertex

(

)

Reimplemented in RPolylineData.

void RPolyline::removeVertex

(

int

index

)

Reimplemented in RPolylineData.

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.

void RPolyline::setBulgeAt	(	int	i,
		double	b
	)

Reimplemented in RPolylineData.

void RPolyline::setBulges

(

const QList< double > &

b

)

void RPolyline::setClosed

(

bool

on

)

Reimplemented in RPolylineData.

void RPolyline::setVertexAt	(	int	i,
		const RVector &	v
	)

void RPolyline::setVertices

(

const QList< RVector > &

vertices

)

bool RPolyline::stretch ( const RPolyline &  area, const RVector &  offset  )

virtual

Reimplemented from RShape.

void RPolyline::to2D ( )

virtual

Flattens this shape to the X/Y plane.

Implements RShape.

QPainterPath 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:

• src/math/RPolyline.h
• src/math/RPolyline.cpp