pcl::CanvasColor Class Reference

A set of color values used to fill free or unused areas of images. More...

#include <CanvasColor.h>

Public Member Functions
	CanvasColor ()=default
	CanvasColor (const CanvasColor &)=default
void	GetCanvasColor (float &v0, float &v1, float &v2) const
void	GetCanvasColor (float &v0, float &v1, float &v2, float &v3) const
void	GetCanvasColor (float *v) const
CanvasColor &	operator= (const CanvasColor &)=default
void	SetCanvasColor (const float *v)
void	SetCanvasColor (float v)
void	SetCanvasColor (float v0, float v1, float v2)
void	SetCanvasColor (float v0, float v1, float v2, float v3)

Detailed Description

Some geometric image transformations, such as rotations and translations for example, generate images with uncovered regions. CanvasColor defines a set of color components to initialize pixels on such unused areas.

CanvasColor stores pixel values in a normalized floating-point format suitable to be used for any pixel sample data type. When using CanvasColor with integer-sampled images, color components should be kept normalized in the normalized [0,1] range.

Definition at line 77 of file CanvasColor.h.

Constructor & Destructor Documentation

CanvasColor() [1/2]

pcl::CanvasColor::CanvasColor ( )

default

Constructs a CanvasColor object with zero (black) color components.

CanvasColor() [2/2]

pcl::CanvasColor::CanvasColor ( const CanvasColor &  )

default

Copy constructor.

Member Function Documentation

GetCanvasColor() [1/3]

void pcl::CanvasColor::GetCanvasColor ( float &  v0, float &  v1, float &  v2  ) const

inline

Retrieves the current RGB sample values in this CanvasColor object.

Parameters

[out]

v0,v1,v2

References to variables that will receive current sample values for the red/gray, green and blue channels, respectively.

Definition at line 103 of file CanvasColor.h.

GetCanvasColor() [2/3]

void pcl::CanvasColor::GetCanvasColor ( float &  v0, float &  v1, float &  v2, float &  v3  ) const

inline

Retrieves the current RGBA sample values in this CanvasColor object.

Parameters

[out]

v0,v1,v2,v3

References to variables that will receive current sample values for the red/gray, green, blue and alpha channels, respectively.

Definition at line 115 of file CanvasColor.h.

GetCanvasColor() [3/3]

void pcl::CanvasColor::GetCanvasColor ( float *  v ) const

inline

Retrieves the current sample values in this CanvasColor object.

Parameters

[out]

v

Starting address of an array where current sample values will be copied. This array must provide storage for at least four elements.

Definition at line 127 of file CanvasColor.h.

operator=()

CanvasColor& pcl::CanvasColor::operator= ( const CanvasColor &  )

default

Copy assignment operator. Returns a reference to this object.

SetCanvasColor() [1/4]

void pcl::CanvasColor::SetCanvasColor ( const float *  v )

inline

Sets current sample values for this CanvasColor object.

Parameters

v	Starting address of an array from which new sample values will be obtained. At least four elements are required.

Definition at line 162 of file CanvasColor.h.

SetCanvasColor() [2/4]

void pcl::CanvasColor::SetCanvasColor ( float  v )

inline

Sets all sample values of this CanvasColor object equal to an specified value v.

Definition at line 171 of file CanvasColor.h.

SetCanvasColor() [3/4]

void pcl::CanvasColor::SetCanvasColor ( float  v0, float  v1, float  v2  )

inline

Sets current RGB sample values for this CanvasColor object.

Parameters

v0,v1,v2

New red/gray, green and blue sample values.

Note

The alpha component will be set to one (white, opaque).

Definition at line 139 of file CanvasColor.h.

SetCanvasColor() [4/4]

void pcl::CanvasColor::SetCanvasColor ( float  v0, float  v1, float  v2, float  v3  )

inline

Sets current RGB sample values for this CanvasColor object.

Parameters

v0,v1,v2,v3

New red/gray, green, blue and alpha sample values.

Note

The alpha component will be set to one (white, opaque).

Definition at line 151 of file CanvasColor.h.

---

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

• CanvasColor.h