PCL
pcl::GradientBrush Class Reference

Base class of PCL gradient brushes. More...

#include <Brush.h>

+ Inheritance diagram for pcl::GradientBrush:

Classes

struct  Stop
 Gradient stop. More...
 

Public Types

using spread_mode = GradientSpreadMode::value_type
 
using stop_list = Array< Stop >
 
- Public Types inherited from pcl::Brush
using style = BrushStyle::value_type
 

Public Member Functions

bool IsGradient () const override
 
spread_mode SpreadMode () const
 
stop_list Stops () const
 
- Public Member Functions inherited from pcl::Brush
 Brush (Brush &&x)
 
 Brush (const Bitmap &bmp)
 
 Brush (const Brush &b)
 
 Brush (RGBA color=0xff000000, style=BrushStyle::Solid)
 
 ~Brush () override
 
RGBA Color () const
 
bool IsEmpty () const
 
bool IsSolid () const
 
bool IsStippled () const
 
bool IsTransparent () const
 
Brushoperator= (Brush &&x)
 
Brushoperator= (const Brush &b)
 
void SetColor (RGBA)
 
void SetStipple (const Bitmap &)
 
void SetStyle (style)
 
Bitmap Stipple () const
 
style Style () const
 
- Public Member Functions inherited from pcl::UIObject
virtual ~UIObject () noexcept(false)
 
virtual void EnsureUnique ()
 
bool IsAlias () const
 
bool IsGarbage () const
 
bool IsNull () const
 
bool IsSameObject (const UIObject &o) const
 
bool IsUnique () const
 
String ObjectId () const
 
IsoString ObjectType () const
 
bool operator< (const UIObject &o) const
 
bool operator== (const UIObject &o) const
 
size_type RefCount () const
 
void SetObjectId (const String &id)
 

Additional Inherited Members

- Static Public Member Functions inherited from pcl::Brush
static BrushNull ()
 
- Static Public Member Functions inherited from pcl::UIObject
static UIObjectNull ()
 
- Protected Member Functions inherited from pcl::UIObject
 UIObject ()=default
 
 UIObject (const UIObject &x)
 
 UIObject (UIObject &&x)
 
UIObjectoperator= (const UIObject &x)
 
UIObjectoperator= (UIObject &&x)
 

Detailed Description

TODO: Write a detailed description for GradientBrush.

See also
Brush, LinearGradientBrush, RadialGradientBrush, ConicalGradientBrush

Definition at line 341 of file Brush.h.

Member Typedef Documentation

◆ spread_mode

using pcl::GradientBrush::spread_mode = GradientSpreadMode::value_type

Represents a gradient spread mode. Supported values are defined in the GradientSpreadMode namespace.

Definition at line 349 of file Brush.h.

◆ stop_list

Represents a list of gradient stops.

Definition at line 407 of file Brush.h.

Member Function Documentation

◆ IsGradient()

bool pcl::GradientBrush::IsGradient ( ) const
inlineoverridevirtual

Returns true iff this object is a gradient brush.

Reimplemented from pcl::Brush.

Definition at line 421 of file Brush.h.

◆ SpreadMode()

spread_mode pcl::GradientBrush::SpreadMode ( ) const

Returns the current gradient spread mode for this gradient brush.

◆ Stops()

stop_list pcl::GradientBrush::Stops ( ) const

Returns the list of stops in this gradient brush.


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