Open 3D Engine EMotionFX Gem 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 | Protected Attributes | List of all members
EMotionFX::PhysicsSetupManipulatorsBase Class Referenceabstract

Base class for various manipulator modes, e.g. collider translation, collider orientation, etc. More...

#include <PhysicsSetupManipulators.h>

Inherited by EMotionFX::ColliderCapsuleManipulators, EMotionFX::ColliderRotationManipulators, EMotionFX::ColliderTranslationManipulators, EMotionFX::JointLimitRotationManipulators, EMotionFX::JointSwingLimitManipulators, EMotionFX::JointTwistLimitManipulators, and EMotionFX::PhysicsSetupManipulatorsNull.

Public Member Functions

virtual void Setup (const PhysicsSetupManipulatorData &physicsSetupManipulatorData)=0
 Called when the manipulator mode is entered to initialize the mode.
 
virtual void Refresh ()=0
 Called when the manipulator mode needs to refresh its values.
 
virtual void Teardown ()=0
 Called when the manipulator mode exits to perform cleanup.
 
virtual void ResetValues ()=0
 
virtual void InvalidateEditorValues ()
 Causes values in associated property editor to refresh.
 
void SetViewportId (AZ::s32 viewportId)
 

Protected Attributes

AZ::s32 m_viewportId
 

Detailed Description

Base class for various manipulator modes, e.g. collider translation, collider orientation, etc.

Member Function Documentation

◆ InvalidateEditorValues()

virtual void EMotionFX::PhysicsSetupManipulatorsBase::InvalidateEditorValues ( )
inlinevirtual

Causes values in associated property editor to refresh.

Reimplemented in EMotionFX::JointLimitRotationManipulators, EMotionFX::JointSwingLimitManipulators, and EMotionFX::JointTwistLimitManipulators.

◆ Refresh()

virtual void EMotionFX::PhysicsSetupManipulatorsBase::Refresh ( )
pure virtual

Called when the manipulator mode needs to refresh its values.

Implemented in EMotionFX::ColliderCapsuleManipulators, EMotionFX::ColliderRotationManipulators, EMotionFX::ColliderTranslationManipulators, EMotionFX::JointLimitRotationManipulators, EMotionFX::JointSwingLimitManipulators, EMotionFX::JointTwistLimitManipulators, and EMotionFX::PhysicsSetupManipulatorsNull.

◆ ResetValues()

virtual void EMotionFX::PhysicsSetupManipulatorsBase::ResetValues ( )
pure virtual

Called when reset hot key is pressed. Should reset values in the manipulator mode to sensible defaults.

Implemented in EMotionFX::ColliderCapsuleManipulators, EMotionFX::ColliderRotationManipulators, EMotionFX::ColliderTranslationManipulators, EMotionFX::JointLimitRotationManipulators, EMotionFX::JointSwingLimitManipulators, EMotionFX::JointTwistLimitManipulators, and EMotionFX::PhysicsSetupManipulatorsNull.

◆ Setup()

virtual void EMotionFX::PhysicsSetupManipulatorsBase::Setup ( const PhysicsSetupManipulatorData &  physicsSetupManipulatorData)
pure virtual

Called when the manipulator mode is entered to initialize the mode.

Implemented in EMotionFX::ColliderCapsuleManipulators, EMotionFX::ColliderRotationManipulators, EMotionFX::ColliderTranslationManipulators, EMotionFX::JointLimitRotationManipulators, EMotionFX::JointSwingLimitManipulators, EMotionFX::JointTwistLimitManipulators, and EMotionFX::PhysicsSetupManipulatorsNull.

◆ Teardown()

virtual void EMotionFX::PhysicsSetupManipulatorsBase::Teardown ( )
pure virtual

Called when the manipulator mode exits to perform cleanup.

Implemented in EMotionFX::ColliderCapsuleManipulators, EMotionFX::ColliderRotationManipulators, EMotionFX::ColliderTranslationManipulators, EMotionFX::JointLimitRotationManipulators, EMotionFX::JointSwingLimitManipulators, EMotionFX::JointTwistLimitManipulators, and EMotionFX::PhysicsSetupManipulatorsNull.

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