QCAD
Open Source 2D CAD
RTextBasedEntity Class Referenceabstract

Text entity. More...

#include <RTextBasedEntity.h>

Inheritance diagram for RTextBasedEntity:
REntity RObject RAttributeDefinitionEntity RAttributeEntity RTextEntity

Public Member Functions

virtual void exportEntity (RExporter &e, bool preview=false, bool forceSelected=false) const
 Exports the entity to the given exporter. More...
 
RVector getAlignmentPoint () const
 
double getAngle () const
 
virtual RTextBasedDatagetData ()=0
 
virtual const RTextBasedDatagetData () const =0
 
RS::TextDrawingDirection getDrawingDirection () const
 
QString getEscapedText (bool escapeUnicode=false) const
 
virtual QList< QSharedPointer< RShape > > getExploded () const
 
QString getFontName () const
 
RS::HAlign getHAlign () const
 
double getHeight () const
 
double getLineSpacingFactor () const
 
RS::TextLineSpacingStyle getLineSpacingStyle () const
 
QList< RPainterPathgetPainterPaths (bool draft=false) const
 
QString getPlainText () const
 
RVector getPosition () const
 
QPair< QVariant, RPropertyAttributesgetProperty (RPropertyTypeId &propertyTypeId, bool humanReadable=false, bool noAttributes=false)
 
virtual QList< QSharedPointer< RShape > > getShapes (const RBox &queryBox=RDEFAULT_RBOX, bool ignoreComplex=false) const
 
virtual RTextBasedDatagetTextData ()
 
double getTextHeight () const
 
double getTextWidth () const
 
virtual RS::EntityType getType () const
 
RS::VAlign getVAlign () const
 
double getWidth () const
 
double getXScale () const
 
bool isBold () const
 
bool isItalic () const
 
bool isSimple () const
 
 RTextBasedEntity (RDocument *document, RObject::Id objectId=RObject::INVALID_ID)
 
void setAlignmentPoint (const RVector &alignmentPoint)
 
void setAngle (double angle)
 
void setBold (bool on)
 
void setDrawingDirection (RS::TextDrawingDirection drawingDirection)
 
void setFontName (const QString &fontName)
 
void setHAlign (RS::HAlign ha)
 
void setItalic (bool on)
 
void setLineSpacingFactor (double lineSpacingFactor)
 
void setLineSpacingStyle (RS::TextLineSpacingStyle lineSpacingStyle)
 
void setPosition (const RVector &position)
 
bool setProperty (RPropertyTypeId propertyTypeId, const QVariant &value, RTransaction *transaction=NULL)
 Sets the given property to the given value. More...
 
void setSimple (bool on)
 
void setText (const QString &text)
 
void setTextHeight (double h)
 
void setVAlign (RS::VAlign va)
 
void setXScale (double xScale)
 
void sync (const RTextBasedEntity &other)
 
virtual ~RTextBasedEntity ()
 
- Public Member Functions inherited from REntity
virtual const RShapecastToConstShape () const
 
virtual RShapecastToShape ()
 
virtual REntityclone () const =0
 
void copyAttributesFrom (REntity *entity, bool copyBlockId=true)
 Copies all attributes (layer, block, color, line weight, line style) from the given entity. More...
 
virtual bool flipHorizontal ()
 
virtual bool flipVertical ()
 
RBlock::Id getBlockId () const
 
QString getBlockName () const
 
virtual RBox getBoundingBox (bool ignoreEmpty=false) const
 
virtual QList< RBoxgetBoundingBoxes (bool ignoreEmpty=false) const
 
virtual QList< RVectorgetCenterPoints (const RBox &queryBox=RDEFAULT_RBOX) const
 
virtual RVector getClosestPointOnEntity (const RVector &point, double range=RNANDOUBLE, bool limited=true) const
 
virtual QSharedPointer< RShapegetClosestShape (const RVector &pos, double range=RNANDOUBLE, bool ignoreComplex=false) const
 
virtual QSharedPointer< RShapegetClosestSimpleShape (const RVector &pos, double range=RNANDOUBLE) const
 
RColor getColor () const
 
RColor getColor (bool resolve, const QStack< REntity * > &blockRefStack)
 
virtual int getComplexity () const
 
virtual double getDistanceTo (const RVector &point, bool limited=true, double range=0.0, bool draft=false, double strictRange=RMAXDOUBLE) const
 
int getDrawOrder () const
 
virtual QList< RVectorgetEndPoints (const RBox &queryBox=RDEFAULT_RBOX) const
 
virtual RPolyline getHull (double offset) const
 
virtual QList< RVectorgetInternalReferencePoints (RS::ProjectionRenderingHint hint=RS::RenderTop) const
 Can be overwritten to return internal, resolved reference points. More...
 
virtual QList< RVectorgetIntersectionPoints (const REntity &other, bool limited=true, const RBox &queryBox=RDEFAULT_RBOX, bool ignoreComplex=true) const
 
virtual QList< RVectorgetIntersectionPoints (const RShape &shape, bool limited=true, const RBox &queryBox=RDEFAULT_RBOX, bool ignoreComplex=true) const
 
virtual QList< RVectorgetIntersectionPointsWithShape (const RShape &shape, bool limited=true, const RBox &queryBox=RDEFAULT_RBOX) const
 Make getIntersectionPoints with shape parameter accessible for script wrappers. More...
 
RLayer::Id getLayerId () const
 
QString getLayerName () const
 
RLinetype::Id getLinetypeId () const
 
RLinetype::Id getLinetypeId (bool resolve, const QStack< REntity * > &blockRefStack) const
 
RLinetypePattern getLinetypePattern () const
 
double getLinetypeScale () const
 
RLineweight::Lineweight getLineweight () const
 
RLineweight::Lineweight getLineweight (bool resolve, const QStack< REntity * > &blockRefStack) const
 
double getLineweightInUnits (const QStack< REntity * > &blockRefStack) const
 
virtual QList< RVectorgetMiddlePoints (const RBox &queryBox=RDEFAULT_RBOX) const
 
REntity::Id getParentId () const
 
virtual RVector getPointOnEntity () const
 
virtual QList< RVectorgetPointsWithDistanceToEnd (double distance, RS::From from=RS::FromAny, const RBox &queryBox=RDEFAULT_RBOX) const
 
virtual QList< RVectorgetReferencePoints (RS::ProjectionRenderingHint hint=RS::RenderTop) const
 
virtual RVector getVectorTo (const RVector &point, bool limited=true, double strictRange=RMAXDOUBLE) const
 
virtual bool intersectsWith (const RShape &shape) const
 
bool isEditable (bool allowInvisible=false) const
 
virtual bool isInside (const RBox &box) const
 
virtual bool isOnEntity (const RVector &point, bool limited=true, double tolerance=RDEFAULT_TOLERANCE_1E_MIN4) const
 
bool isSelected () const
 Reimplemented by entities that are part of a block reference but not stored as part of the block definition (currently only block attributes). More...
 
virtual bool isSelectedForPropertyEditing ()
 
bool isVisible () const
 
virtual bool mirror (const RLine &axis)
 
virtual bool mirror (const RVector &axis1, const RVector &axis2)
 
virtual bool move (const RVector &offset)
 Moves this entity by the given offset. More...
 
virtual bool moveReferencePoint (const RVector &referencePoint, const RVector &targetPoint)
 Moves the given reference point to the given target point or does nothing if this entity has no reference point as the given location. More...
 
 REntity (RDocument *document, Id objectId=-1)
 
virtual bool rotate (double rotation, const RVector &center=RDEFAULT_RVECTOR)
 
virtual bool scale (const RVector &scaleFactors, const RVector &center=RDEFAULT_RVECTOR)
 
virtual bool scale (double scaleFactor, const RVector &center=RDEFAULT_RVECTOR)
 
void setBlockId (RBlock::Id blockId)
 
void setColor (const RColor &color)
 
void setDocument (RDocument *document)
 
void setDrawOrder (int drawOrder)
 Sets the draw order of this entity. More...
 
void setLayerId (RLayer::Id layerId)
 
void setLinetypeId (RLinetype::Id linetypeId)
 
void setLinetypePattern (const RLinetypePattern &linetypePattern)
 
void setLinetypeScale (double linetypeScale)
 
void setLineweight (RLineweight::Lineweight lineweight)
 
void setParentId (REntity::Id parentId)
 
virtual void setSelected (bool on)
 Selects or deselects this entity. More...
 
virtual bool stretch (const RPolyline &area, const RVector &offset)
 Stretches the end points of this entity that are inside area by offset. More...
 
void update () const
 Entities can reimplement this function to invalidate any internal cache (mark the entity as dirty). More...
 
virtual ~REntity ()
 
