AzManipulatorTestFramework::ImmediateModeActionDispatcher Class Reference

Dispatches actions immediately to the manipulators. More...

#include <ImmediateModeActionDispatcher.h>

Inherits AzManipulatorTestFramework::ActionDispatcher< ImmediateModeActionDispatcher >, AzToolsFramework::ViewportInteraction::EditorModifierKeyRequestBus::Handler, and AzToolsFramework::ViewportInteraction::EditorViewportInputTimeNowRequestBus::Handler.

Public Member Functions
	ImmediateModeActionDispatcher (ManipulatorViewportInteraction &manipulatorViewportInteraction)
ImmediateModeActionDispatcher *	ResetEvent ()
	Clear the current event state.
ImmediateModeActionDispatcher *	ExpectTrue (bool result)
	Expect the expression to be true.
ImmediateModeActionDispatcher *	ExpectFalse (bool result)
	Expect the expression to be false.
template<typename ActualT , typename ExpectedT >
ImmediateModeActionDispatcher *	ExpectEq (const ActualT &actual, const ExpectedT &expected)
	Expect the two values to be equivalent.
template<typename ValueT , typename MatcherT >
ImmediateModeActionDispatcher *	ExpectThat (const ValueT &value, const MatcherT &matcher)
	Expect the value to match the matcher.
ImmediateModeActionDispatcher *	GetEntityWorldTransform (AZ::EntityId entityId, AZ::Transform &transform)
	Get the world transform of the specified entity.
ImmediateModeActionDispatcher *	GetKeyboardModifiers (KeyboardModifiers &keyboardModifiers)
ImmediateModeActionDispatcher *	ExecuteBlock (const AZStd::function< void()> &blockFn)
	Execute an arbitrary section of code inline in the action dispatcher.
KeyboardModifiers	QueryKeyboardModifiers () override
AZStd::chrono::milliseconds	EditorViewportInputTimeNow () override
Public Member Functions inherited from AzManipulatorTestFramework::ActionDispatcher< ImmediateModeActionDispatcher >
ImmediateModeActionDispatcher *	SetSnapToGrid (bool enabled)
	Enable/disable grid snapping.
ImmediateModeActionDispatcher *	GridSize (float size)
	Set the grid size.
ImmediateModeActionDispatcher *	SetStickySelect (bool enabled)
	Enable/disable sticky select.
ImmediateModeActionDispatcher *	LogActions (bool logging)
	Enable/disable action logging.
ImmediateModeActionDispatcher *	Trace (const char *format, const Args &... args)
	Output a trace debug message.
ImmediateModeActionDispatcher *	CameraState (const AzFramework::CameraState &cameraState)
	Set the camera state.
ImmediateModeActionDispatcher *	MouseLButtonDown ()
	Set the left mouse button down.
ImmediateModeActionDispatcher *	MouseLButtonUp ()
	Set the left mouse button up.
ImmediateModeActionDispatcher *	MouseMButtonDown ()
	Set the middle mouse button down.
ImmediateModeActionDispatcher *	MouseMButtonUp ()
	Set the middle mouse button up.
ImmediateModeActionDispatcher *	MouseRButtonDown ()
	Set the right mouse button down.
ImmediateModeActionDispatcher *	MouseRButtonUp ()
	Set the right mouse button up.
ImmediateModeActionDispatcher *	MouseLButtonDoubleClick ()
	Send a double click event.
ImmediateModeActionDispatcher *	KeyboardModifierDown (AzToolsFramework::ViewportInteraction::KeyboardModifier keyModifier)
	Set the keyboard modifier button down.
ImmediateModeActionDispatcher *	KeyboardModifierUp (AzToolsFramework::ViewportInteraction::KeyboardModifier keyModifier)
	Set the keyboard modifier button up.
ImmediateModeActionDispatcher *	MousePosition (const AzFramework::ScreenPoint &position)
	Set the mouse position to the specified screen space position.
ImmediateModeActionDispatcher *	ExpectManipulatorBeingInteracted ()
	Expect the selected manipulator to be interacting.
ImmediateModeActionDispatcher *	ExpectManipulatorNotBeingInteracted ()
	Do not expect the selected manipulator to be interacting.
ImmediateModeActionDispatcher *	SetEntityWorldTransform (AZ::EntityId entityId, const AZ::Transform &transform)
	Set the world transform of the specified entity.
ImmediateModeActionDispatcher *	SetSelectedEntity (AZ::EntityId entity)
	Select the specified entity.
ImmediateModeActionDispatcher *	SetSelectedEntities (const AzToolsFramework::EntityIdList &entities)
	Select the specified entities.
ImmediateModeActionDispatcher *	EnterComponentMode (const AZ::Uuid &uuid)
	Enter component mode for the specified component type's uuid.
ImmediateModeActionDispatcher *	EnterComponentMode ()
	Enter component mode for the specified component type.
ImmediateModeActionDispatcher *	DebugBreak ()
	Break out to the debugger mid action sequence (note: do not leave uses in production code).

Protected Member Functions
void	SetSnapToGridImpl (bool enabled) override
void	SetStickySelectImpl (bool enabled) override
void	GridSizeImpl (float size) override
void	CameraStateImpl (const AzFramework::CameraState &cameraState) override
void	MouseLButtonDownImpl () override
void	MouseLButtonUpImpl () override
void	MouseMButtonDownImpl () override
void	MouseMButtonUpImpl () override
void	MouseRButtonDownImpl () override
void	MouseRButtonUpImpl () override
void	MouseLButtonDoubleClickImpl () override
void	MousePositionImpl (const AzFramework::ScreenPoint &position) override
void	KeyboardModifierDownImpl (KeyboardModifier keyModifier) override
void	KeyboardModifierUpImpl (KeyboardModifier keyModifier) override
void	ExpectManipulatorBeingInteractedImpl () override
void	ExpectManipulatorNotBeingInteractedImpl () override
void	SetEntityWorldTransformImpl (AZ::EntityId entityId, const AZ::Transform &transform) override
void	SetSelectedEntityImpl (AZ::EntityId entity) override
void	SetSelectedEntitiesImpl (const AzToolsFramework::EntityIdList &entities) override
void	EnterComponentModeImpl (const AZ::Uuid &uuid) override
Protected Member Functions inherited from AzManipulatorTestFramework::ActionDispatcher< ImmediateModeActionDispatcher >
void	Log (const char *format, const Args &... args)

Additional Inherited Members
Protected Attributes inherited from AzManipulatorTestFramework::ActionDispatcher< ImmediateModeActionDispatcher >
bool	m_logging

Detailed Description

Dispatches actions immediately to the manipulators.

Member Function Documentation

CameraStateImpl()

void AzManipulatorTestFramework::ImmediateModeActionDispatcher::CameraStateImpl ( const AzFramework::CameraState &  cameraState )

overrideprotectedvirtual

Implements AzManipulatorTestFramework::ActionDispatcher< ImmediateModeActionDispatcher >.

EnterComponentModeImpl()

void AzManipulatorTestFramework::ImmediateModeActionDispatcher::EnterComponentModeImpl ( const AZ::Uuid &  uuid )

overrideprotectedvirtual

Implements AzManipulatorTestFramework::ActionDispatcher< ImmediateModeActionDispatcher >.

ExpectManipulatorBeingInteractedImpl()

void AzManipulatorTestFramework::ImmediateModeActionDispatcher::ExpectManipulatorBeingInteractedImpl ( )

overrideprotectedvirtual

Implements AzManipulatorTestFramework::ActionDispatcher< ImmediateModeActionDispatcher >.

ExpectManipulatorNotBeingInteractedImpl()

void AzManipulatorTestFramework::ImmediateModeActionDispatcher::ExpectManipulatorNotBeingInteractedImpl ( )

overrideprotectedvirtual

Implements AzManipulatorTestFramework::ActionDispatcher< ImmediateModeActionDispatcher >.

GetKeyboardModifiers()

ImmediateModeActionDispatcher * AzManipulatorTestFramework::ImmediateModeActionDispatcher::GetKeyboardModifiers ( KeyboardModifiers &  keyboardModifiers )

inline

Get the current state of the keyboard modifiers.

Note

Chained version - KeyboardModifiers is returned via an out param.

GridSizeImpl()

void AzManipulatorTestFramework::ImmediateModeActionDispatcher::GridSizeImpl ( float  size )

overrideprotectedvirtual

Implements AzManipulatorTestFramework::ActionDispatcher< ImmediateModeActionDispatcher >.

KeyboardModifierDownImpl()

void AzManipulatorTestFramework::ImmediateModeActionDispatcher::KeyboardModifierDownImpl ( KeyboardModifier  keyModifier )

overrideprotectedvirtual

Implements AzManipulatorTestFramework::ActionDispatcher< ImmediateModeActionDispatcher >.

KeyboardModifierUpImpl()

void AzManipulatorTestFramework::ImmediateModeActionDispatcher::KeyboardModifierUpImpl ( KeyboardModifier  keyModifier )

overrideprotectedvirtual

Implements AzManipulatorTestFramework::ActionDispatcher< ImmediateModeActionDispatcher >.

MouseLButtonDoubleClickImpl()

void AzManipulatorTestFramework::ImmediateModeActionDispatcher::MouseLButtonDoubleClickImpl ( )

overrideprotectedvirtual

Implements AzManipulatorTestFramework::ActionDispatcher< ImmediateModeActionDispatcher >.

MouseLButtonDownImpl()

void AzManipulatorTestFramework::ImmediateModeActionDispatcher::MouseLButtonDownImpl ( )

overrideprotectedvirtual

Implements AzManipulatorTestFramework::ActionDispatcher< ImmediateModeActionDispatcher >.

MouseLButtonUpImpl()

void AzManipulatorTestFramework::ImmediateModeActionDispatcher::MouseLButtonUpImpl ( )

overrideprotectedvirtual

Implements AzManipulatorTestFramework::ActionDispatcher< ImmediateModeActionDispatcher >.

MouseMButtonDownImpl()

void AzManipulatorTestFramework::ImmediateModeActionDispatcher::MouseMButtonDownImpl ( )

overrideprotectedvirtual

Implements AzManipulatorTestFramework::ActionDispatcher< ImmediateModeActionDispatcher >.

MouseMButtonUpImpl()

void AzManipulatorTestFramework::ImmediateModeActionDispatcher::MouseMButtonUpImpl ( )

overrideprotectedvirtual

Implements AzManipulatorTestFramework::ActionDispatcher< ImmediateModeActionDispatcher >.

MousePositionImpl()

void AzManipulatorTestFramework::ImmediateModeActionDispatcher::MousePositionImpl ( const AzFramework::ScreenPoint &  position )

overrideprotectedvirtual

Implements AzManipulatorTestFramework::ActionDispatcher< ImmediateModeActionDispatcher >.

MouseRButtonDownImpl()

void AzManipulatorTestFramework::ImmediateModeActionDispatcher::MouseRButtonDownImpl ( )

overrideprotectedvirtual

Implements AzManipulatorTestFramework::ActionDispatcher< ImmediateModeActionDispatcher >.

MouseRButtonUpImpl()

void AzManipulatorTestFramework::ImmediateModeActionDispatcher::MouseRButtonUpImpl ( )

overrideprotectedvirtual

Implements AzManipulatorTestFramework::ActionDispatcher< ImmediateModeActionDispatcher >.

SetEntityWorldTransformImpl()

void AzManipulatorTestFramework::ImmediateModeActionDispatcher::SetEntityWorldTransformImpl ( AZ::EntityId  entityId, const AZ::Transform &  transform  )

overrideprotectedvirtual

Implements AzManipulatorTestFramework::ActionDispatcher< ImmediateModeActionDispatcher >.

SetSelectedEntitiesImpl()

void AzManipulatorTestFramework::ImmediateModeActionDispatcher::SetSelectedEntitiesImpl ( const AzToolsFramework::EntityIdList &  entities )

overrideprotectedvirtual

Implements AzManipulatorTestFramework::ActionDispatcher< ImmediateModeActionDispatcher >.

SetSelectedEntityImpl()

void AzManipulatorTestFramework::ImmediateModeActionDispatcher::SetSelectedEntityImpl ( AZ::EntityId  entity )

overrideprotectedvirtual

Implements AzManipulatorTestFramework::ActionDispatcher< ImmediateModeActionDispatcher >.

SetSnapToGridImpl()

void AzManipulatorTestFramework::ImmediateModeActionDispatcher::SetSnapToGridImpl ( bool  enabled )

overrideprotectedvirtual

Implements AzManipulatorTestFramework::ActionDispatcher< ImmediateModeActionDispatcher >.

SetStickySelectImpl()

void AzManipulatorTestFramework::ImmediateModeActionDispatcher::SetStickySelectImpl ( bool  enabled )

overrideprotectedvirtual

Implements AzManipulatorTestFramework::ActionDispatcher< ImmediateModeActionDispatcher >.

---

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

• Code/Framework/AzManipulatorTestFramework/Include/AzManipulatorTestFramework/ImmediateModeActionDispatcher.h