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::BoxViewportEdit Class Reference

#include <BoxViewportEdit.h>

Inherits AzToolsFramework::BaseShapeViewportEdit.

Public Member Functions

 BoxViewportEdit (bool allowAsymmetricalEditing=false)
 
void Setup (const ManipulatorManagerId manipulatorManagerId) override
 
void Teardown () override
 Destroy the manipulators for the shape properties being edited.
 
void UpdateManipulators () override
 Call after modifying the shape to ensure that the space the manipulators operate in is updated, along with other properties.
 
void ResetValuesImpl () override
 
void AddEntityComponentIdPairImpl (const AZ::EntityComponentIdPair &entityComponentIdPair) override
 
void InstallGetBoxDimensions (AZStd::function< AZ::Vector3()> getBoxDimensions)
 
void InstallSetBoxDimensions (AZStd::function< void(const AZ::Vector3 &)> setBoxDimensions)
 
- Public Member Functions inherited from AzToolsFramework::BaseShapeViewportEdit
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)
 

Additional Inherited Members

- Protected Member Functions inherited from AzToolsFramework::BaseShapeViewportEdit
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 inherited from AzToolsFramework::BaseShapeViewportEdit
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

Wraps 6 linear manipulators, providing a viewport experience for modifying the extents of a box. It is designed to be usable either by a component mode or by other contexts which are not associated with a particular component, so editing does not rely on an EntityComponentIdPair or other component-based identifier.

Member Function Documentation

◆ AddEntityComponentIdPairImpl()

void AzToolsFramework::BoxViewportEdit::AddEntityComponentIdPairImpl ( const AZ::EntityComponentIdPair &  entityComponentIdPair)
overridevirtual

Implements AzToolsFramework::BaseShapeViewportEdit.

◆ ResetValuesImpl()

void AzToolsFramework::BoxViewportEdit::ResetValuesImpl ( )
overridevirtual

Implements AzToolsFramework::BaseShapeViewportEdit.

◆ Setup()

void AzToolsFramework::BoxViewportEdit::Setup ( const ManipulatorManagerId  manipulatorManagerId)
overridevirtual

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

Implements AzToolsFramework::BaseShapeViewportEdit.

◆ Teardown()

void AzToolsFramework::BoxViewportEdit::Teardown ( )
overridevirtual

Destroy the manipulators for the shape properties being edited.

Implements AzToolsFramework::BaseShapeViewportEdit.

◆ UpdateManipulators()

void AzToolsFramework::BoxViewportEdit::UpdateManipulators ( )
overridevirtual

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

Implements AzToolsFramework::BaseShapeViewportEdit.

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