- Public Member Functions inherited from RObject
void dump ()
 
QMap< QString, QVariantMap > getCustomProperties () const
 
QVariant getCustomProperty (const QString &title, const QString &key, const QVariant &defaultValue=RDEFAULT_QVARIANT)
 
QStringList getCustomPropertyKeys (const QString &title) const
 
QStringList getCustomPropertyTitles () const
 
virtual QSet< RPropertyTypeIdgetCustomPropertyTypeIds () const
 
RDocumentgetDocument ()
 
const RDocumentgetDocument () const
 
RObject::Handle getHandle () const
 
RObject::Id getId () const
 
virtual QSet< RPropertyTypeIdgetPropertyTypeIds () const
 
virtual bool hasPropertyType (RPropertyTypeId propertyTypeId)
 
bool isProtected () const
 
bool isUndone () const
 
void removeCustomProperty (const QString &title, const QString &key)
 Removes the custom property with the given name. More...
 
 RObject (RDocument *document=NULL, Id id=INVALID_ID)
 
void setCustomProperty (const QString &title, const QString &key, const QVariant &value)
 Sets a custom property with the given name. More...
 
void setDocument (RDocument *document)
 
void setProtected (bool on)
 
virtual void setUndone (bool on)
 
virtual ~RObject ()
 

Static Public Member Functions

static QSet< RPropertyTypeIdgetStaticPropertyTypeIds ()
 
static void init ()
 
- Static Public Member Functions inherited from REntity
static QSet< RPropertyTypeIdgetStaticPropertyTypeIds ()
 
static void init ()
 
static bool isComplex (const RS::EntityType type)
 
static bool isDimension (const RS::EntityType type)
 
- Static Public Member Functions inherited from RObject
static void init ()
 
template<class T >
static bool setMember (T &variable, const QVariant &value, bool condition=true)
 

Static Public Attributes

static RPropertyTypeId PropertyAngle
 
static RPropertyTypeId PropertyBlock
 
static RPropertyTypeId PropertyBold
 
static RPropertyTypeId PropertyColor
 
static RPropertyTypeId PropertyCustom
 Copyright (c) 2011-2015 by Andrew Mustun. More...
 
static RPropertyTypeId PropertyDrawOrder
 
static RPropertyTypeId PropertyFontName
 
static RPropertyTypeId PropertyHAlign
 
static RPropertyTypeId PropertyHandle
 
static RPropertyTypeId PropertyHeight
 
static RPropertyTypeId PropertyItalic
 
static RPropertyTypeId PropertyLayer
 
static RPropertyTypeId PropertyLineSpacingFactor
 
static RPropertyTypeId PropertyLinetype
 
static RPropertyTypeId PropertyLinetypeScale
 
static RPropertyTypeId PropertyLineweight
 
static RPropertyTypeId PropertyPlainText
 
static RPropertyTypeId PropertyPositionX
 
static RPropertyTypeId PropertyPositionY
 
static RPropertyTypeId PropertyPositionZ
 
static RPropertyTypeId PropertySimple
 
static RPropertyTypeId PropertyText
 
static RPropertyTypeId PropertyType
 
static RPropertyTypeId PropertyVAlign
 
static RPropertyTypeId PropertyXScale
 
- Static Public Attributes inherited from REntity
static RPropertyTypeId PropertyBlock
 
static RPropertyTypeId PropertyColor
 
static RPropertyTypeId PropertyCustom
 Copyright (c) 2011-2015 by Andrew Mustun. More...
 
static RPropertyTypeId PropertyDrawOrder
 
static RPropertyTypeId PropertyHandle
 
static RPropertyTypeId PropertyLayer
 
static RPropertyTypeId PropertyLinetype
 
static RPropertyTypeId PropertyLinetypeScale
 
static RPropertyTypeId PropertyLineweight
 
static RPropertyTypeId PropertyMaxX
 
static RPropertyTypeId PropertyMaxY
 
static RPropertyTypeId PropertyMinX
 
static RPropertyTypeId PropertyMinY
 
static RPropertyTypeId PropertyProtected
 
static RPropertyTypeId PropertySizeX
 
static RPropertyTypeId PropertySizeY
 
static RPropertyTypeId PropertyType
 
- Static Public Attributes inherited from RObject
static const Handle INVALID_HANDLE = -1
 
static const Id INVALID_ID = -1
 Copyright (c) 2011-2015 by Andrew Mustun. More...
 
