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

Brush. More...

#include <eVision/Easy/EBrush.h>

Collaboration diagram for eVision::EBrush:

Public Member Functions

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

Public Attributes

eVision::ERGBColor Color
 Color of the brush.
float Opacity
 Opacity of the brush.

Detailed Description

Brush.

License(s): None

Constructor & Destructor Documentation

◆ EBrush() [1/3]

eVision::EBrush::EBrush ( )

Constructs an EBrush.

◆ EBrush() [2/3]

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

Constructs an EBrush.

Parameters
colorBrush color
opacityBrush opacity

◆ EBrush() [3/3]

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

Constructs an EBrush.

Parameters
colorBrush color

Member Function Documentation

◆ IsValid()

bool eVision::EBrush::IsValid ( ) const

Whether the brush is valid, i.e. when its color is defined.

◆ Load() [1/2]

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

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

Parameters
pathThe file path.

◆ Load() [2/2]

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

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

Parameters
serializerThe serializer.

◆ operator!=()

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

Inequality operator.

Parameters
otherOther brush to compare with.

◆ operator==()

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

Equality operator.

Parameters
otherOther brush to compare with.

◆ Save() [1/2]

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

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

Parameters
pathThe file path.

◆ Save() [2/2]

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

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

Parameters
serializerThe ESerializer object that is written to.

◆ Serialize()

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

Serializes the EBrush.

Parameters
serializerSerializer
Deprecated

Use EBrush::Save or EBrush::Load instead.

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

Member Data Documentation

◆ Color

eVision::ERGBColor eVision::EBrush::Color

Color of the brush.

◆ Opacity

float eVision::EBrush::Opacity

Opacity of the brush.