cil::LegendPass Class Reference

#include <legend.h>

Inheritance diagram for cil::LegendPass:

Public Member Functions
	LegendPass (const std::shared_ptr< Vector2i > &backgroundSize)
virtual	~LegendPass ()
int	width () const
void	setWidth (int width)
int	height () const
void	setHeight (int height)
int	spacing () const
void	setSpacing (int spacing)
int	barWidth () const
void	setBarWidth (int width)
int	titleFontSize () const
void	setTitleFontSize (int size)
std::string	titleFontFamily ()
void	setTitleFontFamily (const std::string &family)
Color3f	titleFontColor () const
void	setTitleFontColor (const Color3f &color)
int	labelFontSize () const
void	setLabelFontSize (int size)
std::string	labelFontFamily ()
void	setLabelFontFamily (const std::string &family)
Color3f	labelFontColor () const
void	setLabelFontColor (const Color3f &color)
std::shared_ptr< Legend >	add (const std::string &title, const std::shared_ptr< Image2D > &image)
void	remove (const std::shared_ptr< Legend > &legend)
void	clear ()
std::shared_ptr< Legend >	hit (const Vector2i &coord, float devicePixelRatio)
void	generate ()
void	resize ()
Public Member Functions inherited from cil::Pass
	Pass ()
void	update (UpdateMode mode=UpdateMode::All)
void	updateAsset ()
void	updateBatch ()
void	updateTrans ()
Public Member Functions inherited from cil::Object
	Object ()
virtual	~Object ()

Additional Inherited Members
Public Types inherited from cil::Pass
enum class	UpdateMode {   None = 0 , Asset = 1 , Batch = 2 , Trans = 4 ,   All = Asset | Batch | Trans }
Public Attributes inherited from cil::Pass
std::string	name
	This memeber stores the name of the pass.
bool	enabled
	This member indicates whether the pass is currently enabled. Disabled passes are skipped during rendering.
std::shared_ptr< Background >	background
	This member holds a shared pointer to a Background object which defines the scene background.
std::shared_ptr< Camera >	camera
	This member holds a shared pointer to a Camera object which the current pass uses for rendering.
std::shared_ptr< Node >	node
	This member holds a shared pointer to a Node object which represents the rendering objects of the current pass.
std::shared_ptr< Target >	target
	This member holds a shared pointer to a Target object which stores the rendering results, such as a buffer or texture.
int	assetVersion
int	batchVersion
int	transVersion

Constructor & Destructor Documentation

LegendPass()

cil::LegendPass::LegendPass

(

const std::shared_ptr< Vector2i > &

backgroundSize

)

~LegendPass()

virtual cil::LegendPass::~LegendPass ( )

virtual

Member Function Documentation

add()

std::shared_ptr< Legend > cil::LegendPass::add	(	const std::string &	title,
		const std::shared_ptr< Image2D > &	image )

barWidth()

int cil::LegendPass::barWidth

(

)

const

clear()

void cil::LegendPass::clear

(

)

generate()

void cil::LegendPass::generate

(

)

height()

int cil::LegendPass::height

(

)

const

hit()

std::shared_ptr< Legend > cil::LegendPass::hit	(	const Vector2i &	coord,
		float	devicePixelRatio )

labelFontColor()

Color3f cil::LegendPass::labelFontColor

(

)

const

labelFontFamily()

std::string cil::LegendPass::labelFontFamily

(

)

labelFontSize()

int cil::LegendPass::labelFontSize

(

)

const

remove()

void cil::LegendPass::remove

(

const std::shared_ptr< Legend > &

legend

)

resize()

void cil::LegendPass::resize

(

)

setBarWidth()

void cil::LegendPass::setBarWidth

(

int

width

)

setHeight()

void cil::LegendPass::setHeight

(

int

height

)

setLabelFontColor()

void cil::LegendPass::setLabelFontColor

(

const Color3f &

color

)

setLabelFontFamily()

void cil::LegendPass::setLabelFontFamily

(

const std::string &

family

)

setLabelFontSize()

void cil::LegendPass::setLabelFontSize

(

int

size

)

setSpacing()

void cil::LegendPass::setSpacing

(

int

spacing

)

setTitleFontColor()

void cil::LegendPass::setTitleFontColor

(

const Color3f &

color

)

setTitleFontFamily()

void cil::LegendPass::setTitleFontFamily

(

const std::string &

family

)

setTitleFontSize()

void cil::LegendPass::setTitleFontSize

(

int

size

)

setWidth()

void cil::LegendPass::setWidth

(

int

width

)

spacing()

int cil::LegendPass::spacing

(

)

const

titleFontColor()

Color3f cil::LegendPass::titleFontColor

(

)

const

titleFontFamily()

std::string cil::LegendPass::titleFontFamily

(

)

titleFontSize()

int cil::LegendPass::titleFontSize

(

)

const

width()

int cil::LegendPass::width

(

)

const