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

#include <TranslationManipulators.h>

Inherits AzToolsFramework::Manipulators.

Public Types

enum class  Dimensions { Two , Three }
 How many dimensions does this translation manipulator have.
 
- 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.
 

Public Member Functions

 TranslationManipulators (TranslationManipulators &&)=delete
 
TranslationManipulators & operator= (TranslationManipulators &&)=delete
 
 TranslationManipulators (Dimensions dimensions, const AZ::Transform &worldFromLocal, const AZ::Vector3 &nonUniformScale)
 
void InstallLinearManipulatorMouseDownCallback (const LinearManipulator::MouseActionCallback &onMouseDownCallback)
 
void InstallLinearManipulatorMouseMoveCallback (const LinearManipulator::MouseActionCallback &onMouseMoveCallback)
 
void InstallLinearManipulatorMouseUpCallback (const LinearManipulator::MouseActionCallback &onMouseUpCallback)
 
void InstallPlanarManipulatorMouseDownCallback (const PlanarManipulator::MouseActionCallback &onMouseDownCallback)
 
void InstallPlanarManipulatorMouseMoveCallback (const PlanarManipulator::MouseActionCallback &onMouseMoveCallback)
 
void InstallPlanarManipulatorMouseUpCallback (const PlanarManipulator::MouseActionCallback &onMouseUpCallback)
 
void InstallSurfaceManipulatorMouseDownCallback (const SurfaceManipulator::MouseActionCallback &onMouseDownCallback)
 
void InstallSurfaceManipulatorMouseMoveCallback (const SurfaceManipulator::MouseActionCallback &onMouseMoveCallback)
 
void InstallSurfaceManipulatorMouseUpCallback (const SurfaceManipulator::MouseActionCallback &onMouseUpCallback)
 
void InstallSurfaceManipulatorEntityIdsToIgnoreFn (SurfaceManipulator::EntityIdsToIgnoreFn entityIdsToIgnoreFn)
 
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 SetNonUniformScaleImpl (const AZ::Vector3 &nonUniformScale) override
 
void SetAxes (const AZ::Vector3 &axis1, const AZ::Vector3 &axis2, const AZ::Vector3 &axis3=AZ::Vector3::CreateAxisZ())
 
void ConfigureView2d (const TranslationManipulatorsViewCreateInfo &translationManipulatorViewCreateInfo)
 
void ConfigureView3d (const TranslationManipulatorsViewCreateInfo &translationManipulatorViewCreateInfo)
 
void SetLineBoundWidth (float lineBoundWidth)
 Sets the bound width to use for the line/axis of a linear manipulator.
 
- 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

- Protected Attributes inherited from AzToolsFramework::Manipulators
ManipulatorSpaceWithLocalTransform m_manipulatorSpaceWithLocalTransform
 The space and local transform for the manipulators.
 

Detailed Description

TranslationManipulators is an aggregation of 3 linear manipulators, 3 planar manipulators and one surface manipulator who share the same transform.

Member Function Documentation

◆ SetLocalOrientationImpl()

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

Reimplemented from AzToolsFramework::Manipulators.

◆ SetLocalPositionImpl()

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

Reimplemented from AzToolsFramework::Manipulators.

◆ SetLocalTransformImpl()

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

Reimplemented from AzToolsFramework::Manipulators.

◆ SetNonUniformScaleImpl()

void AzToolsFramework::TranslationManipulators::SetNonUniformScaleImpl ( const AZ::Vector3 &  nonUniformScale)
overridevirtual

Reimplemented from AzToolsFramework::Manipulators.

◆ SetSpaceImpl()

void AzToolsFramework::TranslationManipulators::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: