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 | Protected Member Functions | Protected Attributes | List of all members
AzToolsFramework::BaseShapeViewportEdit Class Referenceabstract

#include <BaseShapeViewportEdit.h>

Inherited by AzToolsFramework::BoxViewportEdit, AzToolsFramework::CapsuleViewportEdit, AzToolsFramework::ShapeTranslationOffsetViewportEdit, and AzToolsFramework::SphereViewportEdit.

Public Member Functions

virtual void Setup (const ManipulatorManagerId manipulatorManagerId)=0
 
virtual void Teardown ()=0
 Destroy the manipulators for the shape properties being edited.
 
virtual void UpdateManipulators ()=0
 Call after modifying the shape to ensure that the space the manipulators operate in is updated, along with other properties.
 
void ResetValues ()
 Reset the shape properties being edited to their default values.
 
void AddEntityComponentIdPair (const AZ::EntityComponentIdPair &entityComponentIdPair)
 
virtual void OnCameraStateChanged (const AzFramework::CameraState &cameraState)
 
void InstallGetManipulatorSpace (AZStd::function< AZ::Transform()> getManipulatorSpace)
 
void InstallGetNonUniformScale (AZStd::function< AZ::Vector3()> getNonUniformScale)
 
void InstallGetTranslationOffset (AZStd::function< AZ::Vector3()> getTranslationOffset)
 
void InstallGetRotationOffset (AZStd::function< AZ::Quaternion()> getRotationOffset)
 
void InstallSetTranslationOffset (AZStd::function< void(const AZ::Vector3 &)> setTranslationOffset)
 
void InstallBeginEditing (AZStd::function< void()> beginEditing)
 
void InstallEndEditing (AZStd::function< void()> endEditing)
 

Protected Member Functions

virtual void ResetValuesImpl ()=0
 
virtual void AddEntityComponentIdPairImpl (const AZ::EntityComponentIdPair &entityComponentIdPair)=0
 
AZ::Transform GetManipulatorSpace () const
 
AZ::Vector3 GetNonUniformScale () const
 
AZ::Vector3 GetTranslationOffset () const
 
AZ::Quaternion GetRotationOffset () const
 
void SetTranslationOffset (const AZ::Vector3 &translationOffset)
 
AZ::Transform GetLocalTransform () const
 
void BeginEditing ()
 
void EndEditing ()
 
void BeginUndoBatch (const char *label)
 
void EndUndoBatch ()
 

Protected Attributes

AZStd::function< AZ::Transform()> m_getManipulatorSpace
 
AZStd::function< AZ::Vector3()> m_getNonUniformScale
 
AZStd::function< AZ::Vector3()> m_getTranslationOffset
 
AZStd::function< AZ::Quaternion()> m_getRotationOffset
 
AZStd::function< void(const AZ::Vector3 &)> m_setTranslationOffset
 
AZStd::function< void()> m_beginEditing
 
AZStd::function< void()> m_endEditing
 
AZStd::unordered_set< AZ::EntityId > m_entityIds
 
UndoSystem::URSequencePoint * m_undoBatch = nullptr
 

Detailed Description

Base class for viewport editing of shapes. This class and its descendants are intended to be viewport independent, so avoid using buses addressed by EntityId or EntityComponentIdPair. To facilitate uses in the main viewport, an EntityComponentIdPair can optionally be specified using AddEntityComponentIdPair, in order to hook manipulators up to undo/redo behavior and UI refreshing.

Member Function Documentation

◆ AddEntityComponentIdPair()

void AzToolsFramework::BaseShapeViewportEdit::AddEntityComponentIdPair ( const AZ::EntityComponentIdPair &  entityComponentIdPair)

Optionally used to associate an EntityComponentIdPair with the shape manipulators. This is useful in the main editor viewport for hooking up undo/redo behavior and UI refreshing. This should be called after Setup. Otherwise, the manipulators will not have been created yet.

◆ InstallBeginEditing()

void AzToolsFramework::BaseShapeViewportEdit::InstallBeginEditing ( AZStd::function< void()>  beginEditing)

Install optional functions to provide hooks for connecting to undo/redo systems, refreshing UI etc. These are not expected to be necessary in the main editor viewport, because the manipulators handle those things automatically, but they may be useful in other viewports.

◆ InstallGetManipulatorSpace()

void AzToolsFramework::BaseShapeViewportEdit::InstallGetManipulatorSpace ( AZStd::function< AZ::Transform()>  getManipulatorSpace)

Install the functions required for the manipulators to interact with the shape and the viewport.

◆ OnCameraStateChanged()

virtual void AzToolsFramework::BaseShapeViewportEdit::OnCameraStateChanged ( const AzFramework::CameraState &  cameraState)
virtual

Optionally allows the viewport editing to respond to the camera state changing, for example by repositioning manipulators to more conveniently accessible locations.

Reimplemented in AzToolsFramework::CapsuleViewportEdit, and AzToolsFramework::SphereViewportEdit.

◆ Setup()

virtual void AzToolsFramework::BaseShapeViewportEdit::Setup ( const ManipulatorManagerId  manipulatorManagerId)
pure virtual

Create manipulators for the shape properties to be edited. Make sure to install all the required functions before calling Setup.

Implemented in AzToolsFramework::BoxViewportEdit, AzToolsFramework::CapsuleViewportEdit, AzToolsFramework::ShapeTranslationOffsetViewportEdit, and AzToolsFramework::SphereViewportEdit.

◆ Teardown()

virtual void AzToolsFramework::BaseShapeViewportEdit::Teardown ( )
pure virtual

Destroy the manipulators for the shape properties being edited.

Implemented in AzToolsFramework::BoxViewportEdit, AzToolsFramework::CapsuleViewportEdit, AzToolsFramework::ShapeTranslationOffsetViewportEdit, and AzToolsFramework::SphereViewportEdit.

◆ UpdateManipulators()

virtual void AzToolsFramework::BaseShapeViewportEdit::UpdateManipulators ( )
pure virtual

Call after modifying the shape to ensure that the space the manipulators operate in is updated, along with other properties.

Implemented in AzToolsFramework::BoxViewportEdit, AzToolsFramework::CapsuleViewportEdit, AzToolsFramework::ShapeTranslationOffsetViewportEdit, and AzToolsFramework::SphereViewportEdit.

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