Base class for all entity classes. More...

#include <REntity.h>

Inheritance diagram for REntity:

Public Member Functions
virtual const RShape *	castToConstShape () const
virtual RShape *	castToShape ()

virtual REntity *	clone () const =0
void	copyAttributesFrom (REntity *entity)
	Copies all attributes (layer, block, color, line weight, line style) from the given entity.
void	dump ()
virtual void	exportEntity (RExporter &e, bool preview=false) const =0
	Exports the entity to the given exporter.
virtual bool	flipHorizontal ()

virtual bool	flipVertical ()

RBlock::Id	getBlockId () const

QString	getBlockName ()

virtual RBox	getBoundingBox () const

virtual QList< RBox >	getBoundingBoxes () const

virtual QList< RVector >	getCenterPoints (const RBox &queryBox=RDEFAULT_RBOX) const

virtual RVector	getClosestPointOnEntity (const RVector &point, double range=RNANDOUBLE, bool limited=true) const

virtual QSharedPointer< RShape >	getClosestShape (const RVector &pos, double range=RNANDOUBLE) const

RColor	getColor () const

RColor	getColor (bool resolve, const QStack< RBlockReferenceEntity * > &blockRefStack)

virtual int	getComplexity () const
virtual REntityData &	getData ()=0
virtual const REntityData &	getData () const =0
virtual double	getDistanceTo (const RVector &point, bool limited=true, double range=0.0, bool draft=false) const

int	getDrawOrder () const

virtual QList< RVector >	getEndPoints (const RBox &queryBox=RDEFAULT_RBOX) const

virtual QList< RVector >	getIntersectionPoints (const REntity &other, bool limited=true, const RBox &queryBox=RDEFAULT_RBOX) const

virtual QList< RVector >	getIntersectionPoints (const RShape &shape, bool limited=true, const RBox &queryBox=RDEFAULT_RBOX) const

RLayer::Id	getLayerId () const

QString	getLayerName ()

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< RVector >	getMiddlePoints (const RBox &queryBox=RDEFAULT_RBOX) const

virtual RVector	getPointOnEntity () const

virtual QList< RVector >	getPointsWithDistanceToEnd (double distance, RS::From from=RS::FromAny, const RBox &queryBox=RDEFAULT_RBOX) const

virtual QPair< QVariant, RPropertyAttributes >	getProperty (RPropertyTypeId propertyTypeId, bool humanReadable=false, bool noAttributes=false)
virtual QList< RVector >	getReferencePoints (RS::ProjectionRenderingHint hint=RS::RenderTop) const

virtual QList< QSharedPointer < RShape > >	getShapes (const RBox &queryBox=RDEFAULT_RBOX) const

virtual RS::EntityType	getType () 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

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)

virtual bool	setProperty (RPropertyTypeId propertyTypeId, const QVariant &value)
	Sets the given property to the given value.
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.
void	update () const
	Entities can reimplement this function to invalidate any internal cache (mark the entity as dirty).
virtual	~REntity ()
Public Member Functions inherited from RObject
QMap< QString, QVariant >	getCustomProperties () const
QVariant	getCustomProperty (const QString &key, const QVariant &defaultValue=RDEFAULT_QVARIANT)
RDocument *	getDocument ()
const RDocument *	getDocument () const
RObject::Handle	getHandle () const
RObject::Id	getId () const
virtual QSet< RPropertyTypeId >	getPropertyTypeIds () const
virtual bool	hasPropertyType (RPropertyTypeId propertyTypeId)
bool	isUndone () const
void	removeCustomProperty (const QString &key)
	Removes the custom property with the given name.
	RObject (RDocument *document=NULL, Id id=INVALID_ID)
