sim.graphics

Class SViewport

java.lang.Object

sim.util.SAbstractReadable

sim.util.SAbstractReadableWriteable

sim.graphics.SViewport

All Implemented Interfaces:

SReadable, SWriteable

public class SViewport

extends SAbstractReadableWriteable

La classe SViewport représente une grille de couleur en deux dimension en espace pixels où sera dessiné la scène du point de vue de le pyramide de vue (ViewFrustum). Les coordonnées sont indexés avec [x][y] où x correspond au numéro de ligne et y correspond au numéro de la colonne du tableau.

- La coordonnée [0][0] correspond au coin supérieur gauche de l'image.

- La coordonnée [width-1][0] correspond au coin supérieur droit de l'image.

- La coordonnée [0][height-1] correspond au coin inférieur gauche de l'image.

- La coordonnée [width-1][height-1] correspond au coint inférieur droit de l'image.

Since:

2014-12-27

Version:

2016-02-12

Author:

Simon Vézina

Field Summary

Fields

Modifier and Type	Field and Description
SColor	BACKGROUND_SCOLOR

Constructor Summary

Constructors

Constructor and Description
SViewport() Constructeur d'un viewport par défaut.
SViewport(int width, int height) Constructeur avec définition des paramètres de largeur (width) et de hauteur (height).
SViewport(int width, int height, java.lang.String file_name) Constructeur d'un viewport.
SViewport(SBufferedReader br) Constructeur du viewport à partir d'information lue dans un fichier de format txt.

Method Summary

Modifier and Type	Method and Description
void	clear() Méthode pour effacer le viewport en réinitialisant l'ensemble des pixels à la couleur par défaut BACKGROUND_COLOR.
boolean	equals(java.lang.Object obj)
java.awt.image.BufferedImage	getBufferedImage() Méthode pour avoir une copie du contenu du viewport sous forme d'un BufferedImage.
int	getHeight() Méthode pour obtenir le nombre de pixels en hauteur (height) du Viewport.
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.
int	getWidth() Méthode pour obtenir le nombre de pixels en largeur (width) du Viewport.
boolean	hasNextPixel() Méthode pour déterminer s'il y a encore des pixels à analyser dans le viewport.
SVectorPixel	nextPixel() Méthode qui retourne le pixel suivant à être analysé.
double	normalAspect() Méthode qui retourne le ratio width/height sans distorsion.
void	restartPixelIteration() Méthode qui réinitialise l'itération des pixels du viewport à l'origine (de coordonnée (0,0)).
void	setColor(int x, int y, SColor color) Méthode pour attribuer une couleur à une coordonnée xy d'un pixel du viewport.
void	setColor(SVectorPixel p, SColor color) Méthode pour attribuer une couleur à une coordonnée xy d'un pixel du viewport.
static void	setImageCounter(int nb) Méthode pour définir le numéro de la prochaine image généré par les viewports.
static void	staticWrite(java.io.BufferedWriter bw) Méthode pour écrire le contenu static de la classe SViewport dans un fichier txt.
void	write(java.io.BufferedWriter bw) Méthode pour écrire un objet SReadableWriteable dans un fichier txt.
void	writeImage() Méthode pour dessiner le viewport dans un fichier image.

Methods inherited from class sim.util.SAbstractReadableWriteable

write

Methods inherited from class sim.util.SAbstractReadable

read

Methods inherited from class java.lang.Object

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

Field Detail

BACKGROUND_SCOLOR

public final SColor BACKGROUND_SCOLOR

Constructor Detail

SViewport

public SViewport()

Constructeur d'un viewport par défaut.

SViewport

public SViewport(int width,

                 int height)

Constructeur avec définition des paramètres de largeur (width) et de hauteur (height).

Parameters:

width - - La largeur du viewport.

height - - La hauteur du viewport.

SViewport

public SViewport(int width,

                 int height,

                 java.lang.String file_name)

          throws SConstructorException

Constructeur d'un viewport.

Parameters:

width - - La largeur du viewport.

height - - La hauteur du viewport.

file_name - - Le nom du fichier image qui sera généré.

Throws:

SConstructorException - Si une erreur est survenue à la construction.

SViewport

public SViewport(SBufferedReader br)

          throws java.io.IOException,

                 SConstructorException

Constructeur du viewport à partir d'information lue dans un fichier de format txt.

Parameters:

br - Le BufferedReader cherchant l'information de le fichier .txt.

Throws:

java.io.IOException - Si une erreur de l'objet SBufferedWriter est lancée.

SConstructorException - Si une erreur est survenue à la construction.

See Also:

