QCAD
Open Source 2D CAD
RSolidEntity Class Reference

Solid entity. More...

#include <RSolidEntity.h>

Inheritance diagram for RSolidEntity:
REntity RObject

Public Member Functions

virtual RSolidEntityclone () const
 
int countVertices () const
 
virtual void exportEntity (RExporter &e, bool preview=false, bool forceSelected=false) const
 Exports the entity to the given exporter. More...
 
virtual RSolidDatagetData ()
 
virtual const RSolidDatagetData () const
 
double getDirection1 () const
 
double getDirection2 () const
 
RVector getEndPoint () const
 
QList< QSharedPointer< RShape > > getExploded () const
 
double getLength () const
 
virtual QPair< QVariant, RPropertyAttributesgetProperty (RPropertyTypeId &propertyTypeId, bool humanReadable=false, bool noAttributes=false, bool showOnRequest=false)
 
RVector getStartPoint () const
 
RS::Ending getTrimEnd (const RVector &trimPoint, const RVector &clickPoint)
 
RVector getVertexAt (int i) const
 
bool reverse ()
 
 RSolidEntity (RDocument *document, const RSolidData &data)
 
virtual bool setProperty (RPropertyTypeId propertyTypeId, const QVariant &value, RTransaction *transaction=NULL)
 Sets the given property to the given value. More...
 
bool trimEndPoint (const RVector &trimPoint, const RVector &clickPoint=RVector::invalid, bool extend=false)
 
bool trimStartPoint (const RVector &trimPoint, const RVector &clickPoint=RVector::invalid, bool extend=false)
 
virtual ~RSolidEntity ()
 
- Public Member Functions inherited from REntity
virtual const RShapecastToConstShape () const
 
virtual RShapecastToShape ()
 
virtual bool clickReferencePoint (const RVector &referencePoint)
 Called when user clicks a reference point. More...
 
virtual bool cloneOnChange () const
 
void copyAttributesFrom (const REntity *entity, bool copyBlockId=true)
 Copies all attributes (layer, block, color, line weight, line style) from the given entity. More...
 
void copyAttributesFrom (const REntityData &entityData, bool copyBlockId=true)
 
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)
 
RColor getColor (const RColor &unresolvedColor, const QStack< REntity * > &blockRefStack)
 
virtual int getComplexity () const
 
RColor getDisplayColor ()
 
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< RRefPointgetInternalReferencePoints (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, int from=RS::FromAny, const RBox &queryBox=RDEFAULT_RBOX) const
 
virtual QList< RRefPointgetReferencePoints (RS::ProjectionRenderingHint hint=RS::RenderTop) const
 
virtual QList< QSharedPointer< RShape > > getShapes (const RBox &queryBox=RDEFAULT_RBOX, bool ignoreComplex=false, bool segment=false) const
 
virtual RS::EntityType getType () const
 
virtual RVector getVectorTo (const RVector &point, bool limited=true, double strictRange=RMAXDOUBLE) const
 
virtual bool intersectsWith (const RShape &shape) const
 
virtual bool isEditable (bool allowInvisible=false) const
 
virtual bool isInside (const RBox &box) const
 
virtual bool isInWorkingSet () const
 
virtual bool isOnEntity (const RVector &point, bool limited=true, double tolerance=RDEFAULT_TOLERANCE_1E_MIN4) const
 
virtual bool isPointType () const
 
virtual bool isSane () const
 
virtual 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 isSelectedWorkingSet () const
 
virtual bool isUpdatesEnabled () const
 
virtual bool isValid () const
 
virtual bool isVisible (RBlock::Id blockId=RBlock::INVALID_ID) 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, 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. More...
 
 REntity (const REntity &other)
 
 REntity (RDocument *document)
 
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)
 
virtual QSharedPointer< REntityscaleNonUniform (const RVector &scaleFactors, const RVector &center=RDEFAULT_RVECTOR)
 
virtual void scaleVisualProperties (double scaleFactor)
 
virtual void setAutoUpdatesBlocked (bool on)
 
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 setLayerName (const QString &n)
 
void setLinetypeId (RLinetype::Id linetypeId)
 Sets the linetype of this entity to the given linetype ID. More...
 
void setLinetypePattern (const RLinetypePattern &linetypePattern)
 
