RImageData Class Reference

Stores and manages all data that defines the geometry and appearance of a raster image entity. More...

#include <RImageData.h>

Inheritance diagram for RImageData:

Public Member Functions
virtual RShape *	castToShape ()
double	getAngle () const
virtual RBox	getBoundingBox (bool ignoreEmpty=false) const
int	getBrightness () const
int	getContrast () const
QList< RVector >	getCorners () const
QList< RVector >	getCornersPx () const
virtual double	getDistanceTo (const RVector &point, bool limited=true, double range=0.0, bool draft=false, double strictRange=RMAXDOUBLE) const
QList< RLine >	getEdges () const
int	getFade () const
QString	getFileName () const
QString	getFullFilePath () const
double	getHeight () const
QImage	getImage () const
RVector	getInsertionPoint () const
int	getPixelHeight () const
int	getPixelWidth () const
virtual RVector	getPointOnEntity () const
virtual QList< RRefPoint >	getReferencePoints (RS::ProjectionRenderingHint hint=RS::RenderTop) const
RVector	getScaleVector () const
virtual QList< QSharedPointer< RShape > >	getShapes (const RBox &queryBox=RDEFAULT_RBOX, bool ignoreComplex=false, bool segment=false, QList< RObject::Id > *entityIds=NULL) const
virtual RS::EntityType	getType () const
RVector	getUVector () const
RVector	getVVector () const
double	getWidth () const
virtual bool	intersectsWith (const RShape &shape) const
void	load () const
RVector	mapFromImage (const RVector &v) const
	Maps the given coordinate from image pixels to drawing coordinates.
RVector	mapToImage (const RVector &v) const
	Maps the given drawing coordinates to image pixel coordinates.
virtual bool	mirror (const RLine &axis)
virtual bool	move (const RVector &offset)
	Moves this entity by the given offset.
virtual bool	moveReferencePoint (const RVector &referencePoint, const RVector &targetPoint, Qt::KeyboardModifiers modifiers=Qt::NoModifier)
	Moves the given reference point to the given target point or does nothing if this entity has no reference point as the given location.
RImageData &	operator= (const RImageData &other)
void	reload ()
	RImageData ()
	Copyright (c) 2011-2018 by Andrew Mustun.
	RImageData (const QString &fileName, const RVector &insertionPoint, const RVector &uVector, const RVector &vVector, int brightness, int contrast, int fade)
	RImageData (const RImageData &other)
virtual bool	rotate (double rotation, const RVector &center=RDEFAULT_RVECTOR)
virtual bool	scale (const RVector &scaleFactors, const RVector &center=RDEFAULT_RVECTOR)
void	setAngle (double a)
void	setBrightness (int v)
void	setContrast (int v)
void	setFade (int v)
void	setFileName (const QString &fn)
void	setHeight (double h, bool keepRatio=false)
void	setInsertionPoint (const RVector &ip)
void	setUVector (const RVector &v)
void	setVVector (const RVector &v)
void	setWidth (double w, bool keepRatio=false)
virtual	~RImageData ()
Public Member Functions inherited from REntityData
virtual const RShape *	castToConstShape () const
virtual bool	clickReferencePoint (const RVector &referencePoint)
	Called when user clicks a reference point.
virtual bool	cloneOnChange () const
	Reimplement to force clone on change in transactions.
void	copyAttributesFrom (const REntityData &entityData, bool copyBlockId=true)
virtual bool	flipHorizontal ()
virtual bool	flipVertical ()
virtual QList< RVector >	getArcReferencePoints (const RBox &queryBox=RDEFAULT_RBOX) const
bool	getAutoUpdatesBlocked () const
RObject::Id	getBlockId () const
QString	getBlockName () const
virtual QList< RBox >	getBoundingBoxes (bool ignoreEmpty=false) const
virtual QList< RVector >	getCenterPoints (const RBox &queryBox=RDEFAULT_RBOX, QList< RObject::Id > *subEntityIds=NULL) const
virtual RVector	getClosestPointOnEntity (const RVector &point, double range=RNANDOUBLE, bool limited=true, RObject::Id *subEntityId=NULL) const
virtual QSharedPointer< RShape >	getClosestShape (const RVector &pos, double range=RNANDOUBLE, bool ignoreComplex=false, RObject::Id *subEntityId=NULL) const
RObject::Id	getClosestSubEntityId (const RVector &pos, double range, bool ignoreComplex) const
	Convenience function for scripts.
