RHatchData

Class in Entity Module
Header: #include <src/entity/RHatchData.h>
Inherits: REntityData, RPainterPathSource

Description

Stores and manages all data that defines the geometry and appearance of a hatch or solid fill entity.

Scriptable: This class is available in script environments.

Copyable: Objects are cleaned up automatically by the garbage collector of the script engine.

Public Functions

	RHatchData()
	RHatchData(bool solid, double scaleFactor, double angle, const QString &patternName)
	RHatchData(const RHatchData &other)
void	addBoundary(QSharedPointer< RShape > shape, bool addAutoLoops=true) Add a boundary shape to the current loop.
void	addBoundaryShape(QSharedPointer< RShape > shape, int loop)
void	autoCloseLoops()
void	cancelLoop()
virtual RShape *	castToShape()
void	clearBoundary()
void	clearCustomPattern()
void	clearGradient()
virtual bool	cloneOnChange() const Reimplement to force clone on change in transactions.
double	getAngle() const
double	getArea() const
bool	getAutoRegen() const
QList< QList< QSharedPointer< RShape > > >	getBoundary() const
QList< RPolyline >	getBoundaryAsPolylines(double segmentLength=RDEFAULT_MIN1) const
QPair< QSharedPointer< RShape >, QSharedPointer< RShape > >	getBoundaryElementsAt(int index, int &internalIndex) const
RPainterPath	getBoundaryPath(double pixelSizeHint=RDEFAULT_MIN1) const
virtual RBox	getBoundingBox(bool ignoreEmpty=false) const
virtual RColor	getColor() const
virtual RColor	getColor(bool resolve, const QStack< QSharedPointer< REntity > > &blockRefStack) const
virtual RColor	getColor(const RColor &unresolvedColor, const QStack< QSharedPointer< REntity > > &blockRefStack) const
int	getComplexity() const
RPattern	getCustomPattern() const
virtual double	getDistanceTo(const RVector &point, bool limited=true, double range=0.0, bool draft=false, double strictRange=RMAXDOUBLE) const
virtual QList< QSharedPointer< RShape > >	getExploded() const
double	getGradientAngle() const
RColor	getGradientColor1() const
RColor	getGradientColor2() const
QString	getGradientName() const
bool	getGradientOneColorMode() const
double	getGradientShift() const
double	getGradientTint() const
double	getLength() const
QList< QSharedPointer< RShape > >	getLoopBoundary(int index) const
int	getLoopCount() const
RVector	getOriginPoint() const
virtual QList< RPainterPath >	getPainterPaths(bool draft=false, double pixelSizeHint=RDEFAULT_MIN1) const
QString	getPatternName() const
virtual RVector	getPointOnEntity() const
virtual QList< RRefPoint >	getReferencePoints(RS::ProjectionRenderingHint hint=RS::RenderTop) const
double	getScale() const
virtual QList< QSharedPointer< RShape > >	getShapes(const RBox &queryBox=RDEFAULT_RBOX, bool ignoreComplex=false, bool segment=false, QList< RObject::Id > *entityIds=NULL) const
int	getTransparency() const
virtual RS::EntityType	getType() const
bool	hasCustomPattern() const
virtual bool	intersectsWith(const RShape &shape) const
bool	isGradient() const
bool	isSolid() const
bool	isWinding() const
virtual bool	mirror(const RLine &axis)
virtual bool	move(const RVector &offset) Moves this entity by the given offset.
virtual bool	moveReferencePoint(const RVector &referencePoint, const RVector &targetPoint, Qt::KeyboardModifiers modifiers=Qt::NoModifier) Moves the given reference point to the given target point or does nothing if this entity has no reference point as the given location.
void	newLoop()
RHatchData &	operator=(const RHatchData &other)
bool	order()
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)
void	setAutoRegen(bool on)
void	setCustomPattern(const RPattern &p)
void	setGradientAngle(double a)
void	setGradientColor1(const RColor &c)
void	setGradientColor2(const RColor &c)
void	setGradientName(const QString &n) Sets the gradient name and makes this hatch a gradient fill.
void	setGradientOneColorMode(bool on)
void	setGradientShift(double s)
void	setGradientTint(double t)
void	setOriginPoint(const RVector &op, bool clearCustom=true)
void	setPattern(const RPattern &p)
void	setPatternName(const QString &n)
void	setScale(double s)
void	setSolid(bool on)
void	setTransparency(int t)
void	setWinding(bool on)
virtual bool	stretch(const RPolyline &area, const RVector &offset) Stretches the end points of this entity that are inside area by offset.
virtual void	update() const Entities can reimplement this function to invalidate any internal cache (mark the entity as dirty).

Static Public Functions

static RHatchProxy *	getHatchProxy()
static bool	hasProxy()
static QString	normalizeGradientName(const QString &n)
static void	setHatchProxy(RHatchProxy *p)

Protected Functions

	RHatchData(RDocument *document, const RHatchData &data)
QBrush	createGradientBrush() const
QList< RLine >	getSegments(const RLine &line) const

Private Functions

bool	addWindingNumber(const int *edgeIndices, int count, double x, double y, int &windingNumber) const Accumulates the winding number contribution of the given range of edges, using the same scanline rules as QPainterPath::contains.
bool	isPointInBoundary(double x, double y) const
void	updateBoundaryBoxes() const Updates the cached bounding boxes of all boundary shapes.
void	updateBoundaryPointCache() const Updates the flattened representation of the boundary path which is used by isPointInBoundary().

Private Attributes

double	angle
bool	autoRegen
QList< QList< QSharedPointer< RShape > > >	boundary Hatch boundary, ordered by loops, in strictly defined order.
int	boundaryBandCount
QVector< int >	boundaryBandEdges
double	boundaryBandHeight
QVector< int >	boundaryBandStart
QVector< double >	boundaryBoxes Bounding box of every boundary shape, grown by the same tolerance the intersection code uses.
bool	boundaryBoxesValid
QVector< qint8 >	boundaryEdgeDirs
QVector< double >	boundaryEdges Flattened boundary (boundaryPath), used to determine whether a point is inside the hatch much faster than QPainterPath::contains can.
double	boundaryFlatteningError
QVector< int >	boundaryLongEdges
double	boundaryMaxX
double	boundaryMaxY
double	boundaryMinX
double	boundaryMinY
RPainterPath	boundaryPath
bool	boundaryPointCacheValid
bool	dirty
bool	gotDraft
double	gotPixelSizeHint
double	gradientAngle
RColor	gradientColor1
RColor	gradientColor2
QString	gradientName Gradient fill data (DXF/DWG compatible).
bool	gradientOneColorMode
double	gradientShift
double	gradientTint
RVector	originPoint
QList< RPainterPath >	painterPaths
RPattern	pattern Custom pattern loaded from DXF file, not LIN file.
QString	patternName
double	scaleFactor
bool	solid
int	transparency
bool	winding

Static Private Attributes

static RHatchProxy *	hatchProxy

Friends

class	RHatchEntity

Member Documentation

RHatchData

RHatchData::RHatchData()

RHatchData

RHatchData::RHatchData(bool solid, double scaleFactor, double angle, const QString &patternName)

Parameters:

• solid: True for a solid fill, false for a hatch pattern.
• scaleFactor: Scale factor of the hatch pattern.
• angle: Rotation angle of the hatch pattern.
• patternName: Name of the hatch pattern. “SOLID” for solid fills.

RHatchData

RHatchData::RHatchData(const RHatchData &other)

addBoundary

void RHatchData::addBoundary(QSharedPointer< RShape > shape, bool addAutoLoops=true)

Add a boundary shape to the current loop.

Parameters:

• addAutoLoops: True: create new loop if boundary does not connect. Otherwise add line segment on the fly (DXF/DWG import).

addBoundaryShape

void RHatchData::addBoundaryShape(QSharedPointer< RShape > shape, int loop)

inline

autoCloseLoops

void RHatchData::autoCloseLoops()

inline

cancelLoop

void RHatchData::cancelLoop()

castToShape

virtual RShape * RHatchData::castToShape()

virtual inline

Reimplemented from castToShape.

clearBoundary

void RHatchData::clearBoundary()

clearCustomPattern

void RHatchData::clearCustomPattern()

clearGradient

void RHatchData::clearGradient()

inline

cloneOnChange

virtual bool RHatchData::cloneOnChange() const

virtual inline const

Reimplement to force clone on change in transactions.

Reimplemented from cloneOnChange.

getAngle

double RHatchData::getAngle() const

inline const

getArea

double RHatchData::getArea() const

const

getAutoRegen

bool RHatchData::getAutoRegen() const

inline const

getBoundary

QList< QList< QSharedPointer< RShape > > > RHatchData::getBoundary() const

inline const

getBoundaryAsPolylines

QList< RPolyline > RHatchData::getBoundaryAsPolylines(double segmentLength=RDEFAULT_MIN1) const

const

getBoundaryElementsAt

QPair< QSharedPointer< RShape >, QSharedPointer< RShape > > RHatchData::getBoundaryElementsAt(int index, int &internalIndex) const

const

Non-Scriptable: This function is not available in script environments.