void	setCustomProperty (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 void	init ()
Static Public Member Functions inherited from RObject
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
static RPropertyTypeId	PropertyDrawOrder
static RPropertyTypeId	PropertyHandle
static RPropertyTypeId	PropertyLayer
static RPropertyTypeId	PropertyLinetype
static RPropertyTypeId	PropertyLineweight
static RPropertyTypeId	PropertyType
Static Public Attributes inherited from RObject
static const Handle	INVALID_HANDLE = -1
static const Id	INVALID_ID = -1

Protected Member Functions
virtual void	print (QDebug dbg) const
	Stream operator for QDebug.
Protected Member Functions inherited from RObject
void	setHandle (RObject::Handle h)
void	setId (RObject::Id id)
bool	setMember (QList< double > &variable, const QVariant &value, bool condition)

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.
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.
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.
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.
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

Base class for all entity classes.

Entities can be exported using an implementor of the exporter interface by calling exportEntity.

Scriptable:: This class is wrapped for script environments.

Shared Pointer Support:: Script wrappers of this class support wrapping in QSharedPointer.

Constructor & Destructor Documentation

REntity::REntity	(	RDocument *	document,
		Id	objectId = `-1`
	)

inline

REntity::~REntity ( )

virtual

Member Function Documentation

virtual const RShape* REntity::castToConstShape ( ) const

inlinevirtual

   \par Non-Scriptable:

This function is not available in script environments.

virtual RShape* REntity::castToShape ( )

inlinevirtual

virtual REntity* REntity::clone ( ) const

pure virtual

Implements RObject.

Implemented in RDimAngularEntity, RDimOrdinateEntity, RDimRotatedEntity, REllipseEntity, RDimAlignedEntity, RDimDiametricEntity, RDimRadialEntity, RSolidEntity, RTextEntity, RArcEntity, RImageEntity, RHatchEntity, RLineEntity, RSplineEntity, RCircleEntity, RPolylineEntity, RBlockReferenceEntity, RLeaderEntity, and RPointEntity.

void REntity::copyAttributesFrom ( REntity * entity )

Copies all attributes (layer, block, color, line weight, line style) from the given entity.

void REntity::dump ( )

virtual void REntity::exportEntity	(	RExporter &	e,
		bool	preview = `false`
	)		const

pure 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.

Implemented in RLeaderEntity, REllipseEntity, RSolidEntity, RTextEntity, RDimensionEntity, RArcEntity, RHatchEntity, RLineEntity, RPolylineEntity, RImageEntity, RSplineEntity, RCircleEntity, RBlockReferenceEntity, and RPointEntity.

virtual bool REntity::flipHorizontal ( )

inlinevirtual

virtual bool REntity::flipVertical ( )

inlinevirtual

RBlock::Id REntity::getBlockId ( ) const

inline

QString REntity::getBlockName ( )

inline

virtual RBox REntity::getBoundingBox ( ) const

inlinevirtual

Returns:: The bounding box that contains this entity.

virtual QList<RBox> REntity::getBoundingBoxes ( ) const

inlinevirtual

Returns:: Vector 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.

virtual QList<RVector> REntity::getCenterPoints ( const RBox & queryBox = RDEFAULT_RBOX ) const

inlinevirtual

Returns:: Vector of center points of this entity. Used for snap to center points.

virtual RVector REntity::getClosestPointOnEntity	(	const RVector &	point,
		double	range = `RNANDOUBLE`,
		bool	limited = `true`
	)		const

inlinevirtual

Returns:: Closest point to point on this entity. Used for snap to points on entity.

virtual QSharedPointer<RShape> REntity::getClosestShape	(	const RVector &	pos,
		double	range = `RNANDOUBLE`
	)		const

inlinevirtual

Returns:: The one shape that is part of this entity which is the closest to the given position.

RColor REntity::getColor ( ) const

inline

RColor REntity::getColor	(	bool	resolve,
		const QStack< RBlockReferenceEntity * > &	blockRefStack
	)

virtual int REntity::getComplexity ( ) const

inlinevirtual

Reimplemented from RObject.

Reimplemented in RPolylineEntity, RSplineEntity, and RHatchEntity.

virtual REntityData& REntity::getData ( )

pure virtual

Returns:: Reference to the data object of the entity.

Implemented in RTextEntity, RDimAngularEntity, REllipseEntity, RDimOrdinateEntity, RDimRotatedEntity, RDimAlignedEntity, RDimDiametricEntity, RSolidEntity, RDimensionEntity, RDimRadialEntity, RArcEntity, RSplineEntity, RHatchEntity, RDimLinearEntity, RLineEntity, RPolylineEntity, RImageEntity, RCircleEntity, RBlockReferenceEntity, RLeaderEntity, and RPointEntity.

virtual const REntityData& REntity::getData ( ) const

pure virtual

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

Implemented in RTextEntity, RDimAngularEntity, RDimOrdinateEntity, RDimRotatedEntity, REllipseEntity, RDimAlignedEntity, RDimDiametricEntity, RDimRadialEntity, RSolidEntity, RArcEntity, RSplineEntity, RDimensionEntity, RHatchEntity, RLineEntity, RPolylineEntity, RImageEntity, RCircleEntity, RLeaderEntity, RBlockReferenceEntity, RDimLinearEntity, and RPointEntity.

virtual double REntity::getDistanceTo	(	const RVector &	point,
		bool	limited = `true`,
		double	range = `0.0`,
		bool	draft = `false`
	)		const

inlinevirtual

int REntity::getDrawOrder ( ) const

inline

Returns:: The draw order of this entity. Entities are usually drawn in ascending order of this number.

virtual QList<RVector> REntity::getEndPoints ( const RBox & queryBox = RDEFAULT_RBOX ) const

inlinevirtual

Returns:: Vector of end points of this entity. Used for snap to end points.

QList< RVector > REntity::getIntersectionPoints	(	const REntity &	other,
		bool	limited = `true`,
		const RBox &	queryBox = `RDEFAULT_RBOX`
	)		const

virtual

QList< RVector > REntity::getIntersectionPoints	(	const RShape &	shape,
		bool	limited = `true`,
		const RBox &	queryBox = `RDEFAULT_RBOX`
	)		const

virtual

RLayer::Id REntity::getLayerId ( ) const

inline

QString REntity::getLayerName ( )

inline

RLinetype::Id REntity::getLinetypeId ( ) const

inline

RLinetype::Id REntity::getLinetypeId	(	bool	resolve,
		const QStack< RBlockReferenceEntity * > &	blockRefStack
	)		const

RLineweight::Lineweight REntity::getLineweight ( ) const

inline

RLineweight::Lineweight REntity::getLineweight	(	bool	resolve,
		const QStack< RBlockReferenceEntity * > &	blockRefStack
	)		const

double REntity::getLineweightInUnits ( const QStack< RBlockReferenceEntity * > & blockRefStack ) const

virtual QList<RVector> REntity::getMiddlePoints ( const RBox & queryBox = RDEFAULT_RBOX ) const

inlinevirtual

Returns:: Vector of middle points of this entity. Used for snap to middle points.

virtual RVector REntity::getPointOnEntity ( ) const

inlinevirtual

Returns:: A point that is on the entity. Used to check if an entity is inside a polygon.

virtual QList<RVector> REntity::getPointsWithDistanceToEnd	(	double	distance,
		RS::From	from = `RS::FromAny`,
		const RBox &	queryBox = `RDEFAULT_RBOX`
	)		const

inlinevirtual

Returns:: Points on entity with given distance to either endpoint. Used for snap to points with distance on entity.

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

Reimplemented in RDimAngularEntity, REllipseEntity, RDimOrdinateEntity, RDimRotatedEntity, RDimAlignedEntity, RDimDiametricEntity, RDimRadialEntity, RSolidEntity, RTextEntity, RDimensionEntity, RArcEntity, RDimLinearEntity, RHatchEntity, RLineEntity, RPolylineEntity, RImageEntity, RSplineEntity, RCircleEntity, RBlockReferenceEntity, RLeaderEntity, and RPointEntity.

virtual QList<RVector> REntity::getReferencePoints ( RS::ProjectionRenderingHint hint = RS::RenderTop ) const

inlinevirtual

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.

virtual QList<QSharedPointer<RShape> > REntity::getShapes ( const RBox & queryBox = RDEFAULT_RBOX ) const

inlinevirtual

Returns:: Shapes that represent the geometry of this entity.

Reimplemented in RHatchEntity, and RTextEntity.

virtual RS::EntityType REntity::getType ( ) const

inlinevirtual

virtual RVector REntity::getVectorTo	(	const RVector &	point,
		bool	limited = `true`
	)		const

inlinevirtual

Returns:: The distance vector from this entity to the given point.

Parameters:

point	the point to which the distance was measured
limited,:	If 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).

void REntity::init ( )

static

Reimplemented from RObject.

Reimplemented in RDimAngularEntity, RDimOrdinateEntity, RDimRotatedEntity, REllipseEntity, RDimLinearEntity, RDimAlignedEntity, RDimensionEntity, RDimDiametricEntity, RDimRadialEntity, RSolidEntity, RTextEntity, RArcEntity, RImageEntity, RHatchEntity, RLineEntity, RSplineEntity, RCircleEntity, RPolylineEntity, RBlockReferenceEntity, RLeaderEntity, and RPointEntity.

virtual bool REntity::intersectsWith ( const RShape & shape ) const

inlinevirtual

Returns:: True if this entity intersects with the given shape, false otherwise.

Todo:: better to pass another entity data object?

bool REntity::isEditable ( bool allowInvisible = false ) const

Returns:: true if this entity can be edited (i.e. is not on a locked layer).

virtual bool REntity::isInside ( const RBox & box ) const

inlinevirtual

Returns:: True if this entity is completely inside the given box, false otherwise. Only geometry is accounted for, not the line width.

virtual bool REntity::isOnEntity	(	const RVector &	point,
		bool	limited = `true`
	)		const

inlinevirtual

Returns:: True if the given point is on this entity.

bool REntity::isSelected ( ) const

inline

Returns:: True if the entity is currently selected. This can for example influence the color in which the entity is exported.

virtual bool REntity::isSelectedForPropertyEditing ( )

inlinevirtual

Returns:: True if this object is selected for editing. This means that the properties of this object should for example be shown in a property editor.

Implements RObject.

bool REntity::isVisible ( ) const

Returns:: true if this entity is visible (i.e. is not on a frozen layer or in a frozen block).

virtual bool REntity::mirror ( const RLine & axis )

inlinevirtual

virtual bool REntity::mirror	(	const RVector &	axis1,
		const RVector &	axis2
	)

inlinevirtual

virtual bool REntity::move ( const RVector & offset )

inlinevirtual

Moves this entity by the given offset.

Returns:: Points on entity which are intersection points in the given document.; True if this entity intersects with the given box or is completely inside it, false otherwise.

virtual bool REntity::moveReferencePoint	(	const RVector &	referencePoint,
		const RVector &	targetPoint
	)

inlinevirtual

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.

void REntity::print ( QDebug dbg ) const

protectedvirtual

Stream operator for QDebug.

Reimplemented from RObject.

Reimplemented in REllipseEntity, RSplineEntity, RPolylineEntity, RLeaderEntity, RTextEntity, RArcEntity, RLineEntity, RSolidEntity, RDimensionEntity, RDimRotatedEntity, RHatchEntity, RBlockReferenceEntity, RDimOrdinateEntity, RImageEntity, RDimAlignedEntity, RDimDiametricEntity, RDimAngularEntity, RDimRadialEntity, RDimLinearEntity, RCircleEntity, and RPointEntity.

virtual bool REntity::rotate	(	double	rotation,
		const RVector &	center = `RDEFAULT_RVECTOR`
	)

inlinevirtual

virtual bool REntity::scale	(	const RVector &	scaleFactors,
		const RVector &	center = `RDEFAULT_RVECTOR`
	)

inlinevirtual

virtual bool REntity::scale	(	double	scaleFactor,
		const RVector &	center = `RDEFAULT_RVECTOR`
	)

inlinevirtual

void REntity::setBlockId ( RBlock::Id blockId )

inline

void REntity::setColor ( const RColor & color )

inline

void REntity::setDocument ( RDocument * document )

inline

Reimplemented from RObject.

void REntity::setDrawOrder ( int drawOrder )

inline

Sets the draw order of this entity.

void REntity::setLayerId ( RLayer::Id layerId )

inline

void REntity::setLinetype ( RLinetype linetype )

inline

void REntity::setLinetypeId ( RLinetype::Id linetypeId )

inline

void REntity::setLineweight ( RLineweight::Lineweight lineweight )

inline

bool REntity::setProperty	(	RPropertyTypeId	propertyTypeId,
		const QVariant &	value
	)

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 RObject.

Reimplemented in RDimAngularEntity, REllipseEntity, RDimOrdinateEntity, RDimRotatedEntity, RDimAlignedEntity, RDimDiametricEntity, RDimRadialEntity, RSolidEntity, RTextEntity, RDimensionEntity, RArcEntity, RDimLinearEntity, RLineEntity, RPolylineEntity, RImageEntity, RSplineEntity, RCircleEntity, RHatchEntity, RBlockReferenceEntity, RLeaderEntity, and RPointEntity.

void REntity::setSelected ( bool on )

Selects or deselects this entity.

virtual bool REntity::stretch	(	const RPolyline &	area,
		const RVector &	offset
	)

inlinevirtual

Stretches the end points of this entity that are inside area by offset.

void REntity::update ( ) const

inline

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

Reimplemented in RBlockReferenceEntity.

Member Data Documentation

RPropertyTypeId REntity::PropertyBlock

static

RPropertyTypeId REntity::PropertyColor

static

RPropertyTypeId REntity::PropertyCustom

static

Reimplemented from RObject.

Reimplemented in RDimAlignedEntity, RDimAngularEntity, RDimDiametricEntity, RDimensionEntity, RDimLinearEntity, RDimOrdinateEntity, RDimRadialEntity, RDimRotatedEntity, RPolylineEntity, RTextEntity, RArcEntity, REllipseEntity, RLeaderEntity, RCircleEntity, RHatchEntity, RImageEntity, RLineEntity, RPointEntity, RSolidEntity, RSplineEntity, and RBlockReferenceEntity.

RPropertyTypeId REntity::PropertyDrawOrder

static

RPropertyTypeId REntity::PropertyHandle

static

Reimplemented from RObject.

Reimplemented in RDimAlignedEntity, RDimAngularEntity, RDimDiametricEntity, RDimensionEntity, RDimLinearEntity, RDimOrdinateEntity, RDimRadialEntity, RDimRotatedEntity, RPolylineEntity, RTextEntity, RArcEntity, REllipseEntity, RLeaderEntity, RCircleEntity, RHatchEntity, RImageEntity, RLineEntity, RPointEntity, RSolidEntity, RSplineEntity, and RBlockReferenceEntity.

RPropertyTypeId REntity::PropertyLayer

static

RPropertyTypeId REntity::PropertyLinetype

static

RPropertyTypeId REntity::PropertyLineweight

static

RPropertyTypeId REntity::PropertyType

static

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

src/core/REntity.h
src/core/REntity.cpp

Public Member Functions

Static Public Member Functions

Static Public Attributes

Protected Member Functions

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation