ViewportAddGuideInteraction Class Reference

Class used while an "Add guide" interaction is in progress in move or anchor mode. More...

#include <ViewportAddGuideInteraction.h>

Inherits ViewportDragInteraction.

Public Member Functions
	ViewportAddGuideInteraction (EditorWindow *editorWindow, AZ::EntityId canvasId, bool guideIsVertical, const AZ::Vector2 &startDragMousePos)
void	Update (const AZ::Vector2 &mousePos) override
	Update the interaction each time the mouse moves.
void	Render (Draw2dHelper &draw2d) override
	Render any display desired during the interaction.
void	EndInteraction (EndState endState) override
	End the interaction.
Public Member Functions inherited from ViewportDragInteraction
	ViewportDragInteraction (const AZ::Vector2 &startMousePos)

Protected Attributes
EditorWindow *	m_editorWindow
AZ::EntityId	m_canvasId
bool	m_guideIsVertical = false
bool	m_isSnapping = false
AZ::Vector2	m_addingGuideAtPosition
AZ::Vector2	m_cursorViewportPos
Protected Attributes inherited from ViewportDragInteraction
AZ::Vector2	m_startMousePos

Additional Inherited Members
Public Types inherited from ViewportDragInteraction
enum class	EndState {   Inside , OutsideX , OutsideY , OutsideXY ,   Canceled }

Detailed Description

Class used while an "Add guide" interaction is in progress in move or anchor mode.

Member Function Documentation

EndInteraction()

void ViewportAddGuideInteraction::EndInteraction ( EndState  endState )

overridevirtual

End the interaction.

Reimplemented from ViewportDragInteraction.

Render()

void ViewportAddGuideInteraction::Render ( Draw2dHelper &  draw2d )

overridevirtual

Render any display desired during the interaction.

Reimplemented from ViewportDragInteraction.

Update()

void ViewportAddGuideInteraction::Update ( const AZ::Vector2 &  mousePos )

overridevirtual

Update the interaction each time the mouse moves.

Implements ViewportDragInteraction.

---

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

• Gems/LyShine/Code/Editor/ViewportAddGuideInteraction.h