RLinetypePattern

Class in Core Module
Header: #include <src/core/RLinetypePattern.h>

Description

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. Represents a linetype pattern which can be used to draw dashed graphical elements.

Scriptable: This class is available in script environments.

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

Public Functions

	RLinetypePattern()
	RLinetypePattern(bool metric, const QString &name, const QString &description)
	RLinetypePattern(bool metric, const QString &name, const QString &description, const QList< double > &dashes)
	RLinetypePattern(bool metric, const QString &name, const QString &description, int num…)
	RLinetypePattern(const RLinetypePattern &other)
	~RLinetypePattern()
double	getDashLengthAt(int i) const
double	getDashOffsetAt(const QList< double > &dashes, int i) const
double	getDelta(double pos) const
QString	getDescription() const
QString	getLabel() const
double	getLargestGap() const
QString	getName() const
bool	getNoOffset() const
int	getNumDashes() const
QList< double >	getPattern() const
double	getPatternLength() const
double	getPatternOffset(double length)
double	getPatternOffsetAt(double length, double symmetryPos, double *gap=NULL, bool end=false)
QString	getPatternString() const
QVector< qreal >	getScreenBasedLinetype()
double	getScreenScale() const
QList< RPainterPath >	getShapeAt(int i) const
QList< int >	getShapeIndices() const
int	getShapeNumberAt(int i) const
RVector	getShapeOffsetAt(int i) const
double	getShapeRotationAt(int i) const
double	getShapeScaleAt(int i) const
QString	getShapeTextAt(int i) const
QString	getShapeTextStyleAt(int i) const
QList< double >	getSymmetries() const
bool	hasDashAt(double pos) const
bool	hasShapeAt(int i) const
bool	hasShapeNumberAt(int i) const
bool	hasShapeOffsetAt(int i) const
bool	hasShapeRotationAt(int i) const
bool	hasShapes() const
bool	hasShapeScaleAt(int i) const
bool	hasShapeTextAt(int i) const
bool	hasShapeTextStyleAt(int i) const
bool	isLoaded()
bool	isMetric() const
bool	isValid() const
void	load()
bool	operator<(const RLinetypePattern &other) const
RLinetypePattern &	operator=(const RLinetypePattern &other)
bool	operator==(const RLinetypePattern &other) const
void	scale(double factor)
void	set(const QList< double > &dashes)
void	setDescription(const QString &d)
void	setMetric(bool on)
void	setName(const QString &n)
void	setNoOffset(bool n)
bool	setPatternString(const QString &patternString) Set pattern based on .lin formatted string.
void	setScreenScale(double s)
void	setShapeNumberAt(int i, int num)
void	setShapeOffsetAt(int i, const RVector &offset)
void	setShapeRotationAt(int i, double r)
void	setShapeScaleAt(int i, double s)
void	setShapeTextAt(int i, const QString &s)
void	setShapeTextStyleAt(int i, const QString &s)
void	updateShapes() Updates the painter paths for the shapes in this pattern.

Static Public Functions

static void	initNameMap()
static QList< QPair< QString, RLinetypePattern * > >	loadAllFrom(bool metric, const QString &fileName) Loads all linetype patterns in the given file into memory.

Private Attributes

QString	description
bool	metric
QString	name
bool	noOffset
QList< double >	pattern
QString	patternString
double	screenScale
QMap< int, int >	shapeNumbers
QMap< int, RVector >	shapeOffsets
QMap< int, double >	shapeRotations
QMap< int, QList< RPainterPath > >	shapes
QMap< int, double >	shapeScales
QMap< int, QString >	shapeTexts
QMap< int, QString >	shapeTextStyles
QList< double >	symmetries

Static Private Attributes

static QMap< QString, QString >	nameMap

Friends

class	RLinetype

Member Documentation

RLinetypePattern

RLinetypePattern::RLinetypePattern()

RLinetypePattern

RLinetypePattern::RLinetypePattern(bool metric, const QString &name, const QString &description)

RLinetypePattern

RLinetypePattern::RLinetypePattern(bool metric, const QString &name, const QString &description, const QList< double > &dashes)

RLinetypePattern

RLinetypePattern::RLinetypePattern(bool metric, const QString &name, const QString &description, int num...)

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

RLinetypePattern

RLinetypePattern::RLinetypePattern(const RLinetypePattern &other)

~RLinetypePattern

RLinetypePattern::~RLinetypePattern()

getDashLengthAt

double RLinetypePattern::getDashLengthAt(int i) const

const

getDashOffsetAt

double RLinetypePattern::getDashOffsetAt(const QList< double > &dashes, int i) const

const

getDelta

double RLinetypePattern::getDelta(double pos) const

const

Returns: Distance from start of pattern to

getDescription

QString RLinetypePattern::getDescription() const

const

getLabel

QString RLinetypePattern::getLabel() const

const

getLargestGap

double RLinetypePattern::getLargestGap() const

const

getName

QString RLinetypePattern::getName() const

const

getNoOffset

bool RLinetypePattern::getNoOffset() const

const

getNumDashes

int RLinetypePattern::getNumDashes() const

const

getPattern

QList< double > RLinetypePattern::getPattern() const

const

getPatternLength

double RLinetypePattern::getPatternLength() const

const

getPatternOffset

double RLinetypePattern::getPatternOffset(double length)

Returns: Offset to use to apply the given pattern to an entity of the given length that the pattern is symmetrical.

getPatternOffsetAt

