pcl::ConicalGradientBrush Class Reference

Conical gradient brush. More...

#include <Brush.h>

Inheritance diagram for pcl::ConicalGradientBrush:

Public Types
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
	ConicalGradientBrush (ConicalGradientBrush &&x)
	ConicalGradientBrush (const ConicalGradientBrush &b)
	ConicalGradientBrush (const DPoint &c, double a, const stop_list &stops=stop_list())
	ConicalGradientBrush (const Point &c, double a, const stop_list &stops=stop_list())
	ConicalGradientBrush (double cx, double cy, double a, const stop_list &stops=stop_list())
void	GetParameters (double &cx, double &cy, double &a) const
void	GetParameters (DPoint &c, double &a) const
ConicalGradientBrush &	operator= (ConicalGradientBrush &&x)
ConicalGradientBrush &	operator= (const ConicalGradientBrush &b)
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 ConicalGradientBrush.

See also

Brush, GradientBrush, LinearGradientBrush, RadialGradientBrush

Definition at line 709 of file Brush.h.

Member Typedef Documentation

stop_list

using pcl::ConicalGradientBrush::stop_list = GradientBrush::stop_list

Represents a list of gradient stops.

Definition at line 716 of file Brush.h.

Constructor & Destructor Documentation

ConicalGradientBrush() [1/5]

pcl::ConicalGradientBrush::ConicalGradientBrush	(	double	cx,
		double	cy,
		double	a,
		const stop_list &	stops = stop_list()
	)

Constructs a ConicalGradientBrush object.

Parameters

cx,cy	Coordinates of the gradient's center.
a	Gradient's angle in radians.
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}.

ConicalGradientBrush() [2/5]

pcl::ConicalGradientBrush::ConicalGradientBrush	(	const DPoint &	c,
		double	a,
		const stop_list &	stops = stop_list()
	)

Constructs a ConicalGradientBrush object.

This is an overloaded constructor, provided for convenience. It behaves like the preceding constructor, except the conical gradient parameters specified as a center point c and angle a in radians.

ConicalGradientBrush() [3/5]

pcl::ConicalGradientBrush::ConicalGradientBrush	(	const Point &	c,
		double	a,
		const stop_list &	stops = stop_list()
	)

Constructs a ConicalGradientBrush object.

This is an overloaded constructor, provided for convenience. It behaves like the preceding constructor, except the conical gradient parameters specified as a center point c and angle a in radians.

ConicalGradientBrush() [4/5]

pcl::ConicalGradientBrush::ConicalGradientBrush ( const ConicalGradientBrush &  b )

inline

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

Definition at line 753 of file Brush.h.

ConicalGradientBrush() [5/5]

pcl::ConicalGradientBrush::ConicalGradientBrush ( ConicalGradientBrush &&  x )

inline

Move constructor.

Definition at line 761 of file Brush.h.

Member Function Documentation

GetParameters() [1/2]

void pcl::ConicalGradientBrush::GetParameters	(	double &	cx,
		double &	cy,
		double &	a
	)		const

Retrieves the conical gradient parameters of this object.

Parameters

[out]	cx,cy	Coordinates of the gradient's center.
[out]	a	Gradient's angle in radians.

See also

GetParameters( DPoint&, double& )

GetParameters() [2/2]

void pcl::ConicalGradientBrush::GetParameters ( DPoint &  c, double &  a  ) const

inline

Returns the conical gradient parameters of this object.

This is an overloaded function, provided for convenience. It behaves like the preceding function, except the center coordinates are retrieved as a DPoint object.

See also

GetParameters( double&, double&, double& )

Definition at line 807 of file Brush.h.

operator=() [1/2]

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

inline

Move assignment operator. Returns a reference to this object.

Definition at line 782 of file Brush.h.

operator=() [2/2]

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

inline

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 773 of file Brush.h.

---

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

• Brush.h