static RPropertyTypeId PropertyCustom
 
static RPropertyTypeId PropertyHandle
 
static RPropertyTypeId PropertyProtected
 

Protected Member Functions

virtual void print (QDebug dbg) const
 Stream operator for QDebug. More...
 
- Protected Member Functions inherited from RObject
void setHandle (RObject::Handle h)
 
void setId (RObject::Id id)
 

Additional Inherited Members

- Public Types inherited from RObject
typedef int Handle
 
typedef int Id
 
enum  XYZ { X, Y, Z }
 
- Static Protected Member Functions inherited from RObject
static bool setMember (QString &variable, const QVariant &value, bool condition=true)
 Sets the given property. More...
 
static bool setMember (double &variable, const QVariant &value, bool condition=true)
 This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts. More...
 
static bool setMember (int &variable, const QVariant &value, bool condition=true)
 This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts. More...
 
static bool setMember (bool &variable, const QVariant &value, bool condition=true)
 This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts. More...
 
static bool setMember (QList< double > &variable, const QVariant &value, bool condition)
 
static bool setMemberVector (QList< RVector > &variable, const QVariant &value, RObject::XYZ xyz)
 
static bool setMemberX (QList< RVector > &variable, const QVariant &value, bool condition=true)
 
static bool setMemberY (QList< RVector > &variable, const QVariant &value, bool condition=true)
 
static bool setMemberZ (QList< RVector > &variable, const QVariant &value, bool condition=true)
 

Detailed Description

Text entity.

Scriptable:
This class is available in script environments.
Shared Pointer Support:
Objects can be used in QSharedPointer.

Constructor & Destructor Documentation

RTextBasedEntity::RTextBasedEntity ( RDocument document,
RObject::Id  objectId = RObject::INVALID_ID 
)
RTextBasedEntity::~RTextBasedEntity ( )
virtual

Member Function Documentation

void RTextBasedEntity::exportEntity ( RExporter e,
bool  preview = false,
bool  forceSelected = false 
) const
virtual

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.

Implements REntity.

Reimplemented in RAttributeEntity.

RVector RTextBasedEntity::getAlignmentPoint ( ) const
inline
double RTextBasedEntity::getAngle ( ) const
inline
virtual RTextBasedData& RTextBasedEntity::getData ( )
pure virtual
Returns
Reference to the data object of the entity.

Implements REntity.

Implemented in RAttributeDefinitionEntity, RAttributeEntity, and RTextEntity.

virtual const RTextBasedData& RTextBasedEntity::getData ( ) const
pure virtual
Returns
Const reference to the data object of the entity.

Implements REntity.

Implemented in RTextEntity, RAttributeDefinitionEntity, and RAttributeEntity.

