RSnapRestriction
Class in Core Module
Header: #include <src/core/RSnapRestriction.h>
Inherited by: RRestrictAngleLength, RRestrictOff, RRestrictOrthogonal
Description
Section titled “Description”Abstract base class for all snap restriction implementations.
Scriptable: This class is available in script environments.
\generateScriptShell
Public Functions
Section titled “Public Functions”RSnapRestriction(RDocumentInterface *documentInterface=NULL) |
|
| virtual | ~RSnapRestriction() |
| RVector | getLastSnap() const |
| virtual void | hideUiOptions() |
| void | reset() |
| virtual RVector | restrictSnap(const RVector &position, const RVector &relativeZero)=0 = 0 |
| virtual void | showUiOptions() |
Protected Attributes
Section titled “Protected Attributes”| RDocumentInterface * | documentInterface |
| RVector | lastSnap |
Member Documentation
Section titled “Member Documentation”RSnapRestriction
Section titled “RSnapRestriction”RSnapRestriction::RSnapRestriction(RDocumentInterface *documentInterface=NULL)inline
~RSnapRestriction
Section titled “~RSnapRestriction”virtual RSnapRestriction::~RSnapRestriction()virtual inline
getLastSnap
Section titled “getLastSnap”RVector RSnapRestriction::getLastSnap() constinline const
hideUiOptions
Section titled “hideUiOptions”virtual void RSnapRestriction::hideUiOptions()virtual inline
void RSnapRestriction::reset()inline
restrictSnap
Section titled “restrictSnap”virtual RVector RSnapRestriction::restrictSnap(const RVector &position, const RVector &relativeZero)=0 = 0pure virtual
Returns: The snapped position (closest relevant position) for the given mouse position.
Reimplemented in restrictSnap, restrictSnap, restrictSnap.
showUiOptions
Section titled “showUiOptions”virtual void RSnapRestriction::showUiOptions()virtual inline
documentInterface
Section titled “documentInterface”RDocumentInterface* RSnapRestriction::documentInterfaceprotected
lastSnap
Section titled “lastSnap”RVector RSnapRestriction::lastSnapprotected