QCAD
Open Source 2D CAD
 All Classes Files Functions Variables Typedefs Enumerations Enumerator Properties Friends Macros Groups Pages
RSnapRestriction Class Reference

Abstract base class for all snap restriction implementations. More...

#include <RSnapRestriction.h>

Inheritance diagram for RSnapRestriction:
RRestrictOff RRestrictOrthogonal RRestrictHorizontal RRestrictVertical

List of all members.

Public Member Functions

RVector getLastSnap () const
virtual void hideUiOptions ()
void reset ()
virtual RVector restrictSnap (const RVector &position, const RVector &relativeZero)=0
 RSnapRestriction (RDocumentInterface &documentInterface)
virtual void showUiOptions ()
virtual ~RSnapRestriction ()

Protected Attributes

RDocumentInterfacedocumentInterface
RVector lastSnap

Detailed Description

Abstract base class for all snap restriction implementations.

Scriptable:
This class is wrapped for script environments.

Constructor & Destructor Documentation

RSnapRestriction::RSnapRestriction ( RDocumentInterface documentInterface)
inline
virtual RSnapRestriction::~RSnapRestriction ( )
inlinevirtual

Member Function Documentation

RVector RSnapRestriction::getLastSnap ( ) const
inline
virtual void RSnapRestriction::hideUiOptions ( )
inlinevirtual
void RSnapRestriction::reset ( )
inline
virtual RVector RSnapRestriction::restrictSnap ( const RVector position,
const RVector relativeZero 
)
pure virtual
Returns:
The snapped position (closest relevant position) for the given mouse position.

Implemented in RRestrictOrthogonal, and RRestrictOff.

virtual void RSnapRestriction::showUiOptions ( )
inlinevirtual

Member Data Documentation

RDocumentInterface& RSnapRestriction::documentInterface
protected
RVector RSnapRestriction::lastSnap
protected

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