/* * 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 // Base gradient components #include #include #include #include #include // Gradient modifier components #include #include #include #include #include #include #include #include // Gradient surface data components #include #include #include namespace UnitTest { void GradientSignalTestEnvironment::AddGemsAndComponents() { AddDynamicModulePaths({ "LmbrCentral" }); AddComponentDescriptors({ AzFramework::TransformComponent::CreateDescriptor(), GradientSignal::ConstantGradientComponent::CreateDescriptor(), GradientSignal::DitherGradientComponent::CreateDescriptor(), GradientSignal::GradientSurfaceDataComponent::CreateDescriptor(), GradientSignal::GradientTransformComponent::CreateDescriptor(), GradientSignal::ImageGradientComponent::CreateDescriptor(), GradientSignal::InvertGradientComponent::CreateDescriptor(), GradientSignal::LevelsGradientComponent::CreateDescriptor(), GradientSignal::MixedGradientComponent::CreateDescriptor(), GradientSignal::PerlinGradientComponent::CreateDescriptor(), GradientSignal::PosterizeGradientComponent::CreateDescriptor(), GradientSignal::RandomGradientComponent::CreateDescriptor(), GradientSignal::ReferenceGradientComponent::CreateDescriptor(), GradientSignal::ShapeAreaFalloffGradientComponent::CreateDescriptor(), GradientSignal::SmoothStepGradientComponent::CreateDescriptor(), GradientSignal::SurfaceAltitudeGradientComponent::CreateDescriptor(), GradientSignal::SurfaceMaskGradientComponent::CreateDescriptor(), GradientSignal::SurfaceSlopeGradientComponent::CreateDescriptor(), GradientSignal::ThresholdGradientComponent::CreateDescriptor(), MockShapeComponent::CreateDescriptor(), }); } void GradientSignalBaseFixture::SetupCoreSystems() { m_mockHandler = new UnitTest::ImageAssetMockAssetHandler(); AZ::Data::AssetManager::Instance().RegisterHandler(m_mockHandler, azrtti_typeid()); } void GradientSignalBaseFixture::TearDownCoreSystems() { AZ::Data::AssetManager::Instance().UnregisterHandler(m_mockHandler); delete m_mockHandler; // delete after removing from the asset manager AzFramework::LegacyAssetEventBus::ClearQueuedEvents(); } AZStd::unique_ptr GradientSignalBaseFixture::CreateMockSurfaceDataSystem(const AZ::Aabb& spawnerBox) { AzFramework::SurfaceData::SurfacePoint point; AZStd::unique_ptr mockSurfaceDataSystem = AZStd::make_unique(); // Give the mock surface data a bunch of fake point values to return. for (float y = spawnerBox.GetMin().GetY(); y < spawnerBox.GetMax().GetY(); y+= 1.0f) { for (float x = spawnerBox.GetMin().GetX(); x < spawnerBox.GetMax().GetX(); x += 1.0f) { // Use our x distance into the spawnerBox as an arbitrary percentage value that we'll use to calculate // our other arbitrary values below. float arbitraryPercentage = AZStd::abs(x / spawnerBox.GetExtents().GetX()); // Create a position that's between min and max Z of the box. point.m_position = AZ::Vector3(x, y, AZ::Lerp(spawnerBox.GetMin().GetZ(), spawnerBox.GetMax().GetZ(), arbitraryPercentage)); // Create an arbitrary normal value. point.m_normal = point.m_position.GetNormalized(); // Create an arbitrary surface value. point.m_surfaceTags.clear(); point.m_surfaceTags.emplace_back(AZ_CRC_CE("test_mask"), arbitraryPercentage); mockSurfaceDataSystem->m_GetSurfacePoints[AZStd::make_pair(x, y)] = { { point } }; } } return mockSurfaceDataSystem; } AZStd::unique_ptr GradientSignalBaseFixture::CreateTestEntity(float shapeHalfBounds) { // Create the base entity AZStd::unique_ptr testEntity = CreateEntity(); LmbrCentral::BoxShapeConfig boxConfig(AZ::Vector3(shapeHalfBounds * 2.0f)); auto boxComponent = testEntity->CreateComponent(LmbrCentral::AxisAlignedBoxShapeComponentTypeId); boxComponent->SetConfiguration(boxConfig); // Create a transform that locates our gradient in the center of our desired mock Shape. auto transform = testEntity->CreateComponent(); transform->SetLocalTM(AZ::Transform::CreateTranslation(AZ::Vector3(shapeHalfBounds))); transform->SetWorldTM(AZ::Transform::CreateTranslation(AZ::Vector3(shapeHalfBounds))); return testEntity; } AZStd::unique_ptr GradientSignalBaseFixture::BuildTestConstantGradient(float shapeHalfBounds) { // Create a Constant Gradient Component with arbitrary parameters. auto entity = CreateTestEntity(shapeHalfBounds); GradientSignal::ConstantGradientConfig config; config.m_value = 0.75f; entity->CreateComponent(config); ActivateEntity(entity.get()); return entity; } AZStd::unique_ptr GradientSignalBaseFixture::BuildTestImageGradient(float shapeHalfBounds) { // Create an Image Gradient Component with arbitrary sizes and parameters. auto entity = CreateTestEntity(shapeHalfBounds); GradientSignal::ImageGradientConfig config; const uint32_t imageSize = 4096; const int32_t imageSeed = 12345; config.m_imageAsset = ImageAssetMockAssetHandler::CreateImageAsset(imageSize, imageSize, imageSeed); config.m_tilingX = 1.0f; config.m_tilingY = 1.0f; entity->CreateComponent(config); // Create a Gradient Transform Component with arbitrary parameters. GradientSignal::GradientTransformConfig gradientTransformConfig; gradientTransformConfig.m_wrappingType = GradientSignal::WrappingType::None; entity->CreateComponent(gradientTransformConfig); ActivateEntity(entity.get()); return entity; } AZStd::unique_ptr GradientSignalBaseFixture::BuildTestPerlinGradient(float shapeHalfBounds) { // Create a Perlin Gradient Component with arbitrary parameters. auto entity = CreateTestEntity(shapeHalfBounds); GradientSignal::PerlinGradientConfig config; config.m_amplitude = 1.0f; config.m_frequency = 1.1f; config.m_octave = 4; config.m_randomSeed = 12345; entity->CreateComponent(config); // Create a Gradient Transform Component with arbitrary parameters. GradientSignal::GradientTransformConfig gradientTransformConfig; gradientTransformConfig.m_wrappingType = GradientSignal::WrappingType::None; entity->CreateComponent(gradientTransformConfig); ActivateEntity(entity.get()); return entity; } AZStd::unique_ptr GradientSignalBaseFixture::BuildTestRandomGradient(float shapeHalfBounds) { // Create a Random Gradient Component with arbitrary parameters. auto entity = CreateTestEntity(shapeHalfBounds); GradientSignal::RandomGradientConfig config; config.m_randomSeed = 12345; entity->CreateComponent(config); // Create a Gradient Transform Component with arbitrary parameters. GradientSignal::GradientTransformConfig gradientTransformConfig; gradientTransformConfig.m_wrappingType = GradientSignal::WrappingType::None; entity->CreateComponent(gradientTransformConfig); ActivateEntity(entity.get()); return entity; } AZStd::unique_ptr GradientSignalBaseFixture::BuildTestShapeAreaFalloffGradient(float shapeHalfBounds) { // Create a Shape Area Falloff Gradient Component with arbitrary parameters. auto entity = CreateTestEntity(shapeHalfBounds); GradientSignal::ShapeAreaFalloffGradientConfig config; config.m_shapeEntityId = entity->GetId(); config.m_falloffWidth = 16.0f; config.m_falloffType = GradientSignal::FalloffType::InnerOuter; entity->CreateComponent(config); ActivateEntity(entity.get()); return entity; } AZStd::unique_ptr GradientSignalBaseFixture::BuildTestDitherGradient( float shapeHalfBounds, const AZ::EntityId& inputGradientId) { // Create a Dither Gradient Component with arbitrary parameters. auto entity = CreateTestEntity(shapeHalfBounds); GradientSignal::DitherGradientConfig config; config.m_gradientSampler.m_gradientId = inputGradientId; config.m_useSystemPointsPerUnit = false; // Use a number other than 1.0f for pointsPerUnit to ensure the dither math is getting exercised properly. config.m_pointsPerUnit = 0.25f; config.m_patternOffset = AZ::Vector3::CreateZero(); config.m_patternType = GradientSignal::DitherGradientConfig::BayerPatternType::PATTERN_SIZE_4x4; entity->CreateComponent(config); ActivateEntity(entity.get()); return entity; } AZStd::unique_ptr GradientSignalBaseFixture::BuildTestInvertGradient( float shapeHalfBounds, const AZ::EntityId& inputGradientId) { // Create an Invert Gradient Component. auto entity = CreateTestEntity(shapeHalfBounds); GradientSignal::InvertGradientConfig config; config.m_gradientSampler.m_gradientId = inputGradientId; entity->CreateComponent(config); ActivateEntity(entity.get()); return entity; } AZStd::unique_ptr GradientSignalBaseFixture::BuildTestLevelsGradient( float shapeHalfBounds, const AZ::EntityId& inputGradientId) { // Create a Levels Gradient Component with arbitrary parameters. auto entity = CreateTestEntity(shapeHalfBounds); GradientSignal::LevelsGradientConfig config; config.m_gradientSampler.m_gradientId = inputGradientId; config.m_inputMin = 0.1f; config.m_inputMid = 0.3f; config.m_inputMax = 0.9f; config.m_outputMin = 0.0f; config.m_outputMax = 1.0f; entity->CreateComponent(config); ActivateEntity(entity.get()); return entity; } AZStd::unique_ptr GradientSignalBaseFixture::BuildTestMixedGradient( float shapeHalfBounds, const AZ::EntityId& baseGradientId, const AZ::EntityId& mixedGradientId) { // Create a Mixed Gradient Component that mixes two input gradients together in arbitrary ways. auto entity = CreateTestEntity(shapeHalfBounds); GradientSignal::MixedGradientConfig config; GradientSignal::MixedGradientLayer layer; layer.m_enabled = true; layer.m_operation = GradientSignal::MixedGradientLayer::MixingOperation::Initialize; layer.m_gradientSampler.m_gradientId = baseGradientId; layer.m_gradientSampler.m_opacity = 1.0f; config.m_layers.push_back(layer); layer.m_operation = GradientSignal::MixedGradientLayer::MixingOperation::Overlay; layer.m_gradientSampler.m_gradientId = mixedGradientId; layer.m_gradientSampler.m_opacity = 0.75f; config.m_layers.push_back(layer); entity->CreateComponent(config); ActivateEntity(entity.get()); return entity; } AZStd::unique_ptr GradientSignalBaseFixture::BuildTestPosterizeGradient( float shapeHalfBounds, const AZ::EntityId& inputGradientId) { // Create a Posterize Gradient Component with arbitrary parameters. auto entity = CreateTestEntity(shapeHalfBounds); GradientSignal::PosterizeGradientConfig config; config.m_gradientSampler.m_gradientId = inputGradientId; config.m_mode = GradientSignal::PosterizeGradientConfig::ModeType::Ps; config.m_bands = 5; entity->CreateComponent(config); ActivateEntity(entity.get()); return entity; } AZStd::unique_ptr GradientSignalBaseFixture::BuildTestReferenceGradient( float shapeHalfBounds, const AZ::EntityId& inputGradientId) { // Create a Reference Gradient Component. auto entity = CreateTestEntity(shapeHalfBounds); GradientSignal::ReferenceGradientConfig config; config.m_gradientSampler.m_gradientId = inputGradientId; config.m_gradientSampler.m_ownerEntityId = entity->GetId(); entity->CreateComponent(config); ActivateEntity(entity.get()); return entity; } AZStd::unique_ptr GradientSignalBaseFixture::BuildTestSmoothStepGradient( float shapeHalfBounds, const AZ::EntityId& inputGradientId) { // Create a Smooth Step Gradient Component with arbitrary parameters. auto entity = CreateTestEntity(shapeHalfBounds); GradientSignal::SmoothStepGradientConfig config; config.m_gradientSampler.m_gradientId = inputGradientId; config.m_smoothStep.m_falloffMidpoint = 0.75f; config.m_smoothStep.m_falloffRange = 0.125f; config.m_smoothStep.m_falloffStrength = 0.25f; entity->CreateComponent(config); ActivateEntity(entity.get()); return entity; } AZStd::unique_ptr GradientSignalBaseFixture::BuildTestThresholdGradient( float shapeHalfBounds, const AZ::EntityId& inputGradientId) { // Create a Threshold Gradient Component with arbitrary parameters. auto entity = CreateTestEntity(shapeHalfBounds); GradientSignal::ThresholdGradientConfig config; config.m_gradientSampler.m_gradientId = inputGradientId; config.m_threshold = 0.75f; entity->CreateComponent(config); ActivateEntity(entity.get()); return entity; } AZStd::unique_ptr GradientSignalBaseFixture::BuildTestSurfaceAltitudeGradient(float shapeHalfBounds) { // Create a Surface Altitude Gradient Component with arbitrary parameters. auto entity = CreateTestEntity(shapeHalfBounds); GradientSignal::SurfaceAltitudeGradientConfig config; config.m_altitudeMin = -5.0f; config.m_altitudeMax = 15.0f; entity->CreateComponent(config); ActivateEntity(entity.get()); return entity; } AZStd::unique_ptr GradientSignalBaseFixture::BuildTestSurfaceMaskGradient(float shapeHalfBounds) { // Create a Surface Mask Gradient Component with arbitrary parameters. auto entity = CreateTestEntity(shapeHalfBounds); GradientSignal::SurfaceMaskGradientConfig config; config.m_surfaceTagList.push_back(AZ_CRC_CE("test_mask")); entity->CreateComponent(config); ActivateEntity(entity.get()); return entity; } AZStd::unique_ptr GradientSignalBaseFixture::BuildTestSurfaceSlopeGradient(float shapeHalfBounds) { // Create a Surface Slope Gradient Component with arbitrary parameters. auto entity = CreateTestEntity(shapeHalfBounds); GradientSignal::SurfaceSlopeGradientConfig config; config.m_slopeMin = 5.0f; config.m_slopeMax = 50.0f; config.m_rampType = GradientSignal::SurfaceSlopeGradientConfig::RampType::SMOOTH_STEP; config.m_smoothStep.m_falloffMidpoint = 0.75f; config.m_smoothStep.m_falloffRange = 0.125f; config.m_smoothStep.m_falloffStrength = 0.25f; entity->CreateComponent(config); ActivateEntity(entity.get()); return entity; } void GradientSignalTest::TestFixedDataSampler(const AZStd::vector& expectedOutput, int size, AZ::EntityId gradientEntityId) { GradientSignal::GradientSampler gradientSampler; gradientSampler.m_gradientId = gradientEntityId; for (int y = 0; y < size; ++y) { for (int x = 0; x < size; ++x) { GradientSignal::GradientSampleParams params; params.m_position = AZ::Vector3(static_cast(x), static_cast(y), 0.0f); const int index = y * size + x; float actualValue = gradientSampler.GetValue(params); float expectedValue = expectedOutput[index]; EXPECT_NEAR(actualValue, expectedValue, 0.01f); } } } }