Skip to content
Download QCAD
QCAD API Reference

RFaceEntity

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

Description

Section titled “Description”

Face entity.

Scriptable: This class is available in script environments.

Shared Pointer Support: Objects can be used in QSharedPointer.

Public Functions

Section titled “Public Functions”
RFaceEntity(RDocument *document, const RFaceData &data)
virtual ~RFaceEntity()
virtual QSharedPointer< RObject > clone() const
QSharedPointer< RFaceEntity > cloneToFaceEntity() const
int countVertices() const
virtual void exportEntity(RExporter &e, bool preview=false, bool forceSelected=false) const
Exports the entity to the given exporter.
virtual RFaceData & getData()
virtual const RFaceData & 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”
RFaceData data

Member Documentation

Section titled “Member Documentation”

RFaceEntity

Section titled “RFaceEntity”
RFaceEntity::RFaceEntity(RDocument *document, const RFaceData &data)

~RFaceEntity

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

virtual

clone

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

virtual inline const

Reimplemented from clone.

cloneToFaceEntity

Section titled “cloneToFaceEntity”
QSharedPointer< RFaceEntity > RFaceEntity::cloneToFaceEntity() const

inline const

countVertices

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

inline const

exportEntity

Section titled “exportEntity”
virtual void RFaceEntity::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 RFaceData & RFaceEntity::getData()

virtual inline

Returns: Reference to the data object of the entity.

Reimplemented from getData.

getData

Section titled “getData”
virtual const RFaceData & RFaceEntity::getData() const

virtual inline const

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

Reimplemented from getData.

getDirection1

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

inline const

getDirection2

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

inline const

getEndPoint

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

inline const

getExploded

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

inline const

getLength

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

inline const

getProperty

Section titled “getProperty”
virtual QPair< QVariant, RPropertyAttributes > RFaceEntity::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 RFaceEntity::getStartPoint() const

inline const

getTrimEnd

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

inline

getVertexAt

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

inline const

reverse

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

inline

setProperty

Section titled “setProperty”
virtual bool RFaceEntity::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 RFaceEntity::trimEndPoint(const RVector &trimPoint, const RVector &clickPoint=RVector::invalid, bool extend=false)

inline

trimStartPoint

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

inline

getRtti

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

static inline

getStaticPropertyTypeIds

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

static inline

init

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

static

PropertyBlock

Section titled “PropertyBlock”
static RPropertyTypeId RFaceEntity::PropertyBlock

static

PropertyColor

Section titled “PropertyColor”
static RPropertyTypeId RFaceEntity::PropertyColor

static

PropertyCustom

Section titled “PropertyCustom”
static RPropertyTypeId RFaceEntity::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 RFaceEntity::PropertyDisplayedColor

static

PropertyDrawOrder

Section titled “PropertyDrawOrder”
static RPropertyTypeId RFaceEntity::PropertyDrawOrder

static

PropertyHandle

Section titled “PropertyHandle”
static RPropertyTypeId RFaceEntity::PropertyHandle

static

PropertyLayer

Section titled “PropertyLayer”
static RPropertyTypeId RFaceEntity::PropertyLayer

static

PropertyLength

Section titled “PropertyLength”
static RPropertyTypeId RFaceEntity::PropertyLength

static

PropertyLinetype

Section titled “PropertyLinetype”
static RPropertyTypeId RFaceEntity::PropertyLinetype

static

PropertyLinetypeScale

Section titled “PropertyLinetypeScale”
static RPropertyTypeId RFaceEntity::PropertyLinetypeScale

static

PropertyLineweight

Section titled “PropertyLineweight”
static RPropertyTypeId RFaceEntity::PropertyLineweight

static

PropertyPoint1X

Section titled “PropertyPoint1X”
static RPropertyTypeId RFaceEntity::PropertyPoint1X

static

PropertyPoint1Y

Section titled “PropertyPoint1Y”
static RPropertyTypeId RFaceEntity::PropertyPoint1Y

static

PropertyPoint1Z

Section titled “PropertyPoint1Z”
static RPropertyTypeId RFaceEntity::PropertyPoint1Z

static

PropertyPoint2X

Section titled “PropertyPoint2X”
static RPropertyTypeId RFaceEntity::PropertyPoint2X

static

PropertyPoint2Y

Section titled “PropertyPoint2Y”
static RPropertyTypeId RFaceEntity::PropertyPoint2Y

static

PropertyPoint2Z

Section titled “PropertyPoint2Z”
static RPropertyTypeId RFaceEntity::PropertyPoint2Z

static

PropertyPoint3X

Section titled “PropertyPoint3X”
static RPropertyTypeId RFaceEntity::PropertyPoint3X

static

PropertyPoint3Y

Section titled “PropertyPoint3Y”
static RPropertyTypeId RFaceEntity::PropertyPoint3Y

static

PropertyPoint3Z

Section titled “PropertyPoint3Z”
static RPropertyTypeId RFaceEntity::PropertyPoint3Z

static

PropertyPoint4X

Section titled “PropertyPoint4X”
static RPropertyTypeId RFaceEntity::PropertyPoint4X

static

PropertyPoint4Y

Section titled “PropertyPoint4Y”
static RPropertyTypeId RFaceEntity::PropertyPoint4Y

static

PropertyPoint4Z

Section titled “PropertyPoint4Z”
static RPropertyTypeId RFaceEntity::PropertyPoint4Z

static

PropertyProtected

Section titled “PropertyProtected”
static RPropertyTypeId RFaceEntity::PropertyProtected

static

PropertyTotalLength

Section titled “PropertyTotalLength”
static RPropertyTypeId RFaceEntity::PropertyTotalLength

static

PropertyType

Section titled “PropertyType”
static RPropertyTypeId RFaceEntity::PropertyType

static

PropertyWorkingSet

Section titled “PropertyWorkingSet”
static RPropertyTypeId RFaceEntity::PropertyWorkingSet

static

print

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

virtual const protected

Stream operator for QDebug.

Reimplemented from print.

data

Section titled “data”
RFaceData RFaceEntity::data

protected