Merge branch 'development' into Prism/AddRepoDialog
nggieber
4 years ago
commit
4b73637ffd
@ -0,0 +1,7 @@
|
|||||||
|
<svg width="24" height="33" viewBox="0 0 24 33" fill="none" xmlns="http://www.w3.org/2000/svg">
|
||||||
|
<rect x="5" y="7" width="2" height="12" fill="#808080"/>
|
||||||
|
<rect x="5" y="19" width="2" height="14" fill="#808080"/>
|
||||||
|
<rect x="17" y="16" width="2" height="12" transform="rotate(90 17 16)" fill="#808080"/>
|
||||||
|
<circle cx="6" cy="6" r="2" fill="#808080"/>
|
||||||
|
<circle cx="18" cy="17" r="2" fill="#808080"/>
|
||||||
|
</svg>
|
||||||
|
After Width: | Height: | Size: 398 B |
@ -0,0 +1,5 @@
|
|||||||
|
<svg width="24" height="24" viewBox="0 0 24 24" fill="none" xmlns="http://www.w3.org/2000/svg">
|
||||||
|
<rect x="5" width="2" height="12" fill="grey"/>
|
||||||
|
<rect x="17" y="12" width="2" height="12" transform="rotate(90 17 12)" fill="grey"/>
|
||||||
|
<circle cx="18" cy="13" r="2" fill="grey"/>
|
||||||
|
</svg>
|
||||||
|
After Width: | Height: | Size: 280 B |
@ -0,0 +1,6 @@
|
|||||||
|
<svg width="24" height="26" viewBox="0 0 24 26" fill="none" xmlns="http://www.w3.org/2000/svg">
|
||||||
|
<rect x="5" width="2" height="12" fill="grey"/>
|
||||||
|
<rect x="5" y="14" width="2" height="12" fill="grey"/>
|
||||||
|
<rect x="17" y="12" width="2" height="12" transform="rotate(90 17 12)" fill="grey"/>
|
||||||
|
<circle cx="18" cy="13" r="2" fill="grey"/>
|
||||||
|
</svg>
|
||||||
|
After Width: | Height: | Size: 335 B |
@ -0,0 +1,6 @@
|
|||||||
|
<svg width="24" height="24" viewBox="0 0 24 24" fill="none" xmlns="http://www.w3.org/2000/svg">
|
||||||
|
<rect x="5" y="7" width="2" height="7" fill="#808080"/>
|
||||||
|
<rect x="17" y="12" width="2" height="12" transform="rotate(90 17 12)" fill="#808080"/>
|
||||||
|
<circle cx="6" cy="6" r="2" fill="#808080"/>
|
||||||
|
<circle cx="18" cy="13" r="2" fill="#808080"/>
|
||||||
|
</svg>
|
||||||
|
After Width: | Height: | Size: 339 B |
@ -0,0 +1,225 @@
|
|||||||
|
/*
|
||||||
|
* Copyright (c) Contributors to the Open 3D Engine Project.
|
||||||
|
* For complete copyright and license terms please see the LICENSE at the root of this distribution.
|
||||||
|
*
|
||||||
|
* SPDX-License-Identifier: Apache-2.0 OR MIT
|
||||||
|
*
|
||||||
|
*/
|
||||||
|
|
||||||
|
#include <AZTestShared/Math/MathTestHelpers.h>
|
||||||
|
#include <AtomToolsFramework/Viewport/ModularViewportCameraController.h>
|
||||||
|
#include <AzCore/UnitTest/TestTypes.h>
|
||||||
|
#include <AzFramework/Viewport/ViewportControllerList.h>
|
||||||
|
#include <AzTest/GemTestEnvironment.h>
|
||||||
|
#include <AzToolsFramework/API/EditorCameraBus.h>
|
||||||
|
#include <AzToolsFramework/ToolsComponents/TransformComponent.h>
|
||||||
|
#include <EditorModularViewportCameraComposer.h>
|
||||||
|
|
||||||
|
namespace UnitTest
|
||||||
|
{
|
||||||
|
class EditorCameraTestEnvironment : public AZ::Test::GemTestEnvironment
|
||||||
|
{
|
||||||
|
// AZ::Test::GemTestEnvironment overrides ...
|
||||||
|
void AddGemsAndComponents() override;
|
||||||
|
};
|
||||||
|
|
||||||
|
void EditorCameraTestEnvironment::AddGemsAndComponents()
|
||||||
|
{
|
||||||
|
AddDynamicModulePaths({ CAMERA_EDITOR_MODULE });
|
||||||
|
AddComponentDescriptors({ AzToolsFramework::Components::TransformComponent::CreateDescriptor() });
|
||||||
|
}
|
||||||
|
|
||||||
|
class EditorCameraFixture : public ::testing::Test
|
||||||
|
{
|
||||||
|
public:
|
||||||
|
AtomToolsFramework::ModularCameraViewportContext* m_cameraViewportContextView = nullptr;
|
||||||
|
AZStd::unique_ptr<SandboxEditor::EditorModularViewportCameraComposer> m_editorModularViewportCameraComposer;
|
||||||
|
AZStd::unique_ptr<AZ::DynamicModuleHandle> m_editorLibHandle;
|
||||||
|
AzFramework::ViewportControllerListPtr m_controllerList;
|
||||||
|
AZStd::unique_ptr<AZ::Entity> m_entity;
|
||||||
|
|
||||||
|
static const AzFramework::ViewportId TestViewportId;
|
||||||
|
|
||||||
|
void SetUp() override
|
||||||
|
{
|
||||||
|
m_editorLibHandle = AZ::DynamicModuleHandle::Create("EditorLib");
|
||||||
|
[[maybe_unused]] const bool loaded = m_editorLibHandle->Load(true);
|
||||||
|
AZ_Assert(loaded, "EditorLib could not be loaded");
|
||||||
|
|
||||||
|
m_controllerList = AZStd::make_shared<AzFramework::ViewportControllerList>();
|
||||||
|
m_controllerList->RegisterViewportContext(TestViewportId);
|
||||||
|
|
||||||
|
m_entity = AZStd::make_unique<AZ::Entity>();
|
||||||
|
m_entity->Init();
|
||||||
|
m_entity->CreateComponent<AzToolsFramework::Components::TransformComponent>();
|
||||||
|
m_entity->Activate();
|
||||||
|
|
||||||
|
m_editorModularViewportCameraComposer = AZStd::make_unique<SandboxEditor::EditorModularViewportCameraComposer>(TestViewportId);
|
||||||
|
|
||||||
|
auto controller = m_editorModularViewportCameraComposer->CreateModularViewportCameraController();
|
||||||
|
// set some overrides for the test
|
||||||
|
controller->SetCameraViewportContextBuilderCallback(
|
||||||
|
[this](AZStd::unique_ptr<AtomToolsFramework::ModularCameraViewportContext>& cameraViewportContext) mutable
|
||||||
|
{
|
||||||
|
cameraViewportContext = AZStd::make_unique<AtomToolsFramework::PlaceholderModularCameraViewportContextImpl>();
|
||||||
|
m_cameraViewportContextView = cameraViewportContext.get();
|
||||||
|
});
|
||||||
|
|
||||||
|
m_controllerList->Add(controller);
|
||||||
|
}
|
||||||
|
|
||||||
|
void TearDown() override
|
||||||
|
{
|
||||||
|
m_editorModularViewportCameraComposer.reset();
|
||||||
|
m_cameraViewportContextView = nullptr;
|
||||||
|
m_entity.reset();
|
||||||
|
m_editorLibHandle = {};
|
||||||
|
}
|
||||||
|
};
|
||||||
|
|
||||||
|
const AzFramework::ViewportId EditorCameraFixture::TestViewportId = AzFramework::ViewportId(1337);
|
||||||
|
|
||||||
|
TEST_F(EditorCameraFixture, ModularViewportCameraControllerReferenceFrameUpdatedWhenViewportEntityisChanged)
|
||||||
|
{
|
||||||
|
// Given
|
||||||
|
const auto entityTransform = AZ::Transform::CreateFromQuaternionAndTranslation(
|
||||||
|
AZ::Quaternion::CreateRotationX(AZ::DegToRad(90.0f)), AZ::Vector3(10.0f, 5.0f, -2.0f));
|
||||||
|
AZ::TransformBus::Event(m_entity->GetId(), &AZ::TransformBus::Events::SetWorldTM, entityTransform);
|
||||||
|
|
||||||
|
// When
|
||||||
|
// imitate viewport entity changing
|
||||||
|
Camera::EditorCameraNotificationBus::Broadcast(
|
||||||
|
&Camera::EditorCameraNotificationBus::Events::OnViewportViewEntityChanged, m_entity->GetId());
|
||||||
|
|
||||||
|
// ensure the viewport updates after the viewport view entity change
|
||||||
|
const float deltaTime = 1.0f / 60.0f;
|
||||||
|
m_controllerList->UpdateViewport({ TestViewportId, AzFramework::FloatSeconds(deltaTime), AZ::ScriptTimePoint() });
|
||||||
|
|
||||||
|
// retrieve updated camera transform
|
||||||
|
const AZ::Transform cameraTransform = m_cameraViewportContextView->GetCameraTransform();
|
||||||
|
|
||||||
|
// Then
|
||||||
|
// camera transform matches that of the entity
|
||||||
|
EXPECT_THAT(cameraTransform, IsClose(entityTransform));
|
||||||
|
}
|
||||||
|
|
||||||
|
TEST_F(EditorCameraFixture, ReferenceFrameRemainsIdentityAfterExternalCameraTransformChangeWhenNotSet)
|
||||||
|
{
|
||||||
|
// Given
|
||||||
|
m_cameraViewportContextView->SetCameraTransform(AZ::Transform::CreateTranslation(AZ::Vector3(10.0f, 20.0f, 30.0f)));
|
||||||
|
|
||||||
|
// When
|
||||||
|
AZ::Transform referenceFrame = AZ::Transform::CreateTranslation(AZ::Vector3(1.0f, 2.0f, 3.0f));
|
||||||
|
AtomToolsFramework::ModularViewportCameraControllerRequestBus::EventResult(
|
||||||
|
referenceFrame, TestViewportId, &AtomToolsFramework::ModularViewportCameraControllerRequestBus::Events::GetReferenceFrame);
|
||||||
|
|
||||||
|
// Then
|
||||||
|
// reference frame is still the identity
|
||||||
|
EXPECT_THAT(referenceFrame, IsClose(AZ::Transform::CreateIdentity()));
|
||||||
|
}
|
||||||
|
|
||||||
|
TEST_F(EditorCameraFixture, ExternalCameraTransformChangeWhenReferenceFrameIsSetUpdatesReferenceFrame)
|
||||||
|
{
|
||||||
|
// Given
|
||||||
|
const AZ::Transform referenceFrame = AZ::Transform::CreateFromQuaternionAndTranslation(
|
||||||
|
AZ::Quaternion::CreateRotationX(AZ::DegToRad(90.0f)), AZ::Vector3(1.0f, 2.0f, 3.0f));
|
||||||
|
AtomToolsFramework::ModularViewportCameraControllerRequestBus::Event(
|
||||||
|
TestViewportId, &AtomToolsFramework::ModularViewportCameraControllerRequestBus::Events::SetReferenceFrame, referenceFrame);
|
||||||
|
|
||||||
|
const AZ::Transform nextTransform = AZ::Transform::CreateTranslation(AZ::Vector3(10.0f, 20.0f, 30.0f));
|
||||||
|
m_cameraViewportContextView->SetCameraTransform(nextTransform);
|
||||||
|
|
||||||
|
// When
|
||||||
|
AZ::Transform currentReferenceFrame = AZ::Transform::CreateTranslation(AZ::Vector3(1.0f, 2.0f, 3.0f));
|
||||||
|
AtomToolsFramework::ModularViewportCameraControllerRequestBus::EventResult(
|
||||||
|
currentReferenceFrame, TestViewportId,
|
||||||
|
&AtomToolsFramework::ModularViewportCameraControllerRequestBus::Events::GetReferenceFrame);
|
||||||
|
|
||||||
|
// Then
|
||||||
|
EXPECT_THAT(currentReferenceFrame, IsClose(nextTransform));
|
||||||
|
}
|
||||||
|
|
||||||
|
TEST_F(EditorCameraFixture, ReferenceFrameReturnedToIdentityAfterClear)
|
||||||
|
{
|
||||||
|
// Given
|
||||||
|
const AZ::Transform referenceFrame = AZ::Transform::CreateFromQuaternionAndTranslation(
|
||||||
|
AZ::Quaternion::CreateRotationX(AZ::DegToRad(90.0f)), AZ::Vector3(1.0f, 2.0f, 3.0f));
|
||||||
|
AtomToolsFramework::ModularViewportCameraControllerRequestBus::Event(
|
||||||
|
TestViewportId, &AtomToolsFramework::ModularViewportCameraControllerRequestBus::Events::SetReferenceFrame, referenceFrame);
|
||||||
|
|
||||||
|
// When
|
||||||
|
AtomToolsFramework::ModularViewportCameraControllerRequestBus::Event(
|
||||||
|
TestViewportId, &AtomToolsFramework::ModularViewportCameraControllerRequestBus::Events::ClearReferenceFrame);
|
||||||
|
|
||||||
|
AZ::Transform currentReferenceFrame = AZ::Transform::CreateTranslation(AZ::Vector3(1.0f, 2.0f, 3.0f));
|
||||||
|
AtomToolsFramework::ModularViewportCameraControllerRequestBus::EventResult(
|
||||||
|
currentReferenceFrame, TestViewportId,
|
||||||
|
&AtomToolsFramework::ModularViewportCameraControllerRequestBus::Events::GetReferenceFrame);
|
||||||
|
|
||||||
|
// Then
|
||||||
|
EXPECT_THAT(currentReferenceFrame, IsClose(AZ::Transform::CreateIdentity()));
|
||||||
|
}
|
||||||
|
|
||||||
|
TEST_F(EditorCameraFixture, InterpolateToTransform)
|
||||||
|
{
|
||||||
|
// When
|
||||||
|
AZ::Transform transformToInterpolateTo = AZ::Transform::CreateFromQuaternionAndTranslation(
|
||||||
|
AZ::Quaternion::CreateRotationZ(AZ::DegToRad(90.0f)), AZ::Vector3(20.0f, 40.0f, 60.0f));
|
||||||
|
AtomToolsFramework::ModularViewportCameraControllerRequestBus::Event(
|
||||||
|
TestViewportId, &AtomToolsFramework::ModularViewportCameraControllerRequestBus::Events::InterpolateToTransform,
|
||||||
|
transformToInterpolateTo, 0.0f);
|
||||||
|
|
||||||
|
// simulate interpolation
|
||||||
|
m_controllerList->UpdateViewport({ TestViewportId, AzFramework::FloatSeconds(0.5f), AZ::ScriptTimePoint() });
|
||||||
|
m_controllerList->UpdateViewport({ TestViewportId, AzFramework::FloatSeconds(0.5f), AZ::ScriptTimePoint() });
|
||||||
|
|
||||||
|
const auto finalTransform = m_cameraViewportContextView->GetCameraTransform();
|
||||||
|
|
||||||
|
// Then
|
||||||
|
EXPECT_THAT(finalTransform, IsClose(transformToInterpolateTo));
|
||||||
|
}
|
||||||
|
|
||||||
|
TEST_F(EditorCameraFixture, InterpolateToTransformWithReferenceSpaceSet)
|
||||||
|
{
|
||||||
|
// Given
|
||||||
|
const AZ::Transform referenceFrame = AZ::Transform::CreateFromQuaternionAndTranslation(
|
||||||
|
AZ::Quaternion::CreateRotationX(AZ::DegToRad(90.0f)), AZ::Vector3(1.0f, 2.0f, 3.0f));
|
||||||
|
AtomToolsFramework::ModularViewportCameraControllerRequestBus::Event(
|
||||||
|
TestViewportId, &AtomToolsFramework::ModularViewportCameraControllerRequestBus::Events::SetReferenceFrame, referenceFrame);
|
||||||
|
|
||||||
|
AZ::Transform transformToInterpolateTo = AZ::Transform::CreateFromQuaternionAndTranslation(
|
||||||
|
AZ::Quaternion::CreateRotationZ(AZ::DegToRad(90.0f)), AZ::Vector3(20.0f, 40.0f, 60.0f));
|
||||||
|
|
||||||
|
// When
|
||||||
|
AtomToolsFramework::ModularViewportCameraControllerRequestBus::Event(
|
||||||
|
TestViewportId, &AtomToolsFramework::ModularViewportCameraControllerRequestBus::Events::InterpolateToTransform,
|
||||||
|
transformToInterpolateTo, 0.0f);
|
||||||
|
|
||||||
|
// simulate interpolation
|
||||||
|
m_controllerList->UpdateViewport({ TestViewportId, AzFramework::FloatSeconds(0.5f), AZ::ScriptTimePoint() });
|
||||||
|
m_controllerList->UpdateViewport({ TestViewportId, AzFramework::FloatSeconds(0.5f), AZ::ScriptTimePoint() });
|
||||||
|
|
||||||
|
AZ::Transform currentReferenceFrame = AZ::Transform::CreateTranslation(AZ::Vector3(1.0f, 2.0f, 3.0f));
|
||||||
|
AtomToolsFramework::ModularViewportCameraControllerRequestBus::EventResult(
|
||||||
|
currentReferenceFrame, TestViewportId,
|
||||||
|
&AtomToolsFramework::ModularViewportCameraControllerRequestBus::Events::GetReferenceFrame);
|
||||||
|
|
||||||
|
const auto finalTransform = m_cameraViewportContextView->GetCameraTransform();
|
||||||
|
|
||||||
|
// Then
|
||||||
|
EXPECT_THAT(finalTransform, IsClose(transformToInterpolateTo));
|
||||||
|
EXPECT_THAT(currentReferenceFrame, IsClose(AZ::Transform::CreateIdentity()));
|
||||||
|
}
|
||||||
|
} // namespace UnitTest
|
||||||
|
|
||||||
|
// required to support running integration tests with the Camera Gem
|
||||||
|
AZTEST_EXPORT int AZ_UNIT_TEST_HOOK_NAME(int argc, char** argv)
|
||||||
|
{
|
||||||
|
::testing::InitGoogleMock(&argc, argv);
|
||||||
|
AZ::Test::printUnusedParametersWarning(argc, argv);
|
||||||
|
AZ::Test::addTestEnvironments({ new UnitTest::EditorCameraTestEnvironment() });
|
||||||
|
int result = RUN_ALL_TESTS();
|
||||||
|
return result;
|
||||||
|
}
|
||||||
|
|
||||||
|
IMPLEMENT_TEST_EXECUTABLE_MAIN();
|
||||||
@ -0,0 +1,200 @@
|
|||||||
|
/*
|
||||||
|
* Copyright (c) Contributors to the Open 3D Engine Project.
|
||||||
|
* For complete copyright and license terms please see the LICENSE at the root of this distribution.
|
||||||
|
*
|
||||||
|
* SPDX-License-Identifier: Apache-2.0 OR MIT
|
||||||
|
*
|
||||||
|
*/
|
||||||
|
|
||||||
|
#include <AzCore/IO/FileReader.h>
|
||||||
|
#include <AzCore/IO/FileIO.h>
|
||||||
|
#include <AzCore/IO/Path/Path.h>
|
||||||
|
|
||||||
|
namespace AZ::IO
|
||||||
|
{
|
||||||
|
FileReader::FileReader() = default;
|
||||||
|
|
||||||
|
FileReader::FileReader(AZ::IO::FileIOBase* fileIoBase, const char* filePath)
|
||||||
|
{
|
||||||
|
Open(fileIoBase, filePath);
|
||||||
|
}
|
||||||
|
|
||||||
|
FileReader::~FileReader()
|
||||||
|
{
|
||||||
|
Close();
|
||||||
|
}
|
||||||
|
|
||||||
|
FileReader::FileReader(FileReader&& other)
|
||||||
|
{
|
||||||
|
AZStd::swap(m_file, other.m_file);
|
||||||
|
AZStd::swap(m_fileIoBase, other.m_fileIoBase);
|
||||||
|
}
|
||||||
|
|
||||||
|
FileReader& FileReader::operator=(FileReader&& other)
|
||||||
|
{
|
||||||
|
// Close the current file and take over other file
|
||||||
|
Close();
|
||||||
|
m_file = AZStd::move(other.m_file);
|
||||||
|
m_fileIoBase = AZStd::move(other.m_fileIoBase);
|
||||||
|
other.m_file = AZStd::monostate{};
|
||||||
|
other.m_fileIoBase = {};
|
||||||
|
|
||||||
|
return *this;
|
||||||
|
}
|
||||||
|
|
||||||
|
bool FileReader::Open(AZ::IO::FileIOBase* fileIoBase, const char* filePath)
|
||||||
|
{
|
||||||
|
// Close file if the FileReader has an instance open
|
||||||
|
Close();
|
||||||
|
|
||||||
|
if (fileIoBase != nullptr)
|
||||||
|
{
|
||||||
|
AZ::IO::HandleType fileHandle;
|
||||||
|
if (fileIoBase->Open(filePath, IO::OpenMode::ModeRead, fileHandle))
|
||||||
|
{
|
||||||
|
m_file = fileHandle;
|
||||||
|
m_fileIoBase = fileIoBase;
|
||||||
|
return true;
|
||||||
|
}
|
||||||
|
}
|
||||||
|
else
|
||||||
|
{
|
||||||
|
AZ::IO::SystemFile file;
|
||||||
|
if (file.Open(filePath, IO::SystemFile::OpenMode::SF_OPEN_READ_ONLY))
|
||||||
|
{
|
||||||
|
m_file = AZStd::move(file);
|
||||||
|
return true;
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
return false;
|
||||||
|
}
|
||||||
|
|
||||||
|
bool FileReader::IsOpen() const
|
||||||
|
{
|
||||||
|
if (auto fileHandle = AZStd::get_if<AZ::IO::HandleType>(&m_file); fileHandle != nullptr)
|
||||||
|
{
|
||||||
|
return *fileHandle != AZ::IO::InvalidHandle;
|
||||||
|
}
|
||||||
|
else if (auto systemFile = AZStd::get_if<AZ::IO::SystemFile>(&m_file); systemFile != nullptr)
|
||||||
|
{
|
||||||
|
return systemFile->IsOpen();
|
||||||
|
}
|
||||||
|
|
||||||
|
return false;
|
||||||
|
}
|
||||||
|
|
||||||
|
void FileReader::Close()
|
||||||
|
{
|
||||||
|
if (auto fileHandle = AZStd::get_if<AZ::IO::HandleType>(&m_file); fileHandle != nullptr)
|
||||||
|
{
|
||||||
|
if (AZ::IO::FileIOBase* fileIo = m_fileIoBase; fileIo != nullptr)
|
||||||
|
{
|
||||||
|
fileIo->Close(*fileHandle);
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
m_file = AZStd::monostate{};
|
||||||
|
m_fileIoBase = {};
|
||||||
|
}
|
||||||
|
|
||||||
|
auto FileReader::Length() const -> SizeType
|
||||||
|
{
|
||||||
|
if (auto fileHandle = AZStd::get_if<AZ::IO::HandleType>(&m_file); fileHandle != nullptr)
|
||||||
|
{
|
||||||
|
if (SizeType fileSize{}; m_fileIoBase->Size(*fileHandle, fileSize))
|
||||||
|
{
|
||||||
|
return fileSize;
|
||||||
|
}
|
||||||
|
}
|
||||||
|
else if (auto systemFile = AZStd::get_if<AZ::IO::SystemFile>(&m_file); systemFile != nullptr)
|
||||||
|
{
|
||||||
|
return systemFile->Length();
|
||||||
|
}
|
||||||
|
|
||||||
|
return 0;
|
||||||
|
}
|
||||||
|
|
||||||
|
auto FileReader::Read(SizeType byteSize, void* buffer) -> SizeType
|
||||||
|
{
|
||||||
|
if (auto fileHandle = AZStd::get_if<AZ::IO::HandleType>(&m_file); fileHandle != nullptr)
|
||||||
|
{
|
||||||
|
if (SizeType bytesRead{}; m_fileIoBase->Read(*fileHandle, buffer, byteSize, false, &bytesRead))
|
||||||
|
{
|
||||||
|
return bytesRead;
|
||||||
|
}
|
||||||
|
}
|
||||||
|
else if (auto systemFile = AZStd::get_if<AZ::IO::SystemFile>(&m_file); systemFile != nullptr)
|
||||||
|
{
|
||||||
|
return systemFile->Read(byteSize, buffer);
|
||||||
|
}
|
||||||
|
|
||||||
|
return 0;
|
||||||
|
}
|
||||||
|
|
||||||
|
auto FileReader::Tell() const -> SizeType
|
||||||
|
{
|
||||||
|
if (auto fileHandle = AZStd::get_if<AZ::IO::HandleType>(&m_file); fileHandle != nullptr)
|
||||||
|
{
|
||||||
|
if (SizeType fileOffset{}; m_fileIoBase->Tell(*fileHandle, fileOffset))
|
||||||
|
{
|
||||||
|
return fileOffset;
|
||||||
|
}
|
||||||
|
}
|
||||||
|
else if (auto systemFile = AZStd::get_if<AZ::IO::SystemFile>(&m_file); systemFile != nullptr)
|
||||||
|
{
|
||||||
|
return systemFile->Tell();
|
||||||
|
}
|
||||||
|
|
||||||
|
return 0;
|
||||||
|
}
|
||||||
|
|
||||||
|
bool FileReader::Seek(AZ::s64 offset, SeekType type)
|
||||||
|
{
|
||||||
|
if (auto fileHandle = AZStd::get_if<AZ::IO::HandleType>(&m_file); fileHandle != nullptr)
|
||||||
|
{
|
||||||
|
return m_fileIoBase->Seek(*fileHandle, offset, type);
|
||||||
|
}
|
||||||
|
else if (auto systemFile = AZStd::get_if<AZ::IO::SystemFile>(&m_file); systemFile != nullptr)
|
||||||
|
{
|
||||||
|
systemFile->Seek(offset, static_cast<AZ::IO::SystemFile::SeekMode>(type));
|
||||||
|
return true;
|
||||||
|
}
|
||||||
|
|
||||||
|
return false;
|
||||||
|
}
|
||||||
|
|
||||||
|
bool FileReader::Eof() const
|
||||||
|
{
|
||||||
|
if (auto fileHandle = AZStd::get_if<AZ::IO::HandleType>(&m_file); fileHandle != nullptr)
|
||||||
|
{
|
||||||
|
return m_fileIoBase->Eof(*fileHandle);
|
||||||
|
}
|
||||||
|
else if (auto systemFile = AZStd::get_if<AZ::IO::SystemFile>(&m_file); systemFile != nullptr)
|
||||||
|
{
|
||||||
|
return systemFile->Eof();
|
||||||
|
}
|
||||||
|
|
||||||
|
return false;
|
||||||
|
}
|
||||||
|
|
||||||
|
bool FileReader::GetFilePath(AZ::IO::FixedMaxPath& filePath) const
|
||||||
|
{
|
||||||
|
if (auto fileHandle = AZStd::get_if<AZ::IO::HandleType>(&m_file); fileHandle != nullptr)
|
||||||
|
{
|
||||||
|
AZ::IO::FixedMaxPathString& pathStringRef = filePath.Native();
|
||||||
|
if (m_fileIoBase->GetFilename(*fileHandle, pathStringRef.data(), pathStringRef.capacity()))
|
||||||
|
{
|
||||||
|
pathStringRef.resize_no_construct(AZStd::char_traits<char>::length(pathStringRef.data()));
|
||||||
|
return true;
|
||||||
|
}
|
||||||
|
}
|
||||||
|
else if (auto systemFile = AZStd::get_if<AZ::IO::SystemFile>(&m_file); systemFile != nullptr)
|
||||||
|
{
|
||||||
|
filePath = systemFile->Name();
|
||||||
|
return true;
|
||||||
|
}
|
||||||
|
|
||||||
|
return false;
|
||||||
|
}
|
||||||
|
}
|
||||||
@ -0,0 +1,92 @@
|
|||||||
|
/*
|
||||||
|
* Copyright (c) Contributors to the Open 3D Engine Project.
|
||||||
|
* For complete copyright and license terms please see the LICENSE at the root of this distribution.
|
||||||
|
*
|
||||||
|
* SPDX-License-Identifier: Apache-2.0 OR MIT
|
||||||
|
*
|
||||||
|
*/
|
||||||
|
#pragma once
|
||||||
|
|
||||||
|
#include <AzCore/IO/Path/Path_fwd.h>
|
||||||
|
#include <AzCore/IO/SystemFile.h>
|
||||||
|
#include <AzCore/std/containers/variant.h>
|
||||||
|
|
||||||
|
namespace AZ::IO
|
||||||
|
{
|
||||||
|
class FileIOBase;
|
||||||
|
enum class SeekType : AZ::u32;
|
||||||
|
|
||||||
|
//! Structure which encapsulates delegates File Read operations
|
||||||
|
//! to either the FileIOBase or SystemFile classes based if a FileIOBase* instance has been supplied
|
||||||
|
//! to the FileSystemReader class
|
||||||
|
//! the SettingsRegistry option to use FileIO
|
||||||
|
class FileReader
|
||||||
|
{
|
||||||
|
using HandleType = AZ::u32;
|
||||||
|
using FileHandleType = AZStd::variant<AZStd::monostate, AZ::IO::SystemFile, HandleType>;
|
||||||
|
public:
|
||||||
|
using SizeType = AZ::u64;
|
||||||
|
|
||||||
|
//! Creates FileReader instance in the default state with no file opend
|
||||||
|
FileReader();
|
||||||
|
~FileReader();
|
||||||
|
|
||||||
|
//! Creates a new FileReader instance and attempts to open the file at the supplied path
|
||||||
|
//! Uses the FileIOBase instance if supplied
|
||||||
|
//! @param fileIOBase pointer to fileIOBase instance
|
||||||
|
//! @param null-terminated filePath to open
|
||||||
|
FileReader(AZ::IO::FileIOBase* fileIoBase, const char* filePath);
|
||||||
|
|
||||||
|
//! Takes ownership of the supplied FileReader handle
|
||||||
|
FileReader(FileReader&& other);
|
||||||
|
|
||||||
|
//! Moves ownership of FileReader handle to this instance
|
||||||
|
FileReader& operator=(FileReader&& other);
|
||||||
|
|
||||||
|
//! Opens a File using the FileIOBase instance if non-nullptr
|
||||||
|
//! Otherwise fall back to use SystemFile
|
||||||
|
//! @param fileIOBase pointer to fileIOBase instance
|
||||||
|
//! @param null-terminated filePath to open
|
||||||
|
//! @return true if the File is opened successfully
|
||||||
|
bool Open(AZ::IO::FileIOBase* fileIoBase, const char* filePath);
|
||||||
|
|
||||||
|
//! Returns true if a file is currently open
|
||||||
|
//! @return true if the file is open
|
||||||
|
bool IsOpen() const;
|
||||||
|
|
||||||
|
//! Closes the File
|
||||||
|
void Close();
|
||||||
|
|
||||||
|
//! Retrieve the length of the OpenFile
|
||||||
|
SizeType Length() const;
|
||||||
|
|
||||||
|
//! Attempts to read up to byte size bytes into the supplied buffer
|
||||||
|
//! @param byteSize - Maximum number of bytes to read
|
||||||
|
//! @param buffer - Buffer to read bytes into
|
||||||
|
//! @returns the number of bytes read if the file is open, otherwise 0
|
||||||
|
SizeType Read(SizeType byteSize, void* buffer);
|
||||||
|
|
||||||
|
//! Returns the current file offset
|
||||||
|
//! @returns file offset if the file is open, otherwise 0
|
||||||
|
SizeType Tell() const;
|
||||||
|
|
||||||
|
//! Seeks within the open file to the offset supplied
|
||||||
|
//! @param offset File offset to seek to
|
||||||
|
//! @param type parameter to indicate the reference point to start the seek from
|
||||||
|
//! @returns true if the file is open and the seek succeeded
|
||||||
|
bool Seek(AZ::s64 offset, SeekType type);
|
||||||
|
|
||||||
|
//! Returns true if the file is open and in the EOF state
|
||||||
|
bool Eof() const;
|
||||||
|
|
||||||
|
//! Store the file path of the open file into the output file path parameter
|
||||||
|
//! The filePath reference is left unmodified, if the path was not stored
|
||||||
|
//! @return true if the filePath was stored
|
||||||
|
bool GetFilePath(AZ::IO::FixedMaxPath& filePath) const;
|
||||||
|
|
||||||
|
private:
|
||||||
|
|
||||||
|
FileHandleType m_file;
|
||||||
|
AZ::IO::FileIOBase* m_fileIoBase{};
|
||||||
|
};
|
||||||
|
}
|
||||||
@ -0,0 +1,72 @@
|
|||||||
|
/*
|
||||||
|
* Copyright (c) Contributors to the Open 3D Engine Project.
|
||||||
|
* For complete copyright and license terms please see the LICENSE at the root of this distribution.
|
||||||
|
*
|
||||||
|
* SPDX-License-Identifier: Apache-2.0 OR MIT
|
||||||
|
*
|
||||||
|
*/
|
||||||
|
#include <AzCore/IO/FileReader.h>
|
||||||
|
#include <FileIOBaseTestTypes.h>
|
||||||
|
#include <AzCore/UnitTest/TestTypes.h>
|
||||||
|
|
||||||
|
namespace UnitTest
|
||||||
|
{
|
||||||
|
template <typename FileIOType>
|
||||||
|
class FileReaderTestFixture
|
||||||
|
: public ScopedAllocatorSetupFixture
|
||||||
|
{
|
||||||
|
public:
|
||||||
|
void SetUp() override
|
||||||
|
{
|
||||||
|
if constexpr (AZStd::is_same_v<FileIOType, TestFileIOBase>)
|
||||||
|
{
|
||||||
|
m_fileIo = AZStd::make_unique<TestFileIOBase>();
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
void TearDown() override
|
||||||
|
{
|
||||||
|
m_fileIo.reset();
|
||||||
|
}
|
||||||
|
|
||||||
|
protected:
|
||||||
|
AZStd::unique_ptr<AZ::IO::FileIOBase> m_fileIo{};
|
||||||
|
};
|
||||||
|
|
||||||
|
using FileIOTypes = ::testing::Types<void, TestFileIOBase>;
|
||||||
|
|
||||||
|
TYPED_TEST_CASE(FileReaderTestFixture, FileIOTypes);
|
||||||
|
|
||||||
|
TYPED_TEST(FileReaderTestFixture, ConstructorWithFilePath_OpensFileSuccessfully)
|
||||||
|
{
|
||||||
|
AZ::IO::FileReader fileReader(this->m_fileIo.get(), AZ::IO::SystemFile::GetNullFilename());
|
||||||
|
EXPECT_TRUE(fileReader.IsOpen());
|
||||||
|
}
|
||||||
|
|
||||||
|
TYPED_TEST(FileReaderTestFixture, Open_OpensFileSucessfully)
|
||||||
|
{
|
||||||
|
AZ::IO::FileReader fileReader;
|
||||||
|
fileReader.Open(this->m_fileIo.get(), AZ::IO::SystemFile::GetNullFilename());
|
||||||
|
EXPECT_TRUE(fileReader.IsOpen());
|
||||||
|
}
|
||||||
|
|
||||||
|
TYPED_TEST(FileReaderTestFixture, Eof_OnNULDeviceFile_Succeeds)
|
||||||
|
{
|
||||||
|
AZ::IO::FileReader fileReader(this->m_fileIo.get(), AZ::IO::SystemFile::GetNullFilename());
|
||||||
|
EXPECT_TRUE(fileReader.Eof());
|
||||||
|
}
|
||||||
|
|
||||||
|
TYPED_TEST(FileReaderTestFixture, GetFilePath_ReturnsNULDeviceFilename_Succeeds)
|
||||||
|
{
|
||||||
|
AZ::IO::FileReader fileReader(this->m_fileIo.get(), AZ::IO::SystemFile::GetNullFilename());
|
||||||
|
AZ::IO::FixedMaxPath filePath;
|
||||||
|
EXPECT_TRUE(fileReader.GetFilePath(filePath));
|
||||||
|
AZ::IO::FixedMaxPath nulFilename{ AZ::IO::SystemFile::GetNullFilename() };
|
||||||
|
if (this->m_fileIo)
|
||||||
|
{
|
||||||
|
EXPECT_TRUE(this->m_fileIo->ResolvePath(nulFilename, nulFilename));
|
||||||
|
}
|
||||||
|
EXPECT_EQ(nulFilename, filePath);
|
||||||
|
}
|
||||||
|
|
||||||
|
} // namespace UnitTest
|
||||||
@ -0,0 +1,39 @@
|
|||||||
|
/*
|
||||||
|
* Copyright (c) Contributors to the Open 3D Engine Project.
|
||||||
|
* For complete copyright and license terms please see the LICENSE at the root of this distribution.
|
||||||
|
*
|
||||||
|
* SPDX-License-Identifier: Apache-2.0 OR MIT
|
||||||
|
*
|
||||||
|
*/
|
||||||
|
|
||||||
|
#pragma once
|
||||||
|
|
||||||
|
#include <AzCore/Interface/Interface.h>
|
||||||
|
#include <AzCore/Serialization/SerializeContext.h>
|
||||||
|
|
||||||
|
namespace AzToolsFramework
|
||||||
|
{
|
||||||
|
//! FocusModeInterface
|
||||||
|
//! Interface to handle the Editor Focus Mode.
|
||||||
|
class FocusModeInterface
|
||||||
|
{
|
||||||
|
public:
|
||||||
|
AZ_RTTI(FocusModeInterface, "{437243B0-F86B-422F-B7B8-4A21CC000702}");
|
||||||
|
|
||||||
|
//! Sets the root entity the Editor should focus on.
|
||||||
|
//! The Editor will only allow the user to select entities that are descendants of the EntityId provided.
|
||||||
|
//! @param entityId The entityId that will become the new focus root.
|
||||||
|
virtual void SetFocusRoot(AZ::EntityId entityId) = 0;
|
||||||
|
|
||||||
|
//! Clears the Editor focus, allowing the user to select the whole level again.
|
||||||
|
virtual void ClearFocusRoot() = 0;
|
||||||
|
|
||||||
|
//! Returns the entity id of the root of the current Editor focus.
|
||||||
|
//! @return The entity id of the root of the Editor focus, or an invalid entity id if no focus is set.
|
||||||
|
virtual AZ::EntityId GetFocusRoot() = 0;
|
||||||
|
|
||||||
|
//! Returns whether the entity id provided is part of the focused sub-tree.
|
||||||
|
virtual bool IsInFocusSubTree(AZ::EntityId entityId) = 0;
|
||||||
|
};
|
||||||
|
|
||||||
|
} // namespace AzToolsFramework
|
||||||
@ -0,0 +1,92 @@
|
|||||||
|
/*
|
||||||
|
* Copyright (c) Contributors to the Open 3D Engine Project.
|
||||||
|
* For complete copyright and license terms please see the LICENSE at the root of this distribution.
|
||||||
|
*
|
||||||
|
* SPDX-License-Identifier: Apache-2.0 OR MIT
|
||||||
|
*
|
||||||
|
*/
|
||||||
|
|
||||||
|
#include <AzCore/Component/TransformBus.h>
|
||||||
|
|
||||||
|
#include <AzToolsFramework/API/ViewportEditorModeTrackerInterface.h>
|
||||||
|
#include <AzToolsFramework/FocusMode/FocusModeSystemComponent.h>
|
||||||
|
|
||||||
|
namespace AzToolsFramework
|
||||||
|
{
|
||||||
|
bool IsInFocusSubTree(AZ::EntityId entityId, AZ::EntityId focusRootId)
|
||||||
|
{
|
||||||
|
if (entityId == AZ::EntityId())
|
||||||
|
{
|
||||||
|
return false;
|
||||||
|
}
|
||||||
|
|
||||||
|
if (entityId == focusRootId)
|
||||||
|
{
|
||||||
|
return true;
|
||||||
|
}
|
||||||
|
|
||||||
|
AZ::EntityId parentId;
|
||||||
|
AZ::TransformBus::EventResult(parentId, entityId, &AZ::TransformInterface::GetParentId);
|
||||||
|
|
||||||
|
return IsInFocusSubTree(parentId, focusRootId);
|
||||||
|
}
|
||||||
|
|
||||||
|
void FocusModeSystemComponent::Init()
|
||||||
|
{
|
||||||
|
}
|
||||||
|
|
||||||
|
void FocusModeSystemComponent::Activate()
|
||||||
|
{
|
||||||
|
AZ::Interface<FocusModeInterface>::Register(this);
|
||||||
|
}
|
||||||
|
|
||||||
|
void FocusModeSystemComponent::Deactivate()
|
||||||
|
{
|
||||||
|
AZ::Interface<FocusModeInterface>::Unregister(this);
|
||||||
|
}
|
||||||
|
|
||||||
|
void FocusModeSystemComponent::Reflect([[maybe_unused]] AZ::ReflectContext* context)
|
||||||
|
{
|
||||||
|
}
|
||||||
|
|
||||||
|
void FocusModeSystemComponent::GetProvidedServices(AZ::ComponentDescriptor::DependencyArrayType& provided)
|
||||||
|
{
|
||||||
|
provided.push_back(AZ_CRC_CE("EditorFocusMode"));
|
||||||
|
}
|
||||||
|
|
||||||
|
void FocusModeSystemComponent::GetRequiredServices([[maybe_unused]] AZ::ComponentDescriptor::DependencyArrayType& required)
|
||||||
|
{
|
||||||
|
}
|
||||||
|
|
||||||
|
void FocusModeSystemComponent::GetIncompatibleServices([[maybe_unused]] AZ::ComponentDescriptor::DependencyArrayType& incompatible)
|
||||||
|
{
|
||||||
|
}
|
||||||
|
|
||||||
|
void FocusModeSystemComponent::SetFocusRoot(AZ::EntityId entityId)
|
||||||
|
{
|
||||||
|
m_focusRoot = entityId;
|
||||||
|
|
||||||
|
// TODO - If m_focusRoot != AZ::EntityId(), activate focus mode via ViewportEditorModeTrackerInterface; else, deactivate focus mode
|
||||||
|
}
|
||||||
|
|
||||||
|
void FocusModeSystemComponent::ClearFocusRoot()
|
||||||
|
{
|
||||||
|
SetFocusRoot(AZ::EntityId());
|
||||||
|
}
|
||||||
|
|
||||||
|
AZ::EntityId FocusModeSystemComponent::GetFocusRoot()
|
||||||
|
{
|
||||||
|
return m_focusRoot;
|
||||||
|
}
|
||||||
|
|
||||||
|
bool FocusModeSystemComponent::IsInFocusSubTree(AZ::EntityId entityId)
|
||||||
|
{
|
||||||
|
if (m_focusRoot == AZ::EntityId())
|
||||||
|
{
|
||||||
|
return true;
|
||||||
|
}
|
||||||
|
|
||||||
|
return AzToolsFramework::IsInFocusSubTree(entityId, m_focusRoot);
|
||||||
|
}
|
||||||
|
|
||||||
|
} // namespace AzToolsFramework
|
||||||
@ -0,0 +1,51 @@
|
|||||||
|
/*
|
||||||
|
* Copyright (c) Contributors to the Open 3D Engine Project.
|
||||||
|
* For complete copyright and license terms please see the LICENSE at the root of this distribution.
|
||||||
|
*
|
||||||
|
* SPDX-License-Identifier: Apache-2.0 OR MIT
|
||||||
|
*
|
||||||
|
*/
|
||||||
|
|
||||||
|
#pragma once
|
||||||
|
|
||||||
|
#include <AzCore/Component/Component.h>
|
||||||
|
#include <AzCore/Memory/SystemAllocator.h>
|
||||||
|
|
||||||
|
#include <AzToolsFramework/FocusMode/FocusModeInterface.h>
|
||||||
|
|
||||||
|
namespace AzToolsFramework
|
||||||
|
{
|
||||||
|
bool IsInFocusSubTree(AZ::EntityId entityId, AZ::EntityId focusRootId);
|
||||||
|
|
||||||
|
//! System Component to handle the Editor Focus Mode system
|
||||||
|
class FocusModeSystemComponent final
|
||||||
|
: public AZ::Component
|
||||||
|
, private FocusModeInterface
|
||||||
|
{
|
||||||
|
public:
|
||||||
|
AZ_COMPONENT(FocusModeSystemComponent, "{6CE522FE-2057-4794-BD05-61E04BD8EA30}");
|
||||||
|
|
||||||
|
FocusModeSystemComponent() = default;
|
||||||
|
virtual ~FocusModeSystemComponent() = default;
|
||||||
|
|
||||||
|
// AZ::Component overrides ...
|
||||||
|
void Init() override;
|
||||||
|
void Activate() override;
|
||||||
|
void Deactivate() override;
|
||||||
|
|
||||||
|
static void Reflect(AZ::ReflectContext* context);
|
||||||
|
static void GetProvidedServices(AZ::ComponentDescriptor::DependencyArrayType& provided);
|
||||||
|
static void GetRequiredServices(AZ::ComponentDescriptor::DependencyArrayType& required);
|
||||||
|
static void GetIncompatibleServices(AZ::ComponentDescriptor::DependencyArrayType& incompatible);
|
||||||
|
|
||||||
|
// FocusModeInterface overrides ...
|
||||||
|
void SetFocusRoot(AZ::EntityId entityId) override;
|
||||||
|
void ClearFocusRoot() override;
|
||||||
|
AZ::EntityId GetFocusRoot() override;
|
||||||
|
bool IsInFocusSubTree(AZ::EntityId entityId) override;
|
||||||
|
|
||||||
|
private:
|
||||||
|
AZ::EntityId m_focusRoot;
|
||||||
|
};
|
||||||
|
|
||||||
|
} // namespace AzToolsFramework
|
||||||
@ -0,0 +1,102 @@
|
|||||||
|
/*
|
||||||
|
* Copyright (c) Contributors to the Open 3D Engine Project.
|
||||||
|
* For complete copyright and license terms please see the LICENSE at the root of this distribution.
|
||||||
|
*
|
||||||
|
* SPDX-License-Identifier: Apache-2.0 OR MIT
|
||||||
|
*
|
||||||
|
*/
|
||||||
|
|
||||||
|
#include <AzToolsFramework/Prefab/PrefabFocusHandler.h>
|
||||||
|
|
||||||
|
#include <AzToolsFramework/Entity/PrefabEditorEntityOwnershipInterface.h>
|
||||||
|
#include <AzToolsFramework/Prefab/Instance/Instance.h>
|
||||||
|
#include <AzToolsFramework/Prefab/Instance/InstanceEntityMapperInterface.h>
|
||||||
|
|
||||||
|
namespace AzToolsFramework::Prefab
|
||||||
|
{
|
||||||
|
PrefabFocusHandler::PrefabFocusHandler()
|
||||||
|
{
|
||||||
|
m_instanceEntityMapperInterface = AZ::Interface<InstanceEntityMapperInterface>::Get();
|
||||||
|
AZ_Assert(
|
||||||
|
m_instanceEntityMapperInterface,
|
||||||
|
"Prefab - PrefabFocusHandler - "
|
||||||
|
"Instance Entity Mapper Interface could not be found. "
|
||||||
|
"Check that it is being correctly initialized.");
|
||||||
|
|
||||||
|
AZ::Interface<PrefabFocusInterface>::Register(this);
|
||||||
|
}
|
||||||
|
|
||||||
|
PrefabFocusHandler::~PrefabFocusHandler()
|
||||||
|
{
|
||||||
|
AZ::Interface<PrefabFocusInterface>::Unregister(this);
|
||||||
|
}
|
||||||
|
|
||||||
|
PrefabFocusOperationResult PrefabFocusHandler::FocusOnOwningPrefab(AZ::EntityId entityId)
|
||||||
|
{
|
||||||
|
InstanceOptionalReference focusedInstance;
|
||||||
|
|
||||||
|
if (entityId == AZ::EntityId())
|
||||||
|
{
|
||||||
|
PrefabEditorEntityOwnershipInterface* prefabEditorEntityOwnershipInterface =
|
||||||
|
AZ::Interface<PrefabEditorEntityOwnershipInterface>::Get();
|
||||||
|
|
||||||
|
if(!prefabEditorEntityOwnershipInterface)
|
||||||
|
{
|
||||||
|
return AZ::Failure(AZStd::string("Could not focus on root prefab instance - internal error "
|
||||||
|
"(PrefabEditorEntityOwnershipInterface unavailable)."));
|
||||||
|
}
|
||||||
|
|
||||||
|
focusedInstance = prefabEditorEntityOwnershipInterface->GetRootPrefabInstance();
|
||||||
|
}
|
||||||
|
else
|
||||||
|
{
|
||||||
|
focusedInstance = m_instanceEntityMapperInterface->FindOwningInstance(entityId);
|
||||||
|
}
|
||||||
|
|
||||||
|
if (!focusedInstance.has_value())
|
||||||
|
{
|
||||||
|
return AZ::Failure(AZStd::string(
|
||||||
|
"Prefab Focus Handler: Couldn't find owning instance of entityId provided."));
|
||||||
|
}
|
||||||
|
|
||||||
|
m_focusedInstance = focusedInstance;
|
||||||
|
m_focusedTemplateId = focusedInstance->get().GetTemplateId();
|
||||||
|
|
||||||
|
FocusModeInterface* focusModeInterface = AZ::Interface<FocusModeInterface>::Get();
|
||||||
|
if (focusModeInterface)
|
||||||
|
{
|
||||||
|
focusModeInterface->SetFocusRoot(focusedInstance->get().GetContainerEntityId());
|
||||||
|
}
|
||||||
|
|
||||||
|
return AZ::Success();
|
||||||
|
}
|
||||||
|
|
||||||
|
TemplateId PrefabFocusHandler::GetFocusedPrefabTemplateId()
|
||||||
|
{
|
||||||
|
return m_focusedTemplateId;
|
||||||
|
}
|
||||||
|
|
||||||
|
InstanceOptionalReference PrefabFocusHandler::GetFocusedPrefabInstance()
|
||||||
|
{
|
||||||
|
return m_focusedInstance;
|
||||||
|
}
|
||||||
|
|
||||||
|
bool PrefabFocusHandler::IsOwningPrefabBeingFocused(AZ::EntityId entityId)
|
||||||
|
{
|
||||||
|
if (!m_focusedInstance.has_value())
|
||||||
|
{
|
||||||
|
// PrefabFocusHandler has not been initialized yet.
|
||||||
|
return false;
|
||||||
|
}
|
||||||
|
|
||||||
|
if (entityId == AZ::EntityId())
|
||||||
|
{
|
||||||
|
return false;
|
||||||
|
}
|
||||||
|
|
||||||
|
InstanceOptionalReference instance = m_instanceEntityMapperInterface->FindOwningInstance(entityId);
|
||||||
|
|
||||||
|
return instance.has_value() && (&instance->get() == &m_focusedInstance->get());
|
||||||
|
}
|
||||||
|
|
||||||
|
} // namespace AzToolsFramework::Prefab
|
||||||
@ -0,0 +1,44 @@
|
|||||||
|
/*
|
||||||
|
* Copyright (c) Contributors to the Open 3D Engine Project.
|
||||||
|
* For complete copyright and license terms please see the LICENSE at the root of this distribution.
|
||||||
|
*
|
||||||
|
* SPDX-License-Identifier: Apache-2.0 OR MIT
|
||||||
|
*
|
||||||
|
*/
|
||||||
|
|
||||||
|
#pragma once
|
||||||
|
|
||||||
|
#include <AzCore/Memory/SystemAllocator.h>
|
||||||
|
|
||||||
|
#include <AzToolsFramework/FocusMode/FocusModeInterface.h>
|
||||||
|
#include <AzToolsFramework/Prefab/PrefabFocusInterface.h>
|
||||||
|
#include <AzToolsFramework/Prefab/Template/Template.h>
|
||||||
|
|
||||||
|
namespace AzToolsFramework::Prefab
|
||||||
|
{
|
||||||
|
class InstanceEntityMapperInterface;
|
||||||
|
|
||||||
|
//! Handles Prefab Focus mode, determining which prefab file entity changes will target.
|
||||||
|
class PrefabFocusHandler final
|
||||||
|
: private PrefabFocusInterface
|
||||||
|
{
|
||||||
|
public:
|
||||||
|
AZ_CLASS_ALLOCATOR(PrefabFocusHandler, AZ::SystemAllocator, 0);
|
||||||
|
|
||||||
|
PrefabFocusHandler();
|
||||||
|
~PrefabFocusHandler();
|
||||||
|
|
||||||
|
// PrefabFocusInterface override ...
|
||||||
|
PrefabFocusOperationResult FocusOnOwningPrefab(AZ::EntityId entityId) override;
|
||||||
|
TemplateId GetFocusedPrefabTemplateId() override;
|
||||||
|
InstanceOptionalReference GetFocusedPrefabInstance() override;
|
||||||
|
bool IsOwningPrefabBeingFocused(AZ::EntityId entityId) override;
|
||||||
|
|
||||||
|
private:
|
||||||
|
InstanceOptionalReference m_focusedInstance;
|
||||||
|
TemplateId m_focusedTemplateId;
|
||||||
|
|
||||||
|
InstanceEntityMapperInterface* m_instanceEntityMapperInterface;
|
||||||
|
};
|
||||||
|
|
||||||
|
} // namespace AzToolsFramework::Prefab
|
||||||
@ -0,0 +1,43 @@
|
|||||||
|
/*
|
||||||
|
* Copyright (c) Contributors to the Open 3D Engine Project.
|
||||||
|
* For complete copyright and license terms please see the LICENSE at the root of this distribution.
|
||||||
|
*
|
||||||
|
* SPDX-License-Identifier: Apache-2.0 OR MIT
|
||||||
|
*
|
||||||
|
*/
|
||||||
|
|
||||||
|
#pragma once
|
||||||
|
|
||||||
|
#include <AzCore/Interface/Interface.h>
|
||||||
|
#include <AzCore/Serialization/SerializeContext.h>
|
||||||
|
|
||||||
|
#include <AzToolsFramework/Prefab/Instance/Instance.h>
|
||||||
|
#include <AzToolsFramework/Prefab/Template/Template.h>
|
||||||
|
|
||||||
|
namespace AzToolsFramework::Prefab
|
||||||
|
{
|
||||||
|
using PrefabFocusOperationResult = AZ::Outcome<void, AZStd::string>;
|
||||||
|
|
||||||
|
//! Interface to handle operations related to the Prefab Focus system.
|
||||||
|
class PrefabFocusInterface
|
||||||
|
{
|
||||||
|
public:
|
||||||
|
AZ_RTTI(PrefabFocusInterface, "{F3CFA37B-5FD8-436A-9C30-60EB54E350E1}");
|
||||||
|
|
||||||
|
//! Set the focused prefab instance to the owning instance of the entityId provided.
|
||||||
|
//! @param entityId The entityId of the entity whose owning instance we want the prefab system to focus on.
|
||||||
|
virtual PrefabFocusOperationResult FocusOnOwningPrefab(AZ::EntityId entityId) = 0;
|
||||||
|
|
||||||
|
//! Returns the template id of the instance the prefab system is focusing on.
|
||||||
|
virtual TemplateId GetFocusedPrefabTemplateId() = 0;
|
||||||
|
|
||||||
|
//! Returns a reference to the instance the prefab system is focusing on.
|
||||||
|
virtual InstanceOptionalReference GetFocusedPrefabInstance() = 0;
|
||||||
|
|
||||||
|
//! Returns whether the entity belongs to the instance that is being focused on, or one of its descendants.
|
||||||
|
//! @param entityId The entityId of the queried entity.
|
||||||
|
//! @return true if the entity belongs to the focused instance or one of its descendants, false otherwise.
|
||||||
|
virtual bool IsOwningPrefabBeingFocused(AZ::EntityId entityId) = 0;
|
||||||
|
};
|
||||||
|
|
||||||
|
} // namespace AzToolsFramework::Prefab
|
||||||
@ -1,43 +0,0 @@
|
|||||||
/*
|
|
||||||
* Copyright (c) Contributors to the Open 3D Engine Project.
|
|
||||||
* For complete copyright and license terms please see the LICENSE at the root of this distribution.
|
|
||||||
*
|
|
||||||
* SPDX-License-Identifier: Apache-2.0 OR MIT
|
|
||||||
*
|
|
||||||
*/
|
|
||||||
|
|
||||||
#pragma once
|
|
||||||
|
|
||||||
#include <AzCore/Interface/Interface.h>
|
|
||||||
#include <AzCore/Serialization/SerializeContext.h>
|
|
||||||
|
|
||||||
namespace AzToolsFramework
|
|
||||||
{
|
|
||||||
namespace Prefab
|
|
||||||
{
|
|
||||||
/*!
|
|
||||||
* PrefabEditInterface
|
|
||||||
* Interface to expose the API to Edit Prefabs in the Editor.
|
|
||||||
*/
|
|
||||||
class PrefabEditInterface
|
|
||||||
{
|
|
||||||
public:
|
|
||||||
AZ_RTTI(PrefabEditInterface, "{DABB1D43-3760-420E-9F1E-5104F0AFF167}");
|
|
||||||
|
|
||||||
/**
|
|
||||||
* Sets the prefab for the instance owning the entity provided as the prefab being edited.
|
|
||||||
* @param entityId The entity whose owning prefab should be edited.
|
|
||||||
*/
|
|
||||||
virtual void EditOwningPrefab(AZ::EntityId entityId) = 0;
|
|
||||||
|
|
||||||
/**
|
|
||||||
* Queries the Edit Manager to know if the provided entity is part of the prefab currently being edited.
|
|
||||||
* @param entityId The entity whose prefab editing state we want to query.
|
|
||||||
* @return True if the prefab owning this entity is being edited, false otherwise.
|
|
||||||
*/
|
|
||||||
virtual bool IsOwningPrefabBeingEdited(AZ::EntityId entityId) = 0;
|
|
||||||
};
|
|
||||||
|
|
||||||
} // namespace Prefab
|
|
||||||
} // namespace AzToolsFramework
|
|
||||||
|
|
||||||
@ -1,46 +0,0 @@
|
|||||||
/*
|
|
||||||
* Copyright (c) Contributors to the Open 3D Engine Project.
|
|
||||||
* For complete copyright and license terms please see the LICENSE at the root of this distribution.
|
|
||||||
*
|
|
||||||
* SPDX-License-Identifier: Apache-2.0 OR MIT
|
|
||||||
*
|
|
||||||
*/
|
|
||||||
|
|
||||||
#include <AzToolsFramework/UI/Prefab/PrefabEditManager.h>
|
|
||||||
|
|
||||||
#include <AzCore/Serialization/SerializeContext.h>
|
|
||||||
|
|
||||||
namespace AzToolsFramework
|
|
||||||
{
|
|
||||||
namespace Prefab
|
|
||||||
{
|
|
||||||
PrefabEditManager::PrefabEditManager()
|
|
||||||
{
|
|
||||||
m_prefabPublicInterface = AZ::Interface<PrefabPublicInterface>::Get();
|
|
||||||
|
|
||||||
if (m_prefabPublicInterface == nullptr)
|
|
||||||
{
|
|
||||||
AZ_Assert(false, "Prefab - could not get PrefabPublicInterface on PrefabEditManager construction.");
|
|
||||||
return;
|
|
||||||
}
|
|
||||||
|
|
||||||
AZ::Interface<PrefabEditInterface>::Register(this);
|
|
||||||
}
|
|
||||||
|
|
||||||
PrefabEditManager::~PrefabEditManager()
|
|
||||||
{
|
|
||||||
AZ::Interface<PrefabEditInterface>::Unregister(this);
|
|
||||||
}
|
|
||||||
|
|
||||||
void PrefabEditManager::EditOwningPrefab(AZ::EntityId entityId)
|
|
||||||
{
|
|
||||||
m_instanceBeingEdited = m_prefabPublicInterface->GetInstanceContainerEntityId(entityId);
|
|
||||||
}
|
|
||||||
|
|
||||||
bool PrefabEditManager::IsOwningPrefabBeingEdited(AZ::EntityId entityId)
|
|
||||||
{
|
|
||||||
AZ::EntityId containerEntity = m_prefabPublicInterface->GetInstanceContainerEntityId(entityId);
|
|
||||||
return m_instanceBeingEdited == containerEntity;
|
|
||||||
}
|
|
||||||
}
|
|
||||||
}
|
|
||||||
@ -1,40 +0,0 @@
|
|||||||
/*
|
|
||||||
* Copyright (c) Contributors to the Open 3D Engine Project.
|
|
||||||
* For complete copyright and license terms please see the LICENSE at the root of this distribution.
|
|
||||||
*
|
|
||||||
* SPDX-License-Identifier: Apache-2.0 OR MIT
|
|
||||||
*
|
|
||||||
*/
|
|
||||||
|
|
||||||
#pragma once
|
|
||||||
|
|
||||||
#include <AzCore/Component/EntityId.h>
|
|
||||||
#include <AzCore/Memory/SystemAllocator.h>
|
|
||||||
|
|
||||||
#include <AzToolsFramework/Prefab/PrefabPublicInterface.h>
|
|
||||||
#include <AzToolsFramework/UI/Prefab/PrefabEditInterface.h>
|
|
||||||
|
|
||||||
namespace AzToolsFramework
|
|
||||||
{
|
|
||||||
namespace Prefab
|
|
||||||
{
|
|
||||||
class PrefabEditManager final
|
|
||||||
: private PrefabEditInterface
|
|
||||||
{
|
|
||||||
public:
|
|
||||||
AZ_CLASS_ALLOCATOR(PrefabEditManager, AZ::SystemAllocator, 0);
|
|
||||||
|
|
||||||
PrefabEditManager();
|
|
||||||
~PrefabEditManager();
|
|
||||||
|
|
||||||
private:
|
|
||||||
// PrefabEditInterface...
|
|
||||||
void EditOwningPrefab(AZ::EntityId entityId) override;
|
|
||||||
bool IsOwningPrefabBeingEdited(AZ::EntityId entityId) override;
|
|
||||||
|
|
||||||
AZ::EntityId m_instanceBeingEdited;
|
|
||||||
|
|
||||||
PrefabPublicInterface* m_prefabPublicInterface;
|
|
||||||
};
|
|
||||||
}
|
|
||||||
}
|
|
||||||
Some files were not shown because too many files have changed in this diff Show More
Loading…
Reference in New Issue