SBufferedReader

Method Detail

getWidth

public int getWidth()

Méthode pour obtenir le nombre de pixels en largeur (width) du Viewport.

Returns:

Le nombre de pixels en largeur.

getHeight

public int getHeight()

Méthode pour obtenir le nombre de pixels en hauteur (height) du Viewport.

Returns:

Le nombre de pixels en hauteur.

getBufferedImage

public java.awt.image.BufferedImage getBufferedImage()

Méthode pour avoir une copie du contenu du viewport sous forme d'un BufferedImage.

Returns:

une copie du contenu du buffer d'image du viewport.

See Also:

BufferedImage

setImageCounter

public static void setImageCounter(int nb)

                            throws SRuntimeException

Méthode pour définir le numéro de la prochaine image généré par les viewports.

Parameters:

nb - - Le numéro de l'image.

Throws:

SRuntimeException - Si le numéro n'est pas entre 0 et 999.

setColor

public void setColor(int x,

                     int y,

                     SColor color)

              throws SCoordinateOutOfBoundException

Méthode pour attribuer une couleur à une coordonnée xy d'un pixel du viewport. Il est important de rappeler que la coordonnée (0,0) correspond au coin supérieur gauche du viewport.

Parameters:

x - - La coordonnée x en largeur (width) du viewport.

y - - La coordonnée y en hauteur (height) du viewport.

color - - La couleur à affecter au pixel.

Throws:

SCoordinateOutOfBoundException - Si la coordonnée (x,y) du pixel n'est pas admissible.

setColor

public void setColor(SVectorPixel p,

                     SColor color)

              throws SCoordinateOutOfBoundException

Méthode pour attribuer une couleur à une coordonnée xy d'un pixel du viewport. Il est important de rappeler que la coordonnée (0,0) correspond au coin supérieur gauche du viewport.

Parameters:

p - - La coordonnée du pixel du viewport.

color - - La couleur à affecter au pixel.

Throws:

SCoordinateOutOfBoundException - Si la coordonnée xy du pixel n'est pas admissible.

clear

public void clear()

Méthode pour effacer le viewport en réinitialisant l'ensemble des pixels à la couleur par défaut BACKGROUND_COLOR. Il y a également réinitilisation de l'itération des pixels du viewport avec la méthode restartPixelIteration().

See Also:

restartPixelIteration, BACKGROUND_COLOR

restartPixelIteration

public void restartPixelIteration()

Méthode qui réinitialise l'itération des pixels du viewport à l'origine (de coordonnée (0,0)).

hasNextPixel

public boolean hasNextPixel()

Méthode pour déterminer s'il y a encore des pixels à analyser dans le viewport.

Returns:

true s'il y a encore des pixels à analyser et false sinon.

nextPixel

public SVectorPixel nextPixel()

Méthode qui retourne le pixel suivant à être analysé. Cette méthode a été développée afin de pouvoir itérer sur l'ensemble des pixels du viewport. L'itération va s'effectuer ligne par ligne ce qui correspond à x=0 jusqu'à x=width-1 et l'on recommence en augmentant y afin qu'il passe de y=0 à y=height-1.

Returns:

la coordonnée du prochain pixel à analyser et null s'il n'y a plus de pixel à itérer.

normalAspect

public double normalAspect()

Méthode qui retourne le ratio width/height sans distorsion. Ce calcul est nécessaire pour la formation de la pyramide de vue (ViewFrustum) afin de déterminer une hauteur de pyramide en fonction de la largueur (déterminée par un angle d'ouverture).

Returns:

Le ratio width/height.

write

public void write(java.io.BufferedWriter bw)

           throws java.io.IOException

Méthode pour écrire un objet SReadableWriteable dans un fichier txt.

Parameters:

bw - - Le buffer pour l'écriture.

Throws:

java.io.IOException - Si une erreur de l'objet BufferedWriter est lancée.

See Also:

BufferedWriter

staticWrite

public static void staticWrite(java.io.BufferedWriter bw)

                        throws java.io.IOException

Méthode pour écrire le contenu static de la classe SViewport dans un fichier txt.

Parameters:

bw - - Le buffer pour l'écriture.

Throws:

java.io.IOException - Si une erreur de l'objet BufferedWriter est lancée.

See Also:

BufferedWriter

writeImage

public void writeImage()

                throws java.io.IOException

Méthode pour dessiner le viewport dans un fichier image.

Throws:

java.io.IOException - S'il y a une erreur lors de l'écriture du fichier image.

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.

equals

public boolean equals(java.lang.Object obj)

Overrides:

equals in class java.lang.Object