sim.graphics.light

Class SAbstractPlanarApertureLight

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

All Implemented Interfaces:

SAttenuatedLight, SInterferenceLight, SLight, SReadable, SWriteable

Direct Known Subclasses:

SApertureMaskLight, SEllipticalApertureLight, SRectangularApertureLight

public abstract class SAbstractPlanarApertureLight

extends SAbstractInterferenceLight

La classe abstraite SAbstractPlanarApertureLight représente une source de lumière planaire pouvant réaliser de l'interférence.

Since:

2016-02-24

Version:

2016-03-08

Author:

Simon Vézina

Field Summary

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
SAbstractPlanarApertureLight() Constructeur d'une source de lumière à ouverture planaire par défaut.
SAbstractPlanarApertureLight(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.

Method Summary

Modifier and Type	Method and Description
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.

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

getCodeName, getColor

Methods inherited from interface sim.util.SWriteable

write

Methods inherited from interface sim.util.SReadable

getReadableName

Constructor Detail

SAbstractPlanarApertureLight

public SAbstractPlanarApertureLight()

Constructeur d'une source de lumière à ouverture planaire par défaut.

SAbstractPlanarApertureLight

public SAbstractPlanarApertureLight(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.

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'oscillateur 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.

Method Detail

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 SAbstractInterferenceLight

Returns:

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