#include <Canvas.h>

Inherited by Freestyle::AppCanvas.

Public Types
typedef std::map< const char , ImagePyramid , ltstr >	mapsMap

Public Member Functions
	Canvas ()

	Canvas (const Canvas &iBrother)

virtual	~Canvas ()

virtual void	preDraw ()

virtual void	Draw ()

virtual void	postDraw ()

virtual void	Render (const StrokeRenderer *iRenderer)

virtual void	RenderBasic (const StrokeRenderer *iRenderer)

virtual void	RenderStroke (Stroke *iStroke)=0

virtual void	init ()=0

void	Clear ()

virtual void	Erase ()

virtual void	readColorPixels (int x, int y, int w, int h, RGBImage &oImage) const =0

virtual void	readDepthPixels (int x, int y, int w, int h, GrayImage &oImage) const =0

virtual void	update ()=0

bool	isEmpty () const

void	loadMap (const char iFileName, const char iMapName, uint iNbLevels=4, float iSigma=1.0f)

float	readMapPixel (const char *iMapName, int level, int x, int y)

void	loadSteerableViewMap (SteerableViewMap *iSVM)

SteerableViewMap *	getSteerableViewMap ()

const FEdge *	selectedFEdge () const

FEdge *	selectedFEdge ()

virtual int	width () const =0

virtual int	height () const =0

virtual BBox< Vec2i >	border () const =0

virtual BBox< Vec3r >	scene3DBBox () const =0

const StrokeRenderer *	renderer () const

StyleModule *	getCurrentStyleModule ()

virtual bool	getRecordFlag () const

int	getStrokeCount () const

void	setSelectedFEdge (FEdge *iFEdge)

void	PushBackStyleModule (StyleModule *iStyleModule)

void	InsertStyleModule (uint index, StyleModule *iStyleModule)

void	RemoveStyleModule (uint index)

void	SwapStyleModules (uint i1, uint i2)

void	ReplaceStyleModule (uint index, StyleModule *iStyleModule)

void	setVisible (uint index, bool iVisible)

void	AddLayer (StrokeLayer *iLayer)

void	resetModified (bool iMod=false)

void	causalStyleModules (std::vector< uint > &vec, uint index=0)

void	setModified (uint index, bool iMod)

Static Public Member Functions
static Canvas *	getInstance ()

Static Public Attributes
static const int	NB_STEERABLE_VIEWMAP = 5

Protected Attributes
std::deque< StrokeLayer * >	_Layers

std::deque< StyleModule * >	_StyleModules

FEdge *	_SelectedFEdge

StrokeRenderer *	_Renderer

StyleModule *	_current_sm

mapsMap	_maps

SteerableViewMap *	_steerableViewMap

bool	_basic

int	stroke_count

Static Protected Attributes
static Canvas *	_pInstance = nullptr

static const char *	_MapsPath = nullptr

Detailed Description

Class to define the canvas on which strokes are drawn. It's used to store state information about the drawing.

Definition at line 54 of file Canvas.h.

Member Typedef Documentation

◆ mapsMap

typedef std::map<const char *, ImagePyramid *, ltstr> Freestyle::Canvas::mapsMap

Definition at line 62 of file Canvas.h.

Constructor & Destructor Documentation

◆ Canvas() [1/2]

Freestyle::Canvas::Canvas ( )

Definition at line 45 of file Canvas.cpp.

References _basic, _current_sm, _pInstance, _Renderer, _SelectedFEdge, _steerableViewMap, Freestyle::PseudoNoise::init(), and NB_STEERABLE_VIEWMAP.

◆ Canvas() [2/2]

Freestyle::Canvas::Canvas ( const Canvas & iBrother )

Definition at line 56 of file Canvas.cpp.

References _basic, _current_sm, _pInstance, _Renderer, _SelectedFEdge, _steerableViewMap, and Freestyle::PseudoNoise::init().

◆ ~Canvas()

Freestyle::Canvas::~Canvas ( )

virtual

Definition at line 67 of file Canvas.cpp.

References _maps, _pInstance, _Renderer, _steerableViewMap, and Clear().

Member Function Documentation

◆ AddLayer()

void Freestyle::Canvas::AddLayer ( StrokeLayer * iLayer )

inline

Definition at line 227 of file Canvas.h.

References _Layers.

◆ border()

virtual BBox< Vec2i > Freestyle::Canvas::border ( ) const

pure virtual

Implemented in Freestyle::AppCanvas.

Referenced by Freestyle::ContextFunctions::GetBorderCF().

◆ causalStyleModules()

void Freestyle::Canvas::causalStyleModules	(	std::vector< uint > &	vec,
		uint	index = 0 )

Definition at line 274 of file Canvas.cpp.

