Open 3D Engine AzFramework 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.
Public Member Functions | Public Attributes | List of all members
AzFramework::RotateCameraInput Class Reference

A camera input to handle motion deltas that can change the orientation of the camera (update pitch and yaw). More...

#include <CameraInput.h>

Inherits AzFramework::CameraInput.

Public Member Functions

 RotateCameraInput (const InputChannelId &rotateChannelId)
 
bool HandleEvents (const InputState &state, const ScreenVector &cursorDelta, float scrollDelta) override
 Respond to input events to transition a camera input to active, handle input while running, and restore to idle when input ends.
 
Camera StepCamera (const Camera &targetCamera, const ScreenVector &cursorDelta, float scrollDelta, float deltaTime) override
 
void SetRotateInputChannelId (const InputChannelId &rotateChannelId)
 
void SetInitiateRotateFn (AZStd::function< void()> initiateRotateFn)
 
- Public Member Functions inherited from AzFramework::CameraInput
bool Beginning () const
 
bool Ending () const
 
bool Idle () const
 
bool Active () const
 
void BeginActivation ()
 
void EndActivation ()
 
void CancelActivation ()
 
void ContinueActivation ()
 
void ClearActivation ()
 
void Reset ()
 
virtual bool HandleEvents (const InputState &state, const ScreenVector &cursorDelta, float scrollDelta)=0
 Respond to input events to transition a camera input to active, handle input while running, and restore to idle when input ends.
 
virtual Camera StepCamera (const Camera &targetCamera, const ScreenVector &cursorDelta, float scrollDelta, float deltaTime)=0
 
virtual bool Exclusive () const
 
void SetActivationBeganFn (ActivateChangeFn activationBeganFn)
 
void SetActivationEndedFn (ActivateChangeFn activationEndedFn)
 

Public Attributes

AZStd::function< float()> m_rotateSpeedFn
 
AZStd::function< bool()> m_invertPitchFn
 
AZStd::function< bool()> m_invertYawFn
 
AZStd::function< bool()> m_constrainPitch
 

Additional Inherited Members

- Public Types inherited from AzFramework::CameraInput
enum class  Activation { Idle , Beginning , Active , Ending }
 
using ActivateChangeFn = AZStd::function< void()>
 
- Protected Member Functions inherited from AzFramework::CameraInput
virtual void ResetImpl ()
 Handle any state reset that may be required for the camera input (optional).
 

Detailed Description

A camera input to handle motion deltas that can change the orientation of the camera (update pitch and yaw).

Member Function Documentation

◆ HandleEvents()

bool AzFramework::RotateCameraInput::HandleEvents ( const InputState &  state,
const ScreenVector &  cursorDelta,
float  scrollDelta 
)
overridevirtual

Respond to input events to transition a camera input to active, handle input while running, and restore to idle when input ends.

Implements AzFramework::CameraInput.

◆ StepCamera()

Camera AzFramework::RotateCameraInput::StepCamera ( const Camera &  targetCamera,
const ScreenVector &  cursorDelta,
float  scrollDelta,
float  deltaTime 
)
overridevirtual

Use processed input events to update the state of the camera.

Note
targetCamera is the current target camera at the beginning of an update. The returned camera is the targetCamera + some delta to get to the next camera position and/or orientation.

Implements AzFramework::CameraInput.

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