void setLinetypeScale (double linetypeScale)
 
void setLineweight (RLineweight::Lineweight lineweight)
 
virtual void setSelected (bool on)
 Selects or deselects this entity. More...
 
virtual void setSelectedWorkingSet (bool on)
 
void setUpdatesEnabled (bool on)
 
virtual void setViewportContext (const RViewportData &)
 
virtual void setZ (double z)
 
virtual bool stretch (const RPolyline &area, const RVector &offset)
 Stretches the end points of this entity that are inside area by offset. More...
 
virtual void to2D ()
 
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 copyCustomPropertiesFrom (RObject *other, const QString &title=RDEFAULT_QSTRING, bool overwrite=false, const QStringList &ignoreList=RDEFAULT_QSTRINGLIST, const QString &mapKeyFrom=RDEFAULT_QSTRING, const QString &mapKeyTo=RDEFAULT_QSTRING)
 Copies all custom properties from the given object. More...
 
void dump () const
 
virtual bool getCustomBoolProperty (const QString &title, const QString &key, bool defaultValue) const
 
virtual double getCustomDoubleProperty (const QString &title, const QString &key, double defaultValue) const
 
virtual int getCustomIntProperty (const QString &title, const QString &key, int defaultValue) const
 
QMap< QString, QVariantMap > getCustomProperties () const
 
virtual QVariant getCustomProperty (const QString &title, const QString &key, const QVariant &defaultValue=RDEFAULT_QVARIANT) const
 
QStringList getCustomPropertyKeys (const QString &title) const
 
QStringList getCustomPropertyTitles () const
 
virtual QSet< RPropertyTypeIdgetCustomPropertyTypeIds () const
 
RDocumentgetDocument ()
 
const RDocumentgetDocument () const
 
bool getFlag (int flag) const
 
RObject::Handle getHandle () const
 
RObject::Id getId () const
 
virtual QSet< RPropertyTypeIdgetPropertyTypeIds (RPropertyAttributes::Option option=RPropertyAttributes::NoOptions) const
 
bool hasCustomProperties () const
 
bool hasCustomProperty (const QString &title, const QRegExp &key) const
 
bool hasCustomProperty (const QString &title, const QString &key) const
 
virtual bool hasPropertyType (RPropertyTypeId propertyTypeId)
 
bool isInvisible () const
 
bool isProtected () const
 
bool isUndone () const
 
virtual bool isWorkingSet () const
 
virtual bool mustAlwaysClone () const
 
virtual void removeCustomProperty (const QString &title, const QString &key)
 Removes the custom property with the given name. More...
 
 RObject (const RObject &other)
 
 RObject (RDocument *document=NULL)
 
virtual void setCustomProperties (const RQMapQStringQString &properties)
 
virtual 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 setFlag (int flag, bool on=true)
 
void setInvisible (bool on)
 
void setProtected (bool on)
 
virtual void setWorkingSet (bool on)
 
virtual bool validate ()
 
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 bool isTextBased (const RS::EntityType type)
 
- Static Public Member Functions inherited from RObject
static RPropertyAttributes getCustomPropertyAttributes (const QString &title, const QString &key)
 
static void init ()
 
static void setCustomPropertyAttributes (const QString &title, const QString &key, const RPropertyAttributes &att)
 Set attributes (read-only, invisible, ...) for the given custom property. More...
 
template<class T >
static bool setMember (T &variable, const QVariant &value, bool condition=true)
 

Static Public Attributes

static RPropertyTypeId PropertyBlock
 
static RPropertyTypeId PropertyColor
 
static RPropertyTypeId PropertyCustom
 Copyright (c) 2011-2018 by Andrew Mustun. More...
 
static RPropertyTypeId PropertyDisplayedColor
 
static RPropertyTypeId PropertyDrawOrder
 
static RPropertyTypeId PropertyHandle
 
static RPropertyTypeId PropertyLayer
 
static RPropertyTypeId PropertyLength
 
static RPropertyTypeId PropertyLinetype
 
static RPropertyTypeId PropertyLinetypeScale
 
static RPropertyTypeId PropertyLineweight
 
static RPropertyTypeId PropertyPoint1X
 
static RPropertyTypeId PropertyPoint1Y
 
