Skip to content
Download QCAD
QCAD API Reference

RSolidEntity

Class in Entity Module
Header: #include <src/entity/RSolidEntity.h>
Inherits: REntity

Description

Section titled “Description”

Solid entity.

Scriptable: This class is available in script environments.

Shared Pointer Support: Objects can be used in QSharedPointer.

Public Functions

Section titled “Public Functions”
RSolidEntity(RDocument *document, const RSolidData &data)
virtual ~RSolidEntity()
virtual QSharedPointer< RObject > clone() const
QSharedPointer< RSolidEntity > cloneToSolidEntity() const
int countVertices() const
virtual void exportEntity(RExporter &e, bool preview=false, bool forceSelected=false) const
Exports the entity to the given exporter.
virtual RSolidData & getData()
virtual const RSolidData & getData() const
double getDirection1() const
double getDirection2() const
RVector getEndPoint() const
QList< QSharedPointer< RShape > > getExploded() const
double getLength() const
virtual QPair< QVariant, RPropertyAttributes > getProperty(RPropertyTypeId &propertyTypeId, bool humanReadable=false, bool noAttributes=false, bool showOnRequest=false)
RVector getStartPoint() const
RS::Ending getTrimEnd(const RVector &trimPoint, const RVector &clickPoint)
RVector getVertexAt(int i) const
bool reverse()
virtual bool setProperty(RPropertyTypeId propertyTypeId, const QVariant &value, RTransaction *transaction=NULL)
Sets the given property to the given value.
bool trimEndPoint(const RVector &trimPoint, const RVector &clickPoint=RVector::invalid, bool extend=false)
bool trimStartPoint(const RVector &trimPoint, const RVector &clickPoint=RVector::invalid, bool extend=false)

Static Public Functions

Section titled “Static Public Functions”
static RS::EntityType getRtti()
static QSet< RPropertyTypeId > getStaticPropertyTypeIds()
static void init()

Static Public Attributes

Section titled “Static Public Attributes”
static RPropertyTypeId PropertyBlock
static RPropertyTypeId PropertyColor
static RPropertyTypeId PropertyCustom
static RPropertyTypeId PropertyDisplayedColor
static RPropertyTypeId PropertyDrawOrder
static RPropertyTypeId PropertyHandle
static RPropertyTypeId PropertyLayer
static RPropertyTypeId PropertyLength
static RPropertyTypeId PropertyLinetype
static RPropertyTypeId PropertyLinetypeScale
static RPropertyTypeId PropertyLineweight
static RPropertyTypeId PropertyPoint1X
static RPropertyTypeId PropertyPoint1Y
static RPropertyTypeId PropertyPoint1Z
static RPropertyTypeId PropertyPoint2X
static RPropertyTypeId PropertyPoint2Y
static RPropertyTypeId PropertyPoint2Z
static RPropertyTypeId PropertyPoint3X
static RPropertyTypeId PropertyPoint3Y
static RPropertyTypeId PropertyPoint3Z
static RPropertyTypeId PropertyPoint4X
static RPropertyTypeId PropertyPoint4Y
static RPropertyTypeId PropertyPoint4Z
static RPropertyTypeId PropertyProtected
static RPropertyTypeId PropertyTotalLength
static RPropertyTypeId PropertyType
static RPropertyTypeId PropertyWorkingSet

Protected Functions

Section titled “Protected Functions”
virtual void print(QDebug dbg) const
Stream operator for QDebug.

Protected Attributes

Section titled “Protected Attributes”
RSolidData data

Member Documentation

Section titled “Member Documentation”

RSolidEntity

Section titled “RSolidEntity”
RSolidEntity::RSolidEntity(RDocument *document, const RSolidData &data)

~RSolidEntity

Section titled “~RSolidEntity”
virtual RSolidEntity::~RSolidEntity()

virtual

clone

Section titled “clone”
virtual QSharedPointer< RObject > RSolidEntity::clone() const

virtual inline const

Reimplemented from clone.

cloneToSolidEntity

Section titled “cloneToSolidEntity”
QSharedPointer< RSolidEntity > RSolidEntity::cloneToSolidEntity() const

inline const

countVertices

Section titled “countVertices”
int RSolidEntity::countVertices() const

inline const

exportEntity

Section titled “exportEntity”
virtual void RSolidEntity::exportEntity(RExporter &e, bool preview=false, bool forceSelected=false) const

virtual const

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.

Reimplemented from exportEntity.

getData

Section titled “getData”
virtual RSolidData & RSolidEntity::getData()

virtual inline

Returns: Reference to the data object of the entity.

Reimplemented from getData.

getData

Section titled “getData”
virtual const RSolidData & RSolidEntity::getData() const

virtual inline const

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

Reimplemented from getData.

getDirection1

Section titled “getDirection1”
double RSolidEntity::getDirection1() const

inline const

getDirection2

Section titled “getDirection2”
double RSolidEntity::getDirection2() const

inline const

getEndPoint

Section titled “getEndPoint”
RVector RSolidEntity::getEndPoint() const

inline const

getExploded

Section titled “getExploded”
QList< QSharedPointer< RShape > > RSolidEntity::getExploded() const

inline const

getLength

Section titled “getLength”
double RSolidEntity::getLength() const

inline const

getProperty

Section titled “getProperty”
virtual QPair< QVariant, RPropertyAttributes > RSolidEntity::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 getProperty.

getStartPoint

Section titled “getStartPoint”
RVector RSolidEntity::getStartPoint() const

inline const

getTrimEnd

Section titled “getTrimEnd”
RS::Ending RSolidEntity::getTrimEnd(const RVector &trimPoint, const RVector &clickPoint)

inline

getVertexAt

Section titled “getVertexAt”
RVector RSolidEntity::getVertexAt(int i) const

inline const

reverse

Section titled “reverse”
bool RSolidEntity::reverse()

inline

setProperty

Section titled “setProperty”
virtual bool RSolidEntity::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 setProperty.

trimEndPoint

Section titled “trimEndPoint”
bool RSolidEntity::trimEndPoint(const RVector &trimPoint, const RVector &clickPoint=RVector::invalid, bool extend=false)

inline

trimStartPoint

Section titled “trimStartPoint”
bool RSolidEntity::trimStartPoint(const RVector &trimPoint, const RVector &clickPoint=RVector::invalid, bool extend=false)

inline

getRtti

Section titled “getRtti”
static RS::EntityType RSolidEntity::getRtti()

static inline

getStaticPropertyTypeIds

Section titled “getStaticPropertyTypeIds”
static QSet< RPropertyTypeId > RSolidEntity::getStaticPropertyTypeIds()

static inline

init

Section titled “init”
static void RSolidEntity::init()

static

PropertyBlock

Section titled “PropertyBlock”
static RPropertyTypeId RSolidEntity::PropertyBlock

static

PropertyColor

Section titled “PropertyColor”
static RPropertyTypeId RSolidEntity::PropertyColor

static

PropertyCustom

Section titled “PropertyCustom”
static RPropertyTypeId RSolidEntity::PropertyCustom

static

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

Section titled “PropertyDisplayedColor”
static RPropertyTypeId RSolidEntity::PropertyDisplayedColor

static

PropertyDrawOrder

Section titled “PropertyDrawOrder”
static RPropertyTypeId RSolidEntity::PropertyDrawOrder

static

PropertyHandle

Section titled “PropertyHandle”
static RPropertyTypeId RSolidEntity::PropertyHandle

static

PropertyLayer

Section titled “PropertyLayer”
static RPropertyTypeId RSolidEntity::PropertyLayer

static

PropertyLength

Section titled “PropertyLength”
static RPropertyTypeId RSolidEntity::PropertyLength

static

PropertyLinetype

Section titled “PropertyLinetype”
static RPropertyTypeId RSolidEntity::PropertyLinetype

static

PropertyLinetypeScale

Section titled “PropertyLinetypeScale”
static RPropertyTypeId RSolidEntity::PropertyLinetypeScale

static

PropertyLineweight

Section titled “PropertyLineweight”
static RPropertyTypeId RSolidEntity::PropertyLineweight

static

PropertyPoint1X

Section titled “PropertyPoint1X”
static RPropertyTypeId RSolidEntity::PropertyPoint1X

static

PropertyPoint1Y

Section titled “PropertyPoint1Y”
static RPropertyTypeId RSolidEntity::PropertyPoint1Y

static

PropertyPoint1Z

Section titled “PropertyPoint1Z”
static RPropertyTypeId RSolidEntity::PropertyPoint1Z

static

PropertyPoint2X

Section titled “PropertyPoint2X”
static RPropertyTypeId RSolidEntity::PropertyPoint2X

static

PropertyPoint2Y

Section titled “PropertyPoint2Y”
static RPropertyTypeId RSolidEntity::PropertyPoint2Y

static

PropertyPoint2Z

Section titled “PropertyPoint2Z”
static RPropertyTypeId RSolidEntity::PropertyPoint2Z

static

PropertyPoint3X

Section titled “PropertyPoint3X”
static RPropertyTypeId RSolidEntity::PropertyPoint3X

static

PropertyPoint3Y

Section titled “PropertyPoint3Y”
static RPropertyTypeId RSolidEntity::PropertyPoint3Y

static

PropertyPoint3Z

Section titled “PropertyPoint3Z”
static RPropertyTypeId RSolidEntity::PropertyPoint3Z

static

PropertyPoint4X

Section titled “PropertyPoint4X”
static RPropertyTypeId RSolidEntity::PropertyPoint4X

static

PropertyPoint4Y

Section titled “PropertyPoint4Y”
static RPropertyTypeId RSolidEntity::PropertyPoint4Y

static

PropertyPoint4Z

Section titled “PropertyPoint4Z”
static RPropertyTypeId RSolidEntity::PropertyPoint4Z

static

PropertyProtected

Section titled “PropertyProtected”
static RPropertyTypeId RSolidEntity::PropertyProtected

static

PropertyTotalLength

Section titled “PropertyTotalLength”
static RPropertyTypeId RSolidEntity::PropertyTotalLength

static

PropertyType

Section titled “PropertyType”
static RPropertyTypeId RSolidEntity::PropertyType

static

PropertyWorkingSet

Section titled “PropertyWorkingSet”
static RPropertyTypeId RSolidEntity::PropertyWorkingSet

static

print

Section titled “print”
virtual void RSolidEntity::print(QDebug dbg) const

virtual const protected

Stream operator for QDebug.

Reimplemented from print.

data

Section titled “data”
RSolidData RSolidEntity::data

protected