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::EditorImageGradientComponent Class Reference

Inherits AzToolsFramework::Components::EditorComponentBase, AzToolsFramework::EditorVisibilityNotificationBus::Handler, LmbrCentral::DependencyNotificationBus::Handler, and AzFramework::PaintBrushNotificationBus::Handler.

Public Member Functions

 AZ_EDITOR_COMPONENT_INTRUSIVE_DESCRIPTOR_TYPE (EditorImageGradientComponent)
 
 AZ_COMPONENT_BASE (EditorImageGradientComponent)
 
 AZ_CLASS_ALLOCATOR (EditorImageGradientComponent, AZ::ComponentAllocator)
 
 AZ_RTTI_NO_TYPE_INFO_DECL ()
 
void Init () override
 Component overrides ...
 
void Activate () override
 
void Deactivate () override
 
void BuildGameEntity (AZ::Entity *gameEntity) override
 
void OnEntityVisibilityChanged (bool visibility) override
 
void OnCompositionChanged () override
 
void OnCompositionRegionChanged (const AZ::Aabb &dirtyRegion) override
 

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 void GetRequiredServices (AZ::ComponentDescriptor::DependencyArrayType &services)
 
static void GetDependentServices (AZ::ComponentDescriptor::DependencyArrayType &services)
 

Static Public Attributes

static constexpr const char *const s_categoryName = "Gradients"
 
static constexpr const char *const s_componentName = "Image Gradient"
 
static constexpr const char *const s_componentDescription = "Generates a gradient by sampling an image asset"
 
static constexpr const char *const s_icon = "Editor/Icons/Components/Gradient.svg"
 
static constexpr const char *const s_viewportIcon = "Editor/Icons/Components/Viewport/Gradient.svg"
 
static constexpr const char *const s_helpUrl = ""
 

Protected Member Functions

bool SavePaintedData ()
 
void OnPaintModeBegin () override
 
void OnPaintModeEnd () override
 
void OnBrushStrokeBegin (const AZ::Color &color) override
 
void OnBrushStrokeEnd () override
 
void OnPaint (const AZ::Color &color, const AZ::Aabb &dirtyArea, ValueLookupFn &valueLookupFn, BlendFn &blendFn) override
 
void OnSmooth (const AZ::Color &color, const AZ::Aabb &dirtyArea, ValueLookupFn &valueLookupFn, AZStd::span< const AZ::Vector3 > valuePointOffsets, SmoothFn &smoothFn) override
 
AZ::Color OnGetColor (const AZ::Vector3 &brushCenter) const override
 
bool GetImageOptionsReadOnly () const
 
AZ::u32 ConfigurationChanged ()
 

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