QCAD Application Framework
CAD Application Development and Automation.
 All Classes Files Functions Variables Typedefs Enumerations Enumerator Properties Friends Macros Groups Pages
Public Member Functions | Protected Member Functions
RSnapEntityBase Class Reference
Snap Module

Base class for entity based snap classes. More...

#include <RSnapEntityBase.h>

Inheritance diagram for RSnapEntityBase:
RSnap RSnapCenter RSnapDistance RSnapEnd RSnapMiddle RSnapOnEntity RSnapPerpendicular RSnapReference RSnapDistanceExtension

List of all members.

Public Member Functions

virtual RVector snap (const RVector &position, RGraphicsView &view, double range=RNANDOUBLE)
virtual RVector snap (const RVector &position, RGraphicsView &view, const QSet< REntity::Id > &candidates, const RBox &queryBox)
virtual ~RSnapEntityBase ()
- Public Member Functions inherited from RSnap
QSet< REntity::Id > getEntityIds ()
RVector getLastSnap () const
RSnap::Status getStatus () const
virtual void hideUiOptions ()
void reset ()
 RSnap ()
virtual void showUiOptions ()
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 ~RSnap ()

Protected Member Functions

virtual QList< RVector > snapEntity (QSharedPointer< REntity > entity, const RVector &point, const RBox &queryBox, RGraphicsView &view)=0

Additional Inherited Members

- Public Types inherited from RSnap
enum  Status {
  Unknown, Free, Grid, Endpoint,
  OnEntity, Center, Middle, Distance,
  Intersection, IntersectionManual, Reference, Perpendicular,
  Coordinate, CoordinatePolar
}
 Snap status, returned by snap tools (most importantly auto snap tool) to indicate what snap was used. More...
- Protected Attributes inherited from RSnap
QSet< REntity::Id > entityIds
RVector lastSnap
RSnap::Status status

Detailed Description

Base class for entity based snap classes.

Scriptable:
This class is wrapped for script environments.

Constructor & Destructor Documentation

virtual RSnapEntityBase::~RSnapEntityBase ( )
inlinevirtual

Member Function Documentation

RVector RSnapEntityBase::snap ( const RVector &  position,
RGraphicsView &  view,
double  range = RNANDOUBLE 
)
virtual
Returns:
The snapped position (closest relevant position) for the given mouse position.

Implements RSnap.

RVector RSnapEntityBase::snap ( const RVector &  position,
RGraphicsView &  view,
const QSet< REntity::Id > &  candidates,
const RBox &  queryBox 
)
virtual
virtual QList<RVector> RSnapEntityBase::snapEntity ( QSharedPointer< REntity >  entity,
const RVector &  point,
const RBox &  queryBox,
RGraphicsView &  view 
)
protectedpure virtual

Implemented in RSnapDistance, RSnapEnd, RSnapReference, RSnapCenter, RSnapMiddle, RSnapOnEntity, and RSnapPerpendicular.

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