ViewportMoveGuideInteraction Class Reference

Class used while a "Move guide" interaction is in progress in move or anchor mode. More...

#include <ViewportMoveGuideInteraction.h>

Inherits ViewportDragInteraction.

Public Member Functions
	ViewportMoveGuideInteraction (EditorWindow *editorWindow, AZ::EntityId canvasId, bool guideIsVertical, int guideIndex, 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)
virtual void	Update (const AZ::Vector2 &mousePos)=0
	Update the interaction each time the mouse moves.
virtual void	Render (Draw2dHelper &draw2d)
	Render any display desired during the interaction.
virtual void	EndInteraction (EndState endState)
	End the interaction.

Protected Member Functions
void	MoveGuideToMousePos (const AZ::Vector2 &mousePos)

Protected Attributes
EditorWindow *	m_editorWindow
AZ::EntityId	m_canvasId
bool	m_guideIsVertical = false
int	m_guideIndex = 0
bool	m_isSnapping = false
float	m_startingPosition = 0.0f
AZStd::string	m_canvasUndoXml
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 a "Move guide" interaction is in progress in move or anchor mode.

Member Function Documentation

EndInteraction()

void ViewportMoveGuideInteraction::EndInteraction ( EndState  endState )

overridevirtual

End the interaction.

Reimplemented from ViewportDragInteraction.

Render()

void ViewportMoveGuideInteraction::Render ( Draw2dHelper &  draw2d )

overridevirtual

Render any display desired during the interaction.

Reimplemented from ViewportDragInteraction.

Update()

void ViewportMoveGuideInteraction::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/ViewportMoveGuideInteraction.h