mm::PdfColor Class Reference

#include <PdfColor.h>

Inherited by mm::PdfColorCMYK, mm::PdfColorCieLab, mm::PdfColorGray, mm::PdfColorRGB, mm::PdfColorSeparation, mm::PdfColorSeparationAll, and mm::PdfColorSeparationNone.

Public Member Functions
	PdfColor ()
	PdfColor (double gray)
	PdfColor (double red, double green, double blue)
	PdfColor (double cyan, double magenta, double yellow, double black)
	PdfColor (const PdfColor &rhs)
virtual	~PdfColor ()
const PdfColor &	operator= (const PdfColor &rhs)
bool	operator== (const PdfColor &rhs) const
bool	operator!= (const PdfColor &rhs) const
bool	IsGrayScale () const
bool	IsRGB () const
bool	IsCMYK () const
bool	IsSeparation () const
bool	IsCieLab () const
PdfColorSpace	GetColorSpace () const
PdfColorSpace	GetAlternateColorSpace () const
double	GetGrayScale () const
double	GetRed () const
double	GetGreen () const
double	GetBlue () const
double	GetCyan () const
double	GetMagenta () const
double	GetYellow () const
double	GetBlack () const
const std::string &	GetName () const
double	GetDensity () const
double	GetCieL () const
double	GetCieA () const
double	GetCieB () const
PdfColor	ConvertToGrayScale () const
PdfColor	ConvertToRGB () const
PdfColor	ConvertToCMYK () const
PdfArray	ToArray () const
PdfObject *	BuildColorSpace (PdfDocument &document) const

Static Public Member Functions
static PdfColor	FromString (const std::string_view &name)
static PdfColor	FromArray (const PdfArray &arr)
static PdfColorSpace	GetColorSpaceForName (const PdfName &name)

Detailed Description

A color object can represent either a grayscale value, a RGB color, a CMYK color, a separation color or a CieLab color.

All drawing functions in pdfmm accept a PdfColor object to specify a drawing color in one of these colorspaces.

Derived classes PdfColorGray, PdfColorRGB, PdfColorCMYK, PdfColorSeparation and PdfColorCieLab are available for easy construction

Constructor & Destructor Documentation

PdfColor() [1/5]

PdfColor::PdfColor

(

)

Create a PdfColor object that is RGB black.

PdfColor() [2/5]

PdfColor::PdfColor ( double  gray )

explicit

Create a new PdfColor object with a grayscale value.

Parameters

gray	a grayscale value between 0.0 and 1.0

PdfColor() [3/5]

PdfColor::PdfColor	(	double	red,
		double	green,
		double	blue
	)

Create a new PdfColor object with a RGB color

Parameters

red	the value of the red component, must be between 0.0 and 1.0
green	the value of the green component, must be between 0.0 and 1.0
blue	the value of the blue component, must be between 0.0 and 1.0

PdfColor() [4/5]

PdfColor::PdfColor	(	double	cyan,
		double	magenta,
		double	yellow,
		double	black
	)

Create a new PdfColor object with a CMYK color

Parameters

cyan	the value of the cyan component, must be between 0.0 and 1.0
magenta	the value of the magenta component, must be between 0.0 and 1.0
yellow	the value of the yellow component, must be between 0.0 and 1.0
black	the value of the black component, must be between 0.0 and 1.0

PdfColor() [5/5]

PdfColor::PdfColor

(

const PdfColor &

rhs

)

Copy constructor

Parameters

rhs	copy rhs into this object

~PdfColor()

PdfColor::~PdfColor ( )

virtual

Destructor

Member Function Documentation

BuildColorSpace()

PdfObject * PdfColor::BuildColorSpace

(

PdfDocument &

document

)

const

Creates a colorspace object from a color to insert into resources.

Parameters

document

a pointer to the owner document of the generated object

Returns

a PdfObject pointer, which can be insert into resources, nullptr if not needed

ConvertToCMYK()

PdfColor PdfColor::ConvertToCMYK

(

)

const

Converts the color object into a CMYK color object.

This is only a convenience function. It might be useful for on screen display but is in NO WAY suitable to professional printing!

Returns

a CMYK color object

See also

IsCMYK()

ConvertToGrayScale()

PdfColor PdfColor::ConvertToGrayScale

(

)

const

Converts the color object into a grayscale color object.

This is only a convenience function. It might be useful for on screen display but is in NO WAY suitable to professional printing!

Returns

a grayscale color object

See also

IsGrayScale()

ConvertToRGB()

PdfColor PdfColor::ConvertToRGB

(

)

const

Converts the color object into a RGB color object.

This is only a convenience function. It might be useful for on screen display but is in NO WAY suitable to professional printing!

Returns

a RGB color object

See also

IsRGB()

FromArray()

PdfColor PdfColor::FromArray ( const PdfArray &  arr )

static

Creates a color object from a PdfArray which represents a color.

Raises an exception if this is no PdfColor!

Parameters

arr	an array that must be a color PdfArray

Returns

a PdfColor object

FromString()

PdfColor PdfColor::FromString ( const std::string_view &  name )

static

Creates a color object from a string.

Parameters

name	a string describing a color.

Supported values are:

