Only allow streaming image assets with supported pixel formats to be selected for an image gradient
Signed-off-by: Chris Galvan <chgalvan@amazon.com>monroegm-disable-blank-issue-2
Chris Galvan
4 years ago
parent
5f334e30f9
commit
9cd84b6b2d
@ -0,0 +1,150 @@
|
|||||||
|
/*
|
||||||
|
* 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 <Atom/RPI.Public/RPIUtils.h>
|
||||||
|
|
||||||
|
#include <AzToolsFramework/AssetBrowser/AssetBrowserEntry.h>
|
||||||
|
#include <AzToolsFramework/UI/PropertyEditor/Model/AssetCompleterModel.h>
|
||||||
|
#include <AzToolsFramework/UI/PropertyEditor/PropertyEditorAPI.h>
|
||||||
|
|
||||||
|
#include <Editor/EditorStreamingImageAssetCtrl.h>
|
||||||
|
|
||||||
|
namespace GradientSignal
|
||||||
|
{
|
||||||
|
namespace Internal
|
||||||
|
{
|
||||||
|
bool IsImageDataPixelAPISupportedForAsset(const AZ::Data::AssetId& assetId)
|
||||||
|
{
|
||||||
|
auto streamingImageAsset = AZ::Data::AssetManager::Instance().GetAsset<AZ::RPI::StreamingImageAsset>(assetId, AZ::Data::AssetLoadBehavior::PreLoad);
|
||||||
|
streamingImageAsset.BlockUntilLoadComplete();
|
||||||
|
|
||||||
|
// Verify if the streaming image asset has a pixel format that is supported
|
||||||
|
// for the image data pixel retrieval API
|
||||||
|
AZ::RHI::Format format = streamingImageAsset->GetImageDescriptor().m_format;
|
||||||
|
return AZ::RPI::IsImageDataPixelAPISupported(format);
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
SupportedImageAssetPickerDialog::SupportedImageAssetPickerDialog(AssetSelectionModel& selection, QWidget* parent)
|
||||||
|
: AzToolsFramework::AssetBrowser::AssetPickerDialog(selection, parent)
|
||||||
|
{
|
||||||
|
}
|
||||||
|
|
||||||
|
bool SupportedImageAssetPickerDialog::EvaluateSelection() const
|
||||||
|
{
|
||||||
|
bool isValid = AzToolsFramework::AssetBrowser::AssetPickerDialog::EvaluateSelection();
|
||||||
|
|
||||||
|
// If we have a valid selection (a streaming image asset), we need to also verify
|
||||||
|
// that its pixel format is supported by the image data retrieval API
|
||||||
|
if (isValid)
|
||||||
|
{
|
||||||
|
const auto productEntry = azrtti_cast<const ProductAssetBrowserEntry*>(m_selection.GetResult());
|
||||||
|
isValid = Internal::IsImageDataPixelAPISupportedForAsset(productEntry->GetAssetId());
|
||||||
|
}
|
||||||
|
|
||||||
|
return isValid;
|
||||||
|
}
|
||||||
|
|
||||||
|
StreamingImagePropertyAssetCtrl::StreamingImagePropertyAssetCtrl(QWidget* parent)
|
||||||
|
: AzToolsFramework::PropertyAssetCtrl(parent)
|
||||||
|
{
|
||||||
|
}
|
||||||
|
|
||||||
|
void StreamingImagePropertyAssetCtrl::PickAssetSelectionFromDialog(AssetSelectionModel& selection, QWidget* parent)
|
||||||
|
{
|
||||||
|
// We need to override and use our own picker dialog so that we can
|
||||||
|
// disable the OK button if a streaming image asset with an unsupported
|
||||||
|
// format has been selected
|
||||||
|
SupportedImageAssetPickerDialog dialog(selection, parent);
|
||||||
|
dialog.exec();
|
||||||
|
}
|
||||||
|
|
||||||
|
void StreamingImagePropertyAssetCtrl::OnAutocomplete(const QModelIndex& index)
|
||||||
|
{
|
||||||
|
auto assetId = m_model->GetAssetIdFromIndex(GetSourceIndex(index));
|
||||||
|
|
||||||
|
// Only allow the autocompleter to select an asset if it has
|
||||||
|
// a supported pixel format
|
||||||
|
if (Internal::IsImageDataPixelAPISupportedForAsset(assetId))
|
||||||
|
{
|
||||||
|
SetSelectedAssetID(assetId);
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
AZ::u32 StreamingImagePropertyHandler::GetHandlerName() const
|
||||||
|
{
|
||||||
|
return AZ_CRC_CE("GradientSignalStreamingImageAsset");
|
||||||
|
}
|
||||||
|
|
||||||
|
bool StreamingImagePropertyHandler::IsDefaultHandler() const
|
||||||
|
{
|
||||||
|
// We don't this to be registered as a default handler, because we don't want
|
||||||
|
// any other AZ::RPI::StreamingImageAsset fields using this handler.
|
||||||
|
// We only want this handler to be used if it was explicitly requested by name,
|
||||||
|
// which in this case is for the image gradient asset since it needs to validate
|
||||||
|
// the format is supported by the pixel retrieval API.
|
||||||
|
return false;
|
||||||
|
}
|
||||||
|
|
||||||
|
QWidget* StreamingImagePropertyHandler::GetFirstInTabOrder(StreamingImagePropertyAssetCtrl* widget)
|
||||||
|
{
|
||||||
|
return widget->GetFirstInTabOrder();
|
||||||
|
}
|
||||||
|
|
||||||
|
QWidget* StreamingImagePropertyHandler::GetLastInTabOrder(StreamingImagePropertyAssetCtrl* widget)
|
||||||
|
{
|
||||||
|
return widget->GetLastInTabOrder();
|
||||||
|
}
|
||||||
|
|
||||||
|
void StreamingImagePropertyHandler::UpdateWidgetInternalTabbing(StreamingImagePropertyAssetCtrl* widget)
|
||||||
|
{
|
||||||
|
widget->UpdateTabOrder();
|
||||||
|
}
|
||||||
|
|
||||||
|
QWidget* StreamingImagePropertyHandler::CreateGUI(QWidget* parent)
|
||||||
|
{
|
||||||
|
// This is the same logic as the AssetPropertyHandlerDefault, only we create our own
|
||||||
|
// StreamingImagePropertyAssetCtrl instead for the GUI widget
|
||||||
|
StreamingImagePropertyAssetCtrl* newCtrl = aznew StreamingImagePropertyAssetCtrl(parent);
|
||||||
|
|
||||||
|
QObject::connect(newCtrl, &StreamingImagePropertyAssetCtrl::OnAssetIDChanged, this, [newCtrl](AZ::Data::AssetId newAssetID)
|
||||||
|
{
|
||||||
|
(void)newAssetID;
|
||||||
|
AzToolsFramework::PropertyEditorGUIMessages::Bus::Broadcast(&AzToolsFramework::PropertyEditorGUIMessages::RequestWrite, newCtrl);
|
||||||
|
AzToolsFramework::PropertyEditorGUIMessages::Bus::Broadcast(&AzToolsFramework::PropertyEditorGUIMessages::OnEditingFinished, newCtrl);
|
||||||
|
});
|
||||||
|
|
||||||
|
return newCtrl;
|
||||||
|
}
|
||||||
|
|
||||||
|
void StreamingImagePropertyHandler::ConsumeAttribute(StreamingImagePropertyAssetCtrl* GUI, AZ::u32 attrib, AzToolsFramework::PropertyAttributeReader* attrValue, const char* debugName)
|
||||||
|
{
|
||||||
|
// Let the AssetPropertyHandlerDefault handle all of the attributes
|
||||||
|
AzToolsFramework::AssetPropertyHandlerDefault::ConsumeAttributeInternal(GUI, attrib, attrValue, debugName);
|
||||||
|
}
|
||||||
|
|
||||||
|
void StreamingImagePropertyHandler::WriteGUIValuesIntoProperty(size_t index, StreamingImagePropertyAssetCtrl* GUI, property_t& instance, AzToolsFramework::InstanceDataNode* node)
|
||||||
|
{
|
||||||
|
// Let the AssetPropertyHandlerDefault handle writing the GUI value into the property
|
||||||
|
AzToolsFramework::AssetPropertyHandlerDefault::WriteGUIValuesIntoPropertyInternal(index, GUI, instance, node);
|
||||||
|
}
|
||||||
|
|
||||||
|
bool StreamingImagePropertyHandler::ReadValuesIntoGUI(size_t index, StreamingImagePropertyAssetCtrl* GUI, const property_t& instance, AzToolsFramework::InstanceDataNode* node)
|
||||||
|
{
|
||||||
|
// Let the AssetPropertyHandlerDefault handle reading values into the GUI
|
||||||
|
return AzToolsFramework::AssetPropertyHandlerDefault::ReadValuesIntoGUIInternal(index, GUI, instance, node);
|
||||||
|
}
|
||||||
|
|
||||||
|
void StreamingImagePropertyHandler::Register()
|
||||||
|
{
|
||||||
|
using namespace AzToolsFramework;
|
||||||
|
|
||||||
|
PropertyTypeRegistrationMessages::Bus::Broadcast(
|
||||||
|
&PropertyTypeRegistrationMessages::Bus::Events::RegisterPropertyType, aznew StreamingImagePropertyHandler());
|
||||||
|
}
|
||||||
|
}
|
||||||
@ -0,0 +1,75 @@
|
|||||||
|
/*
|
||||||
|
* 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
|
||||||
|
|
||||||
|
#if !defined(Q_MOC_RUN)
|
||||||
|
#include <Atom/RPI.Reflect/Image/StreamingImageAsset.h>
|
||||||
|
|
||||||
|
#include <AzToolsFramework/AssetBrowser/AssetPicker/AssetPickerDialog.h>
|
||||||
|
#include <AzToolsFramework/UI/PropertyEditor/PropertyAssetCtrl.hxx>
|
||||||
|
#endif
|
||||||
|
|
||||||
|
namespace GradientSignal
|
||||||
|
{
|
||||||
|
class SupportedImageAssetPickerDialog
|
||||||
|
: public AzToolsFramework::AssetBrowser::AssetPickerDialog
|
||||||
|
{
|
||||||
|
Q_OBJECT
|
||||||
|
public:
|
||||||
|
AZ_CLASS_ALLOCATOR(SupportedImageAssetPickerDialog, AZ::SystemAllocator, 0);
|
||||||
|
|
||||||
|
explicit SupportedImageAssetPickerDialog(AssetSelectionModel& selection, QWidget* parent = nullptr);
|
||||||
|
|
||||||
|
protected:
|
||||||
|
bool EvaluateSelection() const override;
|
||||||
|
};
|
||||||
|
|
||||||
|
class StreamingImagePropertyAssetCtrl
|
||||||
|
: public AzToolsFramework::PropertyAssetCtrl
|
||||||
|
{
|
||||||
|
Q_OBJECT
|
||||||
|
|
||||||
|
public:
|
||||||
|
AZ_CLASS_ALLOCATOR(StreamingImagePropertyAssetCtrl, AZ::SystemAllocator, 0);
|
||||||
|
|
||||||
|
StreamingImagePropertyAssetCtrl(QWidget* parent = nullptr);
|
||||||
|
|
||||||
|
void PickAssetSelectionFromDialog(AssetSelectionModel& selection, QWidget* parent) override;
|
||||||
|
|
||||||
|
public Q_SLOTS:
|
||||||
|
void OnAutocomplete(const QModelIndex& index) override;
|
||||||
|
};
|
||||||
|
|
||||||
|
//! We need a custom asset property handler for the AZ::RPI::StreamingImageAsset on our
|
||||||
|
//! Image Gradient component because only a subset of the streaming image asset pixel formats
|
||||||
|
//! are currently supported by the image data pixel retrieval API that the Image Gradient
|
||||||
|
//! relies on
|
||||||
|
class StreamingImagePropertyHandler
|
||||||
|
: QObject
|
||||||
|
, public AzToolsFramework::PropertyHandler<AZ::Data::Asset<AZ::Data::AssetData>, StreamingImagePropertyAssetCtrl>
|
||||||
|
{
|
||||||
|
Q_OBJECT
|
||||||
|
|
||||||
|
public:
|
||||||
|
AZ_CLASS_ALLOCATOR(StreamingImagePropertyHandler, AZ::SystemAllocator, 0);
|
||||||
|
|
||||||
|
AZ::u32 GetHandlerName() const override;
|
||||||
|
bool IsDefaultHandler() const override;
|
||||||
|
QWidget* GetFirstInTabOrder(StreamingImagePropertyAssetCtrl* widget) override;
|
||||||
|
QWidget* GetLastInTabOrder(StreamingImagePropertyAssetCtrl* widget) override;
|
||||||
|
void UpdateWidgetInternalTabbing(StreamingImagePropertyAssetCtrl* widget);
|
||||||
|
|
||||||
|
QWidget* CreateGUI(QWidget* parent) override;
|
||||||
|
void ConsumeAttribute(StreamingImagePropertyAssetCtrl* GUI, AZ::u32 attrib, AzToolsFramework::PropertyAttributeReader* attrValue, const char* debugName) override;
|
||||||
|
void WriteGUIValuesIntoProperty(size_t index, StreamingImagePropertyAssetCtrl* GUI, property_t& instance, AzToolsFramework::InstanceDataNode* node) override;
|
||||||
|
bool ReadValuesIntoGUI(size_t index, StreamingImagePropertyAssetCtrl* GUI, const property_t& instance, AzToolsFramework::InstanceDataNode* node) override;
|
||||||
|
|
||||||
|
static void Register();
|
||||||
|
};
|
||||||
|
}
|
||||||
Loading…
Reference in New Issue