RObject

Class in Core Module
Header: #include <src/core/RObject.h>
Inherited by: RBlock, RDimStyle, RDocumentVariables, REntity, RLayer, RLayerState, RLayout, RLinetype, RUcs, RView

Description

Abstract base class for all objects.

Objects have an unique ID. Object types may register property types. Objects manage their own set of properties. Example objects are entities, layers, user coordinate systems.

See also: RPropertyTypeId

Scriptable: This class is available in script environments.

Shared Pointer Support: Objects can be used in QSharedPointer.

Public Types


typedef	int Handle
typedef	int Id
enum	ObjectFlag { `NoFlags, Undone, Protect, Selected, Invisible, WorkingSet` }
enum	XYZ { `X, Y, Z` }

Public Functions


	RObject`(const RObject &other)`
	RObject`(RDocument *document=NULL)`
virtual	~RObject`()`
virtual QSharedPointer< RObject >	clone`() const =0` = 0
void	copyCustomPropertiesFrom`(const 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.
void	dump`() const`
virtual void	forceAutoUpdate`()`
virtual int	getComplexity`() 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 QPair< QVariant, RPropertyAttributes >	getProperty`(RPropertyTypeId &propertyTypeId, bool humanReadable=false, bool noAttributes=false, bool showOnRequest=false)`
virtual QSet< RPropertyTypeId >	getPropertyTypeIds`(RPropertyAttributes::Option option=RPropertyAttributes::NoOptions) const`
virtual RS::EntityType	getType`() const`
bool	hasCustomProperties`() const`
bool	hasCustomProperty`(const QString &title, const QRegularExpression &key) const`
bool	hasCustomProperty`(const QString &title, const QString &key) const`
virtual bool	hasPropertyType`(RPropertyTypeId propertyTypeId)`
bool	isInvisible`() const`
virtual bool	isOfType`(RS::EntityType t) const` Override to indicate that this entity is of a certain type, e.g.
bool	isProtected`() const`
virtual bool	isSelected`() 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.
virtual void	setAutoUpdatesBlocked`(bool on)`
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.
void	setDocument`(RDocument *document)`
void	setFlag`(int flag, bool on=true)`
void	setInvisible`(bool on)`
virtual bool	setProperty`(RPropertyTypeId propertyTypeId, const QVariant &value, RTransaction *transaction=NULL)` Sets the given property to the given value.
void	setProtected`(bool on)`
virtual void	setSelected`(bool on)`
virtual void	setWorkingSet`(bool on)`
virtual bool	validate`()`

Static Public Functions


static RPropertyAttributes	getCustomPropertyAttributes`(const QString &title, const QString &key)`
static RS::EntityType	getRtti`()`
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.
static bool	setMember`(T &variable, const QVariant &value, bool condition=true)`

Static Public Attributes


static const Handle	INVALID_HANDLE
static const Id	INVALID_ID
static RPropertyTypeId	PropertyCustom
static RPropertyTypeId	PropertyHandle
static RPropertyTypeId	PropertyInvisible
static RPropertyTypeId	PropertyProtected
static RPropertyTypeId	PropertySelected
static RPropertyTypeId	PropertyType
static RPropertyTypeId	PropertyWorkingSet
static const Handle	UNKNOWN_HANDLE

Protected Functions


virtual void	print`(QDebug dbg) const` Stream operator for QDebug.
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.
void	setUndone`(bool on)`

Static Protected Functions


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	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`(QList< double > &variable, const QVariant &value, bool condition)`
static bool	setMember`(QList< int > &variable, const QVariant &value, bool condition)`
static bool	setMember`(QString &variable, const QVariant &value, bool condition=true)` Sets the given property.
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)`

Private Attributes


QMap< QString, QVariantMap >	customProperties AppID -> key -> value e.g.
RDocument *	document
Flags	flags Object flags (undone, protected, …).
Handle	handle Handle of this object (from DXF / DWG).
Id	objectId Unique ID of this object.

Static Private Attributes


static QMap< QString, QMap< QString, RPropertyAttributes > >	customPropertyAttributes Attributes of custom properties (read-only, invisible, …).

Friends


QDebug	operator<<`(QDebug dbg, const RObject &o)`
class	RStorage

Member Documentation

Handle

typedef int RObject::Handle

Id

typedef int RObject::Id

ObjectFlag

enum ObjectFlag

Value	Description
`NoFlags` `= 0x000`
`Undone` `= 0x001`	object is undone
`Protect` `= 0x002`	object is protected
`Selected` `= 0x004`	object is selected
`Invisible` `= 0x008`	object is invisible
`WorkingSet` `= 0x010`	object is part of the current working set

XYZ

enum XYZ

Value	Description
`X`
`Y`
`Z`

RObject

RObject::RObject(const RObject &other)

RObject

RObject::RObject(RDocument *document=NULL)

~RObject

virtual RObject::~RObject()

virtual

clone

virtual QSharedPointer< RObject > RObject::clone() const =0 = 0

pure virtual const

Reimplemented in clone, clone, clone, clone, clone, clone, clone, clone, clone, clone, clone, clone, clone, clone, clone, clone, clone, clone, clone, clone, clone, clone, clone, clone, clone, clone, clone, clone, clone, clone, clone, clone, clone, clone, clone, clone, clone, clone, clone, clone, clone.

copyCustomPropertiesFrom

void RObject::copyCustomPropertiesFrom(const 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.

Existing properties can be overwritten.

dump

void RObject::dump() const

inline const

forceAutoUpdate

virtual void RObject::forceAutoUpdate()

virtual inline

Reimplemented in forceAutoUpdate.

getComplexity

virtual int RObject::getComplexity() const

virtual inline const

Reimplemented in getComplexity, getComplexity, getComplexity, getComplexity.

getCustomBoolProperty

virtual bool RObject::getCustomBoolProperty(const QString &title, const QString &key, bool defaultValue) const

virtual const

getCustomDoubleProperty

virtual double RObject::getCustomDoubleProperty(const QString &title, const QString &key, double defaultValue) const

virtual const

getCustomIntProperty

virtual int RObject::getCustomIntProperty(const QString &title, const QString &key, int defaultValue) const

virtual const

getCustomProperties

QMap< QString, QVariantMap > RObject::getCustomProperties() const

const

Non-Scriptable: This function is not available in script environments.

Returns: Map of custom properties assigned to this object.

getCustomProperty

virtual QVariant RObject::getCustomProperty(const QString &title, const QString &key, const QVariant &defaultValue=RDEFAULT_QVARIANT) const

virtual const

Returns: Value of given custom property or the given default value if no such property exists.

getCustomPropertyKeys

QStringList RObject::getCustomPropertyKeys(const QString &title) const

const

Returns: List of custom property keys for the given title (application).

getCustomPropertyTitles

QStringList RObject::getCustomPropertyTitles() const

const

Returns: List of custom property titles. These are typically names of applications which have assigned custom properties to this object.

getCustomPropertyTypeIds

virtual QSet< RPropertyTypeId > RObject::getCustomPropertyTypeIds() const

virtual const

Returns: A set of all custom property IDs of properties that are available for this object.

Reimplemented in getCustomPropertyTypeIds.

getDocument

RDocument * RObject::getDocument()

inline

getDocument

const RDocument * RObject::getDocument() const

inline const

getFlag

bool RObject::getFlag(int flag) const

inline const

getHandle

RObject::Handle RObject::getHandle() const

inline const

getId

RObject::Id RObject::getId() const

inline const

Returns: The ID of the object or -1 if the object has no ID. An object without ID is not stored in the DB and not part of a document.

getProperty

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

getPropertyTypeIds

virtual QSet< RPropertyTypeId > RObject::getPropertyTypeIds(RPropertyAttributes::Option option=RPropertyAttributes::NoOptions) const

virtual const

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

getType

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

virtual inline const

Returns: The unique entity type, usually the same as RTTI, different for custom entities.

Reimplemented in getType, getType, getType, getType, getType, getType, getType, getType, getType, getType.

hasCustomProperties

bool RObject::hasCustomProperties() const

const

hasCustomProperty

bool RObject::hasCustomProperty(const QString &title, const QRegularExpression &key) const

const

Non-Scriptable: This function is not available in script environments.

hasCustomProperty

bool RObject::hasCustomProperty(const QString &title, const QString &key) const

const

hasPropertyType

virtual bool RObject::hasPropertyType(RPropertyTypeId propertyTypeId)

virtual inline

Returns: True if this property owner has a property with the given ID, false otherwise.

isInvisible

bool RObject::isInvisible() const

inline const

isOfType

virtual bool RObject::isOfType(RS::EntityType t) const

virtual inline const

Override to indicate that this entity is of a certain type, e.g.

a block reference even if type ID is different.

isProtected

bool RObject::isProtected() const

inline const

isSelected

virtual bool RObject::isSelected() const

virtual inline const

Reimplemented in isSelected.

isUndone

bool RObject::isUndone() const

inline const

isWorkingSet

virtual bool RObject::isWorkingSet() const

virtual inline const

mustAlwaysClone

virtual bool RObject::mustAlwaysClone() const

virtual inline const

Returns: True to always clone object instead of saving diff when object changes. This can be used for complex object types which cannot be modified using properties.

Reimplemented in mustAlwaysClone.

removeCustomProperty

virtual void RObject::removeCustomProperty(const QString &title, const QString &key)

virtual

Removes the custom property with the given name.

setAutoUpdatesBlocked

virtual void RObject::setAutoUpdatesBlocked(bool on)

virtual inline

Reimplemented in setAutoUpdatesBlocked.

setCustomProperties

virtual void RObject::setCustomProperties(const RQMapQStringQString &properties)

virtual

Non-Scriptable: This function is not available in script environments.

setCustomProperty

virtual void RObject::setCustomProperty(const QString &title, const QString &key, const QVariant &value)

virtual

Sets a custom property with the given name.

Reimplemented in setCustomProperty.

setDocument

void RObject::setDocument(RDocument *document)

setFlag

void RObject::setFlag(int flag, bool on=true)

inline

setInvisible

void RObject::setInvisible(bool on)

inline

setProperty

virtual bool RObject::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.

setProtected

void RObject::setProtected(bool on)

inline

setSelected

virtual void RObject::setSelected(bool on)

virtual inline

Reimplemented in setSelected.

setWorkingSet

virtual void RObject::setWorkingSet(bool on)

virtual inline

validate

virtual bool RObject::validate()

virtual inline

Reimplemented in validate.

getCustomPropertyAttributes

static RPropertyAttributes RObject::getCustomPropertyAttributes(const QString &title, const QString &key)

static

Returns: attributes (read-only, invisible, …) for the given custom property.

getRtti

static RS::EntityType RObject::getRtti()

static inline

init

static void RObject::init()

static

setCustomPropertyAttributes

static void RObject::setCustomPropertyAttributes(const QString &title, const QString &key, const RPropertyAttributes &att)

static

Set attributes (read-only, invisible, …) for the given custom property.

setMember

template <class T>
static bool RObject::setMember(T &variable, const QVariant &value, bool condition=true)

static inline

Non-Scriptable: This function is not available in script environments.

INVALID_HANDLE

static const RObject::Handle RObject::INVALID_HANDLE = -1

static

INVALID_ID

static const RObject::Id RObject::INVALID_ID = -1

static

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.

PropertyCustom

static RPropertyTypeId RObject::PropertyCustom

static

PropertyHandle

static RPropertyTypeId RObject::PropertyHandle

static

PropertyInvisible

static RPropertyTypeId RObject::PropertyInvisible

static

PropertyProtected

static RPropertyTypeId RObject::PropertyProtected

static

PropertySelected

static RPropertyTypeId RObject::PropertySelected

static

PropertyType

static RPropertyTypeId RObject::PropertyType

static

PropertyWorkingSet

static RPropertyTypeId RObject::PropertyWorkingSet

static

UNKNOWN_HANDLE

static const RObject::Handle RObject::UNKNOWN_HANDLE = -2

static

print

virtual void RObject::print(QDebug dbg) const

virtual const protected

Stream operator for QDebug.

Reimplemented in print, print, print, print, print, print, print, print, print, print, print, print, print, print, print, print, print, print, print, print, print, print, print, print, print, print, print, print, print, print, print, print, print, print, print, print, print, print, print, print.

setHandle

void RObject::setHandle(RObject::Handle h)

inline protected

setId

void RObject::setId(RObject::Id id)

inline protected

setMemberFlag

bool RObject::setMemberFlag(int flag, const QVariant &value, bool condition=true)

protected

This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.

Non-Scriptable: This function is not available in script environments.

setUndone

void RObject::setUndone(bool on)

protected

setMember

static bool RObject::setMember(bool &variable, const QVariant &value, bool condition=true)

static protected

This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.

Non-Scriptable: This function is not available in script environments.

setMember

static bool RObject::setMember(double &variable, const QVariant &value, bool condition=true)

static protected

This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.

Non-Scriptable: This function is not available in script environments.

setMember

static bool RObject::setMember(int &variable, const QVariant &value, bool condition=true)

static protected

This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.

Non-Scriptable: This function is not available in script environments.

setMember

static bool RObject::setMember(QList< double > &variable, const QVariant &value, bool condition)

static protected

Non-Scriptable: This function is not available in script environments.

Parameters:

value: A list for int / double pairs: QList<QPair<int, double> >

setMember

static bool RObject::setMember(QList< int > &variable, const QVariant &value, bool condition)

static protected

Non-Scriptable: This function is not available in script environments.

Parameters:

value: A list for int / int pairs: QList<QPair<int, int> >

setMember

static bool RObject::setMember(QString &variable, const QVariant &value, bool condition=true)

static protected

Sets the given property.

Non-Scriptable: This function is not available in script environments.

Parameters:

variable: a reference to the (member) variable we want to set
value: the new value
condition: the variable is only set to the new value if condition is true

Return values:

true: if condition is true and the value was successfully converted to the same type as the variable.

setMemberVector

static bool RObject::setMemberVector(QList< RVector > &variable, const QVariant &value, RObject::XYZ xyz)

static protected

Non-Scriptable: This function is not available in script environments.

Parameters:

value: A QList of QPairs of int and double where the int is the index and the double the value.

setMemberX

static bool RObject::setMemberX(QList< RVector > &variable, const QVariant &value, bool condition=true)

static protected

Non-Scriptable: This function is not available in script environments.

Parameters:

value: A list of int / double pairs: QList<QPair<int, double> > representing indexes in the list and values.

setMemberY

static bool RObject::setMemberY(QList< RVector > &variable, const QVariant &value, bool condition=true)

static protected

Non-Scriptable: This function is not available in script environments.

Parameters:

value: A list of int / double pairs: QList<QPair<int, double> > representing indexes in the list and values.

setMemberZ

static bool RObject::setMemberZ(QList< RVector > &variable, const QVariant &value, bool condition=true)

static protected

Non-Scriptable: This function is not available in script environments.

Parameters:

value: A list of int / double pairs: QList<QPair<int, double> > representing indexes in the list and values.

customProperties

QMap<QString, QVariantMap> RObject::customProperties

private

AppID -> key -> value e.g.

‘QCAD’ -> ‘wall thickness’ -> 12.0; or ‘SomeApplication’ -> ‘00001_1000’ -> ‘SomeString’ where ‘00001’ is the position in the list of values and 1000 is the original DXF code from the file.

document

RDocument* RObject::document

private

flags

Flags RObject::flags

private

Object flags (undone, protected, …).

handle

Handle RObject::handle

private

Handle of this object (from DXF / DWG).

objectId

Id RObject::objectId

private

Unique ID of this object.

customPropertyAttributes

static QMap< QString, QMap< QString, RPropertyAttributes > > RObject::customPropertyAttributes

static private

Attributes of custom properties (read-only, invisible, …).

operator<<

QDebug operator<<(QDebug dbg, const RObject &o)

inline

Non-Scriptable: This function is not available in script environments.

RStorage

friend class RStorage

private