• single gray values as string (e.g. '0.5')
• a named color (e.g. 'aquamarine' or 'magenta')
• hex values (e.g. #FF002A (RGB) or #FF12AB3D (CMYK))
• PdfArray's

Returns

a PdfColor object

GetAlternateColorSpace()

PdfColorSpace PdfColor::GetAlternateColorSpace

(

)

const

Get the alternate colorspace of this PdfColor object

Returns

the colorspace of this PdfColor object (must be separation)

GetBlack()

double PdfColor::GetBlack

(

)

const

Get the black color value of this object.

Throws an exception if this is no CMYK or separation color object.

Returns

the black color value of this object (between 0.0 and 1.0)

See also

IsCMYK

GetBlue()

double PdfColor::GetBlue

(

)

const

Get the blue color value of this object.

Throws an exception if this is no RGB color object.

Returns

the blue color value of this object (between 0.0 and 1.0)

See also

IsRGB

GetCieA()

double PdfColor::GetCieA

(

)

const

Get the A color value of this object.

Throws an exception if this is no CIE-Lab color object.

Returns

the A color value of this object (between -128.0 and 127.0)

See also

IsCieLab

GetCieB()

double PdfColor::GetCieB

(

)

const

Get the B color value of this object.

Throws an exception if this is no CIE-Lab color object.

Returns

the B color value of this object (between -128.0 and 127.0)

See also

IsCieLab

GetCieL()

double PdfColor::GetCieL

(

)

const

Get the L color value of this object.

Throws an exception if this is no CIE-Lab color object.

Returns

the L color value of this object (between 0.0 and 100.0)

See also

IsCieLab

GetColorSpace()

PdfColorSpace mm::PdfColor::GetColorSpace ( ) const

inline

Get the colorspace of this PdfColor object

Returns

the colorspace of this PdfColor object

GetColorSpaceForName()

PdfColorSpace PdfColor::GetColorSpaceForName ( const PdfName &  name )

static

Convert a name into a colorspace enum.

Parameters

name	name representing a colorspace such as DeviceGray

Returns

colorspace enum or PdfColorSpace_Unknown if name is unknown

See also

GetNameForColorSpace

GetCyan()

double PdfColor::GetCyan

(

)

const

Get the cyan color value of this object.

Throws an exception if this is no CMYK or separation color object.

Returns

the cyan color value of this object (between 0.0 and 1.0)

See also

IsCMYK

GetDensity()

double PdfColor::GetDensity

(

)

const

Get the density color value of this object.

Throws an exception if this is no separation color object.

Returns

the density value of this object (between 0.0 and 1.0)

See also

IsSeparation

GetGrayScale()

double PdfColor::GetGrayScale

(

)

const

Get the grayscale color value of this object.

Throws an exception if this is no grayscale color object.

Returns

the grayscale color value of this object (between 0.0 and 1.0)

See also

IsGrayScale

GetGreen()

double PdfColor::GetGreen

(

)

const

Get the green color value of this object.

Throws an exception if this is no RGB color object.

Returns

the green color value of this object (between 0.0 and 1.0)

See also

IsRGB

GetMagenta()

double PdfColor::GetMagenta

(

)

const

Get the magenta color value of this object.

Throws an exception if this is no CMYK or separation color object.

Returns

the magenta color value of this object (between 0.0 and 1.0)

See also

IsCMYK

GetName()

const string & PdfColor::GetName

(

)

const

Get the separation name of this object.

Throws an exception if this is no separation color object.

Returns

the name of this object

See also

IsSeparation

GetRed()

double PdfColor::GetRed

(

)

const

Get the red color value of this object.

Throws an exception if this is no RGB color object.

Returns

the red color value of this object (between 0.0 and 1.0)

See also

IsRGB

GetYellow()

double PdfColor::GetYellow

(

)

const

Get the yellow color value of this object.

Throws an exception if this is no CMYK or separation color object.

Returns

the yellow color value of this object (between 0.0 and 1.0)

See also

IsCMYK

IsCieLab()

bool PdfColor::IsCieLab

(

)

const

Test if this is a CIE-Lab color.

Returns

true if this is a lab Color object

IsCMYK()

bool PdfColor::IsCMYK

(

)

const

Test if this is a CMYK color.

Returns

true if this is a CMYK PdfColor object

IsGrayScale()

bool PdfColor::IsGrayScale

(

)

const

Test if this is a grayscale color.

Returns

true if this is a grayscale PdfColor object

IsRGB()

bool PdfColor::IsRGB

(

)

const

Test if this is a RGB color.

Returns

true if this is a RGB PdfColor object

IsSeparation()

bool PdfColor::IsSeparation

(

)

const

Test if this is a separation color.

Returns

true if this is a separation PdfColor object

operator!=()

bool PdfColor::operator!=

(

const PdfColor &

rhs

)

const

Test for inequality of colors.

Parameters

rhs	color to compare to

Returns

true if object color is not equal to rhs

operator=()

const PdfColor & PdfColor::operator=

(

const PdfColor &

rhs

)

Assignment operator

Parameters

rhs	copy rhs into this object

Returns

a reference to this color object

operator==()

bool PdfColor::operator==

(

const PdfColor &

rhs

)

const

Test for equality of colors.

Parameters

rhs	color to compare to

Returns

true if object color is equal to rhs

ToArray()

PdfArray PdfColor::ToArray

(

)

const

Creates a PdfArray which represents a color from a color.

Returns

a PdfArray object