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 Member Functions | List of all members
AzToolsFramework::RotationManipulators Class Reference

#include <RotationManipulators.h>

Inherits AzToolsFramework::Manipulators.

Public Member Functions

 RotationManipulators (const AZ::Transform &worldFromLocal)
 
void InstallLeftMouseDownCallback (const AngularManipulator::MouseActionCallback &onMouseDownCallback)
 
void InstallLeftMouseUpCallback (const AngularManipulator::MouseActionCallback &onMouseUpCallback)
 
void InstallMouseMoveCallback (const AngularManipulator::MouseActionCallback &onMouseMoveCallback)
 
void SetSpaceImpl (const AZ::Transform &worldFromLocal) override
 
void SetLocalTransformImpl (const AZ::Transform &localTransform) override
 
void SetLocalPositionImpl (const AZ::Vector3 &localPosition) override
 
void SetLocalOrientationImpl (const AZ::Quaternion &localOrientation) override
 
void RefreshView (const AZ::Vector3 &worldViewPosition) override
 Refresh the Manipulator and/or View based on the current view position.
 
void DisplayFeedback (AzFramework::DebugDisplayRequests &debugDisplayRequests, const AzFramework::CameraState &cameraState) override
 Provide additional display feedback for an aggregate manipulator.
 
void SetLocalAxes (const AZ::Vector3 &axis1, const AZ::Vector3 &axis2, const AZ::Vector3 &axis3)
 
void SetViewAxis (const AZ::Vector3 &axis)
 
void ConfigureView (float radius, const AZ::Color &axis1Color, const AZ::Color &axis2Color, const AZ::Color &axis3Color)
 
bool PerformingActionViewAxis () const
 
void SetCircleBoundWidth (float circleBoundWidth)
 Sets the bound width to use for the circle (torus) of an angular manipulator.
 
void ProcessManipulators (const ManipulatorVisitCallback &) override
 
- Public Member Functions inherited from AzToolsFramework::Manipulators
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
 

Additional Inherited Members

- Public Types inherited from AzToolsFramework::Manipulators
using ManipulatorVisitCallback = AZStd::function< void(BaseManipulator *)>
 Callback function that is used to visit every manipulator in this group of Manipulators.
 
- Protected Member Functions inherited from AzToolsFramework::Manipulators
virtual void SetNonUniformScaleImpl (const AZ::Vector3 &nonUniformScale)
 
- Protected Attributes inherited from AzToolsFramework::Manipulators
ManipulatorSpaceWithLocalTransform m_manipulatorSpaceWithLocalTransform
 The space and local transform for the manipulators.
 

Detailed Description

RotationManipulators is an aggregation of 3 angular manipulators who share the same origin in addition to a view aligned angular manipulator (facing the camera).

Member Function Documentation

◆ DisplayFeedback()

void AzToolsFramework::RotationManipulators::DisplayFeedback ( AzFramework::DebugDisplayRequests &  debugDisplay,
const AzFramework::CameraState &  cameraState 
)
overridevirtual

Provide additional display feedback for an aggregate manipulator.

Reimplemented from AzToolsFramework::Manipulators.

◆ ProcessManipulators()

void AzToolsFramework::RotationManipulators::ProcessManipulators ( const ManipulatorVisitCallback &  )
overridevirtual

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

Implements AzToolsFramework::Manipulators.

◆ RefreshView()

void AzToolsFramework::RotationManipulators::RefreshView ( const AZ::Vector3 &  worldViewPosition)
overridevirtual

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

Reimplemented from AzToolsFramework::Manipulators.

◆ SetLocalOrientationImpl()

void AzToolsFramework::RotationManipulators::SetLocalOrientationImpl ( const AZ::Quaternion &  localOrientation)
overridevirtual

Reimplemented from AzToolsFramework::Manipulators.

◆ SetLocalPositionImpl()

void AzToolsFramework::RotationManipulators::SetLocalPositionImpl ( const AZ::Vector3 &  localPosition)
overridevirtual

Reimplemented from AzToolsFramework::Manipulators.

◆ SetLocalTransformImpl()

void AzToolsFramework::RotationManipulators::SetLocalTransformImpl ( const AZ::Transform &  localTransform)
overridevirtual

Reimplemented from AzToolsFramework::Manipulators.

◆ SetSpaceImpl()

void AzToolsFramework::RotationManipulators::SetSpaceImpl ( const AZ::Transform &  worldFromLocal)
overridevirtual

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

Reimplemented from AzToolsFramework::Manipulators.

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