double RLinetypePattern::getPatternOffsetAt(double length, double symmetryPos, double *gap=NULL, bool end=false)

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

Returns: Offset to use for an entity with the given length, so that the given dash (index) is in the middle of the entity.

getPatternString

QString RLinetypePattern::getPatternString() const

const

getScreenBasedLinetype

QVector< qreal > RLinetypePattern::getScreenBasedLinetype()

Returns: Line pattern that can be used for a QPen to render screen optimized patterns. Empty vector for continuous.

getScreenScale

double RLinetypePattern::getScreenScale() const

const

getShapeAt

QList< RPainterPath > RLinetypePattern::getShapeAt(int i) const

const

getShapeIndices

QList< int > RLinetypePattern::getShapeIndices() const

const

getShapeNumberAt

int RLinetypePattern::getShapeNumberAt(int i) const

const

getShapeOffsetAt

RVector RLinetypePattern::getShapeOffsetAt(int i) const

const

getShapeRotationAt

double RLinetypePattern::getShapeRotationAt(int i) const

const

getShapeScaleAt

double RLinetypePattern::getShapeScaleAt(int i) const

const

getShapeTextAt

QString RLinetypePattern::getShapeTextAt(int i) const

const

getShapeTextStyleAt

QString RLinetypePattern::getShapeTextStyleAt(int i) const

const

getSymmetries

QList< double > RLinetypePattern::getSymmetries() const

inline const

hasDashAt

bool RLinetypePattern::hasDashAt(double pos) const

const

hasShapeAt

bool RLinetypePattern::hasShapeAt(int i) const

const

hasShapeNumberAt

bool RLinetypePattern::hasShapeNumberAt(int i) const

const

hasShapeOffsetAt

bool RLinetypePattern::hasShapeOffsetAt(int i) const

const

hasShapeRotationAt

bool RLinetypePattern::hasShapeRotationAt(int i) const

const

hasShapes

bool RLinetypePattern::hasShapes() const

const

hasShapeScaleAt

bool RLinetypePattern::hasShapeScaleAt(int i) const

const

hasShapeTextAt

bool RLinetypePattern::hasShapeTextAt(int i) const

const

hasShapeTextStyleAt

bool RLinetypePattern::hasShapeTextStyleAt(int i) const

const

isLoaded

bool RLinetypePattern::isLoaded()

inline

isMetric

bool RLinetypePattern::isMetric() const

inline const

isValid

bool RLinetypePattern::isValid() const

const

load

void RLinetypePattern::load()

inline

operator<

bool RLinetypePattern::operator<(const RLinetypePattern &other) const

const

operator=

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

operator==

bool RLinetypePattern::operator==(const RLinetypePattern &other) const

const

scale

void RLinetypePattern::scale(double factor)

set

void RLinetypePattern::set(const QList< double > &dashes)

setDescription

void RLinetypePattern::setDescription(const QString &d)

setMetric

void RLinetypePattern::setMetric(bool on)

inline

setName

void RLinetypePattern::setName(const QString &n)

setNoOffset

void RLinetypePattern::setNoOffset(bool n)

setPatternString

bool RLinetypePattern::setPatternString(const QString &patternString)

Set pattern based on .lin formatted string.

e.g. “A,3.81,[TRACK1,ltypeshp.shx,S=6.35],3.81”

setScreenScale

void RLinetypePattern::setScreenScale(double s)

setShapeNumberAt

void RLinetypePattern::setShapeNumberAt(int i, int num)

setShapeOffsetAt

void RLinetypePattern::setShapeOffsetAt(int i, const RVector &offset)

setShapeRotationAt

void RLinetypePattern::setShapeRotationAt(int i, double r)

setShapeScaleAt

void RLinetypePattern::setShapeScaleAt(int i, double s)

setShapeTextAt

void RLinetypePattern::setShapeTextAt(int i, const QString &s)

setShapeTextStyleAt

void RLinetypePattern::setShapeTextStyleAt(int i, const QString &s)

updateShapes

void RLinetypePattern::updateShapes()

Updates the painter paths for the shapes in this pattern.

initNameMap

static void RLinetypePattern::initNameMap()

static

loadAllFrom

static QList< QPair< QString, RLinetypePattern * > > RLinetypePattern::loadAllFrom(bool metric, const QString &fileName)

static

Loads all linetype patterns in the given file into memory.

description

QString RLinetypePattern::description

private

metric

bool RLinetypePattern::metric

private

name

QString RLinetypePattern::name

private

noOffset

bool RLinetypePattern::noOffset

private

pattern

QList<double> RLinetypePattern::pattern

private

patternString

QString RLinetypePattern::patternString

private

screenScale

double RLinetypePattern::screenScale

private

shapeNumbers

QMap<int, int> RLinetypePattern::shapeNumbers

private

shapeOffsets

QMap<int, RVector> RLinetypePattern::shapeOffsets

private

shapeRotations

QMap<int, double> RLinetypePattern::shapeRotations

private

shapes

QMap<int, QList<RPainterPath> > RLinetypePattern::shapes

private

shapeScales

QMap<int, double> RLinetypePattern::shapeScales

private

shapeTexts

QMap<int, QString> RLinetypePattern::shapeTexts

private

shapeTextStyles

QMap<int, QString> RLinetypePattern::shapeTextStyles

private

symmetries

QList<double> RLinetypePattern::symmetries

private

nameMap

static QMap< QString, QString > RLinetypePattern::nameMap

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.

RLinetype

friend class RLinetype

private