QCAD
Open Source 2D CAD
RViewportEntity Class Reference

Viewport entity. More...

#include <RViewportEntity.h>

Inheritance diagram for RViewportEntity:
REntity RObject

Public Member Functions

virtual RViewportEntityclone () 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 RViewportDatagetData ()
 
virtual const RViewportDatagetData () const
 
double getHeight () const
 
QPair< QVariant, RPropertyAttributesgetProperty (RPropertyTypeId &propertyTypeId, bool humanReadable=false, bool noAttributes=false)
 
double getRotation () const
 
double getScale () const
 
int getStatus () const
 
RVector getViewCenter () 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)
 
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 RShapecastToConstShape () const
 
virtual RShapecastToShape ()
 
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)
 
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 isOnEntity (const RVector &point, bool limited=true, double tolerance=RDEFAULT_TOLERANCE_1E_MIN4) const
 
virtual bool isSane () 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). More...
 
virtual bool isSelectedForPropertyEditing ()
 
virtual bool isUpdatesEnabled () const
 
virtual bool isValid () const
 
virtual 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. 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...
 
 REntity (RDocument *document)
 
 REntity (const REntity &other)
 
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 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 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...
 
void setUpdatesEnabled (bool on)
 
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)
 Copies all custom properties from the given object. More...
 
void dump () const
 
bool getCustomBoolProperty (const QString &title, const QString &key, bool defaultValue) const
 
double getCustomDoubleProperty (const QString &title, const QString &key, double defaultValue) const
 
int getCustomIntProperty (const QString &title, const QString &key, int defaultValue) const
 
QMap< QString, QVariantMap > getCustomProperties () const
 
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
 
RObject::Handle getHandle () const
 
RObject::Id getId () const
 
virtual QSet< RPropertyTypeIdgetPropertyTypeIds () const
 
bool hasCustomProperties () const
 
bool hasCustomProperty (const QString &title, const QString &key) const
 
bool hasCustomProperty (const QString &title, const QRegExp &key) const
 
virtual bool hasPropertyType (RPropertyTypeId propertyTypeId)
 
bool isProtected () const
 
bool isUndone () const
 
void removeCustomProperty (const QString &title, const QString &key)
 Removes the custom property with the given name. More...
 
 RObject (RDocument *document=NULL)
 
 RObject (const RObject &other)
 
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 setProtected (bool on)
 
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 Public Member Functions inherited from RObject
static void init ()
 
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-2017 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-2017 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 Public Attributes inherited from RObject
static const Handle INVALID_HANDLE = -1
 
static const Id INVALID_ID = -1
 Copyright (c) 2011-2017 by Andrew Mustun. More...
 
static RPropertyTypeId PropertyCustom
 
static RPropertyTypeId PropertyHandle
 
static RPropertyTypeId PropertyProtected
 
static RPropertyTypeId PropertyType
 

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)
 
void setUndone (bool on)
 

Protected Attributes

RViewportData data
 

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. 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 (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 (QList< double > &variable, const QVariant &value, bool condition)
 
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:
This class is available in script environments.
Shared Pointer Support:
Objects can be used in QSharedPointer.

Constructor & Destructor Documentation

RViewportEntity::RViewportEntity ( RDocument document,
const RViewportData data 
)
RViewportEntity::~RViewportEntity ( )
virtual

Member Function Documentation

virtual RViewportEntity* RViewportEntity::clone ( ) const
inlinevirtual

Implements REntity.

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.

RVector RViewportEntity::getCenter ( ) const
inline
virtual RViewportData& RViewportEntity::getData ( )
inlinevirtual
Returns
Reference to the data object of the entity.

Implements REntity.

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

Implements REntity.

double RViewportEntity::getHeight ( ) const
inline
QPair< QVariant, RPropertyAttributes > RViewportEntity::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.

double RViewportEntity::getRotation ( ) const
inline
double RViewportEntity::getScale ( ) const
inline
static QSet<RPropertyTypeId> RViewportEntity::getStaticPropertyTypeIds ( )
inlinestatic
int RViewportEntity::getStatus ( ) const
inline
RVector RViewportEntity::getViewCenter ( ) const
inline
int RViewportEntity::getViewportId ( ) const
inline
RVector RViewportEntity::getViewTarget ( ) const
inline
double RViewportEntity::getWidth ( ) const
inline
void RViewportEntity::init ( )
static
bool RViewportEntity::isOff ( ) const
inline
bool RViewportEntity::isOverall ( ) const
inline
void RViewportEntity::print ( QDebug  dbg) const
protectedvirtual

Stream operator for QDebug.

Reimplemented from REntity.

void RViewportEntity::setCenter ( const RVector c)
inline
void RViewportEntity::setData ( RViewportData d)
void RViewportEntity::setHeight ( double  h)
inline
void RViewportEntity::setOff ( bool  v)
inline
void RViewportEntity::setOverall ( bool  on)
inline
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.

void RViewportEntity::setRotation ( double  r)
inline
void RViewportEntity::setScale ( double  s)
inline
void RViewportEntity::setStatus ( int  s)
inline
void RViewportEntity::setViewCenter ( const RVector c)
inline
void RViewportEntity::setViewportId ( int  id)
inline
void RViewportEntity::setViewTarget ( const RVector t)
inline
void RViewportEntity::setWidth ( double  w)
inline

Member Data Documentation

RViewportData RViewportEntity::data
protected
RPropertyTypeId RViewportEntity::PropertyBlock
static
RPropertyTypeId RViewportEntity::PropertyCenterX
static
RPropertyTypeId RViewportEntity::PropertyCenterY
static
RPropertyTypeId RViewportEntity::PropertyCenterZ
static
RPropertyTypeId RViewportEntity::PropertyColor
static
RPropertyTypeId RViewportEntity::PropertyCustom
static

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

RPropertyTypeId RViewportEntity::PropertyDisplayedColor
static
RPropertyTypeId RViewportEntity::PropertyDrawOrder
static
RPropertyTypeId RViewportEntity::PropertyHandle
static
RPropertyTypeId RViewportEntity::PropertyHeight
static
RPropertyTypeId RViewportEntity::PropertyLayer
static
RPropertyTypeId RViewportEntity::PropertyLinetype
static
RPropertyTypeId RViewportEntity::PropertyLinetypeScale
static
RPropertyTypeId RViewportEntity::PropertyLineweight
static
RPropertyTypeId RViewportEntity::PropertyOn
static
RPropertyTypeId RViewportEntity::PropertyOverall
static
RPropertyTypeId RViewportEntity::PropertyRotation
static
RPropertyTypeId RViewportEntity::PropertyScale
static
RPropertyTypeId RViewportEntity::PropertyType
static
RPropertyTypeId RViewportEntity::PropertyViewCenterX
static
RPropertyTypeId RViewportEntity::PropertyViewCenterY
static
RPropertyTypeId RViewportEntity::PropertyViewTargetX
static
RPropertyTypeId RViewportEntity::PropertyViewTargetY
static
RPropertyTypeId RViewportEntity::PropertyViewTargetZ
static
RPropertyTypeId RViewportEntity::PropertyWidth
static

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