Skip to content
Download QCAD
QCAD API Reference

RDimensionEntity

Class in Entity Module
Header: #include <src/entity/RDimensionEntity.h>
Inherits: REntity
Inherited by: RDimAngularEntity, RDimDiametricEntity, RDimLinearEntity, RDimOrdinateEntity, RDimRadialEntity

Description

Section titled “Description”

Base class for dimension entity classes.

Scriptable: This class is available in script environments.

Shared Pointer Support: Objects can be used in QSharedPointer.

Public Functions

Section titled “Public Functions”
RDimensionEntity(RDocument *document)
virtual ~RDimensionEntity()
void clearStyleOverrides()
virtual void exportEntity(RExporter &e, bool preview=false, bool forceSelected=false) const
Exports the entity to the given exporter.
virtual const RDimensionData & getData() const =0 = 0
virtual RDimensionData & getData()=0 = 0
RVector getDefinitionPoint() const
QString getDimBlockName() const
double getDimscale() const
double getExtLineFixLength() const
QString getFontName() const
double getLinearFactor() const
double getLineSpacingFactor() const
RS::TextLineSpacingStyle getLineSpacingStyle() const
QString getMeasurement(bool resolveAutoMeasurement=true) const
virtual QPair< QVariant, RPropertyAttributes > getProperty(RPropertyTypeId &propertyTypeId, bool humanReadable=false, bool noAttributes=false, bool showOnRequest=false)
QString getText() const
RTextData getTextData() const
RVector getTextPosition() const
double getTextRotation() const
bool hasCustomTextPosition() const
bool hasDimensionBlockReference() const
bool hasOverride(RS::KnownVariable key) const
bool isArrow1Flipped() const
bool isArrow2Flipped() const
bool isExtLineFix() const
void setArrow1Flipped(bool on)
void setArrow2Flipped(bool on)
void setCustomTextPosition(bool on)
void setDefinitionPoint(const RVector &p)
void setDimscale(double f)
void setExtLineFix(bool on)
void setExtLineFixLength(double v)
void setFontName(const QString &fn)
void setLinearFactor(double f)
virtual bool setProperty(RPropertyTypeId propertyTypeId, const QVariant &value, RTransaction *transaction=NULL)
Sets the given property to the given value.
void setText(const QString &t)
void setTextPosition(const RVector &p)
void updateBoundingBox(const RBox &b) const
void updateShapes(const QList< QSharedPointer< RShape > > &s) const
void updateTextData(const RTextData &d) const
void updateTextPositionCenter(const RVector &p) const

Static Public Functions

Section titled “Static Public Functions”
static QSet< QString > getDimensionBlockNames(RDocument *doc)
static RS::EntityType getRtti()
static QSet< RPropertyTypeId > getStaticPropertyTypeIds()
static void init()
static void renderDimensionText(RExporter &e, const RDocument *doc, RTextData &textData, bool isSelected=false, bool forceSelected=false)

Static Public Attributes

