/* * 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 #include #include #include #include #include #include #include #include #include #include namespace GradientSignal { void PerlinGradientConfig::Reflect(AZ::ReflectContext* context) { AZ::SerializeContext* serialize = azrtti_cast(context); if (serialize) { serialize->Class() ->Version(1) ->Field("randomSeed", &PerlinGradientConfig::m_randomSeed) ->Field("octave", &PerlinGradientConfig::m_octave) ->Field("amplitude", &PerlinGradientConfig::m_amplitude) ->Field("frequency", &PerlinGradientConfig::m_frequency) ; AZ::EditContext* edit = serialize->GetEditContext(); if (edit) { edit->Class( "Perlin Noise Gradient", "") ->ClassElement(AZ::Edit::ClassElements::EditorData, "") ->Attribute(AZ::Edit::Attributes::Visibility, AZ::Edit::PropertyVisibility::ShowChildrenOnly) ->Attribute(AZ::Edit::Attributes::AutoExpand, true) ->DataElement(AZ::Edit::UIHandlers::Slider, &PerlinGradientConfig::m_randomSeed, "Random Seed", "Using different seeds will cause the noise output to change") ->Attribute(AZ::Edit::Attributes::Min, 1) ->Attribute(AZ::Edit::Attributes::Max, std::numeric_limits::max()) ->Attribute(AZ::Edit::Attributes::SoftMin, 1) ->Attribute(AZ::Edit::Attributes::SoftMax, 100) ->Attribute(AZ::Edit::Attributes::Step, 10) ->DataElement(AZ::Edit::UIHandlers::Slider, &PerlinGradientConfig::m_octave, "Octaves", "Number of recursions in the pattern generation, higher octaves refine the pattern") ->Attribute(AZ::Edit::Attributes::Min, 0) ->Attribute(AZ::Edit::Attributes::Max, 16) ->Attribute(AZ::Edit::Attributes::SoftMax, 8) ->DataElement(AZ::Edit::UIHandlers::Slider, &PerlinGradientConfig::m_amplitude, "Amplitude", "Higher amplitudes widen the aperture of the highs (light) and lows (dark)") ->Attribute(AZ::Edit::Attributes::Min, 0.f) ->Attribute(AZ::Edit::Attributes::Max, std::numeric_limits::max()) ->Attribute(AZ::Edit::Attributes::SoftMax, 8.0f) ->DataElement(AZ::Edit::UIHandlers::Slider, &PerlinGradientConfig::m_frequency, "Frequency", "Rescales coordinates based on a multiplied factor") ->Attribute(AZ::Edit::Attributes::DisplayDecimals, 4) ->Attribute(AZ::Edit::Attributes::Min, 0.0001f) ->Attribute(AZ::Edit::Attributes::Max, std::numeric_limits::max()) ->Attribute(AZ::Edit::Attributes::SoftMax, 8.0f) ->Attribute(AZ::Edit::Attributes::Step, 0.25f) ->Attribute(AZ::Edit::Attributes::SliderCurveMidpoint, 0.25) // Give the frequency a non-linear scale slider with higher precision at the low end ; } } if (auto behaviorContext = azrtti_cast(context)) { behaviorContext->Class() ->Constructor() ->Attribute(AZ::Script::Attributes::Category, "Vegetation") ->Property("randomSeed", BehaviorValueProperty(&PerlinGradientConfig::m_randomSeed)) ->Property("octave", BehaviorValueProperty(&PerlinGradientConfig::m_octave)) ->Property("amplitude", BehaviorValueProperty(&PerlinGradientConfig::m_amplitude)) ->Property("frequency", BehaviorValueProperty(&PerlinGradientConfig::m_frequency)) ; } } void PerlinGradientComponent::GetProvidedServices(AZ::ComponentDescriptor::DependencyArrayType& services) { services.push_back(AZ_CRC_CE("GradientService")); } void PerlinGradientComponent::GetIncompatibleServices(AZ::ComponentDescriptor::DependencyArrayType& services) { services.push_back(AZ_CRC_CE("GradientService")); } void PerlinGradientComponent::GetRequiredServices(AZ::ComponentDescriptor::DependencyArrayType& services) { services.push_back(AZ_CRC_CE("GradientTransformService")); } void PerlinGradientComponent::Reflect(AZ::ReflectContext* context) { PerlinGradientConfig::Reflect(context); AZ::SerializeContext* serialize = azrtti_cast(context); if (serialize) { serialize->Class() ->Version(0) ->Field("Configuration", &PerlinGradientComponent::m_configuration) ; } if (auto behaviorContext = azrtti_cast(context)) { behaviorContext->Constant("PerlinGradientComponentTypeId", BehaviorConstant(PerlinGradientComponentTypeId)); behaviorContext->Class()->RequestBus("PerlinGradientRequestBus"); behaviorContext->EBus("PerlinGradientRequestBus") ->Attribute(AZ::Script::Attributes::Category, "Vegetation") ->Event("GetRandomSeed", &PerlinGradientRequestBus::Events::GetRandomSeed) ->Event("SetRandomSeed", &PerlinGradientRequestBus::Events::SetRandomSeed) ->VirtualProperty("RandomSeed", "GetRandomSeed", "SetRandomSeed") ->Event("GetAmplitude", &PerlinGradientRequestBus::Events::GetAmplitude) ->Event("SetAmplitude", &PerlinGradientRequestBus::Events::SetAmplitude) ->VirtualProperty("Amplitude", "GetAmplitude", "SetAmplitude") ->Event("GetOctaves", &PerlinGradientRequestBus::Events::GetOctaves) ->Event("SetOctaves", &PerlinGradientRequestBus::Events::SetOctaves) ->VirtualProperty("Octaves", "GetOctaves", "SetOctaves") ->Event("GetFrequency", &PerlinGradientRequestBus::Events::GetFrequency) ->Event("SetFrequency", &PerlinGradientRequestBus::Events::SetFrequency) ->VirtualProperty("Frequency", "GetFrequency", "SetFrequency") ; } } PerlinGradientComponent::PerlinGradientComponent(const PerlinGradientConfig& configuration) : m_configuration(configuration) { } void PerlinGradientComponent::Activate() { // This will immediately call OnGradientTransformChanged and initialize m_gradientTransform. GradientTransformNotificationBus::Handler::BusConnect(GetEntityId()); m_perlinImprovedNoise.reset(aznew PerlinImprovedNoise(AZ::GetMax(m_configuration.m_randomSeed, 1))); PerlinGradientRequestBus::Handler::BusConnect(GetEntityId()); // Connect to GradientRequestBus last so that everything is initialized before listening for gradient queries. GradientRequestBus::Handler::BusConnect(GetEntityId()); } void PerlinGradientComponent::Deactivate() { // Disconnect from GradientRequestBus first to ensure no queries are in process when deactivating. GradientRequestBus::Handler::BusDisconnect(); PerlinGradientRequestBus::Handler::BusDisconnect(); GradientTransformNotificationBus::Handler::BusDisconnect(); m_perlinImprovedNoise.reset(); } bool PerlinGradientComponent::ReadInConfig(const AZ::ComponentConfig* baseConfig) { if (auto config = azrtti_cast(baseConfig)) { m_configuration = *config; return true; } return false; } bool PerlinGradientComponent::WriteOutConfig(AZ::ComponentConfig* outBaseConfig) const { if (auto config = azrtti_cast(outBaseConfig)) { *config = m_configuration; return true; } return false; } void PerlinGradientComponent::OnGradientTransformChanged(const GradientTransform& newTransform) { AZStd::unique_lock lock(m_queryMutex); m_gradientTransform = newTransform; } float PerlinGradientComponent::GetValue(const GradientSampleParams& sampleParams) const { AZStd::shared_lock lock(m_queryMutex); if (m_perlinImprovedNoise) { AZ::Vector3 uvw = sampleParams.m_position; bool wasPointRejected = false; m_gradientTransform.TransformPositionToUVW(sampleParams.m_position, uvw, wasPointRejected); if (!wasPointRejected) { return m_perlinImprovedNoise->GenerateOctaveNoise( uvw.GetX(), uvw.GetY(), uvw.GetZ(), m_configuration.m_octave, m_configuration.m_amplitude, m_configuration.m_frequency); } } return 0.0f; } void PerlinGradientComponent::GetValues(AZStd::span positions, AZStd::span outValues) const { if (positions.size() != outValues.size()) { AZ_Assert(false, "input and output lists are different sizes (%zu vs %zu).", positions.size(), outValues.size()); return; } AZ::Vector3 uvw; bool wasPointRejected = false; AZStd::shared_lock lock(m_queryMutex); for (size_t index = 0; index < positions.size(); index++) { m_gradientTransform.TransformPositionToUVW(positions[index], uvw, wasPointRejected); if (!wasPointRejected) { outValues[index] = m_perlinImprovedNoise->GenerateOctaveNoise( uvw.GetX(), uvw.GetY(), uvw.GetZ(), m_configuration.m_octave, m_configuration.m_amplitude, m_configuration.m_frequency); } else { outValues[index] = 0.0f; } } } int PerlinGradientComponent::GetRandomSeed() const { return m_configuration.m_randomSeed; } void PerlinGradientComponent::SetRandomSeed(int seed) { // Only hold the lock while we're changing the data. Don't hold onto it during the OnCompositionChanged call, because that can // execute an arbitrary amount of logic, including calls back to this component. { AZStd::unique_lock lock(m_queryMutex); m_configuration.m_randomSeed = AZStd::GetMax(seed, 1); m_perlinImprovedNoise.release(); m_perlinImprovedNoise.reset(aznew PerlinImprovedNoise(m_configuration.m_randomSeed)); } LmbrCentral::DependencyNotificationBus::Event(GetEntityId(), &LmbrCentral::DependencyNotificationBus::Events::OnCompositionChanged); } int PerlinGradientComponent::GetOctaves() const { return m_configuration.m_octave; } void PerlinGradientComponent::SetOctaves(int octaves) { // Only hold the lock while we're changing the data. Don't hold onto it during the OnCompositionChanged call, because that can // execute an arbitrary amount of logic, including calls back to this component. { AZStd::unique_lock lock(m_queryMutex); m_configuration.m_octave = octaves; } LmbrCentral::DependencyNotificationBus::Event(GetEntityId(), &LmbrCentral::DependencyNotificationBus::Events::OnCompositionChanged); } float PerlinGradientComponent::GetAmplitude() const { return m_configuration.m_amplitude; } void PerlinGradientComponent::SetAmplitude(float amp) { // Only hold the lock while we're changing the data. Don't hold onto it during the OnCompositionChanged call, because that can // execute an arbitrary amount of logic, including calls back to this component. { AZStd::unique_lock lock(m_queryMutex); m_configuration.m_amplitude = amp; } LmbrCentral::DependencyNotificationBus::Event(GetEntityId(), &LmbrCentral::DependencyNotificationBus::Events::OnCompositionChanged); } float PerlinGradientComponent::GetFrequency() const { return m_configuration.m_frequency; } void PerlinGradientComponent::SetFrequency(float frequency) { // Only hold the lock while we're changing the data. Don't hold onto it during the OnCompositionChanged call, because that can // execute an arbitrary amount of logic, including calls back to this component. { AZStd::unique_lock lock(m_queryMutex); m_configuration.m_frequency = frequency; } LmbrCentral::DependencyNotificationBus::Event(GetEntityId(), &LmbrCentral::DependencyNotificationBus::Events::OnCompositionChanged); } }