QCAD
Open Source 2D CAD
 All Classes Files Functions Variables Typedefs Enumerations Enumerator Properties Friends Macros Groups Pages
RBlockReferenceEntity Class Reference

Block reference entity. More...

#include <RBlockReferenceEntity.h>

Inheritance diagram for RBlockReferenceEntity:
REntity RObject

List of all members.

Public Member Functions

bool applyTransformationTo (REntity &entity) const
virtual RBlockReferenceEntityclone () const
virtual void exportEntity (RExporter &e, bool preview=false) const
 Exports the entity to the given exporter.
virtual RBlockReferenceDatagetData ()
virtual const RBlockReferenceDatagetData () const
RVector getPosition () const
virtual QPair< QVariant,
RPropertyAttributes
getProperty (RPropertyTypeId &propertyTypeId, bool humanReadable=false, bool noAttributes=false)
virtual QSet< RPropertyTypeIdgetPropertyTypeIds () const
RBlock::Id getReferencedBlockId () const
QString getReferencedBlockName () const
double getRotation () const
RVector getScaleFactors () const
virtual RS::EntityType getType () const
virtual void print (QDebug dbg) const
QSharedPointer< REntityqueryEntity (REntity::Id entityId) const
 RBlockReferenceEntity (RDocument *document, const RBlockReferenceData &data, RObject::Id objectId=RObject::INVALID_ID)
virtual bool setProperty (RPropertyTypeId propertyTypeId, const QVariant &value, RTransaction *transaction=NULL)
 Sets the given property to the given value.
void setReferencedBlockId (RBlock::Id blockId)
virtual void update () const
 Entities can reimplement this function to invalidate any internal cache (mark the entity as dirty).
void update (REntity::Id entityId) const
virtual ~RBlockReferenceEntity ()
- Public Member Functions inherited from REntity
virtual const RShapecastToConstShape () const
virtual RShapecastToShape ()
 
void copyAttributesFrom (REntity *entity, bool copyBlockId=true)
 Copies all attributes (layer, block, color, line weight, line style) from the given entity.
void dump ()
virtual bool flipHorizontal ()
 
virtual bool flipVertical ()
 
RBlock::Id getBlockId () const
 
QString getBlockName () const
 
virtual RBox getBoundingBox () const
 
virtual QList< RBoxgetBoundingBoxes () 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) const
 
RColor getColor () const
 
RColor getColor (bool resolve, const QStack< RBlockReferenceEntity * > &blockRefStack)
 
virtual int getComplexity () const
virtual double getDistanceTo (const RVector &point, bool limited=true, double range=0.0, bool draft=false) const
 
int getDrawOrder () const
 
virtual QList< RVectorgetEndPoints (const RBox &queryBox=RDEFAULT_RBOX) const
 
virtual QList< RVectorgetInternalReferencePoints (RS::ProjectionRenderingHint hint=RS::RenderTop) const
 Can be overwritten to return internal, resolved reference points.
virtual QList< RVectorgetIntersectionPoints (const REntity &other, bool limited=true, const RBox &queryBox=RDEFAULT_RBOX) const
 
virtual QList< RVectorgetIntersectionPoints (const RShape &shape, bool limited=true, const RBox &queryBox=RDEFAULT_RBOX) const
 
RLayer::Id getLayerId () const
 
QString getLayerName () const
 
RLinetype::Id getLinetypeId () const
 
RLinetype::Id getLinetypeId (bool resolve, const QStack< RBlockReferenceEntity * > &blockRefStack) const
 
RLineweight::Lineweight getLineweight () const
 
RLineweight::Lineweight getLineweight (bool resolve, const QStack< RBlockReferenceEntity * > &blockRefStack) const
 
double getLineweightInUnits (const QStack< RBlockReferenceEntity * > &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 QList< QSharedPointer
< RShape > > 
getShapes (const RBox &queryBox=RDEFAULT_RBOX) const
 
virtual RVector getVectorTo (const RVector &point, bool limited=true) 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) 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).
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.
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.
 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.
void setLayerId (RLayer::Id layerId)
 
void setLinetype (RLinetype linetype)
 
void setLinetypeId (RLinetype::Id linetypeId)
 
void setLineweight (RLineweight::Lineweight lineweight)
 
void setParentId (REntity::Id parentId)
 
virtual void setSelected (bool on)
 Selects or deselects this entity.
virtual bool stretch (const RPolyline &area, const RVector &offset)
 Stretches the end points of this entity that are inside area by offset.
virtual ~REntity ()
- Public Member Functions inherited from RObject
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 bool hasPropertyType (RPropertyTypeId propertyTypeId)
bool isUndone () const
void removeCustomProperty (const QString &title, const QString &key)
 Removes the custom property with the given name.
 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.
virtual void setUndone (bool on)
virtual ~RObject ()

Static Public Member Functions

static QSet< RPropertyTypeIdgetStaticPropertyTypeIds ()
static void init ()

Static Public Attributes

static RPropertyTypeId PropertyBlock
static RPropertyTypeId PropertyColor
static RPropertyTypeId PropertyCustom
 Copyright (c) 2011-2013 by Andrew Mustun.
static RPropertyTypeId PropertyDrawOrder
static RPropertyTypeId PropertyHandle
static RPropertyTypeId PropertyLayer
static RPropertyTypeId PropertyLinetype
static RPropertyTypeId PropertyLineweight
static RPropertyTypeId PropertyPositionX
static RPropertyTypeId PropertyPositionY
static RPropertyTypeId PropertyPositionZ
static RPropertyTypeId PropertyReferencedBlock
static RPropertyTypeId PropertyRotation
static RPropertyTypeId PropertyScaleX
static RPropertyTypeId PropertyScaleY
static RPropertyTypeId PropertyScaleZ
static RPropertyTypeId PropertyType
- Static Public Attributes inherited from REntity
static RPropertyTypeId PropertyMaxX
static RPropertyTypeId PropertyMaxY
static RPropertyTypeId PropertyMinX
static RPropertyTypeId PropertyMinY
- Static Public Attributes inherited from RObject
static const Handle INVALID_HANDLE = -1
static const Id INVALID_ID = -1
 Copyright (c) 2011-2013 by Andrew Mustun.

Protected Attributes

RBlockReferenceData data
int recursionDepth

Additional Inherited Members


Detailed Description

Block reference entity.

Scriptable:
This class is wrapped for script environments.
Shared Pointer Support:
Script wrappers of this class support wrapping in QSharedPointer.

Constructor & Destructor Documentation

RBlockReferenceEntity::RBlockReferenceEntity ( RDocument document,
const RBlockReferenceData data,
RObject::Id  objectId = RObject::INVALID_ID 
)
RBlockReferenceEntity::~RBlockReferenceEntity ( )
virtual

Member Function Documentation

bool RBlockReferenceEntity::applyTransformationTo ( REntity entity) const
inline
virtual RBlockReferenceEntity* RBlockReferenceEntity::clone ( ) const
inlinevirtual

Implements REntity.

void RBlockReferenceEntity::exportEntity ( RExporter e,
bool  preview = 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.

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

Implements REntity.

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

Implements REntity.

RVector RBlockReferenceEntity::getPosition ( ) const
inline
QPair< QVariant, RPropertyAttributes > RBlockReferenceEntity::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.

QSet< RPropertyTypeId > RBlockReferenceEntity::getPropertyTypeIds ( ) const
virtual
Returns:
A set of all property IDs of properties that are available for this object. The IDs that are returned can be translated into a group title and a property title using getPropertyGroupTitle and getPropertyTitle.

Reimplemented from RObject.

RBlock::Id RBlockReferenceEntity::getReferencedBlockId ( ) const
inline
QString RBlockReferenceEntity::getReferencedBlockName ( ) const
inline
double RBlockReferenceEntity::getRotation ( ) const
inline
RVector RBlockReferenceEntity::getScaleFactors ( ) const
inline
static QSet<RPropertyTypeId> RBlockReferenceEntity::getStaticPropertyTypeIds ( )
inlinestatic

Reimplemented from REntity.

virtual RS::EntityType RBlockReferenceEntity::getType ( ) const
inlinevirtual

Reimplemented from REntity.

void RBlockReferenceEntity::init ( )
static

Reimplemented from REntity.

void RBlockReferenceEntity::print ( QDebug  dbg) const
virtual
   \par Non-Scriptable:

This function is not available in script environments.

Reimplemented from REntity.

QSharedPointer<REntity> RBlockReferenceEntity::queryEntity ( REntity::Id  entityId) const
inline
bool RBlockReferenceEntity::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.

void RBlockReferenceEntity::setReferencedBlockId ( RBlock::Id  blockId)
inline
virtual void RBlockReferenceEntity::update ( ) const
inlinevirtual

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

Reimplemented from REntity.

void RBlockReferenceEntity::update ( REntity::Id  entityId) const
inline

Member Data Documentation

RBlockReferenceData RBlockReferenceEntity::data
protected
RPropertyTypeId RBlockReferenceEntity::PropertyBlock
static

Reimplemented from REntity.

RPropertyTypeId RBlockReferenceEntity::PropertyColor
static

Reimplemented from REntity.

RPropertyTypeId RBlockReferenceEntity::PropertyCustom
static

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

Reimplemented from REntity.

RPropertyTypeId RBlockReferenceEntity::PropertyDrawOrder
static

Reimplemented from REntity.

RPropertyTypeId RBlockReferenceEntity::PropertyHandle
static

Reimplemented from REntity.

RPropertyTypeId RBlockReferenceEntity::PropertyLayer
static

Reimplemented from REntity.

RPropertyTypeId RBlockReferenceEntity::PropertyLinetype
static

Reimplemented from REntity.

RPropertyTypeId RBlockReferenceEntity::PropertyLineweight
static

Reimplemented from REntity.

RPropertyTypeId RBlockReferenceEntity::PropertyPositionX
static
RPropertyTypeId RBlockReferenceEntity::PropertyPositionY
static
RPropertyTypeId RBlockReferenceEntity::PropertyPositionZ
static
RPropertyTypeId RBlockReferenceEntity::PropertyReferencedBlock
static
RPropertyTypeId RBlockReferenceEntity::PropertyRotation
static
RPropertyTypeId RBlockReferenceEntity::PropertyScaleX
static
RPropertyTypeId RBlockReferenceEntity::PropertyScaleY
static
RPropertyTypeId RBlockReferenceEntity::PropertyScaleZ
static
RPropertyTypeId RBlockReferenceEntity::PropertyType
static

Reimplemented from REntity.

int RBlockReferenceEntity::recursionDepth
mutableprotected

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