donner::editor::RotateCursorSet Class Reference

RAII owner for the editor's custom cursors. More...

#include "donner/editor/RotateCursorSet.h"

Public Member Functions
	RotateCursorSet (const RotateCursorSet &)=delete
RotateCursorSet &	operator= (const RotateCursorSet &)=delete
	RotateCursorSet (RotateCursorSet &&)=delete
RotateCursorSet &	operator= (RotateCursorSet &&)=delete
bool	initialize (GLFWwindow *window, std::shared_ptr< geode::GeodeDevice > geodeDevice)
	Create all custom cursors for window.
bool	setRotateCursor (SelectionTransformCorner corner)
	Set the custom rotate cursor matching corner.
bool	setScaleCursor (SelectionTransformCorner corner)
	Set the custom scale (resize) cursor matching corner.
bool	setSelectCursor ()
	Set the custom select (arrow) cursor.
bool	setPathModifyCursor ()
	Set the custom path-modify (anchor-point) cursor.
bool	setPanCursor (PanCursorKind kind)
	Set the custom pan cursor for kind.
bool	setPenCursor ()
	Set the base pen-tool cursor.
bool	setPenCursor (PenCursorHint hint)
	Set the contextual pen-tool cursor for hint.
void	clearIfActive ()
	Restore GLFW's default cursor if a custom cursor is active.
bool	valid () const
	Whether all custom cursors were created successfully.

Detailed Description

RAII owner for the editor's custom cursors.

Member Function Documentation

initialize()

bool donner::editor::RotateCursorSet::initialize ( GLFWwindow * window, std::shared_ptr< geode::GeodeDevice > geodeDevice )

nodiscard

Create all custom cursors for window.

Parameters

window	GLFW window that will receive cursor changes.
geodeDevice	Shared Geode device for Geode editor builds.

Returns

true if every cursor was created.

setPanCursor()

bool donner::editor::RotateCursorSet::setPanCursor ( PanCursorKind kind )

nodiscard

Set the custom pan cursor for kind.

Parameters

kind	Pan cursor visual state to apply.

Returns

true if a custom cursor was available and applied.

setPathModifyCursor()

bool donner::editor::RotateCursorSet::setPathModifyCursor ( )

nodiscard

Set the custom path-modify (anchor-point) cursor.

Returns

true if a custom cursor was available and applied.

setPenCursor() [1/2]

bool donner::editor::RotateCursorSet::setPenCursor ( )

nodiscard

Set the base pen-tool cursor.

Returns

true if a custom cursor was available and applied.

setPenCursor() [2/2]

bool donner::editor::RotateCursorSet::setPenCursor ( PenCursorHint hint )

nodiscard

Set the contextual pen-tool cursor for hint.

Parameters

hint	Pen cursor visual state (base/add/remove/close).

Returns

true if a custom cursor was available and applied.

setRotateCursor()

bool donner::editor::RotateCursorSet::setRotateCursor ( SelectionTransformCorner corner )

nodiscard

Set the custom rotate cursor matching corner.

Parameters

corner

Selection corner under the pointer.

Returns

true if a custom cursor was available and applied.

setScaleCursor()

bool donner::editor::RotateCursorSet::setScaleCursor ( SelectionTransformCorner corner )

nodiscard

Set the custom scale (resize) cursor matching corner.

Parameters

corner

Selection corner under the pointer.

Returns

true if a custom cursor was available and applied.

setSelectCursor()

bool donner::editor::RotateCursorSet::setSelectCursor ( )

nodiscard

Set the custom select (arrow) cursor.

Returns

true if a custom cursor was available and applied.

---

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

• donner/editor/RotateCursorSet.h