RS::TextDrawingDirection RTextBasedEntity::getDrawingDirection ( ) const
inline
QString RTextBasedEntity::getEscapedText ( bool  escapeUnicode = false) const
inline
virtual QList<QSharedPointer<RShape> > RTextBasedEntity::getExploded ( ) const
inlinevirtual
QString RTextBasedEntity::getFontName ( ) const
inline
RS::HAlign RTextBasedEntity::getHAlign ( ) const
inline
double RTextBasedEntity::getHeight ( ) const
inline
double RTextBasedEntity::getLineSpacingFactor ( ) const
inline
RS::TextLineSpacingStyle RTextBasedEntity::getLineSpacingStyle ( ) const
inline
QList<RPainterPath> RTextBasedEntity::getPainterPaths ( bool  draft = false) const
inline
QString RTextBasedEntity::getPlainText ( ) const
inline
RVector RTextBasedEntity::getPosition ( ) const
inline
QPair< QVariant, RPropertyAttributes > RTextBasedEntity::getProperty ( RPropertyTypeId propertyTypeId,
bool  humanReadable = false,
bool  noAttributes = 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 REntity.

Reimplemented in RAttributeDefinitionEntity, and RAttributeEntity.

virtual QList<QSharedPointer<RShape> > RTextBasedEntity::getShapes ( const RBox queryBox = RDEFAULT_RBOX,
bool  ignoreComplex = false 
) const
inlinevirtual

Returns
Shapes that represent the geometry of this entity.

Reimplemented from REntity.

static QSet<RPropertyTypeId> RTextBasedEntity::getStaticPropertyTypeIds ( )
inlinestatic
virtual RTextBasedData& RTextBasedEntity::getTextData ( )
inlinevirtual
double RTextBasedEntity::getTextHeight ( ) const
inline
double RTextBasedEntity::getTextWidth ( ) const
inline
virtual RS::EntityType RTextBasedEntity::getType ( ) const
inlinevirtual

Reimplemented from REntity.

Reimplemented in RAttributeDefinitionEntity, RAttributeEntity, and RTextEntity.

RS::VAlign RTextBasedEntity::getVAlign ( ) const
inline
double RTextBasedEntity::getWidth ( ) const
inline
double RTextBasedEntity::getXScale ( ) const
inline
void RTextBasedEntity::init ( )
static
bool RTextBasedEntity::isBold ( ) const
inline
bool RTextBasedEntity::isItalic ( ) const
inline
bool RTextBasedEntity::isSimple ( ) const
inline
void RTextBasedEntity::print ( QDebug  dbg) const
protectedvirtual

Stream operator for QDebug.

Reimplemented from REntity.

Reimplemented in RAttributeDefinitionEntity, RAttributeEntity, and RTextEntity.

void RTextBasedEntity::setAlignmentPoint ( const RVector alignmentPoint)
inline
void RTextBasedEntity::setAngle ( double  angle)
inline
void RTextBasedEntity::setBold ( bool  on)
inline
void RTextBasedEntity::setDrawingDirection ( RS::TextDrawingDirection  drawingDirection)
inline
void RTextBasedEntity::setFontName ( const QString &  fontName)
inline
void RTextBasedEntity::setHAlign ( RS::HAlign  ha)
inline
void RTextBasedEntity::setItalic ( bool  on)
inline
void RTextBasedEntity::setLineSpacingFactor ( double  lineSpacingFactor)
inline
void RTextBasedEntity::setLineSpacingStyle ( RS::TextLineSpacingStyle  lineSpacingStyle)
inline
void RTextBasedEntity::setPosition ( const RVector position)
inline
bool RTextBasedEntity::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 REntity.

Reimplemented in RAttributeDefinitionEntity, and RAttributeEntity.

void RTextBasedEntity::setSimple ( bool  on)
inline
void RTextBasedEntity::setText ( const QString &  text)
inline
void RTextBasedEntity::setTextHeight ( double  h)
inline
void RTextBasedEntity::setVAlign ( RS::VAlign  va)
inline
void RTextBasedEntity::setXScale ( double  xScale)
inline
void RTextBasedEntity::sync ( const RTextBasedEntity other)
inline

Member Data Documentation

RPropertyTypeId RTextBasedEntity::PropertyAngle
static
RPropertyTypeId RTextBasedEntity::PropertyBlock
static
RPropertyTypeId RTextBasedEntity::PropertyBold
static
RPropertyTypeId RTextBasedEntity::PropertyColor
static
RPropertyTypeId RTextBasedEntity::PropertyCustom
static

Copyright (c) 2011-2015 by Andrew Mustun.

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.

RPropertyTypeId RTextBasedEntity::PropertyDrawOrder
static
RPropertyTypeId RTextBasedEntity::PropertyFontName
static
RPropertyTypeId RTextBasedEntity::PropertyHAlign
static
RPropertyTypeId RTextBasedEntity::PropertyHandle
static
RPropertyTypeId RTextBasedEntity::PropertyHeight
static
RPropertyTypeId RTextBasedEntity::PropertyItalic
static
RPropertyTypeId RTextBasedEntity::PropertyLayer
static
RPropertyTypeId RTextBasedEntity::PropertyLineSpacingFactor
static
RPropertyTypeId RTextBasedEntity::PropertyLinetype
static
RPropertyTypeId RTextBasedEntity::PropertyLinetypeScale
static
RPropertyTypeId RTextBasedEntity::PropertyLineweight
static
RPropertyTypeId RTextBasedEntity::PropertyPlainText
static
RPropertyTypeId RTextBasedEntity::PropertyPositionX
static
RPropertyTypeId RTextBasedEntity::PropertyPositionY
static
RPropertyTypeId RTextBasedEntity::PropertyPositionZ
static
RPropertyTypeId RTextBasedEntity::PropertySimple
static
RPropertyTypeId RTextBasedEntity::PropertyText
static
RPropertyTypeId RTextBasedEntity::PropertyType
static
RPropertyTypeId RTextBasedEntity::PropertyVAlign
static
RPropertyTypeId RTextBasedEntity::PropertyXScale
static

The documentation for this class was generated from the following files: