RSnap Class Reference

Abstract base class for all grid and object snap implementations. More...

#include <RSnap.h>

Inheritance diagram for RSnap:

Public Types
enum	Status {   Unknown = 0 , Free = 1 , Grid = 2 , Endpoint = 3 ,   OnEntity = 4 , Center = 5 , Middle = 6 , Distance = 7 ,   Intersection = 8 , IntersectionManual = 9 , Reference = 10 , Perpendicular = 11 ,   Tangential = 12 , Coordinate = 13 , CoordinatePolar = 14 }
	Snap status, returned by snap tools (most importantly auto snap tool) to indicate what snap was used. More...

Public Member Functions
virtual void	finishEvent ()
QList< RObject::Id >	getEntityIds ()
RVector	getLastSnap () const
RSnap::Status	getStatus () const
virtual void	hideUiOptions ()
virtual void	reset ()
	RSnap (RSnap::Status s=RSnap::Unknown)
void	setLastSnap (const RVector &v)
void	setStatus (RSnap::Status s)
virtual void	showUiOptions ()
virtual RVector	snap (const RVector &position, RGraphicsView &view, double range=RNANDOUBLE)
virtual RVector	snap (RMouseEvent &event)
	This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.
virtual void	suspendEvent ()
	~RSnap ()

Protected Attributes
QList< RObject::Id >	entityIds
RVector	lastSnap
RSnap::Status	status

Detailed Description

Abstract base class for all grid and object snap implementations.

A snap class implements an object or grid snap tool. For example to snap to end points of objects.

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

\generateScriptShell

Member Enumeration Documentation

Status

enum RSnap::Status

Snap status, returned by snap tools (most importantly auto snap tool) to indicate what snap was used.

Enumerator
Unknown
Free
Grid
Endpoint
OnEntity
Center
Middle
Distance
Intersection
IntersectionManual
Reference
Perpendicular
Tangential
Coordinate
CoordinatePolar

Constructor & Destructor Documentation

RSnap()

RSnap::RSnap

(

RSnap::Status

s = RSnap::Unknown

)

~RSnap()

RSnap::~RSnap

(

)

Member Function Documentation

finishEvent()

virtual void RSnap::finishEvent ( )

inlinevirtual

getEntityIds()

QList< RObject::Id > RSnap::getEntityIds ( )

inline

Returns

Set of entity IDs that are relevant for the last performed snap, usually used for highlighting.

getLastSnap()

RVector RSnap::getLastSnap ( ) const

inline

getStatus()

RSnap::Status RSnap::getStatus ( ) const

inline

hideUiOptions()

virtual void RSnap::hideUiOptions ( )

inlinevirtual

Reimplemented in RSnapCoordinate, RSnapDistanceExtension, and RSnapDistance.

reset()

virtual void RSnap::reset ( )

inlinevirtual

Reimplemented in RSnapAuto.

setLastSnap()

void RSnap::setLastSnap ( const RVector & v )

inline

setStatus()

void RSnap::setStatus ( RSnap::Status s )

inline

showUiOptions()

virtual void RSnap::showUiOptions ( )

inlinevirtual

Reimplemented in RSnapCoordinate, RSnapDistanceExtension, and RSnapDistance.

snap() [1/2]

virtual RVector RSnap::snap ( const RVector & position, RGraphicsView & view, double range = RNANDOUBLE )

inlinevirtual

Returns

The snapped position (closest relevant position) for the given mouse position.

Reimplemented in RSnapAuto, RSnapEntityBase, RSnapFree, RSnapGrid, and RSnapIntersection.

snap() [2/2]

RVector RSnap::snap ( RMouseEvent & event )

virtual

This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.

Non-Scriptable:\nThis function is not available in script environments.\n

suspendEvent()

virtual void RSnap::suspendEvent ( )

inlinevirtual

Member Data Documentation

entityIds

QList<RObject::Id> RSnap::entityIds

protected

lastSnap

RVector RSnap::lastSnap

protected

status

RSnap::Status RSnap::status

protected

---

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

• src/core/RSnap.h
• src/core/RSnap.cpp