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

GlobalPaintBrushSettingsSystemComponent owns the current global paintbrush settings for the Editor. More...

#include <GlobalPaintBrushSettingsSystemComponent.h>

Inherits AZ::Component, AzToolsFramework::ActionManagerRegistrationNotificationBus::Handler, and AzToolsFramework::GlobalPaintBrushSettingsRequestBus::Handler.

Public Member Functions

 AZ_COMPONENT (GlobalPaintBrushSettingsSystemComponent, "{78C4CCDE-BDDE-4A49-9534-6D0B62404338}")
 
void OnActionRegistrationHook () override
 
void OnMenuBindingHook () override
 

Static Public Member Functions

static void Reflect (AZ::ReflectContext *context)
 

Protected Member Functions

void Activate () override
 
void Deactivate () override
 
GlobalPaintBrushSettingsGetSettingsPointerForPropertyEditor () override
 
GlobalPaintBrushSettings GetSettings () const override
 
PaintBrushMode GetBrushMode () const override
 
void SetBrushMode (PaintBrushMode brushMode) override
 
PaintBrushColorMode GetBrushColorMode () const override
 
void SetBrushColorMode (PaintBrushColorMode colorMode) override
 
float GetSize () const override
 
AZStd::pair< float, float > GetSizeRange () const override
 
AZ::Color GetColor () const override
 
float GetHardnessPercent () const override
 
float GetFlowPercent () const override
 
float GetDistancePercent () const override
 
AzFramework::PaintBrushBlendMode GetBlendMode () const override
 
AzFramework::PaintBrushSmoothMode GetSmoothMode () const override
 
size_t GetSmoothingRadius () const override
 
size_t GetSmoothingSpacing () const override
 
void SetSize (float size) override
 
void SetSizeRange (float minSize, float maxSize) override
 
void SetColor (const AZ::Color &color) override
 
void SetHardnessPercent (float hardnessPercent) override
 
void SetFlowPercent (float flowPercent) override
 
void SetDistancePercent (float distancePercent) override
 
void SetBlendMode (AzFramework::PaintBrushBlendMode blendMode) override
 
void SetSmoothMode (AzFramework::PaintBrushSmoothMode smoothMode) override
 
void SetSmoothingRadius (size_t radius) override
 
void SetSmoothingSpacing (size_t spacing) override
 

Protected Attributes

GlobalPaintBrushSettings m_settings
 

Detailed Description

GlobalPaintBrushSettingsSystemComponent owns the current global paintbrush settings for the Editor.


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