Open 3D Engine AzToolsFramework 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 Types | Public Member Functions | Protected Attributes | List of all members
AzToolsFramework::Manipulators Class Referenceabstract

#include <BaseManipulator.h>

Inherited by AzToolsFramework::RotationManipulators, AzToolsFramework::ScaleManipulators, and AzToolsFramework::TranslationManipulators.

Public Types

using ManipulatorVisitCallback = AZStd::function< void(BaseManipulator *)>
 Callback function that is used to visit every manipulator in this group of Manipulators.
 

Public Member Functions

void Register (ManipulatorManagerId manipulatorManagerId)
 
void Unregister ()
 
void SetBoundsDirty ()
 
void AddEntityComponentIdPair (const AZ::EntityComponentIdPair &entityComponentIdPair)
 
void RemoveEntityId (AZ::EntityId entityId)
 
void RemoveEntityComponentIdPair (const AZ::EntityComponentIdPair &entityComponentIdPair)
 
bool PerformingAction ()
 
bool Registered ()
 
const AZ::Transform & GetLocalTransform () const
 
const AZ::Transform & GetSpace () const
 
const AZ::Vector3 & GetNonUniformScale () const
 
void SetSpace (const AZ::Transform &worldFromLocal)
 
void SetLocalTransform (const AZ::Transform &localTransform)
 
void SetLocalPosition (const AZ::Vector3 &localPosition)
 
void SetLocalOrientation (const AZ::Quaternion &localOrientation)
 
void SetNonUniformScale (const AZ::Vector3 &nonUniformScale)
 
virtual void RefreshView (const AZ::Vector3 &worldViewPosition)
 Refresh the Manipulator and/or View based on the current view position.
 
virtual void DisplayFeedback (AzFramework::DebugDisplayRequests &debugDisplay, const AzFramework::CameraState &cameraState)
 Provide additional display feedback for an aggregate manipulator.
 
virtual void ProcessManipulators (const ManipulatorVisitCallback &)=0
 

Protected Member Functions

virtual void SetSpaceImpl (const AZ::Transform &worldFromLocal)
 
virtual void SetLocalTransformImpl (const AZ::Transform &localTransform)
 
virtual void SetLocalPositionImpl (const AZ::Vector3 &localPosition)
 
virtual void SetLocalOrientationImpl (const AZ::Quaternion &localOrientation)
 
virtual void SetNonUniformScaleImpl (const AZ::Vector3 &nonUniformScale)
 

Protected Attributes

ManipulatorSpaceWithLocalTransform m_manipulatorSpaceWithLocalTransform
 The space and local transform for the manipulators.
 

Detailed Description

Base class to be used when composing aggregate manipulator types - wraps some common functionality all manipulators need.

Member Function Documentation

◆ DisplayFeedback()

virtual void AzToolsFramework::Manipulators::DisplayFeedback ( AzFramework::DebugDisplayRequests &  debugDisplay,
const AzFramework::CameraState &  cameraState 
)
inlinevirtual

Provide additional display feedback for an aggregate manipulator.

Reimplemented in AzToolsFramework::RotationManipulators.

◆ ProcessManipulators()

virtual void AzToolsFramework::Manipulators::ProcessManipulators ( const ManipulatorVisitCallback &  )
pure virtual

Common processing for base manipulator type - Implement for all individual manipulators used in an aggregate manipulator.

Implemented in AzToolsFramework::RotationManipulators, and AzToolsFramework::ScaleManipulators.

◆ RefreshView()

virtual void AzToolsFramework::Manipulators::RefreshView ( const AZ::Vector3 &  worldViewPosition)
inlinevirtual

Refresh the Manipulator and/or View based on the current view position.

Reimplemented in AzToolsFramework::RotationManipulators.

◆ SetSpaceImpl()

virtual void AzToolsFramework::Manipulators::SetSpaceImpl ( const AZ::Transform &  worldFromLocal)
inlineprotectedvirtual

Allows implementers to perform additional logic when updating the location of the manipulator group.

Reimplemented in AzToolsFramework::RotationManipulators, AzToolsFramework::ScaleManipulators, and AzToolsFramework::TranslationManipulators.

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