Returns: Pair of two shapes that connect to the vertex at the given index. The first shape connects with its end point, the second with its start point.

getBoundaryPath

RPainterPath RHatchData::getBoundaryPath(double pixelSizeHint=RDEFAULT_MIN1) const

const

Returns: Painter path that represents this hatch boundary.

getBoundingBox

virtual RBox RHatchData::getBoundingBox(bool ignoreEmpty=false) const

virtual const

Returns: The bounding box that contains this entity.

Reimplemented from getBoundingBox.

getColor

virtual RColor RHatchData::getColor() const

virtual inline const

Reimplemented from getColor.

getColor

virtual RColor RHatchData::getColor(bool resolve, const QStack< QSharedPointer< REntity > > &blockRefStack) const

virtual inline const

Returns: Color of this entity.

Parameters:

• resolve: Resolve color if ByLayer or ByBlock.

Reimplemented from getColor.

getColor

virtual RColor RHatchData::getColor(const RColor &unresolvedColor, const QStack< QSharedPointer< REntity > > &blockRefStack) const

virtual inline const

Reimplemented from getColor.

getComplexity

int RHatchData::getComplexity() const

const

getCustomPattern

RPattern RHatchData::getCustomPattern() const

inline const

getDistanceTo

virtual double RHatchData::getDistanceTo(const RVector &point, bool limited=true, double range=0.0, bool draft=false, double strictRange=RMAXDOUBLE) const

virtual const

Returns: The shortest distance from this entity to the given point.

Parameters:

• limited: Limit lines, arcs at end points, otherwise the orthogonal distance to the unlimited line / circle is returned.
• range: This is returned for solid filled entities (solid filled or dense hatches, text entities) if the point is on the entity and the distance would be zero.
• draft: Calculate based on draft mode representation of the entity.
• strictRange: If limited, this is the maximum range from either end point of the entity. Zero to only return distances that are strictly orthogonal to the entity.

Reimplemented from getDistanceTo.

getExploded

virtual QList< QSharedPointer< RShape > > RHatchData::getExploded() const

virtual const

getGradientAngle

double RHatchData::getGradientAngle() const

inline const

getGradientColor1

RColor RHatchData::getGradientColor1() const

inline const

getGradientColor2

RColor RHatchData::getGradientColor2() const

inline const

getGradientName

QString RHatchData::getGradientName() const

inline const

getGradientOneColorMode

bool RHatchData::getGradientOneColorMode() const

inline const

getGradientShift

double RHatchData::getGradientShift() const

inline const

getGradientTint

double RHatchData::getGradientTint() const

inline const

getLength

double RHatchData::getLength() const

const

getLoopBoundary

QList< QSharedPointer< RShape > > RHatchData::getLoopBoundary(int index) const

const

getLoopCount

int RHatchData::getLoopCount() const

inline const

getOriginPoint

RVector RHatchData::getOriginPoint() const

inline const

getPainterPaths

virtual QList< RPainterPath > RHatchData::getPainterPaths(bool draft=false, double pixelSizeHint=RDEFAULT_MIN1) const

virtual const

Parameters:

• pixelSizeHint: Pixel size hint for rendering arcs. Negative if it does not matter (current cached painter paths are returned).

Reimplemented from getPainterPaths.

getPatternName

QString RHatchData::getPatternName() const

inline const

getPointOnEntity

virtual RVector RHatchData::getPointOnEntity() const

virtual const

Returns: A point that is on the entity. Used to check if an entity is inside a polygon.

Reimplemented from getPointOnEntity.

getReferencePoints

virtual QList< RRefPoint > RHatchData::getReferencePoints(RS::ProjectionRenderingHint hint=RS::RenderTop) const

virtual const

Returns: Vector of reference points of this entity. Reference points can usually be moved around by the user to change the geometry of the entity.

Reimplemented from getReferencePoints.

getScale

double RHatchData::getScale() const

inline const

getShapes

virtual QList< QSharedPointer< RShape > > RHatchData::getShapes(const RBox &queryBox=RDEFAULT_RBOX, bool ignoreComplex=false, bool segment=false, QList< RObject::Id > *entityIds=NULL) const

virtual const

Returns: Shapes that represent the geometry of this entity.

Parameters:

• queryBox: Limit returned shapes to query box
• ignoreComplex: Ignore complex shapes and explode those into simple shapes
• segment: Split up splines into spline segments

Reimplemented from getShapes.

getTransparency

int RHatchData::getTransparency() const

inline const

getType

virtual RS::EntityType RHatchData::getType() const

virtual inline const

Reimplemented from getType.

hasCustomPattern

bool RHatchData::hasCustomPattern() const

inline const

intersectsWith

virtual bool RHatchData::intersectsWith(const RShape &shape) const

virtual const

Returns: True if this entity intersects with the given shape, false otherwise.

Reimplemented from intersectsWith.

isGradient

bool RHatchData::isGradient() const

inline const

Returns: True if this hatch is a gradient fill (gradient name set).

isSolid

bool RHatchData::isSolid() const

inline const

isWinding

bool RHatchData::isWinding() const

inline const

mirror

virtual bool RHatchData::mirror(const RLine &axis)

virtual

Reimplemented from mirror.

move

virtual bool RHatchData::move(const RVector &offset)

virtual

Moves this entity by the given offset.

Reimplemented from move.

moveReferencePoint

virtual bool RHatchData::moveReferencePoint(const RVector &referencePoint, const RVector &targetPoint, Qt::KeyboardModifiers modifiers=Qt::NoModifier)

virtual

Moves the given reference point to the given target point or does nothing if this entity has no reference point as the given location.

Returns: True if a reference point has been moved successfully, false otherwise.

Reimplemented from moveReferencePoint.

newLoop

void RHatchData::newLoop()

operator=

RHatchData & RHatchData::operator=(const RHatchData &other)

order

bool RHatchData::order()

rotate

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

virtual

Reimplemented from rotate.

scale

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

virtual

Reimplemented from scale.

setAngle

void RHatchData::setAngle(double a)

setAutoRegen

void RHatchData::setAutoRegen(bool on)

inline

setCustomPattern

void RHatchData::setCustomPattern(const RPattern &p)

inline

setGradientAngle

void RHatchData::setGradientAngle(double a)

inline

setGradientColor1

void RHatchData::setGradientColor1(const RColor &c)

inline

setGradientColor2

void RHatchData::setGradientColor2(const RColor &c)

inline

setGradientName

void RHatchData::setGradientName(const QString &n)

inline

Sets the gradient name and makes this hatch a gradient fill.

Valid names are LINEAR, CYLINDER, INVCYLINDER, SPHERICAL, INVSPHERICAL, HEMISPHERICAL, INVHEMISPHERICAL, CURVED, INVCURVED (CYLINDER and INVCYLINDER are cyclic gradients from color 1 to color 2 and back to color 1). AutoCAD resource names (GR_LINEAR, GR_CYLIN, GR_INVCYL, …) are accepted and normalized to the DXF names. An empty name means no gradient (regular hatch or solid fill).

setGradientOneColorMode

void RHatchData::setGradientOneColorMode(bool on)

inline

setGradientShift

void RHatchData::setGradientShift(double s)

inline

setGradientTint

void RHatchData::setGradientTint(double t)

inline

setOriginPoint

void RHatchData::setOriginPoint(const RVector &op, bool clearCustom=true)

inline

setPattern

void RHatchData::setPattern(const RPattern &p)

inline

setPatternName

void RHatchData::setPatternName(const QString &n)

inline

setScale

void RHatchData::setScale(double s)

setSolid

void RHatchData::setSolid(bool on)

inline

setTransparency

void RHatchData::setTransparency(int t)

inline

setWinding

void RHatchData::setWinding(bool on)

inline

stretch

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

virtual

Stretches the end points of this entity that are inside area by offset.

Reimplemented from stretch.

update

virtual void RHatchData::update() const

virtual const

Entities can reimplement this function to invalidate any internal cache (mark the entity as dirty).

Reimplemented from update.

getHatchProxy

static RHatchProxy * RHatchData::getHatchProxy()

static inline

Non-Scriptable: This function is not available in script environments.

hasProxy

static bool RHatchData::hasProxy()

static inline

normalizeGradientName

static QString RHatchData::normalizeGradientName(const QString &n)

static

Returns: Normalized gradient name: the canonical DXF name in upper case. Accepts DXF names (e.g. “CYLINDER”) as well as AutoCAD resource names (e.g. “GR_CYLIN”) as used by the AutoCAD gradient user interface.

setHatchProxy

static void RHatchData::setHatchProxy(RHatchProxy *p)

static inline

Non-Scriptable: This function is not available in script environments.

RHatchData

RHatchData::RHatchData(RDocument *document, const RHatchData &data)

protected

createGradientBrush

QBrush RHatchData::createGradientBrush() const

const protected

Returns: Gradient brush used to render this gradient fill. Approximates the AutoCAD gradient types (LINEAR, CYLINDER, SPHERICAL, HEMISPHERICAL, CURVED and their INV counterparts).

getSegments

QList< RLine > RHatchData::getSegments(const RLine &line) const

const protected

addWindingNumber

bool RHatchData::addWindingNumber(const int *edgeIndices, int count, double x, double y, int &windingNumber) const

const private

Accumulates the winding number contribution of the given range of edges, using the same scanline rules as QPainterPath::contains.

Returns: False if the point is too close to one of the edges to be classified reliably from the flattened boundary.

isPointInBoundary

bool RHatchData::isPointInBoundary(double x, double y) const

const private

Returns: True if the given point is inside the hatch boundary.

Equivalent to boundaryPath.contains(QPointF(x, y)) but based on the flattened, indexed boundary maintained by updateBoundaryPointCache(). Points which are too close to the boundary for the flattened representation to decide are handed to QPainterPath::contains.

updateBoundaryBoxes

void RHatchData::updateBoundaryBoxes() const

const private

Updates the cached bounding boxes of all boundary shapes.

The intersection code applies the same test but recalculates the bounding box of the shape for every single call. Since one hatch typically intersects every boundary element with hundreds of pattern lines, the bounding boxes are calculated once here instead.

updateBoundaryPointCache

void RHatchData::updateBoundaryPointCache() const

const private

Updates the flattened representation of the boundary path which is used by isPointInBoundary().

The boundary is flattened into line segments once and the segments are sorted into horizontal bands. Testing a point then only has to look at the few edges which cross the band the point is in, instead of at every element of the boundary path.

angle

double RHatchData::angle

private

autoRegen

bool RHatchData::autoRegen

private

boundary

QList<QList<QSharedPointer<RShape> > > RHatchData::boundary

private

Hatch boundary, ordered by loops, in strictly defined order.

boundaryBandCount

int RHatchData::boundaryBandCount

private

boundaryBandEdges

QVector<int> RHatchData::boundaryBandEdges

private

boundaryBandHeight

double RHatchData::boundaryBandHeight

private

boundaryBandStart

QVector<int> RHatchData::boundaryBandStart

private

boundaryBoxes

QVector<double> RHatchData::boundaryBoxes

private

Bounding box of every boundary shape, grown by the same tolerance the intersection code uses.

Cached to avoid recalculating the bounding box of every boundary element for every single hatch pattern line.

boundaryBoxesValid

bool RHatchData::boundaryBoxesValid

private

boundaryEdgeDirs

QVector<qint8> RHatchData::boundaryEdgeDirs

private

boundaryEdges

QVector<double> RHatchData::boundaryEdges

private

Flattened boundary (boundaryPath), used to determine whether a point is inside the hatch much faster than QPainterPath::contains can.

Four coordinates per edge (x1,y1,x2,y2 with y1<y2), the edges sorted into horizontal bands (CSR style: bandStart indexes into bandEdges).

boundaryFlatteningError

double RHatchData::boundaryFlatteningError

private

boundaryLongEdges

QVector<int> RHatchData::boundaryLongEdges

private

boundaryMaxX

double RHatchData::boundaryMaxX

private

boundaryMaxY

double RHatchData::boundaryMaxY

private

boundaryMinX

double RHatchData::boundaryMinX

private

boundaryMinY

double RHatchData::boundaryMinY

private

boundaryPath

RPainterPath RHatchData::boundaryPath

private

boundaryPointCacheValid

bool RHatchData::boundaryPointCacheValid

private

dirty

bool RHatchData::dirty

private

gotDraft

bool RHatchData::gotDraft

private

gotPixelSizeHint

double RHatchData::gotPixelSizeHint

private

gradientAngle

double RHatchData::gradientAngle

private

gradientColor1

RColor RHatchData::gradientColor1

private

gradientColor2

RColor RHatchData::gradientColor2

private

gradientName

QString RHatchData::gradientName

private

Gradient fill data (DXF/DWG compatible).

An empty gradient name means this hatch is not a gradient fill.

gradientOneColorMode

bool RHatchData::gradientOneColorMode

private

gradientShift

double RHatchData::gradientShift

private

gradientTint

double RHatchData::gradientTint

private

originPoint

RVector RHatchData::originPoint

private

painterPaths

QList<RPainterPath> RHatchData::painterPaths

private

pattern

RPattern RHatchData::pattern

private

Custom pattern loaded from DXF file, not LIN file.

Pattern is stored independent of pattern origin point.

patternName

QString RHatchData::patternName

private

scaleFactor

double RHatchData::scaleFactor

private

solid

bool RHatchData::solid

private

transparency

int RHatchData::transparency

private

winding

bool RHatchData::winding

private

hatchProxy

static RHatchProxy * RHatchData::hatchProxy = NULL

static private

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.

RHatchEntity

friend class RHatchEntity

private