Mike Balfour
7123ed18be
* Naive GetValues() implementation. Added the method itself, and the benchmarks which show that even the naive version is currently 10-50% faster than calling GetValue() for multiple values. Signed-off-by: Mike Balfour <82224783+mbalfour-amzn@users.noreply.github.com> * Added comments documenting why the const_cast is there. Signed-off-by: Mike Balfour <82224783+mbalfour-amzn@users.noreply.github.com> * Fixed link errors by creating new Shared.Tests lib. Signed-off-by: Mike Balfour <82224783+mbalfour-amzn@users.noreply.github.com> * Addressed PR feedback. Signed-off-by: Mike Balfour <82224783+mbalfour-amzn@users.noreply.github.com> * Fixed incorrect comparison. Signed-off-by: Mike Balfour <82224783+mbalfour-amzn@users.noreply.github.com>
94 lines
3.9 KiB
C++
94 lines
3.9 KiB
C++
/*
|
|
* 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/EBus/EBus.h>
|
|
#include <AzCore/Component/EntityId.h>
|
|
#include <AzCore/Math/Vector3.h>
|
|
|
|
#include <AtomCore/std/containers/array_view.h>
|
|
|
|
namespace GradientSignal
|
|
{
|
|
struct GradientSampleParams final
|
|
{
|
|
AZ_CLASS_ALLOCATOR(GradientSampleParams, AZ::SystemAllocator, 0);
|
|
AZ_TYPE_INFO(GradientSampleParams, "{DC4B9269-CB3C-4071-989D-C885FB9946A5}");
|
|
|
|
GradientSampleParams() {}
|
|
GradientSampleParams(const AZ::Vector3& position) : m_position(position) {}
|
|
AZ::Vector3 m_position = AZ::Vector3(0.0f, 0.0f, 0.0f);
|
|
};
|
|
|
|
/**
|
|
* Handles gradient sampling requests based on up to 3 data points such as X,Y,Z
|
|
*/
|
|
class GradientRequests
|
|
: public AZ::EBusTraits
|
|
{
|
|
public:
|
|
////////////////////////////////////////////////////////////////////////
|
|
// EBusTraits
|
|
static const AZ::EBusHandlerPolicy HandlerPolicy = AZ::EBusHandlerPolicy::Single;
|
|
static const AZ::EBusAddressPolicy AddressPolicy = AZ::EBusAddressPolicy::ById;
|
|
using BusIdType = AZ::EntityId;
|
|
using MutexType = AZStd::recursive_mutex;
|
|
|
|
////////////////////////////////////////////////////////////////////////
|
|
|
|
virtual ~GradientRequests() = default;
|
|
|
|
/**
|
|
* Given a certain position, generate a value. Implementations of this need to be thread-safe without using locks,
|
|
* as it can get called from both the Main thread and the Vegetation thread simultaneously, and has the potential to cause
|
|
* lock inversion deadlocks.
|
|
* @return a value generated using the position
|
|
*/
|
|
virtual float GetValue(const GradientSampleParams& sampleParams) const = 0;
|
|
|
|
/**
|
|
* Given a list of positions, generate values. Implementations of this need to be thread-safe without using locks,
|
|
* as it can get called from multiple threads simultaneously and has the potential to cause lock inversion deadlocks.
|
|
* \param positions The input list of positions to query.
|
|
* \param outValues The output list of values. This list is expected to be the same size as the positions list.
|
|
*/
|
|
virtual void GetValues(AZStd::array_view<AZ::Vector3> positions, AZStd::array_view<float> outValues) const
|
|
{
|
|
// Reference implementation of GetValues for any gradients that don't have their own optimized implementations.
|
|
// This is 10%-60% faster than calling GetValue via EBus many times due to the per-call EBus overhead.
|
|
|
|
AZ_Assert(
|
|
positions.size() == outValues.size(), "input and output lists are different sizes (%zu vs %zu).",
|
|
positions.size(), outValues.size());
|
|
|
|
if (positions.size() == outValues.size())
|
|
{
|
|
GradientSampleParams sampleParams;
|
|
for (size_t index = 0; index < positions.size(); index++)
|
|
{
|
|
sampleParams.m_position = positions[index];
|
|
|
|
// The const_cast is necessary for now since array_view currently only supports const entries.
|
|
// If/when array_view is fixed to support non-const, or AZStd::span gets created, the const_cast can get removed.
|
|
auto& outValue = const_cast<float&>(outValues[index]);
|
|
outValue = GetValue(sampleParams);
|
|
}
|
|
}
|
|
}
|
|
|
|
/**
|
|
* Call to check the hierarchy to see if a given entityId exists in the gradient signal chain
|
|
*/
|
|
virtual bool IsEntityInHierarchy([[maybe_unused]] const AZ::EntityId& entityId) const { return false; }
|
|
};
|
|
|
|
using GradientRequestBus = AZ::EBus<GradientRequests>;
|
|
|
|
} // namespace GradientSignal
|
|
|