static RPropertyTypeId PropertyPoint1Z
 
static RPropertyTypeId PropertyPoint2X
 
static RPropertyTypeId PropertyPoint2Y
 
static RPropertyTypeId PropertyPoint2Z
 
static RPropertyTypeId PropertyPoint3X
 
static RPropertyTypeId PropertyPoint3Y
 
static RPropertyTypeId PropertyPoint3Z
 
static RPropertyTypeId PropertyPoint4X
 
static RPropertyTypeId PropertyPoint4Y
 
static RPropertyTypeId PropertyPoint4Z
 
static RPropertyTypeId PropertyProtected
 
static RPropertyTypeId PropertyTotalLength
 
static RPropertyTypeId PropertyType
 
static RPropertyTypeId PropertyWorkingSet
 
- Static Public Attributes inherited from REntity
static RPropertyTypeId PropertyBlock
 
static RPropertyTypeId PropertyColor
 
static RPropertyTypeId PropertyCustom
 Copyright (c) 2011-2018 by Andrew Mustun. More...
 
static RPropertyTypeId PropertyDisplayedColor
 
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 RPropertyTypeId PropertyWorkingSet
 
- Static Public Attributes inherited from RObject
static const Handle INVALID_HANDLE = -1
 
static const Id INVALID_ID = -1
 Copyright (c) 2011-2018 by Andrew Mustun. More...
 
static RPropertyTypeId PropertyCustom
 
static RPropertyTypeId PropertyHandle
 
static RPropertyTypeId PropertyInvisible
 
static RPropertyTypeId PropertyProtected
 
static RPropertyTypeId PropertySelected
 
static RPropertyTypeId PropertyType
 
static RPropertyTypeId PropertyWorkingSet
 

Protected Member Functions

virtual void print (QDebug dbg) const
 Stream operator for QDebug. More...
 
- Protected Member Functions inherited from REntity
void setParentId (REntity::Id parentId)
 
- Protected Member Functions inherited from RObject
void setHandle (RObject::Handle h)
 
void setId (RObject::Id id)
 
