eVision C++ API 26.10.0-beta.2.dev
Loading...
Searching...
No Matches
eVision::EPen Struct Reference

Pen. More...

#include <eVision/Easy/EPen.h>

Collaboration diagram for eVision::EPen:

Public Member Functions

 EPen ()
 Constructs an EPen.
 EPen (const eVision::ERGBColor &color, int32_t width, eVision::EPenStyle style)
 Constructs an EPen.
 EPen (const eVision::ERGBColor &color, int32_t width)
 Constructs an EPen.
 EPen (const eVision::ERGBColor &color)
 Constructs an EPen.
 EPen (const eVision::ERGBColor &color, float opacity, int32_t width, eVision::EPenStyle style)
 Constructs an EPen.
 EPen (const eVision::ERGBColor &color, float opacity, int32_t width)
 Constructs an EPen.
 EPen (const eVision::ERGBColor &color, float opacity)
 Constructs an EPen.
 EPen (const eVision::EBrush &brush, int32_t width, eVision::EPenStyle style)
 Constructs an EPen.
 EPen (const eVision::EBrush &brush, int32_t width)
 Constructs an EPen.
 EPen (const eVision::EBrush &brush)
 Constructs an EPen.
bool operator== (const eVision::EPen &other) const
 Equality operator.
bool operator!= (const eVision::EPen &other) const
 Inequality operator.
bool IsValid () const
 Whether the pen is valid, i.e. when its brush is valid and its width is bigger than 0.
void Serialize (eVision::ESerializer *serializer)
 Serializes the EPen.
void Load (const std::string &path)
 Loads the EPen. The given ESerializer must have been created for reading.
void Load (eVision::ESerializer *serializer)
 Loads the EPen. The given ESerializer must have been created for reading.
void Save (const std::string &path)
 Saves the EPen. The given ESerializer must have been created for writing.
void Save (eVision::ESerializer *serializer)
 Saves the EPen. The given ESerializer must have been created for writing.

Public Attributes

eVision::EBrush Brush
 Brush used to draw the content of the pen.
int32_t Width
 Width of the pen.
eVision::EPenStyle Style
 Style of the pen.

Detailed Description

Pen.

License(s): None

Constructor & Destructor Documentation

◆ EPen() [1/10]

eVision::EPen::EPen ( )

Constructs an EPen.

◆ EPen() [2/10]

eVision::EPen::EPen ( const eVision::ERGBColor & color,
int32_t width,
eVision::EPenStyle style )

Constructs an EPen.

Parameters
colorColor of the pen.
widthWidth of the pen.
styleStyle of the pen.

◆ EPen() [3/10]

eVision::EPen::EPen ( const eVision::ERGBColor & color,
int32_t width )

Constructs an EPen.

Parameters
colorColor of the pen.
widthWidth of the pen.

◆ EPen() [4/10]

eVision::EPen::EPen ( const eVision::ERGBColor & color)

Constructs an EPen.

Parameters
colorColor of the pen.

◆ EPen() [5/10]

eVision::EPen::EPen ( const eVision::ERGBColor & color,
float opacity,
int32_t width,
eVision::EPenStyle style )

Constructs an EPen.

Parameters
colorColor of the pen.
opacityopacity of the pen.
widthWidth of the pen.
styleStyle of the pen.

◆ EPen() [6/10]

eVision::EPen::EPen ( const eVision::ERGBColor & color,
float opacity,
int32_t width )

Constructs an EPen.

Parameters
colorColor of the pen.
opacityopacity of the pen.
widthWidth of the pen.

◆ EPen() [7/10]

eVision::EPen::EPen ( const eVision::ERGBColor & color,
float opacity )

Constructs an EPen.

Parameters
colorColor of the pen.
opacityopacity of the pen.

◆ EPen() [8/10]

eVision::EPen::EPen ( const eVision::EBrush & brush,
int32_t width,
eVision::EPenStyle style )

Constructs an EPen.

Parameters
brushBrush of the pen.
widthWidth of the pen.
styleStyle of the pen.

◆ EPen() [9/10]

eVision::EPen::EPen ( const eVision::EBrush & brush,
int32_t width )

Constructs an EPen.

Parameters
brushBrush of the pen.
widthWidth of the pen.

◆ EPen() [10/10]

eVision::EPen::EPen ( const eVision::EBrush & brush)

Constructs an EPen.

Parameters
brushBrush of the pen.

Member Function Documentation

◆ IsValid()

bool eVision::EPen::IsValid ( ) const

Whether the pen is valid, i.e. when its brush is valid and its width is bigger than 0.

◆ Load() [1/2]

void eVision::EPen::Load ( const std::string & path)

Loads the EPen. The given ESerializer must have been created for reading.

Parameters
pathThe file path.

◆ Load() [2/2]

void eVision::EPen::Load ( eVision::ESerializer * serializer)

Loads the EPen. The given ESerializer must have been created for reading.

Parameters
serializerThe serializer.

◆ operator!=()

bool eVision::EPen::operator!= ( const eVision::EPen & other) const

Inequality operator.

Parameters
otherOther pen to compare with.

◆ operator==()

bool eVision::EPen::operator== ( const eVision::EPen & other) const

Equality operator.

Parameters
otherOther pen to compare with.

◆ Save() [1/2]

void eVision::EPen::Save ( const std::string & path)

Saves the EPen. The given ESerializer must have been created for writing.

Parameters
pathThe file path.

◆ Save() [2/2]

void eVision::EPen::Save ( eVision::ESerializer * serializer)

Saves the EPen. The given ESerializer must have been created for writing.

Parameters
serializerThe ESerializer object that is written to.

◆ Serialize()

void eVision::EPen::Serialize ( eVision::ESerializer * serializer)

Serializes the EPen.

Parameters
serializerSerializer
Deprecated

Use EPen::Save or EPen::Load instead.

Deprecated in version 24.10. Scheduled to be removed in version 27.6.

Member Data Documentation

◆ Brush

eVision::EBrush eVision::EPen::Brush

Brush used to draw the content of the pen.

◆ Style

eVision::EPenStyle eVision::EPen::Style

Style of the pen.

◆ Width

int32_t eVision::EPen::Width

Width of the pen.