Open 3D Engine GradientSignal Gem API Reference  24.09
O3DE is an open-source, fully-featured, high-fidelity, modular 3D engine for building games and simulations, available to every industry.
GradientSignal::EditorGradientBakerComponent Class Reference

Inherits AzToolsFramework::Components::EditorComponentBase, GradientRequestBus::Handler, GradientBakerRequestBus::Handler, GradientImageCreatorRequestBus::Handler, LmbrCentral::DependencyNotificationBus::Handler, and AZ::TickBus::Handler.

Public Member Functions

 AZ_EDITOR_COMPONENT (EditorGradientBakerComponent, EditorGradientBakerComponentTypeId, AzToolsFramework::Components::EditorComponentBase)
 
void Activate () override
 Component overrides ...
 
void Deactivate () override
 
float GetValue (const GradientSampleParams &sampleParams) const override
 GradientRequestBus overrides ...
 
void GetValues (AZStd::span< const AZ::Vector3 > positions, AZStd::span< float > outValues) const override
 
bool IsEntityInHierarchy (const AZ::EntityId &entityId) const override
 
AZ::Vector2 GetOutputResolution () const override
 GradientImageCreatorRequestBus overrides ...
 
void SetOutputResolution (const AZ::Vector2 &resolution) override
 
OutputFormat GetOutputFormat () const override
 
void SetOutputFormat (OutputFormat outputFormat) override
 
AZ::IO::Path GetOutputImagePath () const override
 
void SetOutputImagePath (const AZ::IO::Path &outputImagePath) override
 
void BakeImage () override
 GradientBakerRequestBus overrides ...
 
AZ::EntityId GetInputBounds () const override
 
void SetInputBounds (const AZ::EntityId &inputBounds) override
 
void OnCompositionChanged () override
 LmbrCentral::DependencyNotificationBus overrides ...
 

Static Public Member Functions

static void Reflect (AZ::ReflectContext *context)
 
static void GetProvidedServices (AZ::ComponentDescriptor::DependencyArrayType &services)
 
static void GetIncompatibleServices (AZ::ComponentDescriptor::DependencyArrayType &services)
 

Static Public Attributes

static constexpr const char *const s_categoryName = "Gradients"
 
static constexpr const char *const s_componentName = "Gradient Baker"
 
static constexpr const char *const s_componentDescription = "Bakes out an inbound gradient signal to a streaming image asset"
 
static constexpr const char *const s_icon = "Editor/Icons/Components/GradientBaker.svg"
 
static constexpr const char *const s_viewportIcon = "Editor/Icons/Components/Viewport/GradientBaker.svg"
 
static constexpr const char *const s_helpUrl = ""
 

Protected Member Functions

void OnTick (float deltaTime, AZ::ScriptTimePoint time) override
 AZ::TickBus overrides ...
 
void OnConfigurationChanged ()
 
void SetupDependencyMonitor ()
 
void StartBakeImageJob ()
 
bool IsBakeDisabled () const
 

The documentation for this class was generated from the following file: