RSnapRestriction Class Reference

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

#include <RSnapRestriction.h>

Inheritance diagram for RSnapRestriction:

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

Protected Attributes
RDocumentInterface *	documentInterface
RVector	lastSnap

Detailed Description

Abstract base class for all snap restriction implementations.

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

\generateScriptShell

Constructor & Destructor Documentation

RSnapRestriction()

RSnapRestriction::RSnapRestriction ( RDocumentInterface * documentInterface = NULL )

inline

~RSnapRestriction()

virtual RSnapRestriction::~RSnapRestriction ( )

inlinevirtual

Member Function Documentation

getLastSnap()

RVector RSnapRestriction::getLastSnap ( ) const

inline

hideUiOptions()

virtual void RSnapRestriction::hideUiOptions ( )

inlinevirtual

Reimplemented in RRestrictAngleLengthExtension.

reset()

void RSnapRestriction::reset ( )

inline

restrictSnap()

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 RRestrictAngleLength, RRestrictOff, and RRestrictOrthogonal.

showUiOptions()

virtual void RSnapRestriction::showUiOptions ( )

inlinevirtual

Reimplemented in RRestrictAngleLengthExtension.

Member Data Documentation

documentInterface

RDocumentInterface* RSnapRestriction::documentInterface

protected

lastSnap

RVector RSnapRestriction::lastSnap

protected

---

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

• src/core/RSnapRestriction.h