rt::Scene Struct Reference

#include <Scene.h>

Public Member Functions
	Scene ()
	Default constructor. Nothing to do.
	~Scene ()
	Destructor. Frees objects.
void	init (Viewer &viewer)
	This function calls the init method of each of its objects.
void	draw (Viewer &viewer)
	This function calls the draw method of each of its objects.
void	light (Viewer &viewer)
	This function calls the light method of each of its lights.
void	addObject (GraphicalObject *anObject)
	Adds a new object to the scene.
void	addLight (Light *aLight)
	Adds a new light to the scene.
Real	rayIntersection (const Ray &ray, GraphicalObject *&object, Point3 &p)

Public Attributes
std::vector< Light * >	myLights
	The list of lights modelled as a vector.
std::vector< GraphicalObject * >	myObjects
	The list of objects modelled as a vector.

Detailed Description

Models a scene, i.e. a collection of lights and graphical objects (could be a tree, but we keep a list for now for the sake of simplicity).

Note

Once the scene receives a new object, it owns the object and is thus responsible for its deallocation.

Definition at line 26 of file Scene.h.

Constructor & Destructor Documentation

Scene()

rt::Scene::Scene ( )

inline

Default constructor. Nothing to do.

Definition at line 33 of file Scene.h.

{}

~Scene()

rt::Scene::~Scene ( )

inline

Destructor. Frees objects.

Definition at line 36 of file Scene.h.

    {
      for ( Light* light : myLights )
        delete light;
      for ( GraphicalObject* obj : myObjects )
        delete obj;
      // The vector is automatically deleted.
    }

Member Function Documentation

addLight()

void rt::Scene::addLight ( Light *  aLight )

inline

Adds a new light to the scene.

Definition at line 75 of file Scene.h.

    {
      myLights.push_back( aLight );
    }

addObject()

void rt::Scene::addObject ( GraphicalObject *  anObject )

inline

Adds a new object to the scene.

Definition at line 69 of file Scene.h.

    {
      myObjects.push_back( anObject );
    }

draw()

void rt::Scene::draw ( Viewer &  viewer )

inline

This function calls the draw method of each of its objects.

Definition at line 54 of file Scene.h.

    {
      for ( GraphicalObject* obj : myObjects )
        obj->draw( viewer );
      for ( Light* light : myLights )
        light->draw( viewer );
    }

init()

void rt::Scene::init ( Viewer &  viewer )

inline

This function calls the init method of each of its objects.

Definition at line 46 of file Scene.h.

    {
      for ( GraphicalObject* obj : myObjects )
        obj->init( viewer );
      for ( Light* light : myLights )
        light->init( viewer );
    }

light()

void rt::Scene::light ( Viewer &  viewer )

inline

This function calls the light method of each of its lights.

Definition at line 62 of file Scene.h.

    {
      for ( Light* light : myLights )
        light->light( viewer );
    }

rayIntersection()

Real rt::Scene::rayIntersection ( const Ray &  ray, GraphicalObject *&  object, Point3 &  p  )

inline

Parameters

[in]	ray	the ray that is traveling in the scene
[out]	object	either a null pointer (0) if no object is intersected by the ray or a pointer to the closest object intersected by the given ray.
[out]	p	if object is not null, then it is the point of intersection between the ray and this object.

Returns

a non-positive value if there was an intersection, positive otherwise (e.g. could be like the distance to the closest object to the ray).

Definition at line 93 of file Scene.h.

    {
      object = 0;
      return 1.0f;
    }

Member Data Documentation

myLights

std::vector< Light* > rt::Scene::myLights

The list of lights modelled as a vector.

Definition at line 28 of file Scene.h.

myObjects

std::vector< GraphicalObject* > rt::Scene::myObjects

The list of objects modelled as a vector.

Definition at line 30 of file Scene.h.

---

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

• TP2/Scene.h