Section titled “Static Public Attributes”
static RPropertyTypeId PropertyArchTick
static RPropertyTypeId PropertyArrow1Flipped
static RPropertyTypeId PropertyArrow2Flipped
static RPropertyTypeId PropertyAutoLabel
static RPropertyTypeId PropertyAutoTextPos
static RPropertyTypeId PropertyBlock
static RPropertyTypeId PropertyColor
static RPropertyTypeId PropertyCustom
static RPropertyTypeId PropertyDefinitionPointX
static RPropertyTypeId PropertyDefinitionPointY
static RPropertyTypeId PropertyDefinitionPointZ
static RPropertyTypeId PropertyDimadec
static RPropertyTypeId PropertyDimasz
static RPropertyTypeId PropertyDimaunit
static RPropertyTypeId PropertyDimazin
static RPropertyTypeId PropertyDimBlockName
static RPropertyTypeId PropertyDimclrt
static RPropertyTypeId PropertyDimdec
static RPropertyTypeId PropertyDimdsep
static RPropertyTypeId PropertyDimexe
static RPropertyTypeId PropertyDimexo
static RPropertyTypeId PropertyDimgap
static RPropertyTypeId PropertyDimlfac
static RPropertyTypeId PropertyDimlunit
static RPropertyTypeId PropertyDimscale
static RPropertyTypeId PropertyDimtad
static RPropertyTypeId PropertyDimtih
static RPropertyTypeId PropertyDimtsz
static RPropertyTypeId PropertyDimtxt
static RPropertyTypeId PropertyDimzin
static RPropertyTypeId PropertyDisplayedColor
static RPropertyTypeId PropertyDrawOrder
static RPropertyTypeId PropertyExtLineFix
static RPropertyTypeId PropertyExtLineFixLength
static RPropertyTypeId PropertyFontName
static RPropertyTypeId PropertyHandle
static RPropertyTypeId PropertyLayer
static RPropertyTypeId PropertyLinetype
static RPropertyTypeId PropertyLinetypeScale
static RPropertyTypeId PropertyLineweight
static RPropertyTypeId PropertyLowerTolerance
static RPropertyTypeId PropertyMeasuredValue
static RPropertyTypeId PropertyMiddleOfTextX
static RPropertyTypeId PropertyMiddleOfTextY
static RPropertyTypeId PropertyMiddleOfTextZ
static RPropertyTypeId PropertyProtected
static RPropertyTypeId PropertyText
static RPropertyTypeId PropertyTextRotation
static RPropertyTypeId PropertyType
static RPropertyTypeId PropertyUpperTolerance
static RPropertyTypeId PropertyWorkingSet

Protected Functions

Section titled “Protected Functions”
virtual void print(QDebug dbg) const
Stream operator for QDebug.

Member Documentation

Section titled “Member Documentation”

RDimensionEntity

Section titled “RDimensionEntity”
RDimensionEntity::RDimensionEntity(RDocument *document)

~RDimensionEntity

Section titled “~RDimensionEntity”
virtual RDimensionEntity::~RDimensionEntity()

virtual

clearStyleOverrides

Section titled “clearStyleOverrides”
void RDimensionEntity::clearStyleOverrides()

inline

exportEntity

Section titled “exportEntity”
virtual void RDimensionEntity::exportEntity(RExporter &e, bool preview=false, bool forceSelected=false) const

virtual const

Exports the entity to the given exporter.

The exporter might be a file exporter, a graphics scene or any other platform one can export entities to.

Reimplemented from exportEntity.

getData

Section titled “getData”
virtual const RDimensionData & RDimensionEntity::getData() const =0 = 0

pure virtual const

Returns: Const reference to the data object of the entity.

Reimplemented from getData.

Reimplemented in getData, getData, getData, getData, getData, getData, getData, getData, getData, getData.

getData

Section titled “getData”
virtual RDimensionData & RDimensionEntity::getData()=0 = 0

pure virtual

Returns: Reference to the data object of the entity.

Reimplemented from getData.

Reimplemented in getData, getData, getData, getData, getData, getData, getData, getData, getData, getData.

getDefinitionPoint

Section titled “getDefinitionPoint”
RVector RDimensionEntity::getDefinitionPoint() const

inline const

getDimBlockName

Section titled “getDimBlockName”
QString RDimensionEntity::getDimBlockName() const

inline const

getDimscale

Section titled “getDimscale”
double RDimensionEntity::getDimscale() const

inline const

getExtLineFixLength

Section titled “getExtLineFixLength”
double RDimensionEntity::getExtLineFixLength() const

inline const

getFontName

Section titled “getFontName”
QString RDimensionEntity::getFontName() const

inline const

getLinearFactor

Section titled “getLinearFactor”
double RDimensionEntity::getLinearFactor() const

inline const

getLineSpacingFactor

Section titled “getLineSpacingFactor”
double RDimensionEntity::getLineSpacingFactor() const

inline const

getLineSpacingStyle

Section titled “getLineSpacingStyle”
RS::TextLineSpacingStyle RDimensionEntity::getLineSpacingStyle() const

inline const

getMeasurement

Section titled “getMeasurement”
QString RDimensionEntity::getMeasurement(bool resolveAutoMeasurement=true) const

inline const

getProperty

Section titled “getProperty”
virtual QPair< QVariant, RPropertyAttributes > RDimensionEntity::getProperty(RPropertyTypeId &propertyTypeId, bool humanReadable=false, bool noAttributes=false, bool showOnRequest=false)

virtual

Returns: The value and attributes of the given property or an invalid property if this property owner has no property with the given ID.

Reimplemented from getProperty.

Reimplemented in getProperty, getProperty, getProperty, getProperty, getProperty, getProperty, getProperty, getProperty, getProperty.

getText

Section titled “getText”
QString RDimensionEntity::getText() const

inline const

getTextData

Section titled “getTextData”
RTextData RDimensionEntity::getTextData() const

inline const

getTextPosition

Section titled “getTextPosition”
RVector RDimensionEntity::getTextPosition() const

inline const

getTextRotation

Section titled “getTextRotation”
double RDimensionEntity::getTextRotation() const

inline const

hasCustomTextPosition

Section titled “hasCustomTextPosition”
bool RDimensionEntity::hasCustomTextPosition() const

inline const

hasDimensionBlockReference

Section titled “hasDimensionBlockReference”
bool RDimensionEntity::hasDimensionBlockReference() const

inline const

hasOverride

Section titled “hasOverride”
bool RDimensionEntity::hasOverride(RS::KnownVariable key) const

inline const

isArrow1Flipped

Section titled “isArrow1Flipped”
bool RDimensionEntity::isArrow1Flipped() const

inline const

isArrow2Flipped

Section titled “isArrow2Flipped”
bool RDimensionEntity::isArrow2Flipped() const

inline const

isExtLineFix

Section titled “isExtLineFix”
bool RDimensionEntity::isExtLineFix() const

inline const

setArrow1Flipped

Section titled “setArrow1Flipped”
void RDimensionEntity::setArrow1Flipped(bool on)

inline

setArrow2Flipped

Section titled “setArrow2Flipped”
void RDimensionEntity::setArrow2Flipped(bool on)

inline

setCustomTextPosition

Section titled “setCustomTextPosition”
void RDimensionEntity::setCustomTextPosition(bool on)

inline

setDefinitionPoint

Section titled “setDefinitionPoint”
void RDimensionEntity::setDefinitionPoint(const RVector &p)

inline

setDimscale

Section titled “setDimscale”
void RDimensionEntity::setDimscale(double f)

inline

setExtLineFix

Section titled “setExtLineFix”
void RDimensionEntity::setExtLineFix(bool on)

inline

setExtLineFixLength

Section titled “setExtLineFixLength”
void RDimensionEntity::setExtLineFixLength(double v)

inline

setFontName

Section titled “setFontName”
void RDimensionEntity::setFontName(const QString &fn)

inline

setLinearFactor

Section titled “setLinearFactor”
void RDimensionEntity::setLinearFactor(double f)

inline

setProperty

Section titled “setProperty”
virtual bool RDimensionEntity::setProperty(RPropertyTypeId propertyTypeId, const QVariant &value, RTransaction *transaction=NULL)

virtual

Sets the given property to the given value.

If this property owner does not know a property with that ID, it is up to the property owner what happens. The property might be added into a list of dynamic properties or dropped.

Returns: True if the property owner was modified in any way, false otherwise.

Reimplemented from setProperty.

Reimplemented in setProperty, setProperty, setProperty, setProperty, setProperty, setProperty, setProperty, setProperty, setProperty.

setText

Section titled “setText”
void RDimensionEntity::setText(const QString &t)

inline

setTextPosition

Section titled “setTextPosition”
void RDimensionEntity::setTextPosition(const RVector &p)

inline

updateBoundingBox

Section titled “updateBoundingBox”
void RDimensionEntity::updateBoundingBox(const RBox &b) const

inline const

updateShapes

Section titled “updateShapes”
void RDimensionEntity::updateShapes(const QList< QSharedPointer< RShape > > &s) const

inline const

updateTextData

Section titled “updateTextData”
void RDimensionEntity::updateTextData(const RTextData &d) const

inline const

updateTextPositionCenter

Section titled “updateTextPositionCenter”
void RDimensionEntity::updateTextPositionCenter(const RVector &p) const

inline const

getDimensionBlockNames

Section titled “getDimensionBlockNames”
static QSet< QString > RDimensionEntity::getDimensionBlockNames(RDocument *doc)

static

Returns: All used dimension block names (upper case).

getRtti

Section titled “getRtti”
static RS::EntityType RDimensionEntity::getRtti()

static inline

getStaticPropertyTypeIds

Section titled “getStaticPropertyTypeIds”
static QSet< RPropertyTypeId > RDimensionEntity::getStaticPropertyTypeIds()

static inline

init

Section titled “init”
static void RDimensionEntity::init()

static

renderDimensionText

Section titled “renderDimensionText”
static void RDimensionEntity::renderDimensionText(RExporter &e, const RDocument *doc, RTextData &textData, bool isSelected=false, bool forceSelected=false)

static

PropertyArchTick

Section titled “PropertyArchTick”
static RPropertyTypeId RDimensionEntity::PropertyArchTick

static

PropertyArrow1Flipped

Section titled “PropertyArrow1Flipped”
static RPropertyTypeId RDimensionEntity::PropertyArrow1Flipped

static

PropertyArrow2Flipped

Section titled “PropertyArrow2Flipped”
static RPropertyTypeId RDimensionEntity::PropertyArrow2Flipped

static

PropertyAutoLabel

Section titled “PropertyAutoLabel”
static RPropertyTypeId RDimensionEntity::PropertyAutoLabel

static

PropertyAutoTextPos

Section titled “PropertyAutoTextPos”
static RPropertyTypeId RDimensionEntity::PropertyAutoTextPos

static

PropertyBlock

Section titled “PropertyBlock”
static RPropertyTypeId RDimensionEntity::PropertyBlock

static

PropertyColor

Section titled “PropertyColor”
static RPropertyTypeId RDimensionEntity::PropertyColor

static

PropertyCustom

Section titled “PropertyCustom”
static RPropertyTypeId RDimensionEntity::PropertyCustom

static

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.

PropertyDefinitionPointX

Section titled “PropertyDefinitionPointX”
static RPropertyTypeId RDimensionEntity::PropertyDefinitionPointX

static

PropertyDefinitionPointY

Section titled “PropertyDefinitionPointY”
static RPropertyTypeId RDimensionEntity::PropertyDefinitionPointY

static

PropertyDefinitionPointZ

Section titled “PropertyDefinitionPointZ”
static RPropertyTypeId RDimensionEntity::PropertyDefinitionPointZ

static

PropertyDimadec

Section titled “PropertyDimadec”
static RPropertyTypeId RDimensionEntity::PropertyDimadec

static

PropertyDimasz

Section titled “PropertyDimasz”
static RPropertyTypeId RDimensionEntity::PropertyDimasz

static

PropertyDimaunit

Section titled “PropertyDimaunit”
static RPropertyTypeId RDimensionEntity::PropertyDimaunit

static

PropertyDimazin

Section titled “PropertyDimazin”
static RPropertyTypeId RDimensionEntity::PropertyDimazin

static

PropertyDimBlockName

Section titled “PropertyDimBlockName”
static RPropertyTypeId RDimensionEntity::PropertyDimBlockName

static

PropertyDimclrt

Section titled “PropertyDimclrt”
static RPropertyTypeId RDimensionEntity::PropertyDimclrt

static

PropertyDimdec

Section titled “PropertyDimdec”
static RPropertyTypeId RDimensionEntity::PropertyDimdec

static

PropertyDimdsep

Section titled “PropertyDimdsep”
static RPropertyTypeId RDimensionEntity::PropertyDimdsep

static

PropertyDimexe

Section titled “PropertyDimexe”
static RPropertyTypeId RDimensionEntity::PropertyDimexe

static

PropertyDimexo

Section titled “PropertyDimexo”
static RPropertyTypeId RDimensionEntity::PropertyDimexo

static

PropertyDimgap

Section titled “PropertyDimgap”
static RPropertyTypeId RDimensionEntity::PropertyDimgap

static

PropertyDimlfac

Section titled “PropertyDimlfac”
static RPropertyTypeId RDimensionEntity::PropertyDimlfac

static

PropertyDimlunit

Section titled “PropertyDimlunit”
static RPropertyTypeId RDimensionEntity::PropertyDimlunit

static

PropertyDimscale

Section titled “PropertyDimscale”
static RPropertyTypeId RDimensionEntity::PropertyDimscale

static

PropertyDimtad

Section titled “PropertyDimtad”
static RPropertyTypeId RDimensionEntity::PropertyDimtad

static

PropertyDimtih

Section titled “PropertyDimtih”
static RPropertyTypeId RDimensionEntity::PropertyDimtih

static

PropertyDimtsz

Section titled “PropertyDimtsz”
static RPropertyTypeId RDimensionEntity::PropertyDimtsz

static

PropertyDimtxt

Section titled “PropertyDimtxt”
static RPropertyTypeId RDimensionEntity::PropertyDimtxt

static

PropertyDimzin

Section titled “PropertyDimzin”
static RPropertyTypeId RDimensionEntity::PropertyDimzin

static

PropertyDisplayedColor

Section titled “PropertyDisplayedColor”
static RPropertyTypeId RDimensionEntity::PropertyDisplayedColor

static

PropertyDrawOrder

Section titled “PropertyDrawOrder”
static RPropertyTypeId RDimensionEntity::PropertyDrawOrder

static

PropertyExtLineFix

Section titled “PropertyExtLineFix”
static RPropertyTypeId RDimensionEntity::PropertyExtLineFix

static

PropertyExtLineFixLength

Section titled “PropertyExtLineFixLength”
static RPropertyTypeId RDimensionEntity::PropertyExtLineFixLength

static

PropertyFontName

Section titled “PropertyFontName”
static RPropertyTypeId RDimensionEntity::PropertyFontName

static

PropertyHandle

Section titled “PropertyHandle”
static RPropertyTypeId RDimensionEntity::PropertyHandle

static

PropertyLayer

Section titled “PropertyLayer”
static RPropertyTypeId RDimensionEntity::PropertyLayer

static

PropertyLinetype

Section titled “PropertyLinetype”
static RPropertyTypeId RDimensionEntity::PropertyLinetype

static

PropertyLinetypeScale

Section titled “PropertyLinetypeScale”
static RPropertyTypeId RDimensionEntity::PropertyLinetypeScale

static

PropertyLineweight

Section titled “PropertyLineweight”
static RPropertyTypeId RDimensionEntity::PropertyLineweight

static

PropertyLowerTolerance

Section titled “PropertyLowerTolerance”
static RPropertyTypeId RDimensionEntity::PropertyLowerTolerance

static

PropertyMeasuredValue

Section titled “PropertyMeasuredValue”
static RPropertyTypeId RDimensionEntity::PropertyMeasuredValue

static

PropertyMiddleOfTextX

Section titled “PropertyMiddleOfTextX”
static RPropertyTypeId RDimensionEntity::PropertyMiddleOfTextX

static

PropertyMiddleOfTextY

Section titled “PropertyMiddleOfTextY”
static RPropertyTypeId RDimensionEntity::PropertyMiddleOfTextY

static

PropertyMiddleOfTextZ

Section titled “PropertyMiddleOfTextZ”
static RPropertyTypeId RDimensionEntity::PropertyMiddleOfTextZ

static

PropertyProtected

Section titled “PropertyProtected”
static RPropertyTypeId RDimensionEntity::PropertyProtected

static

PropertyText

Section titled “PropertyText”
static RPropertyTypeId RDimensionEntity::PropertyText

static

PropertyTextRotation

Section titled “PropertyTextRotation”
static RPropertyTypeId RDimensionEntity::PropertyTextRotation

static

PropertyType

Section titled “PropertyType”
static RPropertyTypeId RDimensionEntity::PropertyType

static

PropertyUpperTolerance

Section titled “PropertyUpperTolerance”
static RPropertyTypeId RDimensionEntity::PropertyUpperTolerance

static

PropertyWorkingSet

Section titled “PropertyWorkingSet”
static RPropertyTypeId RDimensionEntity::PropertyWorkingSet

static

print

Section titled “print”
virtual void RDimensionEntity::print(QDebug dbg) const

virtual const protected

Stream operator for QDebug.

Reimplemented from print.

Reimplemented in print, print, print, print, print, print, print, print, print, print.