References _StyleModules, and size().

Referenced by Freestyle::Controller::updateCausalStyleModules().

◆ Clear()

void Freestyle::Canvas::Clear ( )

Definition at line 120 of file Canvas.cpp.

References _Layers, _steerableViewMap, _StyleModules, Freestyle::SteerableViewMap::Reset(), and stroke_count.

Referenced by Freestyle::Controller::Clear(), Freestyle::Controller::CloseFile(), and ~Canvas().

◆ Draw()

void Freestyle::Canvas::Draw ( )

virtual

Definition at line 88 of file Canvas.cpp.

References _current_sm, _Layers, _StyleModules, Freestyle::StyleModule::execute(), Freestyle::TimeStamp::increment(), Freestyle::TimeStamp::instance(), postDraw(), preDraw(), stroke_count, and Freestyle::StrokeLayer::strokes_size().

Referenced by Freestyle::Controller::DrawStrokes().

◆ Erase()

void Freestyle::Canvas::Erase ( )

virtual

Reimplemented in Freestyle::AppCanvas.

Definition at line 151 of file Canvas.cpp.

References _Layers, _steerableViewMap, Freestyle::SteerableViewMap::Reset(), stroke_count, and update().

Referenced by Freestyle::AppCanvas::Erase().

◆ getCurrentStyleModule()

StyleModule * Freestyle::Canvas::getCurrentStyleModule ( )

inline

Definition at line 191 of file Canvas.h.

References _current_sm.

◆ getInstance()

static Canvas * Freestyle::Canvas::getInstance ( )

inlinestatic

Returns a pointer on the Canvas instance

Definition at line 57 of file Canvas.h.

References _pInstance.

Referenced by Freestyle::ContextFunctions::GetBorderCF(), Freestyle::ContextFunctions::GetCanvasHeightCF(), Freestyle::ContextFunctions::GetCanvasWidthCF(), Freestyle::ContextFunctions::GetSelectedFEdgeCF(), Freestyle::ContextFunctions::LoadMapCF(), Freestyle::Functions0D::DensityF0D::operator()(), Freestyle::Functions0D::GetViewMapGradientNormF0D::operator()(), Freestyle::Functions0D::LocalAverageDepthF0D::operator()(), Freestyle::Functions0D::ReadCompleteViewMapPixelF0D::operator()(), Freestyle::Functions0D::ReadMapPixelF0D::operator()(), Freestyle::Functions0D::ReadSteerableViewMapPixelF0D::operator()(), Freestyle::Functions1D::GetSteerableViewMapDensityF1D::operator()(), Freestyle::PSStrokeRenderer::PSStrokeRenderer(), Freestyle::ContextFunctions::ReadCompleteViewMapPixelCF(), Freestyle::ContextFunctions::ReadDirectionalViewMapPixelCF(), Freestyle::ContextFunctions::ReadMapPixelCF(), and Freestyle::TextStrokeRenderer::TextStrokeRenderer().

◆ getRecordFlag()

virtual bool Freestyle::Canvas::getRecordFlag ( ) const

inlinevirtual

Definition at line 196 of file Canvas.h.

◆ getSteerableViewMap()

SteerableViewMap * Freestyle::Canvas::getSteerableViewMap ( )

inline

Returns the steerable VM

Definition at line 165 of file Canvas.h.

References _steerableViewMap.

Referenced by Freestyle::Controller::ComputeSteerableViewMap(), Freestyle::Controller::displayDensityCurves(), Freestyle::Functions0D::GetViewMapGradientNormF0D::operator()(), Freestyle::Functions0D::ReadCompleteViewMapPixelF0D::operator()(), Freestyle::Functions0D::ReadSteerableViewMapPixelF0D::operator()(), Freestyle::Functions1D::GetSteerableViewMapDensityF1D::operator()(), Freestyle::ContextFunctions::ReadCompleteViewMapPixelCF(), Freestyle::ContextFunctions::ReadDirectionalViewMapPixelCF(), and Freestyle::Controller::saveSteerableViewMapImages().

◆ getStrokeCount()

int Freestyle::Canvas::getStrokeCount ( ) const

inline

Definition at line 201 of file Canvas.h.

References stroke_count.

Referenced by Freestyle::Controller::DrawStrokes().

◆ height()

virtual int Freestyle::Canvas::height ( ) const

pure virtual

Implemented in Freestyle::AppCanvas.

Referenced by Freestyle::ContextFunctions::GetCanvasHeightCF(), loadMap(), Freestyle::Functions0D::DensityF0D::operator()(), Freestyle::Functions0D::LocalAverageDepthF0D::operator()(), Freestyle::PSStrokeRenderer::PSStrokeRenderer(), readMapPixel(), and Freestyle::TextStrokeRenderer::TextStrokeRenderer().

◆ init()

virtual void Freestyle::Canvas::init ( )

pure virtual

Implemented in Freestyle::AppCanvas.

◆ InsertStyleModule()

void Freestyle::Canvas::InsertStyleModule	(	uint	index,
		StyleModule *	iStyleModule )

Definition at line 177 of file Canvas.cpp.

References _Layers, and _StyleModules.

Referenced by Freestyle::Controller::InsertStyleModule(), Freestyle::Controller::InsertStyleModule(), and Freestyle::Controller::InsertStyleModule().

◆ isEmpty()

bool Freestyle::Canvas::isEmpty ( ) const

inline

Definition at line 121 of file Canvas.h.

References _Layers.

◆ loadMap()

void Freestyle::Canvas::loadMap	(	const char *	iFileName,
		const char *	iMapName,
		uint	iNbLevels = 4,
		float	iSigma = 1.0f )

Loads an image map. The map will be scaled (without preserving the ratio in order to fit the actual canvas size.). The image must be a gray values image...

Parameters

iFileName	The name of the image file
iMapName	The name that will be used to access this image
iNbLevels	The number of levels in the map pyramid. (default = 4). If iNbLevels == 0, the complete pyramid is built.

Definition at line 305 of file Canvas.cpp.

References _maps, _MapsPath, Box, ImBuf::byte_buffer, Freestyle::c, ImBufByteBuffer::data, ImBuf::ftype, Freestyle::ImagePyramid::getNumberOfLevels(), Freestyle::GaussianFilter::getSmoothedPixel(), height(), Freestyle::ImagePyramid::height(), IB_rect, IMB_allocImBuf(), IMB_dupImBuf(), IMB_FTYPE_BMP, IMB_loadiffname(), IMB_saveiff(), IMB_scale(), int, Freestyle::ImagePyramid::pixel(), Freestyle::GrayImage::setPixel(), w(), width(), Freestyle::ImagePyramid::width(), Freestyle::x, and y.

Referenced by Freestyle::ContextFunctions::LoadMapCF().

◆ loadSteerableViewMap()

void Freestyle::Canvas::loadSteerableViewMap ( SteerableViewMap * iSVM )

inline

Sets the steerable viewmap

Definition at line 159 of file Canvas.h.

References _steerableViewMap.

◆ postDraw()

void Freestyle::Canvas::postDraw ( )

virtual

Reimplemented in Freestyle::AppCanvas.

Definition at line 115 of file Canvas.cpp.

References update().

Referenced by Draw(), and Freestyle::AppCanvas::postDraw().

◆ preDraw()

void Freestyle::Canvas::preDraw ( )

virtual

Reimplemented in Freestyle::AppCanvas.

Definition at line 86 of file Canvas.cpp.

Referenced by Draw(), and Freestyle::AppCanvas::preDraw().

◆ PushBackStyleModule()

void Freestyle::Canvas::PushBackStyleModule ( StyleModule * iStyleModule )

inserts a shader at pos index+1

Definition at line 170 of file Canvas.cpp.

References _Layers, and _StyleModules.

◆ readColorPixels()

virtual void Freestyle::Canvas::readColorPixels	(	int	x,
		int	y,
		int	w,
		int	h,
		RGBImage &	oImage ) const

pure virtual

Implemented in Freestyle::AppCanvas.

Referenced by Freestyle::Functions0D::DensityF0D::operator()().

◆ readDepthPixels()

virtual void Freestyle::Canvas::readDepthPixels	(	int	x,
		int	y,
		int	w,
		int	h,
		GrayImage &	oImage ) const

pure virtual

Implemented in Freestyle::AppCanvas.

Referenced by Freestyle::Functions0D::LocalAverageDepthF0D::operator()().

◆ readMapPixel()

float Freestyle::Canvas::readMapPixel	(	const char *	iMapName,
		int	level,
		int	x,
		int	y )

Reads a pixel value in a map. Returns a value between 0 and 1.

Parameters

iMapName	The name of the map
level	The level of the pyramid from which the pixel must be read.
x	The abscissa of the desired pixel specified in level0 coordinate system. The origin is the lower left corner.
y	The ordinate of the desired pixel specified in level0 coordinate system. The origin is the lower left corner.

Definition at line 452 of file Canvas.cpp.

References _maps, G, G_DEBUG_FREESTYLE, height(), Freestyle::ImagePyramid::height(), Freestyle::ImagePyramid::pixel(), and Freestyle::ImagePyramid::width().

Referenced by Freestyle::Functions0D::ReadMapPixelF0D::operator()(), and Freestyle::ContextFunctions::ReadMapPixelCF().