Client-side interface to a PixInsight Pen object.
More...
#include <Pen.h>
|
using | cap = PenCap::value_type |
|
using | join = PenJoin::value_type |
|
using | style = PenStyle::value_type |
|
TODO: Write a detailed description for Pen.
Definition at line 162 of file Pen.h.
◆ cap
using pcl::Pen::cap = PenCap::value_type |
Represents a pen cap style.
Definition at line 174 of file Pen.h.
◆ join
using pcl::Pen::join = PenJoin::value_type |
Represents a pen join style.
Definition at line 179 of file Pen.h.
◆ style
using pcl::Pen::style = PenStyle::value_type |
Represents a pen drawing style.
Definition at line 169 of file Pen.h.
◆ Pen() [1/2]
pcl::Pen::Pen |
( |
RGBA |
color = 0xff000000 , |
|
|
float |
width = 0 , |
|
|
style |
s = PenStyle::Solid , |
|
|
cap |
c = PenCap::Square , |
|
|
join |
j = PenJoin::Miter |
|
) |
| |
Constructs a Pen object with the specified color, width in pixels, and drawing, cap and join styles.
◆ Pen() [2/2]
pcl::Pen::Pen |
( |
const Pen & |
p | ) |
|
|
inline |
Copy constructor. This object will reference the same server-side pen as the specified instance p.
Definition at line 192 of file Pen.h.
◆ ~Pen()
Destroys a Pen object. If this object references an existing pen in the PixInsight core application, its reference count is decremented. If it becomes unreferenced, it will be garbage-collected.
Definition at line 201 of file Pen.h.
◆ Brush()
◆ Cap()
cap pcl::Pen::Cap |
( |
| ) |
const |
Returns the current pen cap style.
- See also
- SetCap()
◆ Color()
RGBA pcl::Pen::Color |
( |
| ) |
const |
Returns the pen color as a 32-bit AARRGGBB pixel color value.
- See also
- SetColor()
◆ GetBrush()
◆ IsEmpty()
bool pcl::Pen::IsEmpty |
( |
| ) |
const |
|
inline |
Returns true iff this pen draws no strokes, i.e. if the current pen drawing style is PenStyle::Empty.
- See also
- IsSolid(), Style()
Definition at line 284 of file Pen.h.
◆ IsSolid()
bool pcl::Pen::IsSolid |
( |
| ) |
const |
|
inline |
Returns true iff this pen draws solid strokes, i.e. if the current pen drawing style is PenStyle::Solid.
- See also
- IsEmpty(), Style()
Definition at line 273 of file Pen.h.
◆ Join()
join pcl::Pen::Join |
( |
| ) |
const |
Returns the current pen join style.
- See also
- SetJoin()
◆ Null()
static Pen& pcl::Pen::Null |
( |
| ) |
|
|
static |
Returns a reference to a null pen. A null Pen object does not correspond to an existing pen object in the PixInsight core application.
◆ operator=()
Pen& pcl::Pen::operator= |
( |
const Pen & |
p | ) |
|
|
inline |
Assignment operator. Returns a reference to this object.
Makes this object reference the same server-side pen as the specified instance p. If the previous pen becomes unreferenced, it will be garbage-collected by the PixInsight core application.
Definition at line 212 of file Pen.h.
◆ SetBrush()
void pcl::Pen::SetBrush |
( |
const pcl::Brush & |
brush | ) |
|
Sets the current pen brush
- See also
- Brush()
◆ SetCap()
void pcl::Pen::SetCap |
( |
cap |
c | ) |
|
Sets the current pen cap style.
- See also
- Cap()
◆ SetColor()
void pcl::Pen::SetColor |
( |
RGBA |
color | ) |
|
Sets the pen color as a 32-bit AARRGGBB pixel color value.
- See also
- Color()
◆ SetJoin()
void pcl::Pen::SetJoin |
( |
join |
j | ) |
|
Sets the current pen join style.
- See also
- Join()
◆ SetStyle()
void pcl::Pen::SetStyle |
( |
style |
| ) |
|
◆ SetWidth()
void pcl::Pen::SetWidth |
( |
float |
w | ) |
|
Sets the pen width in pixels.
A zero width means that this is a cosmetic pen. Cosmetic pens always draw one-pixel strokes, regardless of the transformation applied to the graphics context where they are applied.
- See also
- Width()
◆ Style()
style pcl::Pen::Style |
( |
| ) |
const |
◆ Width()
float pcl::Pen::Width |
( |
| ) |
const |
Returns the pen width in pixels.
A zero width means that this is a cosmetic pen. Cosmetic pens always draw one-pixel strokes, regardless of the transformation applied to the graphics context where they are applied.
- See also
- SetWidth()
The documentation for this class was generated from the following file: