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 | List of all members
EMotionFX::JointSwingLimitManipulators Class Reference

Provides functionality for interactively editing character physics joint limit extents in the Animation Editor Viewport. More...

#include <JointSwingLimitManipulators.h>

Inherits EMotionFX::PhysicsSetupManipulatorsBase, AZ::TickBus::Handler, and PhysicsSetupManipulatorRequestBus::Handler.

Public Member Functions

void Setup (const PhysicsSetupManipulatorData &physicsSetupManipulatorData) override
 Called when the manipulator mode is entered to initialize the mode.
 
void Refresh () override
 Called when the manipulator mode needs to refresh its values.
 
void Teardown () override
 Called when the manipulator mode exits to perform cleanup.
 
void ResetValues () override
 
void InvalidateEditorValues () override
 Causes values in associated property editor to refresh.
 
- Public Member Functions inherited from EMotionFX::PhysicsSetupManipulatorsBase
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)
 

Additional Inherited Members

- Protected Attributes inherited from EMotionFX::PhysicsSetupManipulatorsBase
AZ::s32 m_viewportId
 

Detailed Description

Provides functionality for interactively editing character physics joint limit extents in the Animation Editor Viewport.

Member Function Documentation

◆ InvalidateEditorValues()

void EMotionFX::JointSwingLimitManipulators::InvalidateEditorValues ( )
overridevirtual

Causes values in associated property editor to refresh.

Reimplemented from EMotionFX::PhysicsSetupManipulatorsBase.

◆ Refresh()

void EMotionFX::JointSwingLimitManipulators::Refresh ( )
overridevirtual

Called when the manipulator mode needs to refresh its values.

Implements EMotionFX::PhysicsSetupManipulatorsBase.

◆ ResetValues()

void EMotionFX::JointSwingLimitManipulators::ResetValues ( )
overridevirtual

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

Implements EMotionFX::PhysicsSetupManipulatorsBase.

◆ Setup()

void EMotionFX::JointSwingLimitManipulators::Setup ( const PhysicsSetupManipulatorData &  physicsSetupManipulatorData)
overridevirtual

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

Implements EMotionFX::PhysicsSetupManipulatorsBase.

◆ Teardown()

void EMotionFX::JointSwingLimitManipulators::Teardown ( )
overridevirtual

Called when the manipulator mode exits to perform cleanup.

Implements EMotionFX::PhysicsSetupManipulatorsBase.

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