RWipeoutData

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

Description

Stores and manages all data that defines the geometry and appearance of a wipeout entity.

Scriptable: This class is available in script environments.

Copyable: Objects are cleaned up automatically by the garbage collector of the script engine.

Public Functions


	RWipeoutData`()`
	RWipeoutData`(const RPolyline &polyline)`
RPolyline	getBoundary`() const`
virtual QList< RBox >	getBoundingBoxes`(bool ignoreEmpty) const`
virtual double	getDistanceTo`(const RVector &point, bool limited=true, double range=0.0, bool draft=false, double strictRange=RMAXDOUBLE) const`
virtual QList< RRefPoint >	getReferencePoints`(RS::ProjectionRenderingHint hint=RS::RenderTop) const`
bool	getShowFrame`() const`
virtual RS::EntityType	getType`() const`
virtual bool	moveReferencePoint`(const RVector &referencePoint, const RVector &targetPoint, Qt::KeyboardModifiers modifiers)` Moves the given reference point to the given target point or does nothing if this entity has no reference point as the given location.
void	setShowFrame`(bool on)`

Protected Functions


	RWipeoutData`(RDocument *document, const RWipeoutData &data)`

Private Attributes


bool	showFrame

Friends


class	RWipeoutEntity

Member Documentation

RWipeoutData

RWipeoutData::RWipeoutData()

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.

RWipeoutData

RWipeoutData::RWipeoutData(const RPolyline &polyline)

getBoundary

RPolyline RWipeoutData::getBoundary() const

const

getBoundingBoxes

virtual QList< RBox > RWipeoutData::getBoundingBoxes(bool ignoreEmpty) const

virtual const

Returns: List of bounding boxes that contain this entity. This is used for complex entities such as block references to further optimize algorithms that depend on bounding boxes (e.g. spatial index algorithms). The default implementation returns the bounding box that contains the whole entity.

Reimplemented from getBoundingBoxes.

getDistanceTo

virtual double RWipeoutData::getDistanceTo(const RVector &point, bool limited=true, double range=0.0, bool draft=false, double strictRange=RMAXDOUBLE) const

virtual const

Returns: The shortest distance from this entity to the given point.

Parameters:

limited: Limit lines, arcs at end points, otherwise the orthogonal distance to the unlimited line / circle is returned.
range: This is returned for solid filled entities (solid filled or dense hatches, text entities) if the point is on the entity and the distance would be zero.
draft: Calculate based on draft mode representation of the entity.
strictRange: If limited, this is the maximum range from either end point of the entity. Zero to only return distances that are strictly orthogonal to the entity.

Reimplemented from getDistanceTo.

getReferencePoints

virtual QList< RRefPoint > RWipeoutData::getReferencePoints(RS::ProjectionRenderingHint hint=RS::RenderTop) const

virtual const

Returns: Vector of reference points of this entity. Reference points can usually be moved around by the user to change the geometry of the entity.

Reimplemented from getReferencePoints.

getShowFrame

bool RWipeoutData::getShowFrame() const

inline const

getType

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

virtual inline const

Reimplemented from getType.

moveReferencePoint

virtual bool RWipeoutData::moveReferencePoint(const RVector &referencePoint, const RVector &targetPoint, Qt::KeyboardModifiers modifiers)

virtual

Moves the given reference point to the given target point or does nothing if this entity has no reference point as the given location.

Returns: True if a reference point has been moved successfully, false otherwise.

Reimplemented from moveReferencePoint.

setShowFrame

void RWipeoutData::setShowFrame(bool on)

inline

RWipeoutData

RWipeoutData::RWipeoutData(RDocument *document, const RWipeoutData &data)

protected

showFrame

bool RWipeoutData::showFrame

private

RWipeoutEntity

friend class RWipeoutEntity

private