This is used to get/set the global paintbrush settings. More...
#include <GlobalPaintBrushSettingsRequestBus.h>
Inherits AZ::EBusTraits.
Public Types | |
using | MutexType = AZStd::recursive_mutex |
Public Member Functions | |
virtual GlobalPaintBrushSettings * | GetSettingsPointerForPropertyEditor ()=0 |
virtual GlobalPaintBrushSettings | GetSettings () const =0 |
Returns a copy of the current global paintbrush settings. | |
virtual PaintBrushMode | GetBrushMode () const =0 |
Returns the current brush mode for the paint brush settings. | |
virtual void | SetBrushMode (PaintBrushMode brushMode)=0 |
Sets the brush mode for the paint brush settings. | |
virtual PaintBrushColorMode | GetBrushColorMode () const =0 |
Returns the current color mode for the paint brush settings. | |
virtual void | SetBrushColorMode (PaintBrushColorMode colorMode)=0 |
Sets the color mode for the paint brush settings. | |
virtual AZ::Color | GetColor () const =0 |
virtual AzFramework::PaintBrushBlendMode | GetBlendMode () const =0 |
Returns the current brush stroke blend mode. | |
virtual AzFramework::PaintBrushSmoothMode | GetSmoothMode () const =0 |
Returns the current brush stroke smooth mode. | |
virtual void | SetBlendMode (AzFramework::PaintBrushBlendMode blendMode)=0 |
virtual void | SetSmoothMode (AzFramework::PaintBrushSmoothMode smoothMode)=0 |
virtual void | SetColor (const AZ::Color &color)=0 |
virtual float | GetSize () const =0 |
virtual AZStd::pair< float, float > | GetSizeRange () const =0 |
virtual float | GetHardnessPercent () const =0 |
Returns the brush stamp hardness (0=soft falloff, 100=hard edge). | |
virtual float | GetFlowPercent () const =0 |
Returns the brush stamp flow setting (0=transparent stamp, 100=opaque stamp) | |
virtual float | GetDistancePercent () const =0 |
Returns the brush distance to move between each stamp placement in % of paintbrush size. | |
virtual void | SetSize (float size)=0 |
virtual void | SetSizeRange (float minSize, float maxSize)=0 |
virtual void | SetHardnessPercent (float hardnessPercent)=0 |
virtual void | SetFlowPercent (float flowPercent)=0 |
virtual void | SetDistancePercent (float distancePercent)=0 |
virtual size_t | GetSmoothingRadius () const =0 |
virtual size_t | GetSmoothingSpacing () const =0 |
virtual void | SetSmoothingRadius (size_t radius)=0 |
virtual void | SetSmoothingSpacing (size_t spacing)=0 |
Static Public Attributes | |
static const AZ::EBusHandlerPolicy | HandlerPolicy = AZ::EBusHandlerPolicy::Single |
This is used to get/set the global paintbrush settings.
|
pure virtual |
Returns the current brush stroke color, including opacity. In monochrome painting, the RGB values will all be identical.
|
pure virtual |
Returns a pointer to the current paintbrush settings. This shouldn't normally be used, but it's necessary for exposing the global paintbrush settings outwards to the Property Editor window.
|
pure virtual |
Returns the brush stamp size (diameter).
|
pure virtual |
Returns the brush stamp min/max size range. The range is used to ensure that our brush size is appropriately sized relative to the world size of the data we're painting. If we let it get too big, we can run into serious performance issues.
|
pure virtual |
Returns the number of pixels in each direction to use for smoothing calculations.
|
pure virtual |
Returns the number of pixels to skip between pixel fetches for smoothing calculations.
|
pure virtual |
Sets the brush stroke blend mode.
blendMode | The new blend mode. |
|
pure virtual |
Set the brush stroke color, including opacity.
color | The new brush color. In monochrome painting, only the Red value will be used. |
|
pure virtual |
Set the brush distance % to move between each stamp placement.
distancePercent | The new distance %, typically in the 0-100 range. |
|
pure virtual |
Sets the brush stamp flow setting.
flow | The new flow, in 0-100 range. |
|
pure virtual |
Sets the brush stamp hardness.
hardness | The new hardness, in 0-100 range. |
|
pure virtual |
Sets the brush stamp size (diameter).
size | The new size, in meters. |
|
pure virtual |
Sets the brush stamp min/max size range. The range is used to ensure that our brush size is appropriately sized relative to the world size of the data we're painting. If we let it get too big, we can run into serious performance issues.
minSize | The minimum size of the paint brush in meters. |
maxSize | The maximum size of the paint brush in meters. |
|
pure virtual |
Set the number of pixels in each direction to use for smoothing calculations.
The | number of pixels in each direction to use |
|
pure virtual |
Set the number of pixels to skip between pixel fetches for smoothing calculations
The | number of pixels to skip |
|
pure virtual |
Sets the brush stroke smooth mode.
smoothMode | The new smooth mode. |