QCAD
Open Source 2D CAD
RBlockReferenceData Class Reference

Defines the geometry and appearance of a block reference entity. More...

#include <RBlockReferenceData.h>

Inheritance diagram for RBlockReferenceData:
REntityData

Public Member Functions

void applyColumnRowOffsetTo (REntity &entity, int col, int row) const
 
bool applyTransformationTo (REntity &entity) const
 
virtual RBox getBoundingBox (bool ignoreEmpty=false) const
 
virtual QList< RBoxgetBoundingBoxes (bool ignoreEmpty=false) const
 
int getColumnCount () const
 
RVector getColumnRowOffset (int col, int row) const
 
double getColumnSpacing () const
 
virtual double getDistanceTo (const RVector &point, bool limited=true, double range=0.0, bool draft=false, double strictRange=RMAXDOUBLE) const
 
virtual QList< RVectorgetInternalReferencePoints (RS::ProjectionRenderingHint hint=RS::RenderTop) const
 Can be overwritten to return internal, resolved reference points. More...
 
RVector getPosition () const
 
RBlock::Id getReferencedBlockId () const
 
QString getReferencedBlockName () const
 
virtual QList< RVectorgetReferencePoints (RS::ProjectionRenderingHint hint=RS::RenderTop) const
 
double getRotation () const
 
int getRowCount () const
 
double getRowSpacing () const
 
RVector getScaleFactors () const
 
virtual QList< QSharedPointer< RShape > > getShapes (const RBox &queryBox=RDEFAULT_RBOX, bool ignoreComplex=false) const
 
virtual RVector getVectorTo (const RVector &point, bool limited=true, double strictRange=RMAXDOUBLE) const
 
void groundReferencedBlockId () const
 
RVector mapToBlock (const RVector &v) const
 
virtual bool mirror (const RLine &axis)
 
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...
 
QSharedPointer< REntityqueryEntity (REntity::Id entityId) const
 
 RBlockReferenceData ()
 Copyright (c) 2011-2015 by Andrew Mustun. More...
 
 RBlockReferenceData (RBlock::Id referencedBlockId, const RVector &position, const RVector &scaleFactors, double angle, int columnCount=1, int rowCount=1, double columnSpacing=0, double rowSpacing=0)
 
virtual bool rotate (double rotation, const RVector &center=RDEFAULT_RVECTOR)
 
virtual bool scale (const RVector &scaleFactors, const RVector &center=RDEFAULT_RVECTOR)
 
void setColumnCount (int c)
 
void setColumnSpacing (double s)
 
void setPosition (const RVector &p)
 
void setReferencedBlockId (RBlock::Id blockId)
 
void setReferencedBlockName (const QString &blockName)
 
void setRotation (double r)
 
void setRowCount (int c)
 
void setRowSpacing (double s)
 
void setScaleFactors (const RVector &sf)
 
virtual void update () const
 Entities can reimplement this function to invalidate any internal cache (mark the entity as dirty). More...
 
virtual void update (RObject::Id entityId) const
 
- Public Member Functions inherited from REntityData
virtual const RShapecastToConstShape () const
 
virtual RShapecastToShape ()
 
virtual bool flipHorizontal ()
 
virtual bool flipVertical ()
 
RBlock::Id getBlockId () const
 
QString getBlockName () 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 RColor getColor () const
 
virtual RColor getColor (bool resolve, const QStack< REntity * > &blockRefStack) const
 
RDocumentgetDocument ()
 
const RDocumentgetDocument () const
 
virtual int getDrawOrder () const
 
virtual QList< RVectorgetEndPoints (const RBox &queryBox=RDEFAULT_RBOX) const
 
virtual RPolyline getHull (double offset) const
 
virtual QList< RVectorgetIntersectionPoints (const REntityData &other, bool limited=true, bool same=false, const RBox &queryBox=RDEFAULT_RBOX, bool ignoreComplex=true) const
 Override to disable intersection point. More...
 
virtual QList< RVectorgetIntersectionPoints (const RShape &shape, bool limited=true, const RBox &queryBox=RDEFAULT_RBOX, bool ignoreComplex=true) const
 
RLayer::Id getLayerId () const
 
QString getLayerName () const
 
virtual RLinetype::Id getLinetypeId () const
 
virtual RLinetype::Id getLinetypeId (bool resolve, const QStack< REntity * > &blockRefStack) const
 
virtual RLinetypePattern getLinetypePattern () const
 
virtual double getLinetypeScale () const
 
virtual RLineweight::Lineweight getLineweight () const
 
virtual 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
 
RObject::Id getParentId () const
 
virtual RVector getPointOnEntity () const
 
virtual QList< RVectorgetPointsWithDistanceToEnd (double distance, RS::From from=RS::FromAny, const RBox &queryBox=RDEFAULT_RBOX) const
 
virtual bool intersectsWith (const RShape &shape) const
 
virtual bool isInside (const RBox &box) const
 
virtual bool isOnEntity (const RVector &point, bool limited=true, double tolerance=RDEFAULT_TOLERANCE_1E_MIN4) const
 
virtual bool isSelected () const
 
virtual bool mirror (const RVector &axis1, const RVector &axis2)
 
 REntityData (RDocument *document=NULL)
 Copyright (c) 2011-2015 by Andrew Mustun. More...
 
virtual bool scale (double scaleFactor, const RVector &center=RDEFAULT_RVECTOR)
 
virtual void setBlockId (RBlock::Id blockId)
 
void setColor (const RColor &color)
 
void setDocument (RDocument *document)
 
virtual void setDrawOrder (int drawOrder)
 Sets the draw order of this entity. More...
 
virtual void setLayerId (RLayer::Id layerId)
 
virtual void setLinetypeId (RLinetype::Id linetypeId)
 
virtual void setLinetypePattern (const RLinetypePattern &p)
 
virtual void setLinetypeScale (double linetypeScale)
 
void setLineweight (RLineweight::Lineweight lineweight)
 
virtual void setParentId (RObject::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...
 
virtual ~REntityData ()
 

Protected Member Functions

 RBlockReferenceData (RDocument *document, const RBlockReferenceData &data)
 

Private Attributes

QList< RBoxboundingBoxes
 
QMap< REntity::Id, QSharedPointer< REntity > > cache
 
int columnCount
 
double columnSpacing
 
RVector position
 
RBlock::Id referencedBlockId
 
double rotation
 
int rowCount
 
double rowSpacing
 
RVector scaleFactors
 

Friends

class RBlockReferenceEntity
 
class RViewportEntity
 

Additional Inherited Members

- Protected Attributes inherited from REntityData
RBlock::Id blockId
 
RColor color
 
RDocumentdocument
 
int drawOrder
 
RLayer::Id layerId
 
RLinetype::Id linetypeId
 
double linetypeScale
 
RLineweight::Lineweight lineweight
 
RObject::Id parentId
 
bool selectionStatus
 

Detailed Description

Defines the geometry and appearance of a block reference entity.

Scriptable:
This class is available in script environments.
Copyable:
Objects are cleaned up automatically by the garbage collector of the script engine.

Constructor & Destructor Documentation

RBlockReferenceData::RBlockReferenceData ( RDocument document,
const RBlockReferenceData data 
)
protected
RBlockReferenceData::RBlockReferenceData ( )

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.

RBlockReferenceData::RBlockReferenceData ( RBlock::Id  referencedBlockId,
const RVector position,
const RVector scaleFactors,
double  angle,
int  columnCount = 1,
int  rowCount = 1,
double  columnSpacing = 0,
double  rowSpacing = 0 
)

Member Function Documentation

void RBlockReferenceData::applyColumnRowOffsetTo ( REntity entity,
int  col,
int  row 
) const
bool RBlockReferenceData::applyTransformationTo ( REntity entity) const
RBox RBlockReferenceData::getBoundingBox ( bool  ignoreEmpty = false) const
virtual
Returns
The bounding box that contains this entity.

Reimplemented from REntityData.

QList< RBox > RBlockReferenceData::getBoundingBoxes ( bool  ignoreEmpty = false) const
virtual
Returns
List of bounding boxes that contain this entity. This is used for complex entities such as block references to further optimize algorithms that depend on bounding boxes (e.g. spatial index algorithms). The default implementation returns the bounding box that contains the whole entity.

Reimplemented from REntityData.

int RBlockReferenceData::getColumnCount ( ) const
inline
RVector RBlockReferenceData::getColumnRowOffset ( int  col,
int  row 
) const
double RBlockReferenceData::getColumnSpacing ( ) const
inline
double RBlockReferenceData::getDistanceTo ( const RVector point,
bool  limited = true,
double  range = 0.0,
bool  draft = false,
double  strictRange = RMAXDOUBLE 
) const
virtual
Returns
The shortest distance from this entity to the given point.
Parameters
limitedLimit lines, arcs at end points, otherwise the orthogonal distance to the unlimited line / circle is returned.
rangeThis is returned for solid filled entities (solid filled or dense hatches, text entities) if the point is on the entity and the distance would be zero.
draftCalculate based on draft mode representation of the entity.
strictRangeIf limited, this is the maximum range from either end point of the entity. Zero to only return distances that are strictly orthogonal to the entity.

Reimplemented from REntityData.

QList< RVector > RBlockReferenceData::getInternalReferencePoints ( RS::ProjectionRenderingHint  hint = RS::RenderTop) const
virtual

Can be overwritten to return internal, resolved reference points.

This is used for example for block references in combination with snap to reference points. Default implementation returns same as getReferencePoints().

Reimplemented from REntityData.

RVector RBlockReferenceData::getPosition ( ) const
inline
RBlock::Id RBlockReferenceData::getReferencedBlockId ( ) const
inline
QString RBlockReferenceData::getReferencedBlockName ( ) const
QList< RVector > RBlockReferenceData::getReferencePoints ( RS::ProjectionRenderingHint  hint = RS::RenderTop) const
virtual
Returns
Vector of reference points of this entity. Reference points can usually be moved around by the user to change the geometry of the entity.

Implements REntityData.

double RBlockReferenceData::getRotation ( ) const
inline
int RBlockReferenceData::getRowCount ( ) const
inline
double RBlockReferenceData::getRowSpacing ( ) const
inline
RVector RBlockReferenceData::getScaleFactors ( ) const
inline
QList< QSharedPointer< RShape > > RBlockReferenceData::getShapes ( const RBox queryBox = RDEFAULT_RBOX,
bool  ignoreComplex = false 
) const
virtual
Returns
Shapes that represent the geometry of this entity.

Reimplemented from REntityData.

RVector RBlockReferenceData::getVectorTo ( const RVector point,
bool  limited = true,
double  strictRange = RMAXDOUBLE 
) const
virtual
Returns
The distance vector from this entity to the given point.
Parameters
pointthe point to which the distance was measured
limitedIf true, an invalid vector is returned if the closest point on the entity is outside of the entity (e.g. in the extension line of a line or outside the start / end angle of an arc).

Reimplemented from REntityData.

void RBlockReferenceData::groundReferencedBlockId ( ) const
inline
RVector RBlockReferenceData::mapToBlock ( const RVector v) const
bool RBlockReferenceData::mirror ( const RLine axis)
virtual

Reimplemented from REntityData.

bool RBlockReferenceData::move ( const RVector offset)
virtual

Moves this entity by the given offset.

Reimplemented from REntityData.

bool RBlockReferenceData::moveReferencePoint ( const RVector referencePoint,
const RVector targetPoint 
)
virtual

Moves the given reference point to the given target point or does nothing if this entity has no reference point as the given location.

Returns
True if a reference point has been moved successfully, false otherwise.

Implements REntityData.

QSharedPointer< REntity > RBlockReferenceData::queryEntity ( REntity::Id  entityId) const
Returns
The entity with the given ID, transformed according to the transformation of this block reference.
bool RBlockReferenceData::rotate ( double  rotation,
const RVector center = RDEFAULT_RVECTOR 
)
virtual

Reimplemented from REntityData.

bool RBlockReferenceData::scale ( const RVector scaleFactors,
const RVector center = RDEFAULT_RVECTOR 
)
virtual

Reimplemented from REntityData.

void RBlockReferenceData::setColumnCount ( int  c)
inline
void RBlockReferenceData::setColumnSpacing ( double  s)
inline
void RBlockReferenceData::setPosition ( const RVector p)
void RBlockReferenceData::setReferencedBlockId ( RBlock::Id  blockId)
void RBlockReferenceData::setReferencedBlockName ( const QString &  blockName)
void RBlockReferenceData::setRotation ( double  r)
void RBlockReferenceData::setRowCount ( int  c)
inline
void RBlockReferenceData::setRowSpacing ( double  s)
inline
void RBlockReferenceData::setScaleFactors ( const RVector sf)
void RBlockReferenceData::update ( ) const
virtual

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

Reimplemented from REntityData.

void RBlockReferenceData::update ( RObject::Id  entityId) const
virtual

Friends And Related Function Documentation

friend class RBlockReferenceEntity
friend
friend class RViewportEntity
friend

Member Data Documentation

QList<RBox> RBlockReferenceData::boundingBoxes
mutableprivate
QMap<REntity::Id, QSharedPointer<REntity> > RBlockReferenceData::cache
mutableprivate
int RBlockReferenceData::columnCount
private
double RBlockReferenceData::columnSpacing
private
RVector RBlockReferenceData::position
private
RBlock::Id RBlockReferenceData::referencedBlockId
mutableprivate
double RBlockReferenceData::rotation
private
int RBlockReferenceData::rowCount
private
double RBlockReferenceData::rowSpacing
private
RVector RBlockReferenceData::scaleFactors
private

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