bool setMemberFlag (int flag, 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...
 
void setUndone (bool on)
 

Protected Attributes

RSolidData data
 

Additional Inherited Members

- Public Types inherited from RObject
typedef int Handle
 
typedef int Id
 
enum  ObjectFlag {
  NoFlags = 0x000, Undone = 0x001, Protect = 0x002, Selected = 0x004,
  Invisible = 0x008, WorkingSet = 0x010
}
 
enum  XYZ { X, Y, Z }
 
- Static Protected Member Functions inherited from RObject
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 (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 (QList< double > &variable, const QVariant &value, bool condition)
 
static bool setMember (QString &variable, const QVariant &value, bool condition=true)
 Sets the given property. More...
 
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

Solid entity.

Scriptable:\nThis class is available in script environments.\n
Shared Pointer Support:\nObjects can be used in QSharedPointer.\n

Constructor & Destructor Documentation

◆ RSolidEntity()

RSolidEntity::RSolidEntity ( RDocument document,
const RSolidData data 
)

◆ ~RSolidEntity()

RSolidEntity::~RSolidEntity ( )
virtual

Member Function Documentation

◆ clone()

virtual RSolidEntity* RSolidEntity::clone ( ) const
inlinevirtual

Implements REntity.

◆ countVertices()

int RSolidEntity::countVertices ( ) const
inline

◆ exportEntity()

void RSolidEntity::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.

◆ getData() [1/2]

virtual RSolidData& RSolidEntity::getData ( )
inlinevirtual
Returns
Reference to the data object of the entity.

Implements REntity.

◆ getData() [2/2]

virtual const RSolidData& RSolidEntity::getData ( ) const
inlinevirtual
Returns
Const reference to the data object of the entity.

Implements REntity.

◆ getDirection1()

double RSolidEntity::getDirection1 ( ) const
inline

◆ getDirection2()

double RSolidEntity::getDirection2 ( ) const
inline

◆ getEndPoint()

RVector RSolidEntity::getEndPoint ( ) const
inline

◆ getExploded()

QList<QSharedPointer<RShape> > RSolidEntity::getExploded ( ) const
inline

◆ getLength()

double RSolidEntity::getLength ( ) const
inline

◆ getProperty()

QPair< QVariant, RPropertyAttributes > RSolidEntity::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 REntity.

◆ getStartPoint()

RVector RSolidEntity::getStartPoint ( ) const
inline

◆ getStaticPropertyTypeIds()

static QSet<RPropertyTypeId> RSolidEntity::getStaticPropertyTypeIds ( )
inlinestatic

◆ getTrimEnd()

RS::Ending RSolidEntity::getTrimEnd ( const RVector trimPoint,
const RVector clickPoint 
)
inline

◆ getVertexAt()

RVector RSolidEntity::getVertexAt ( int  i) const
inline

◆ init()

void RSolidEntity::init ( )
static

◆ print()

void RSolidEntity::print ( QDebug  dbg) const
protectedvirtual

Stream operator for QDebug.

Reimplemented from REntity.

◆ reverse()

bool RSolidEntity::reverse ( )
inline

◆ setProperty()

bool RSolidEntity::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.

◆ trimEndPoint()

bool RSolidEntity::trimEndPoint ( const RVector trimPoint,
const RVector clickPoint = RVector::invalid,
bool  extend = false 
)
inline

◆ trimStartPoint()

bool RSolidEntity::trimStartPoint ( const RVector trimPoint,
const RVector clickPoint = RVector::invalid,
bool  extend = false 
)
inline

Member Data Documentation

◆ data

RSolidData RSolidEntity::data
protected

◆ PropertyBlock

RPropertyTypeId RSolidEntity::PropertyBlock
static

◆ PropertyColor

RPropertyTypeId RSolidEntity::PropertyColor
static

◆ PropertyCustom

RPropertyTypeId RSolidEntity::PropertyCustom
static

Copyright (c) 2011-2018 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.

◆ PropertyDisplayedColor

RPropertyTypeId RSolidEntity::PropertyDisplayedColor
static

◆ PropertyDrawOrder

RPropertyTypeId RSolidEntity::PropertyDrawOrder
static

◆ PropertyHandle

RPropertyTypeId RSolidEntity::PropertyHandle
static

◆ PropertyLayer

RPropertyTypeId RSolidEntity::PropertyLayer
static

◆ PropertyLength

RPropertyTypeId RSolidEntity::PropertyLength
static

◆ PropertyLinetype

RPropertyTypeId RSolidEntity::PropertyLinetype
static

◆ PropertyLinetypeScale

RPropertyTypeId RSolidEntity::PropertyLinetypeScale
static

◆ PropertyLineweight

RPropertyTypeId RSolidEntity::PropertyLineweight
static

◆ PropertyPoint1X

RPropertyTypeId RSolidEntity::PropertyPoint1X
static

◆ PropertyPoint1Y

RPropertyTypeId RSolidEntity::PropertyPoint1Y
static

◆ PropertyPoint1Z

RPropertyTypeId RSolidEntity::PropertyPoint1Z
static

◆ PropertyPoint2X

RPropertyTypeId RSolidEntity::PropertyPoint2X
static

◆ PropertyPoint2Y

RPropertyTypeId RSolidEntity::PropertyPoint2Y
static

◆ PropertyPoint2Z

RPropertyTypeId RSolidEntity::PropertyPoint2Z
static

◆ PropertyPoint3X

RPropertyTypeId RSolidEntity::PropertyPoint3X
static

◆ PropertyPoint3Y

RPropertyTypeId RSolidEntity::PropertyPoint3Y
static

◆ PropertyPoint3Z

RPropertyTypeId RSolidEntity::PropertyPoint3Z
static

◆ PropertyPoint4X

RPropertyTypeId RSolidEntity::PropertyPoint4X
static

◆ PropertyPoint4Y

RPropertyTypeId RSolidEntity::PropertyPoint4Y
static

◆ PropertyPoint4Z

RPropertyTypeId RSolidEntity::PropertyPoint4Z
static

◆ PropertyProtected

RPropertyTypeId RSolidEntity::PropertyProtected
static

◆ PropertyTotalLength

RPropertyTypeId RSolidEntity::PropertyTotalLength
static

◆ PropertyType

RPropertyTypeId RSolidEntity::PropertyType
static

◆ PropertyWorkingSet

RPropertyTypeId RSolidEntity::PropertyWorkingSet
static

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