virtual RColor	getColor () const
virtual RColor	getColor (bool resolve, const QStack< QSharedPointer< REntity > > &blockRefStack) const
virtual RColor	getColor (const RColor &unresolvedColor, const QStack< QSharedPointer< REntity > > &blockRefStack) const
virtual RColor	getDisplayColor ()
RDocument *	getDocument ()
const RDocument *	getDocument () const
virtual int	getDrawOrder () const
virtual QList< RVector >	getEndPoints (const RBox &queryBox=RDEFAULT_RBOX, QList< RObject::Id > *subEntityIds=NULL) const
virtual RPolyline	getHull (double offset) const
virtual QList< RRefPoint >	getInternalReferencePoints (RS::ProjectionRenderingHint hint=RS::RenderTop, QList< RObject::Id > *subEntityIds=NULL) const
	Can be overwritten to return internal, resolved reference points.
virtual QList< RVector >	getIntersectionPoints (const REntityData &other, bool limited=true, bool same=false, const RBox &queryBox=RDEFAULT_RBOX, bool ignoreComplex=true, QList< QPair< RObject::Id, RObject::Id > > *entityIds=NULL) const
virtual QList< RVector >	getIntersectionPoints (const RShape &shape, bool limited=true, const RBox &queryBox=RDEFAULT_RBOX, bool ignoreComplex=true) const
RObject::Id	getLayerId () const
QString	getLayerName () const
virtual RObject::Id	getLinetypeId () const
virtual RObject::Id	getLinetypeId (bool resolve, const QStack< QSharedPointer< REntity > > &blockRefStack) const
virtual RLinetypePattern	getLinetypePattern () const
virtual double	getLinetypeScale () const
virtual RLineweight::Lineweight	getLineweight () const
virtual RLineweight::Lineweight	getLineweight (bool resolve, const QStack< QSharedPointer< REntity > > &blockRefStack) const
double	getLineweightInUnits (const QStack< QSharedPointer< REntity > > &blockRefStack) const
virtual QList< RVector >	getMiddlePoints (const RBox &queryBox=RDEFAULT_RBOX, QList< RObject::Id > *subEntityIds=NULL) const
RObject::Id	getParentId () const
virtual QList< RVector >	getPointsWithDistanceToEnd (double distance, int from=RS::FromAny, const RBox &queryBox=RDEFAULT_RBOX, QList< RObject::Id > *subEntityIds=NULL) const
virtual RVector	getVectorTo (const RVector &point, bool limited=true, double strictRange=RMAXDOUBLE) const
virtual bool	isInside (const RBox &box) const
virtual bool	isOnEntity (const RVector &point, bool limited=true, double tolerance=RDEFAULT_TOLERANCE_1E_MIN4) const
virtual bool	isPointType () const
virtual bool	isSane () const
virtual bool	isSelected () const
virtual bool	isSelectedWorkingSet () const
virtual bool	isUpdatesEnabled () const
virtual bool	isValid () const
virtual bool	mirror (const RVector &axis1, const RVector &axis2)
	REntityData (RDocument *document=NULL)
	Copyright (c) 2011-2018 by Andrew Mustun.
virtual bool	scale (double scaleFactor, const RVector &center=RDEFAULT_RVECTOR)
virtual void	scaleVisualProperties (double scaleFactor)
void	setAutoUpdatesBlocked (bool on)
virtual void	setBlockId (RObject::Id blockId)
void	setColor (const RColor &color)
void	setDocument (RDocument *document)
virtual void	setDrawOrder (int drawOrder)
	Sets the draw order of this entity.
virtual void	setLayerId (RObject::Id layerId)
void	setLayerName (const QString &layerName)
virtual void	setLinetypeId (RObject::Id linetypeId)
	Sets the linetype of this entity to the given linetype ID.
virtual void	setLinetypePattern (const RLinetypePattern &p)
virtual void	setLinetypeScale (double linetypeScale)
void	setLineweight (RLineweight::Lineweight lineweight)
virtual void	setParentId (RObject::Id parentId)
virtual void	setSelected (bool on)
	Selects or deselects this entity.
virtual void	setSelectedWorkingSet (bool on)
	Selects or deselects this entity for addition to the current working set.
void	setUpdatesEnabled (bool on)
	Enables / disables cache updates.
virtual void	setZ (double z)
virtual bool	stretch (const RPolyline &area, const RVector &offset)
	Stretches the end points of this entity that are inside area by offset.
virtual void	to2D ()
virtual void	update () const
	Entities can reimplement this function to invalidate any internal cache (mark the entity as dirty).
virtual	~REntityData ()

Protected Member Functions
	RImageData (RDocument *document, const RImageData &data)

Private Attributes
int	brightness
int	contrast
int	fade
QString	fileName
QImage	image
RVector	insertionPoint
RVector	uVector
RVector	vVector

Friends
class	RImageEntity

Additional Inherited Members
Static Public Member Functions inherited from REntityData
static int	getDefaultDrawOrder ()
Protected Attributes inherited from REntityData
bool	autoUpdatesBlocked
	Block auto updates is true during imports, undo and redo.
RObject::Id	blockId
RColor	color
RDocument *	document
int	drawOrder
RObject::Id	layerId
RObject::Id	linetypeId
double	linetypeScale
RLineweight::Lineweight	lineweight
RObject::Id	parentId
bool	selectionStatus
bool	selectionStatusWorkingSet
bool	updatesEnabled

Detailed Description

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

Scriptable:\nThis class is available in script environments.\n

Copyable:\nObjects are cleaned up automatically by the garbage collector of the script engine.\n

Constructor & Destructor Documentation

RImageData() [1/4]

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

protected

RImageData() [2/4]

RImageData::RImageData

(

)

Copyright (c) 2011-2018 by Andrew Mustun.

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.

RImageData() [3/4]

RImageData::RImageData

(

const RImageData &

other

)

RImageData() [4/4]

RImageData::RImageData	(	const QString &	fileName,
		const RVector &	insertionPoint,
		const RVector &	uVector,
		const RVector &	vVector,
		int	brightness,
		int	contrast,
		int	fade )

~RImageData()

RImageData::~RImageData ( )

virtual

Member Function Documentation

castToShape()

virtual RShape * RImageData::castToShape ( )

inlinevirtual

Reimplemented from REntityData.

getAngle()

double RImageData::getAngle ( ) const

inline

getBoundingBox()

RBox RImageData::getBoundingBox ( bool ignoreEmpty = false ) const

virtual

Returns

The bounding box that contains this entity.

Reimplemented from REntityData.

getBrightness()

int RImageData::getBrightness ( ) const

inline

getContrast()

int RImageData::getContrast ( ) const

inline

getCorners()

QList< RVector > RImageData::getCorners

(

)

const

getCornersPx()

QList< RVector > RImageData::getCornersPx

(

)

const

getDistanceTo()

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

virtual

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 REntityData.

getEdges()

QList< RLine > RImageData::getEdges

(

)

const

getFade()

int RImageData::getFade ( ) const

inline

getFileName()

QString RImageData::getFileName ( ) const

inline

getFullFilePath()

QString RImageData::getFullFilePath

(

)

const

getHeight()

double RImageData::getHeight

(

)

const

getImage()

QImage RImageData::getImage

(

)

const

getInsertionPoint()

RVector RImageData::getInsertionPoint ( ) const

inline

getPixelHeight()

int RImageData::getPixelHeight

(

)

const

getPixelWidth()

int RImageData::getPixelWidth

(

)

const

getPointOnEntity()

RVector RImageData::getPointOnEntity ( ) const

virtual

Returns

A point that is on the entity. Used to check if an entity is inside a polygon.

Reimplemented from REntityData.

getReferencePoints()

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

virtual

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.

Implements REntityData.

getScaleVector()

RVector RImageData::getScaleVector

(

)

const

getShapes()

QList< QSharedPointer< RShape > > RImageData::getShapes ( const RBox & queryBox = RDEFAULT_RBOX, bool ignoreComplex = false, bool segment = false, QList< RObject::Id > * entityIds = NULL ) const

virtual

Returns

Shapes that represent the geometry of this entity.

Parameters

queryBox	Limit returned shapes to query box
ignoreComplex	Ignore complex shapes and explode those into simple shapes
segment	Split up splines into spline segments

Reimplemented from REntityData.

getType()

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

inlinevirtual

Reimplemented from REntityData.

getUVector()

RVector RImageData::getUVector ( ) const

inline

getVVector()

RVector RImageData::getVVector ( ) const

inline

getWidth()

double RImageData::getWidth

(

)

const

intersectsWith()

bool RImageData::intersectsWith ( const RShape & shape ) const

virtual

Returns

True if this entity intersects with the given shape, false otherwise.

Todo

better to pass another entity data object?

Reimplemented from REntityData.

load()

void RImageData::load

(

)

const

mapFromImage()

RVector RImageData::mapFromImage

(

const RVector &

v

)

const

Maps the given coordinate from image pixels to drawing coordinates.

mapToImage()

RVector RImageData::mapToImage

(

const RVector &

v

)

const

Maps the given drawing coordinates to image pixel coordinates.

mirror()

bool RImageData::mirror ( const RLine & axis )

virtual

Reimplemented from REntityData.

move()

bool RImageData::move ( const RVector & offset )

virtual

Moves this entity by the given offset.

Reimplemented from REntityData.

moveReferencePoint()

bool RImageData::moveReferencePoint ( const RVector & referencePoint, const RVector & targetPoint, Qt::KeyboardModifiers modifiers = Qt::NoModifier )

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.

Implements REntityData.

operator=()

RImageData & RImageData::operator=

(

const RImageData &

other

)

reload()

void RImageData::reload

(

)

rotate()

bool RImageData::rotate ( double rotation, const RVector & center = RDEFAULT_RVECTOR )

virtual

Reimplemented from REntityData.

scale()

bool RImageData::scale ( const RVector & scaleFactors, const RVector & center = RDEFAULT_RVECTOR )

virtual

Reimplemented from REntityData.

setAngle()

void RImageData::setAngle ( double a )

inline

setBrightness()

void RImageData::setBrightness ( int v )

inline

setContrast()

void RImageData::setContrast ( int v )

inline

setFade()

void RImageData::setFade ( int v )

inline

setFileName()

void RImageData::setFileName ( const QString & fn )

inline

setHeight()

void RImageData::setHeight	(	double	h,
		bool	keepRatio = false )

setInsertionPoint()

void RImageData::setInsertionPoint ( const RVector & ip )

inline

setUVector()

void RImageData::setUVector ( const RVector & v )

inline

setVVector()

void RImageData::setVVector ( const RVector & v )

inline

setWidth()

void RImageData::setWidth	(	double	w,
		bool	keepRatio = false )

Friends And Related Symbol Documentation

RImageEntity

friend class RImageEntity

friend

Member Data Documentation

brightness

int RImageData::brightness

private

contrast

int RImageData::contrast

private

fade

int RImageData::fade

private

fileName

QString RImageData::fileName

mutableprivate

image

QImage RImageData::image

mutableprivate

insertionPoint

RVector RImageData::insertionPoint

private

uVector

RVector RImageData::uVector

private

vVector

RVector RImageData::vVector

private

---

The documentation for this class was generated from the following files:

• src/entity/RImageData.h
• src/entity/RImageData.cpp