MAGE  v0.171.0
Matthias Advanced Game Engine
Public Types | Public Member Functions | Private Attributes | List of all members
mage::script::MouseLookScript Class Reference

#include <mouse_look_script.hpp>

Inheritance diagram for mage::script::MouseLookScript:
mage::BehaviorScript mage::Component

Public Types

enum  RotationAxes : U8 { RotationAxes::MouseX = 1, RotationAxes::MouseY = 2, RotationAxes::MouseXAndY = MouseX | MouseY }
 

Public Member Functions

 MouseLookScript ()
 
 MouseLookScript (const MouseLookScript &script) noexcept
 
 MouseLookScript (MouseLookScript &&script) noexcept
 
virtual ~MouseLookScript ()
 
MouseLookScript & operator= (const MouseLookScript &script) noexcept
 
MouseLookScript & operator= (MouseLookScript &&script) noexcept
 
virtual void Load ([[maybe_unused]] Engine &engine) override
 
virtual void Update ([[maybe_unused]] Engine &engine) override
 
RotationAxes GetRotationAxes () const noexcept
 
void SetRotationAxes (RotationAxes axes) noexcept
 
F32 GetSensitivityX () const noexcept
 
F32 GetSensitivityY () const noexcept
 
const F32x2 GetSensitivity () const noexcept
 
void SetSensitivityX (F32 x) noexcept
 
void SetSensitivityY (F32 y) noexcept
 
void SetSensitivity (F32 x, F32 y)
 
void SetSensitivity (F32x2 sensitivity) noexcept
 
void XM_CALLCONV SetSensitivity (FXMVECTOR sensitivity) noexcept
 
F32 GetMinimumRotationX () const noexcept
 
F32 GetMinimumRotationY () const noexcept
 
const F32x2 GetMinimumRotation () const noexcept
 
void SetMinimumRotationX (F32 x) noexcept
 
void SetMinimumRotationY (F32 y) noexcept
 
void SetMinimumRotation (F32 x, F32 y) noexcept
 
void SetMinimumRotation (F32x2 minimum_rotation) noexcept
 
void XM_CALLCONV SetMinimumRotation (FXMVECTOR minimum_rotation) noexcept
 
F32 GetMaximumRotationX () const noexcept
 
F32 GetMaximumRotationY () const noexcept
 
const F32x2 GetMaximumRotation () const noexcept
 
void SetMaximumRotationX (F32 x) noexcept
 
void SetMaximumRotationY (F32 y) noexcept
 
void SetMaximumRotation (F32 x, F32 y) noexcept
 
void SetMaximumRotation (F32x2 maximum_rotation) noexcept
 
void XM_CALLCONV SetMaximumRotation (FXMVECTOR maximum_rotation) noexcept
 
void InvertDirectionX () noexcept
 
void InvertDirectionY () noexcept
 
- Public Member Functions inherited from mage::BehaviorScript
virtual ~BehaviorScript ()
 
BehaviorScript & operator= (const BehaviorScript &script) noexcept
 
BehaviorScript & operator= (BehaviorScript &&script) noexcept
 
virtual void FixedUpdate ([[maybe_unused]] Engine &engine)
 
virtual void Close ([[maybe_unused]] Engine &engine)
 
- Public Member Functions inherited from mage::Component
virtual ~Component ()
 
Component & operator= (const Component &component) noexcept
 
Component & operator= (Component &&component) noexcept
 
State GetState () const noexcept
 
void SetState (State state) noexcept
 
U64 GetGuid () const noexcept
 
bool HasOwner () const noexcept
 
ProxyPtr< Node > GetOwner () noexcept
 
ProxyPtr< const Node > GetOwner () const noexcept
 

Private Attributes

bool m_locked
 
RotationAxes m_axes
 
F32x2 m_sensitivity
 
F32x2 m_minimum_rotation
 
F32x2 m_maximum_rotation
 
F32x2 m_direction
 

Additional Inherited Members

- Protected Member Functions inherited from mage::BehaviorScript
 BehaviorScript () noexcept
 
 BehaviorScript (const BehaviorScript &script) noexcept
 
 BehaviorScript (BehaviorScript &&script) noexcept
 
- Protected Member Functions inherited from mage::Component
 Component () noexcept
 
 Component (const Component &component) noexcept
 
 Component (Component &&component) noexcept
 

Member Enumeration Documentation

◆ RotationAxes

enum mage::script::MouseLookScript::RotationAxes : U8
strong
Enumerator
MouseX 
MouseY 
MouseXAndY 

Constructor & Destructor Documentation

◆ MouseLookScript() [1/3]

mage::script::MouseLookScript::MouseLookScript ( )

◆ MouseLookScript() [2/3]

mage::script::MouseLookScript::MouseLookScript ( const MouseLookScript &  script)
defaultnoexcept

◆ MouseLookScript() [3/3]

mage::script::MouseLookScript::MouseLookScript ( MouseLookScript &&  script)
defaultnoexcept

◆ ~MouseLookScript()

mage::script::MouseLookScript::~MouseLookScript ( )
virtualdefault

Member Function Documentation

◆ GetMaximumRotation()

const F32x2 mage::script::MouseLookScript::GetMaximumRotation ( ) const
noexcept

◆ GetMaximumRotationX()

F32 mage::script::MouseLookScript::GetMaximumRotationX ( ) const
noexcept

◆ GetMaximumRotationY()

F32 mage::script::MouseLookScript::GetMaximumRotationY ( ) const
noexcept

◆ GetMinimumRotation()

const F32x2 mage::script::MouseLookScript::GetMinimumRotation ( ) const
noexcept

◆ GetMinimumRotationX()

F32 mage::script::MouseLookScript::GetMinimumRotationX ( ) const
noexcept

◆ GetMinimumRotationY()

F32 mage::script::MouseLookScript::GetMinimumRotationY ( ) const
noexcept

◆ GetRotationAxes()

RotationAxes mage::script::MouseLookScript::GetRotationAxes ( ) const
noexcept

◆ GetSensitivity()

const F32x2 mage::script::MouseLookScript::GetSensitivity ( ) const
noexcept

◆ GetSensitivityX()

F32 mage::script::MouseLookScript::GetSensitivityX ( ) const
noexcept

◆ GetSensitivityY()

F32 mage::script::MouseLookScript::GetSensitivityY ( ) const
noexcept

◆ InvertDirectionX()

void mage::script::MouseLookScript::InvertDirectionX ( )
noexcept

◆ InvertDirectionY()

void mage::script::MouseLookScript::InvertDirectionY ( )
noexcept

◆ Load()

void mage::script::MouseLookScript::Load ( [[maybe_unused] ] Engine &  engine)
overridevirtual

Loads this behavior script. Allows this behavior script to preform any pre-processing.

Parameters
[in,out]engineA reference to the engine.
Exceptions
ExceptionFailed to load this behavior script.

Reimplemented from mage::BehaviorScript.

◆ operator=() [1/2]

MouseLookScript & mage::script::MouseLookScript::operator= ( const MouseLookScript &  script)
defaultnoexcept

◆ operator=() [2/2]

MouseLookScript & mage::script::MouseLookScript::operator= ( MouseLookScript &&  script)
defaultnoexcept

◆ SetMaximumRotation() [1/3]

void mage::script::MouseLookScript::SetMaximumRotation ( F32  x,
F32  y 
)
noexcept

◆ SetMaximumRotation() [2/3]

void mage::script::MouseLookScript::SetMaximumRotation ( F32x2  maximum_rotation)
noexcept

◆ SetMaximumRotation() [3/3]

void XM_CALLCONV mage::script::MouseLookScript::SetMaximumRotation ( FXMVECTOR  maximum_rotation)
noexcept

◆ SetMaximumRotationX()

void mage::script::MouseLookScript::SetMaximumRotationX ( F32  x)
noexcept

◆ SetMaximumRotationY()

void mage::script::MouseLookScript::SetMaximumRotationY ( F32  y)
noexcept

◆ SetMinimumRotation() [1/3]

void mage::script::MouseLookScript::SetMinimumRotation ( F32  x,
F32  y 
)
noexcept

◆ SetMinimumRotation() [2/3]

void mage::script::MouseLookScript::SetMinimumRotation ( F32x2  minimum_rotation)
noexcept

◆ SetMinimumRotation() [3/3]

void XM_CALLCONV mage::script::MouseLookScript::SetMinimumRotation ( FXMVECTOR  minimum_rotation)
noexcept

◆ SetMinimumRotationX()

void mage::script::MouseLookScript::SetMinimumRotationX ( F32  x)
noexcept

◆ SetMinimumRotationY()

void mage::script::MouseLookScript::SetMinimumRotationY ( F32  y)
noexcept

◆ SetRotationAxes()

void mage::script::MouseLookScript::SetRotationAxes ( RotationAxes  axes)
noexcept

◆ SetSensitivity() [1/3]

void mage::script::MouseLookScript::SetSensitivity ( F32  x,
F32  y 
)

◆ SetSensitivity() [2/3]

void mage::script::MouseLookScript::SetSensitivity ( F32x2  sensitivity)
noexcept

◆ SetSensitivity() [3/3]

void XM_CALLCONV mage::script::MouseLookScript::SetSensitivity ( FXMVECTOR  sensitivity)
noexcept

◆ SetSensitivityX()

void mage::script::MouseLookScript::SetSensitivityX ( F32  x)
noexcept

◆ SetSensitivityY()

void mage::script::MouseLookScript::SetSensitivityY ( F32  y)
noexcept

◆ Update()

void mage::script::MouseLookScript::Update ( [[maybe_unused] ] Engine &  engine)
overridevirtual

Updates this behavior script.

This method is called once per frame.

Parameters
[in,out]engineA reference to the engine.
Exceptions
ExceptionFailed to update this behavior script.

Reimplemented from mage::BehaviorScript.

Member Data Documentation

◆ m_axes

RotationAxes mage::script::MouseLookScript::m_axes
private

◆ m_direction

F32x2 mage::script::MouseLookScript::m_direction
private

◆ m_locked

bool mage::script::MouseLookScript::m_locked
private

◆ m_maximum_rotation

F32x2 mage::script::MouseLookScript::m_maximum_rotation
private

◆ m_minimum_rotation

F32x2 mage::script::MouseLookScript::m_minimum_rotation
private

◆ m_sensitivity

F32x2 mage::script::MouseLookScript::m_sensitivity
private