Film Class Reference

Holds all the operations regarding to input/output of colour information. More...

#include <Film.h>

Collaboration diagram for Film:

Public Member Functions
	Film ()
	Film constructor. More...
void	setDimensions (int _w, int _h)
	Sets the dimensions of the Film. More...
	~Film ()
	Destructor for the Film. More...
void	writePixel (ngl::Colour _colour)
	Will create a pixel and push it to the pixel vector. More...
void	writeFile (const char *_image_name)
	Iterates over the pixel vector and writes into a file using basic output stream methods. More...

Private Attributes
int	m_width
	Width of the Film's image. More...
int	m_height
	Height of the Film's image. More...
std::vector< Pixel >	m_pixels
	Vector of pixels. The index of the pixel corresponds to this equation: i = height * y + x. More...
std::ofstream	m_file
	File output stream, in charge of writing the pixels into a file. More...

Friends
class	Renderer

Detailed Description

Holds all the operations regarding to input/output of colour information.

Author

Ramon Blanquer

Definition at line 29 of file Film.h.

Constructor & Destructor Documentation

Film::Film

(

)

Film constructor.

Definition at line 7 of file Film.cpp.

{}

Film::~Film

(

)

Destructor for the Film.

Definition at line 9 of file Film.cpp.

{}

Member Function Documentation

void Film::setDimensions	(	int	_w,
		int	_h
	)

Sets the dimensions of the Film.

Parameters

[in]	_w	Width of the Film/Image.
[in]	_h	Height of the Film/Image.

Definition at line 11 of file Film.cpp.

References m_height, and m_width.

{
  m_width = _w;
  m_height = _h;
}

Here is the caller graph for this function:

void Film::writeFile

(

const char *

_image_name

)

Iterates over the pixel vector and writes into a file using basic output stream methods.

Parameters

[in]

_image_name

The file will be written with the name [_image_name].ppm

Definition at line 26 of file Film.cpp.

References m_file, m_height, m_pixels, and m_width.

{
  m_file.open(_image_name, std::ios::out | std::ios::binary);
  m_file << "P6\n" << m_width << " " << m_height << "\n255\n";

  for(unsigned int i = 0; i < m_pixels.size(); ++i)
  {
    m_file << (unsigned char) (m_pixels.at(i).r * 255) <<
              (unsigned char) (m_pixels.at(i).g * 255) <<
              (unsigned char) (m_pixels.at(i).b * 255);
  }

  m_file.close();
}

Here is the caller graph for this function:

void Film::writePixel

(

ngl::Colour

_colour

)

Will create a pixel and push it to the pixel vector.

Parameters

[in]

_colour

Colour that will be written in that pixel.

Definition at line 17 of file Film.cpp.

References Pixel::b, Pixel::g, m_pixels, and Pixel::r.

{
  Pixel curr;
  curr.r = _colour.m_r;
  curr.g = _colour.m_g;
  curr.b = _colour.m_b;
  m_pixels.push_back(curr);
}

Here is the caller graph for this function:

Friends And Related Function Documentation

friend class Renderer

friend

Definition at line 58 of file Film.h.

Member Data Documentation

std::ofstream Film::m_file

private

File output stream, in charge of writing the pixels into a file.

Definition at line 76 of file Film.h.

int Film::m_height

private

Height of the Film's image.

Definition at line 68 of file Film.h.

std::vector<Pixel> Film::m_pixels

private

Vector of pixels. The index of the pixel corresponds to this equation: i = height * y + x.

Definition at line 72 of file Film.h.

int Film::m_width

private

Width of the Film's image.

Definition at line 64 of file Film.h.

---

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

• FinalSubmission/include/Film.h
• FinalSubmission/src/Film.cpp