RUcs

Class in Core Module
Header: #include <src/core/RUcs.h>
Inherits: RObject

Description

Represents a user coordinate system (UCS) in a drawing.

The current UCS of a drawing defines the current workplane and coordinate system that is being used for all input.

Scriptable: This class is available in script environments.

Shared Pointer Support: Objects can be used in QSharedPointer.

Public Functions

	RUcs()
	RUcs(RDocument *document, const QString &name, const RVector &origin, const RVector &xAxisDirection, const RVector &yAxisDirection)
virtual	~RUcs()
virtual QSharedPointer< RObject >	clone() const
QSharedPointer< RUcs >	cloneToUcs() const
virtual QPair< QVariant, RPropertyAttributes >	getProperty(RPropertyTypeId &propertyTypeId, bool humanReadable=false, bool noAttributes=false, bool showOnRequest=false)
virtual RS::EntityType	getType() const
RVector	getZAxisDirection()
RVector	mapFromUcs(const RVector &positionUcs) Maps the given UCS (user coordinate system) position to an absolute WCS (world coordinate system) position.
RVector	mapToUcs(const RVector &positionWcs) Maps the given WCS position to a UCS position.
void	setOrigin(const RVector &o)
virtual bool	setProperty(RPropertyTypeId propertyTypeId, const QVariant &value, RTransaction *transaction=NULL) Sets the given property to the given value.
void	setXAxisDirection(const RVector &x)
void	setYAxisDirection(const RVector &y)

Static Public Functions

static RS::EntityType	getRtti()
static void	init()

Public Attributes

QString	name
RVector	origin
RVector	xAxisDirection
RVector	yAxisDirection

Static Public Attributes

static RPropertyTypeId	PropertyName
static RPropertyTypeId	PropertyOriginX
static RPropertyTypeId	PropertyOriginY
static RPropertyTypeId	PropertyOriginZ
static RPropertyTypeId	PropertyXAxisDirectionX
static RPropertyTypeId	PropertyXAxisDirectionY
static RPropertyTypeId	PropertyXAxisDirectionZ
static RPropertyTypeId	PropertyYAxisDirectionX
static RPropertyTypeId	PropertyYAxisDirectionY
static RPropertyTypeId	PropertyYAxisDirectionZ

Member Documentation

RUcs

RUcs::RUcs()

inline

RUcs

RUcs::RUcs(RDocument *document, const QString &name, const RVector &origin, const RVector &xAxisDirection, const RVector &yAxisDirection)

inline

~RUcs

virtual RUcs::~RUcs()

virtual inline

clone

virtual QSharedPointer< RObject > RUcs::clone() const

virtual inline const

Reimplemented from clone.

cloneToUcs

QSharedPointer< RUcs > RUcs::cloneToUcs() const

inline const

getProperty

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

getType

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

virtual inline const

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

Reimplemented from getType.

getZAxisDirection

RVector RUcs::getZAxisDirection()

Returns: Vector that indicates the direction of the Z-Axis (orthogonal to the XY plane).

mapFromUcs

RVector RUcs::mapFromUcs(const RVector &positionUcs)

Maps the given UCS (user coordinate system) position to an absolute WCS (world coordinate system) position.

mapToUcs

RVector RUcs::mapToUcs(const RVector &positionWcs)

Maps the given WCS position to a UCS position.

setOrigin

void RUcs::setOrigin(const RVector &o)

inline

setProperty

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

setXAxisDirection

void RUcs::setXAxisDirection(const RVector &x)

inline

setYAxisDirection

void RUcs::setYAxisDirection(const RVector &y)

inline

getRtti

static RS::EntityType RUcs::getRtti()

static inline

init

static void RUcs::init()

static

name

QString RUcs::name

origin

RVector RUcs::origin

xAxisDirection

RVector RUcs::xAxisDirection

yAxisDirection

RVector RUcs::yAxisDirection

PropertyName

static RPropertyTypeId RUcs::PropertyName

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.

PropertyOriginX

static RPropertyTypeId RUcs::PropertyOriginX

static

PropertyOriginY

static RPropertyTypeId RUcs::PropertyOriginY

static

PropertyOriginZ

static RPropertyTypeId RUcs::PropertyOriginZ

static

PropertyXAxisDirectionX

static RPropertyTypeId RUcs::PropertyXAxisDirectionX

static

PropertyXAxisDirectionY

static RPropertyTypeId RUcs::PropertyXAxisDirectionY

static

PropertyXAxisDirectionZ

static RPropertyTypeId RUcs::PropertyXAxisDirectionZ

static

PropertyYAxisDirectionX

static RPropertyTypeId RUcs::PropertyYAxisDirectionX

static

PropertyYAxisDirectionY

static RPropertyTypeId RUcs::PropertyYAxisDirectionY

static

PropertyYAxisDirectionZ

static RPropertyTypeId RUcs::PropertyYAxisDirectionZ

static