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.
Public Member Functions | Static Public Attributes | List of all members
GradientSignal::ImageGradientModificationNotifications Class Reference

EBus that notifies about the current state of Image Gradient modifications. More...

#include <ImageGradientModificationBus.h>

Inherits AZ::ComponentBus.

Public Member Functions

virtual void OnImageGradientBrushStrokeBegin ()
 Notify any listeners that a brush stroke has started on this image gradient.
 
virtual void OnImageGradientBrushStrokeEnd ([[maybe_unused]] AZStd::shared_ptr< ImageTileBuffer > changedDataBuffer, [[maybe_unused]] const AZ::Aabb &dirtyRegion)
 

Static Public Attributes

static const AZ::EBusHandlerPolicy HandlerPolicy = AZ::EBusHandlerPolicy::Single
 

Detailed Description

EBus that notifies about the current state of Image Gradient modifications.

Member Function Documentation

◆ OnImageGradientBrushStrokeEnd()

virtual void GradientSignal::ImageGradientModificationNotifications::OnImageGradientBrushStrokeEnd ( [[maybe_unused] ] AZStd::shared_ptr< ImageTileBuffer >  changedDataBuffer,
[[maybe_unused] ] const AZ::Aabb &  dirtyRegion 
)
inlinevirtual

Notify any listeners that a brush stroke has ended on this image gradient.

Parameters
changedDataBufferA pointer to the ImageTileBuffer containing the changed data. The buffer will be deleted after this notification unless a listener keeps a copy of the pointer (for undo/redo, for example).
dirtyRegionThe AABB defining the world space region affected by the brush stroke.
The documentation for this class was generated from the following file: