sim.graphics.light

Class SApertureMaskLight

java.lang.Object

sim.util.SAbstractReadable

sim.util.SAbstractReadableWriteable

sim.graphics.light.SAbstractLight

sim.graphics.light.SAbstractAttenuatedLight

sim.graphics.light.SAbstractInterferenceLight

sim.graphics.light.SAbstractPlanarApertureLight

sim.graphics.light.SApertureMaskLight

All Implemented Interfaces:

SAttenuatedLight, SInterferenceLight, SLight, SReadable, SWriteable

public class SApertureMaskLight

extends SAbstractPlanarApertureLight

La classe SApertureMaskLight représente une ouverture rectangulaire masquée. Le masque sera déterminé par une texture. La couleur noire correspondra au masque ce qui déterminera où il n'y aura pas d'oscillateur pour générer la source de lumière.

Since:

2016-03-04

Version:

2016-03-08

Author:

Simon Vézina

Field Summary

Fields

Modifier and Type	Field and Description
static java.awt.Color	MASK_COLOR La constante MASK_COLOR correspond à la couleur du masque.

Fields inherited from class sim.graphics.light.SAbstractLight

AMBIENT_LIGHT_CODE, APERTURE_MASK_LIGHT_CODE, DIRECTIONAL_LIGHT_CODE, ELLIPTICAL_APERTURE_LIGHT_CODE, LINEAR_APERTURE_LIGHT_CODE, POINT_LIGHT_CODE, RECTANGULAR_APERTURE_LIGHT_CODE

Constructor Summary

Constructors

Constructor and Description
SApertureMaskLight() Constructeur d'une ouverture planaire avec masque par défaut.
SApertureMaskLight(double wave_length, SVector3d position, double amp, double cst_att, double lin_att, double quad_att, int period_iteration, int nb_oscillator, SVector3d front, SVector3d up, double height, double width) Constructeur d'une source de lumière à ouverture planaire avec masque.
SApertureMaskLight(SBufferedReader sbr) Constructeur d'une source de lumière à ouverture rectangulaire masquée pouvant réaliser de l'interférence à partir d'information lue dans un fichier de format txt.

Method Summary

Modifier and Type	Method and Description
int	getCodeName() Méthode pour obtenir le numéro correspondant au nom de la source de lumière.
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.
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.graphics.light.SAbstractInterferenceLight

getRelativeIntensity

Methods inherited from class sim.graphics.light.SAbstractAttenuatedLight

amplification, attenuation, getOrientation, getPosition

Methods inherited from class sim.graphics.light.SAbstractLight

getColor

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

Methods inherited from interface sim.graphics.light.SAttenuatedLight

amplification, attenuation, getOrientation, getPosition

Methods inherited from interface sim.graphics.light.SLight

getColor

Field Detail

MASK_COLOR

public static final java.awt.Color MASK_COLOR

La constante MASK_COLOR correspond à la couleur du masque.

Constructor Detail

SApertureMaskLight

public SApertureMaskLight()

Constructeur d'une ouverture planaire avec masque par défaut.

SApertureMaskLight

public SApertureMaskLight(double wave_length,

                          SVector3d position,

                          double amp,

                          double cst_att,

                          double lin_att,

                          double quad_att,

                          int period_iteration,

                          int nb_oscillator,

                          SVector3d front,

                          SVector3d up,

                          double height,

                          double width)

                   throws SConstructorException

Constructeur d'une source de lumière à ouverture planaire avec masque.

Parameters:

wave_length - La longueur d'onde de la source de lumière (en nm).

position - La position de la source.

amp - Le facteur d'amplification de la source de lumière.

cst_att - La constante d'atténuation à taux constant.

lin_att - La constante d'atténuation à taux linéaire.

quad_att - La constante d'atténuation à taux quadratique.

period_iteration - Le nombre d'itérations réalisées dans les calculs effectués sur un cycle de période d'oscillation des oscillateurs.

nb_oscillator - Le nombre d'oscillateurs dans l'axe de la plus petite dimension (entre width et height).

front - L'orientation perpendiculaire au plan de l'ouverture planaire.

up - L'orientation du haut de l'ouverture planaire.

height - La hauteur de l'ouverture planaire (dans l'orientation de up).

width - La largeur de l'ouverture planaire.

Throws:

SConstructorException - Si une erreur est survenue à la construction.

SApertureMaskLight

public SApertureMaskLight(SBufferedReader sbr)

                   throws java.io.IOException,

                          SConstructorException

Constructeur d'une source de lumière à ouverture rectangulaire masquée pouvant réaliser de l'interférence à partir d'information lue dans un fichier de format txt.

Parameters:

sbr - Le BufferedReader cherchant l'information dans le fichier txt.

Throws:

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

SException - Si des facteurs d'atténuation sont initialisés avec des valeurs erronées.

SConstructorException - Si une erreur est survenue à la construction.

See Also:

SBufferedReader

Method Detail

getCodeName

public int getCodeName()

Description copied from interface: SLight

Méthode pour obtenir le numéro correspondant au nom de la source de lumière.

Returns:

Le numéro correspondant au nom de la géométrie.

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 SAbstractPlanarApertureLight

Returns:

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