Radial gradient brush. More...

#include <Brush.h>

Inheritance diagram for pcl::RadialGradientBrush:

Public Types
using	spread_mode = GradientBrush::spread_mode

using	stop_list = GradientBrush::stop_list

Public Types inherited from pcl::GradientBrush
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
	RadialGradientBrush (const DPoint &c, double r, const DPoint &f=DPoint(uint32_max), const stop_list &stops=stop_list(), spread_mode spread=GradientSpreadMode::Pad)

	RadialGradientBrush (const Point &c, double r, const Point &f=Point(uint32_max), const stop_list &stops=stop_list(), spread_mode spread=GradientSpreadMode::Pad)

	RadialGradientBrush (const RadialGradientBrush &b)

	RadialGradientBrush (double cx, double cy, double r, double fx=uint32_max, double fy=uint32_max, const stop_list &stops=stop_list(), spread_mode spread=GradientSpreadMode::Pad)

	RadialGradientBrush (RadialGradientBrush &&x)

void	GetParameters (double &cx, double &cy, double &r, double &fx, double &fy) const

void	GetParameters (DPoint &c, double &r, DPoint &f) const

RadialGradientBrush &	operator= (const RadialGradientBrush &b)

RadialGradientBrush &	operator= (RadialGradientBrush &&x)

Public Member Functions inherited from pcl::GradientBrush
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

Brush &	operator= (Brush &&x)

Brush &	operator= (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 Brush &	Null ()

Static Public Member Functions inherited from pcl::UIObject
static UIObject &	Null ()

Protected Member Functions inherited from pcl::UIObject
	UIObject ()=default

	UIObject (const UIObject &x)

	UIObject (UIObject &&x)

UIObject &	operator= (const UIObject &x)

UIObject &	operator= (UIObject &&x)

Detailed Description

TODO: Write a detailed description for RadialGradientBrush.

See also: Brush, GradientBrush, LinearGradientBrush, ConicalGradientBrush

Definition at line 576 of file Brush.h.

Member Typedef Documentation

◆ spread_mode

using pcl::RadialGradientBrush::spread_mode = GradientBrush::spread_mode

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

Definition at line 584 of file Brush.h.

◆ stop_list

using pcl::RadialGradientBrush::stop_list = GradientBrush::stop_list

Represents a list of gradient stops.

Definition at line 589 of file Brush.h.

Constructor & Destructor Documentation

◆ RadialGradientBrush() [1/5]

pcl::RadialGradientBrush::RadialGradientBrush	(	double	cx,
		double	cy,
		double	r,
		double	fx = `uint32_max`,
		double	fy = `uint32_max`,
		const stop_list &	stops = `stop_list()`,
		spread_mode	spread = `GradientSpreadMode::Pad`
	)

Constructs a RadialGradientBrush object.

Parameters

cx,cy	Coordinates of the gradient's center.
r	Gradient's radius.
fx,fy	Coordinates of the gradient's focal point. If these coordinates are not specified, they will be set at the specified gradient's center point.
stops	Reference to a list of gradient stops. If an empty list is specified (as by default), two stops will be generated automatically: {0.0,0x00000000} and {1.0,0xFF000000}.
spread	Gradient spread mode. Supported spread modes are defined in the GradientSpreadMode namespace. The default is GradientSpreadMode::Pad.

◆ RadialGradientBrush() [2/5]

pcl::RadialGradientBrush::RadialGradientBrush	(	const DPoint &	c,
		double	r,
		const DPoint &	f = `DPoint(uint32_max)`,
		const stop_list &	stops = `stop_list()`,
		spread_mode	spread = `GradientSpreadMode::Pad`
	)

Constructs a RadialGradientBrush object.

This is an overloaded constructor, provided for convenience. It behaves like the preceding constructor, except the radial gradient parameters are specified as a center point c, radius r and focal point f.

◆ RadialGradientBrush() [3/5]

pcl::RadialGradientBrush::RadialGradientBrush	(	const Point &	c,
		double	r,
		const Point &	f = `Point(uint32_max)`,
		const stop_list &	stops = `stop_list()`,
		spread_mode	spread = `GradientSpreadMode::Pad`
	)

Constructs a RadialGradientBrush object.

This is an overloaded constructor, provided for convenience. It behaves like the preceding constructor, except the radial gradient parameters are specified as a center point c, radius r and focal point f.

◆ RadialGradientBrush() [4/5]

pcl::RadialGradientBrush::RadialGradientBrush ( const RadialGradientBrush & b )

inline

Copy constructor. This object will reference the same server-side brush as the specified instance b.

Definition at line 640 of file Brush.h.

◆ RadialGradientBrush() [5/5]

pcl::RadialGradientBrush::RadialGradientBrush ( RadialGradientBrush && x )

inline

Move constructor.

Definition at line 648 of file Brush.h.

Member Function Documentation

◆ GetParameters() [1/2]

void pcl::RadialGradientBrush::GetParameters	(	double &	cx,
		double &	cy,
		double &	r,
		double &	fx,
		double &	fy
	)		const

Retrieves the radial gradient parameters of this object.

Parameters

[out]	cx,cy	Coordinates of the gradient's center.
[out]	r	Gradient's radius.
[out]	fx,fy	Coordinates of the gradient's focal point.

See also: GetParameters( DPoint&, double&, DPoint& )

◆ GetParameters() [2/2]

void pcl::RadialGradientBrush::GetParameters	(	DPoint &	c,
		double &	r,
		DPoint &	f
	)		const

inline

Returns the radial gradient parameters of this object.

This is an overloaded function, provided for convenience. It behaves like the preceding function, except the center and focal point parameters are retrieved as DPoint objects.

See also: GetParameters( double&, double&, double&, double&, double& )

Definition at line 695 of file Brush.h.

References pcl::GenericPoint< T >::x, and pcl::GenericPoint< T >::y.

◆ operator=() [1/2]

RadialGradientBrush& pcl::RadialGradientBrush::operator= ( const RadialGradientBrush & b )

inline

Copy assignment operator. Returns a reference to this object.

Makes this object reference the same server-side brush as the specified instance b. If the previous brush becomes unreferenced, it will be garbage-collected by the PixInsight core application.

Definition at line 660 of file Brush.h.

◆ operator=() [2/2]

RadialGradientBrush& pcl::RadialGradientBrush::operator= ( RadialGradientBrush && x )

inline

Move assignment operator. Returns a reference to this object.

Definition at line 669 of file Brush.h.

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

Brush.h

Public Types

Public Member Functions

Additional Inherited Members

Detailed Description

TODO: Write a detailed description for RadialGradientBrush.

Member Typedef Documentation

◆ spread_mode

◆ stop_list

Constructor & Destructor Documentation

◆ RadialGradientBrush() [1/5]

◆ RadialGradientBrush() [2/5]

◆ RadialGradientBrush() [3/5]

◆ RadialGradientBrush() [4/5]

◆ RadialGradientBrush() [5/5]

Member Function Documentation

◆ GetParameters() [1/2]

◆ GetParameters() [2/2]

◆ operator=() [1/2]

◆ operator=() [2/2]