RViewportEntity Class Reference

Viewport entity. More...

#include <RViewportEntity.h>

Inheritance diagram for RViewportEntity:

Public Member Functions
virtual RViewportEntity *	clone () const
virtual void	exportEntity (RExporter &e, bool preview=false, bool forceSelected=false) const
	Exports the entity to the given exporter. More...
RVector	getCenter () const
virtual RViewportData &	getData ()
virtual const RViewportData &	getData () const
double	getHeight () const
RVector	getPosition () const
virtual QPair< QVariant, RPropertyAttributes >	getProperty (RPropertyTypeId &propertyTypeId, bool humanReadable=false, bool noAttributes=false, bool showOnRequest=false)
double	getRotation () const
double	getScale () const
int	getStatus () const
RVector	getViewCenter () const
RVector	getViewOffset () const
int	getViewportId () const
RVector	getViewTarget () const
double	getWidth () const
bool	isOff () const
bool	isOverall () const
	RViewportEntity (RDocument *document, const RViewportData &data)
void	setCenter (const RVector &c)
void	setData (RViewportData &d)
void	setHeight (double h)
void	setOff (bool v)
void	setOverall (bool on)
void	setPosition (const RVector &p)
virtual bool	setProperty (RPropertyTypeId propertyTypeId, const QVariant &value, RTransaction *transaction=NULL)
	Sets the given property to the given value. More...
void	setRotation (double r)
void	setScale (double s)
void	setStatus (int s)
void	setViewCenter (const RVector &c)
void	setViewportId (int id)
void	setViewTarget (const RVector &t)
void	setWidth (double w)
virtual	~RViewportEntity ()
Public Member Functions inherited from REntity
virtual const RShape *	castToConstShape () const
virtual RShape *	castToShape ()
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< RBox >	getBoundingBoxes (bool ignoreEmpty=false) 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, bool ignoreComplex=false) const
virtual QSharedPointer< RShape >	getClosestSimpleShape (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< RVector >	getEndPoints (const RBox &queryBox=RDEFAULT_RBOX) const
virtual RPolyline	getHull (double offset) const
virtual QList< RRefPoint >	getInternalReferencePoints (RS::ProjectionRenderingHint hint=RS::RenderTop) const
	Can be overwritten to return internal, resolved reference points. More...
virtual QList< RVector >	getIntersectionPoints (const REntity &other, bool limited=true, const RBox &queryBox=RDEFAULT_RBOX, bool ignoreComplex=true) const
virtual QList< RVector >	getIntersectionPoints (const RShape &shape, bool limited=true, const RBox &queryBox=RDEFAULT_RBOX, bool ignoreComplex=true) const
virtual QList< RVector >	getIntersectionPointsWithShape (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< RVector >	getMiddlePoints (const RBox &queryBox=RDEFAULT_RBOX) const
REntity::Id	getParentId () const
virtual RVector	getPointOnEntity () const
virtual QList< RVector >	getPointsWithDistanceToEnd (double distance, int from=RS::FromAny, const RBox &queryBox=RDEFAULT_RBOX) const
virtual QList< RRefPoint >	getReferencePoints (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< REntity >	scaleNonUniform (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< RPropertyTypeId >	getCustomPropertyTypeIds () const
RDocument *	getDocument ()
const RDocument *	getDocument () const
bool	getFlag (int flag) const
RObject::Handle	getHandle () const
RObject::Id	getId () const
virtual QSet< RPropertyTypeId >	getPropertyTypeIds (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< RPropertyTypeId >	getStaticPropertyTypeIds ()
static void	init ()
Static Public Member Functions inherited from REntity
static QSet< RPropertyTypeId >	getStaticPropertyTypeIds ()
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	PropertyCenterX
static RPropertyTypeId	PropertyCenterY
static RPropertyTypeId	PropertyCenterZ
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	PropertyHeight
static RPropertyTypeId	PropertyLayer
static RPropertyTypeId	PropertyLinetype
static RPropertyTypeId	PropertyLinetypeScale
static RPropertyTypeId	PropertyLineweight
static RPropertyTypeId	PropertyOn
static RPropertyTypeId	PropertyOverall
static RPropertyTypeId	PropertyRotation
static RPropertyTypeId	PropertyScale
static RPropertyTypeId	PropertyType
static RPropertyTypeId	PropertyViewCenterX
static RPropertyTypeId	PropertyViewCenterY
static RPropertyTypeId	PropertyViewTargetX
static RPropertyTypeId	PropertyViewTargetY
static RPropertyTypeId	PropertyViewTargetZ
static RPropertyTypeId	PropertyWidth
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
RViewportData	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

Viewport entity.

Scriptable:\nThis class is available in script environments.\n

Shared Pointer Support:\nObjects can be used in QSharedPointer.\n

Constructor & Destructor Documentation

RViewportEntity()

RViewportEntity::RViewportEntity	(	RDocument *	document,
		const RViewportData &	data
	)

~RViewportEntity()

RViewportEntity::~RViewportEntity ( )

virtual

Member Function Documentation

clone()

virtual RViewportEntity* RViewportEntity::clone ( ) const

inlinevirtual

Implements REntity.

exportEntity()

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

getCenter()

RVector RViewportEntity::getCenter ( ) const

inline

getData() [1/2]

virtual RViewportData& RViewportEntity::getData ( )

inlinevirtual

Returns

Reference to the data object of the entity.

Implements REntity.

getData() [2/2]

virtual const RViewportData& RViewportEntity::getData ( ) const

inlinevirtual

Returns

Const reference to the data object of the entity.

Implements REntity.

getHeight()

double RViewportEntity::getHeight ( ) const

inline

getPosition()

RVector RViewportEntity::getPosition ( ) const

inline

getProperty()

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

getRotation()

double RViewportEntity::getRotation ( ) const

inline

getScale()

double RViewportEntity::getScale ( ) const

inline

getStaticPropertyTypeIds()

static QSet<RPropertyTypeId> RViewportEntity::getStaticPropertyTypeIds ( )

inlinestatic

getStatus()

int RViewportEntity::getStatus ( ) const

inline

getViewCenter()

RVector RViewportEntity::getViewCenter ( ) const

inline

getViewOffset()

RVector RViewportEntity::getViewOffset ( ) const

inline

getViewportId()

int RViewportEntity::getViewportId ( ) const

inline

getViewTarget()

RVector RViewportEntity::getViewTarget ( ) const

inline

getWidth()

double RViewportEntity::getWidth ( ) const

inline

init()

void RViewportEntity::init ( )

static

isOff()

bool RViewportEntity::isOff ( ) const

inline

isOverall()

bool RViewportEntity::isOverall ( ) const

inline

print()

void RViewportEntity::print ( QDebug  dbg ) const

protectedvirtual

Stream operator for QDebug.

Reimplemented from REntity.

setCenter()

void RViewportEntity::setCenter ( const RVector &  c )

inline

setData()

void RViewportEntity::setData

(

RViewportData &

d

)

setHeight()

void RViewportEntity::setHeight ( double  h )

inline

setOff()

void RViewportEntity::setOff ( bool  v )

inline

setOverall()

void RViewportEntity::setOverall ( bool  on )

inline

setPosition()

void RViewportEntity::setPosition ( const RVector &  p )

inline

setProperty()

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

setRotation()

void RViewportEntity::setRotation ( double  r )

inline

setScale()

void RViewportEntity::setScale ( double  s )

inline

setStatus()

void RViewportEntity::setStatus ( int  s )

inline

setViewCenter()

void RViewportEntity::setViewCenter ( const RVector &  c )

inline

setViewportId()

void RViewportEntity::setViewportId ( int  id )

inline

setViewTarget()

void RViewportEntity::setViewTarget ( const RVector &  t )

inline

setWidth()

void RViewportEntity::setWidth ( double  w )

inline

Member Data Documentation

data

RViewportData RViewportEntity::data

protected

PropertyBlock

RPropertyTypeId RViewportEntity::PropertyBlock

static

PropertyCenterX

RPropertyTypeId RViewportEntity::PropertyCenterX

static

PropertyCenterY

RPropertyTypeId RViewportEntity::PropertyCenterY

static

PropertyCenterZ

RPropertyTypeId RViewportEntity::PropertyCenterZ

static

PropertyColor

RPropertyTypeId RViewportEntity::PropertyColor

static

PropertyCustom

RPropertyTypeId RViewportEntity::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 RViewportEntity::PropertyDisplayedColor

static

PropertyDrawOrder

RPropertyTypeId RViewportEntity::PropertyDrawOrder

static

PropertyHandle

RPropertyTypeId RViewportEntity::PropertyHandle

static

PropertyHeight

RPropertyTypeId RViewportEntity::PropertyHeight

static

PropertyLayer

RPropertyTypeId RViewportEntity::PropertyLayer

static

PropertyLinetype

RPropertyTypeId RViewportEntity::PropertyLinetype

static

PropertyLinetypeScale

RPropertyTypeId RViewportEntity::PropertyLinetypeScale

static

PropertyLineweight

RPropertyTypeId RViewportEntity::PropertyLineweight

static

PropertyOn

RPropertyTypeId RViewportEntity::PropertyOn

static

PropertyOverall

RPropertyTypeId RViewportEntity::PropertyOverall

static

PropertyRotation

RPropertyTypeId RViewportEntity::PropertyRotation

static

PropertyScale

RPropertyTypeId RViewportEntity::PropertyScale

static

PropertyType

RPropertyTypeId RViewportEntity::PropertyType

static

PropertyViewCenterX

RPropertyTypeId RViewportEntity::PropertyViewCenterX

static

PropertyViewCenterY

RPropertyTypeId RViewportEntity::PropertyViewCenterY

static

PropertyViewTargetX

RPropertyTypeId RViewportEntity::PropertyViewTargetX

static

PropertyViewTargetY

RPropertyTypeId RViewportEntity::PropertyViewTargetY

static

PropertyViewTargetZ

RPropertyTypeId RViewportEntity::PropertyViewTargetZ

static

PropertyWidth

RPropertyTypeId RViewportEntity::PropertyWidth

static

---

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

• src/core/RViewportEntity.h
• src/core/RViewportEntity.cpp