Open 3D Engine AzManipulatorTestFramework API Reference 23.10.0
O3DE is an open-source, fully-featured, high-fidelity, modular 3D engine for building games and simulations, available to every industry.
AzManipulatorTestFramework::ActionDispatcher< DerivedDispatcherT > Class Template Referenceabstract

Base class for derived immediate action dispatchers. More...

#include <ActionDispatcher.h>

Public Member Functions

DerivedDispatcherT * SetSnapToGrid (bool enabled)
 Enable/disable grid snapping.
 
DerivedDispatcherT * GridSize (float size)
 Set the grid size.
 
DerivedDispatcherT * SetStickySelect (bool enabled)
 Enable/disable sticky select.
 
DerivedDispatcherT * LogActions (bool logging)
 Enable/disable action logging.
 
template<typename... Args>
DerivedDispatcherT * Trace (const char *format, const Args &... args)
 Output a trace debug message.
 
DerivedDispatcherT * CameraState (const AzFramework::CameraState &cameraState)
 Set the camera state.
 
DerivedDispatcherT * MouseLButtonDown ()
 Set the left mouse button down.
 
DerivedDispatcherT * MouseLButtonUp ()
 Set the left mouse button up.
 
DerivedDispatcherT * MouseMButtonDown ()
 Set the middle mouse button down.
 
DerivedDispatcherT * MouseMButtonUp ()
 Set the middle mouse button up.
 
DerivedDispatcherT * MouseRButtonDown ()
 Set the right mouse button down.
 
DerivedDispatcherT * MouseRButtonUp ()
 Set the right mouse button up.
 
DerivedDispatcherT * MouseLButtonDoubleClick ()
 Send a double click event.
 
DerivedDispatcherT * KeyboardModifierDown (AzToolsFramework::ViewportInteraction::KeyboardModifier keyModifier)
 Set the keyboard modifier button down.
 
DerivedDispatcherT * KeyboardModifierUp (AzToolsFramework::ViewportInteraction::KeyboardModifier keyModifier)
 Set the keyboard modifier button up.
 
DerivedDispatcherT * MousePosition (const AzFramework::ScreenPoint &position)
 Set the mouse position to the specified screen space position.
 
DerivedDispatcherT * ExpectManipulatorBeingInteracted ()
 Expect the selected manipulator to be interacting.
 
DerivedDispatcherT * ExpectManipulatorNotBeingInteracted ()
 Do not expect the selected manipulator to be interacting.
 
DerivedDispatcherT * SetEntityWorldTransform (AZ::EntityId entityId, const AZ::Transform &transform)
 Set the world transform of the specified entity.
 
DerivedDispatcherT * SetSelectedEntity (AZ::EntityId entity)
 Select the specified entity.
 
DerivedDispatcherT * SetSelectedEntities (const AzToolsFramework::EntityIdList &entities)
 Select the specified entities.
 
DerivedDispatcherT * EnterComponentMode (const AZ::Uuid &uuid)
 Enter component mode for the specified component type's uuid.
 
DerivedDispatcherT * DebugBreak ()
 Break out to the debugger mid action sequence (note: do not leave uses in production code).
 
template<typename ComponentT >
DerivedDispatcherT * EnterComponentMode ()
 Enter component mode for the specified component type.
 

Protected Member Functions

virtual void SetSnapToGridImpl (bool enabled)=0
 
virtual void SetStickySelectImpl (bool enabled)=0
 
virtual void GridSizeImpl (float size)=0
 
virtual void CameraStateImpl (const AzFramework::CameraState &cameraState)=0
 
virtual void MouseLButtonDownImpl ()=0
 
virtual void MouseLButtonUpImpl ()=0
 
virtual void MouseMButtonDownImpl ()=0
 
virtual void MouseMButtonUpImpl ()=0
 
virtual void MouseRButtonDownImpl ()=0
 
virtual void MouseRButtonUpImpl ()=0
 
virtual void MouseLButtonDoubleClickImpl ()=0
 
virtual void MousePositionImpl (const AzFramework::ScreenPoint &position)=0
 
virtual void KeyboardModifierDownImpl (AzToolsFramework::ViewportInteraction::KeyboardModifier keyModifier)=0
 
virtual void KeyboardModifierUpImpl (AzToolsFramework::ViewportInteraction::KeyboardModifier keyModifier)=0
 
virtual void ExpectManipulatorBeingInteractedImpl ()=0
 
virtual void ExpectManipulatorNotBeingInteractedImpl ()=0
 
virtual void SetEntityWorldTransformImpl (AZ::EntityId entityId, const AZ::Transform &transform)=0
 
virtual void SetSelectedEntityImpl (AZ::EntityId entity)=0
 
virtual void SetSelectedEntitiesImpl (const AzToolsFramework::EntityIdList &entities)=0
 
virtual void EnterComponentModeImpl (const AZ::Uuid &uuid)=0
 
template<typename... Args>
void Log (const char *format, const Args &... args)
 

Protected Attributes

bool m_logging = false
 

Detailed Description

template<typename DerivedDispatcherT>
class AzManipulatorTestFramework::ActionDispatcher< DerivedDispatcherT >

Base class for derived immediate action dispatchers.


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