sim.graphics

Class SScene

java.lang.Object

sim.util.SAbstractReadable

sim.util.SAbstractReadableWriteable

sim.graphics.SScene

All Implemented Interfaces:

SReadable, SWriteable

public class SScene
extends SAbstractReadableWriteable

La classe SScene représente une scène en trois dimensions. Une scène comprend des primitives, des matériaux, des lumières, ainsi que des paramètres de visionnement comme une caméra, un viewport et le ray tracer.

Since:

2014-12-26

Version:

2016-03-04

Author:

Simon Vézina

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	DEFAULT_SCENE_FILE_NAME La constante DEFAULT_SCENE_FILE_NAME correspond au nom du fichier de scène par défaut étant égal à "default_scene.txt".

Constructor Summary

Constructors

Constructor and Description
SScene() Constructeur d'une scène par défaut.
SScene(java.lang.String file_name) Constructeur avec lecture d'un fichier txt.

Method Summary

Modifier and Type	Method and Description
SRaytracer	buildRaytracer() Méthode pour faire la construction du raytracer associé à la scène en fonction de ses paramètres comme le viewport, la caméra, les géométries et les lumières.
SCamera	getCamera() Méthode pour obtenir la caméra de la scene.
java.util.List<SLight>	getLightList() Méthode pour obtenir la liste des sources de lumière de la scène.
java.util.List<SPrimitive>	getPrimitiveList() Méthode pour obtenir la liste des primitives de la scène.
java.lang.String	getReadableName() Méthode pour obtenir le nom de l'objet implémentant l'interface SReadable.
java.lang.String[]	getReadableParameterName() Méthode pour obtenir un tableau des mots clés permettant de définir les paramètres de l'objet implémentant l'interface SReadable lors de sa lecture.
SViewport	getViewport() Méthode pour obtenir le viewport de la scene.
void	write(java.io.BufferedWriter bw) Méthode pour écrire un objet SWriteable dans un fichier txt en utilisant un BufferedWriter.

Methods inherited from class sim.util.SAbstractReadableWriteable

write

Methods inherited from class sim.util.SAbstractReadable

read

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

DEFAULT_SCENE_FILE_NAME

public static final java.lang.String DEFAULT_SCENE_FILE_NAME

La constante DEFAULT_SCENE_FILE_NAME correspond au nom du fichier de scène par défaut étant égal à "default_scene.txt".

See Also:

Constant Field Values

Constructor Detail

SScene

public SScene()

Constructeur d'une scène par défaut.

SScene

public SScene(java.lang.String file_name)
       throws java.io.FileNotFoundException,
              java.io.IOException,
              SConstructorException

Constructeur avec lecture d'un fichier txt.

Parameters:

file_name - - Le nom du fichier en lecture.

Throws:

java.io.FileNotFoundException - Si le fichier de lecture n'a pas été trouvé.

java.io.IOException - Si une erreur de type I/O est survenue.

SConstructorException - Si une erreur est survenue lors de la construction.

Method Detail

getCamera

public SCamera getCamera()

Méthode pour obtenir la caméra de la scene.

Returns:

La caméra de la scene.

getViewport

public SViewport getViewport()

Méthode pour obtenir le viewport de la scene.

Returns:

Le viewport de la scene.

getPrimitiveList

public java.util.List<SPrimitive> getPrimitiveList()

Méthode pour obtenir la liste des primitives de la scène.

Returns:

La liste des primitives.

getLightList

public java.util.List<SLight> getLightList()

Méthode pour obtenir la liste des sources de lumière de la scène.

Returns:

La liste des sources de lumière.

buildRaytracer

public SRaytracer buildRaytracer()

Méthode pour faire la construction du raytracer associé à la scène en fonction de ses paramètres comme le viewport, la caméra, les géométries et les lumières.

Returns:

Le ray tracer de la scène.

write

public void write(java.io.BufferedWriter bw)
           throws java.io.IOException

Description copied from interface: SWriteable

Méthode pour écrire un objet SWriteable dans un fichier txt en utilisant un BufferedWriter.

Parameters:

bw - - Le buffer pour l'écriture.

Throws:

java.io.IOException - Si une erreur de type I/O a été lancée par l'objet BufferedWriter.

See Also:

BufferedWriter

getReadableName

public java.lang.String getReadableName()

Description copied from interface: SReadable

Méthode pour obtenir le nom de l'objet implémentant l'interface SReadable. Ce nom correspond également au mot clé à rechercher lors d'une lecture avec un SBufferedReader pour en faire la construction de l'objet en question.

Returns:

Le nom de l'objet lisible.

getReadableParameterName

public java.lang.String[] getReadableParameterName()

Description copied from interface: SReadable

Méthode pour obtenir un tableau des mots clés permettant de définir les paramètres de l'objet implémentant l'interface SReadable lors de sa lecture.

Specified by:

getReadableParameterName in interface SReadable

Overrides:

getReadableParameterName in class SAbstractReadable

Returns:

Un tableau des mots clés des paramètres.