SRay

java.lang.Object
- sim.geometry.SRay

All Implemented Interfaces:

java.lang.Comparable<SRay>
```
public class SRay
extends java.lang.Object
implements java.lang.Comparable<SRay>
```
La classe SRay représente un rayon pouvant réaliser une intersection avec une géométrie.

Cette classe implémente l'interface Comparable (permettant les usages des méthodes de triage des librairies de base de java). La comparaison sera effectuée sur la valeur du champ local t qui représente le temps afin d'intersecter une géométrie. S'il n'y a pas d'intersection, la valeur de t sera égale à l'infini.

Since:

2014-12-30

Version:

2016-03-15

Author:

Simon Vézina

Field Summary

Fields
Modifier and Type	Field and Description
`static double`	`DEFAULT_REFRACTIVE_INDEX` La constante 'DEFAULT_REFRACTIV_INDEX' correspond à la valeur de l'indice de réfraction par défaut où un rayon voyage.
`static double`	`MINIMUM_EPSILON` La constante 'MINIMUM_EPSILON' correspond à la plus petite valeur du temps mininal de parcours qu'un rayon doit effectuer avant de pouvoir intersecter une géométrie.

Constructor Summary

Constructors
Constructor and Description
`SRay(SVector3d origin, SVector3d direction, double refractive_index)` Constructeur d'un rayon dont l'objectif sera de tenter d'intersecter une géométrie.

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`boolean`	`asIntersected()` Méthode pour déterminer si le rayon a effectué une intersection avec une géométrie.
`boolean`	`asUV()` Méthode pour déterminer si le rayon intersecté possède une coordonnée de uv de texture.
`int`	`compareTo(SRay ray)`
`boolean`	`equals(java.lang.Object obj)`
`SVector3d`	`getDirection()` Méthode pour obtenir la direction du rayon.
`static double`	`getEpsilon()` Méthode pour obtenir la valeur d'epsilon présentement en vigueur pour les calculs d'intersection entre les rayons et les géométries.
`SGeometry`	`getGeometry()` Méthode pour obtenir la géométrie qui est en intersection avec le rayon.
`SVector3d`	`getIntersectionPosition()` Méthode pour obtenir la position de l'intersection entre le rayon et la géométrie.
`SVector3d`	`getNormal()` Méthode pour obtenir la normal à la surface de la géométrie en intersection avec le rayon.
`SVector3d`	`getOrigin()` Méthode pour obtenir l'origine du rayon.
`SVector3d`	`getPosition(double t_value)` Méthode pour obtenir la position d'un rayon après un déplacement de celui-ci.
`double`	`getRefractiveIndex()` Méthode pour obtenir l'indice de réfraction du milieu dans lequel le rayon voyage.
`double`	`getT()` Méthode pour obtenir le temps (ou la distance puisque la direction est unitaire) afin de réaliser une intersection entre le rayon et une géométrie.
`SVectorUV`	`getUV()` Méthode pour obtenir la coordonnée uv associée à l'intersection sur la géométrie.
`SRay`	`intersection(SGeometry geometry, SVector3d normal, double t, boolean is_inside_intersection)` Méthode pour générer un rayon intersecté à partir d'un rayon lancée et de ses caractéristiques définissant l'intersection.
`SRay`	`intersection(SGeometry geometry, SVector3d normal, SVectorUV uv, double t, boolean is_inside_intersection)` Méthode pour générer un rayon intersecté à partir d'un rayon lancée et de ses caractéristiques définissant l'intersection.
`boolean`	`isInsideIntersection()` Méthode pour déterminer si le rayon a effectué une intersection de l'intérieur de la géométrie.
`static void`	`setEpsilon(double e)` Méthode pour définir le temps/distance minimal que doit effectuer un rayon afin de valider une intersection.
`java.lang.String`	`toString()`

Methods inherited from class java.lang.Object
getClass, hashCode, notify, notifyAll, wait, wait, wait

- Field Detail
  - MINIMUM_EPSILON
```
public static final double MINIMUM_EPSILON
```
    La constante 'MINIMUM_EPSILON' correspond à la plus petite valeur du temps mininal de parcours qu'un rayon doit effectuer avant de pouvoir intersecter une géométrie. Cette contrainte est nécessaire pour une raison de stabilité numérique. Elle est présentement définie à 1.0E-8 elle et doit toujours être supérieure à SMath.EPSILON.
    
    See Also:
    
    Constant Field Values
  - DEFAULT_REFRACTIVE_INDEX
```
public static final double DEFAULT_REFRACTIVE_INDEX
```
    La constante 'DEFAULT_REFRACTIV_INDEX' correspond à la valeur de l'indice de réfraction par défaut où un rayon voyage. Cet indice de réfraction est égal à celui du vide (n = 1.0).
    
    See Also:
    
    Constant Field Values
- Constructor Detail
  - SRay
```
public SRay(SVector3d origin,
            SVector3d direction,
            double refractive_index)
     throws SConstructorException
```
    Constructeur d'un rayon dont l'objectif sera de tenter d'intersecter une géométrie.
    
    Parameters:
    
    origin - - L'origine du rayon.
    
    direction - - La direction du rayon.
    
    refractive_index - - L'indice de réfraction du milieu où voyage le rayon.
    
    Throws:
    
    SConstructorException - Si la direction du rayon correspond à un vecteur nul.
- Method Detail
  - setEpsilon
```
public static void setEpsilon(double e)
                       throws SRuntimeException
```
    Méthode pour définir le temps/distance minimal que doit effectuer un rayon afin de valider une intersection. Cette valeur est nécessaire pour des raisons numériques. Elle doit être positive et supérieure à un valeur minimal de 1e-6. Il peut être affecté en fonction de la position du front clipping plane d'une pyramide de vue (view Frustum).
    
    Parameters:
    
    e - - La valeur d'epsilon.
    
    Throws:
    
    SRuntimeException - Si la nouvelle valeur d'epsilon est inférieure à la valeur minimale acceptée par la classe.
    
    See Also:
    
    MINIMUM_EPSILON
  - getEpsilon
```
public static double getEpsilon()
```
    Méthode pour obtenir la valeur d'epsilon présentement en vigueur pour les calculs d'intersection entre les rayons et les géométries.
    
    Returns:
    
    La valeur d'epsilon.
  - getOrigin
```
public SVector3d getOrigin()
```
    Méthode pour obtenir l'origine du rayon.
    
    Returns:
    
    L'origine du rayon.
  - getDirection
```
public SVector3d getDirection()
```
    Méthode pour obtenir la direction du rayon.
    
    Returns:
    
    La direction du rayon.
  - getPosition
```
public SVector3d getPosition(double t_value)
```
    Méthode pour obtenir la position d'un rayon après un déplacement de celui-ci.
    
    Parameters:
    
    t_value - - Le temps/distance à écouler dans le déplacement du rayon.
    
    Returns:
    
    Le vecteur position du rayon après déplacement.
  - asIntersected
```
public boolean asIntersected()
```
    Méthode pour déterminer si le rayon a effectué une intersection avec une géométrie.
    
    Returns:
    
    true s'il y a eu une intersection et false sinon.
  - isInsideIntersection
```
public boolean isInsideIntersection()
                             throws SRuntimeException
```
    Méthode pour déterminer si le rayon a effectué une intersection de l'intérieur de la géométrie.
    
    Returns:
    
    true s'il y a eu une intersection à l'intérieur de la géométrie et false sinon.
    
    Throws:
    
    SRuntimeException - Si le rayon n'a pas effectué d'intersection.
  - getT
```
public double getT()
```
    Méthode pour obtenir le temps (ou la distance puisque la direction est unitaire) afin de réaliser une intersection entre le rayon et une géométrie. Si le rayon n'a pas été intersecté, la valeur sera l'infini .
    
    Returns:
    
    Le temps/distance pour effectuer l'intersection et l'infini s'il n'y a pas eu d'intersection.
  - getRefractiveIndex
```
public double getRefractiveIndex()
```
    Méthode pour obtenir l'indice de réfraction du milieu dans lequel le rayon voyage.
    
    Returns:
    
    l'indice de réfraction du milieu où voyage le rayon.
  - getIntersectionPosition
```
public SVector3d getIntersectionPosition()
                                  throws SRuntimeException
```
    Méthode pour obtenir la position de l'intersection entre le rayon et la géométrie.
    
    Returns:
    
    La position de l'intersection
    
    Throws:
    
    SRuntimeException - S'il n'y a pas eu d'intersection avec ce rayon, le point d'intersection est indéterminé.
  - getGeometry
```
public SGeometry getGeometry()
                      throws SRuntimeException
```
    Méthode pour obtenir la géométrie qui est en intersection avec le rayon.
    
    Returns:
    
    La géométrie en intersection.
    
    Throws:
    
    SRuntimeException - S'il n'y a pas eu d'intersection avec ce rayon, la géométrie est indéterminée.
  - getNormal
```
public SVector3d getNormal()
                    throws SRuntimeException
```
    Méthode pour obtenir la normal à la surface de la géométrie en intersection avec le rayon.
    
    Returns:
    
    La normal à la surface à l'endroit de l'intersection.
    
    Throws:
    
    SRuntimeException - S'il n'y a pas eu d'intersection avec ce rayon, la normale est indéterminée.
  - getUV
```
public SVectorUV getUV()
                throws SRuntimeException
```
    Méthode pour obtenir la coordonnée uv associée à l'intersection sur la géométrie.
    
    Returns:
    
    La coordonnée uv associé à l'intersection sur la géométrie. S'il n'y a pas de coordonnée uv associée à l'intersection, la valeur null sera retournée.
    
    Throws:
    
    SRuntimeException - S'il n'y a pas eu d'intersection avec ce rayon, la coordonnée uv est indéterminée.
  - asUV
```
public boolean asUV()
             throws SRuntimeException
```
    Méthode pour déterminer si le rayon intersecté possède une coordonnée de uv de texture.
    
    Returns:
    
    true s'il y a une coordonnée uv et false sinon.
    
    Throws:
    
    SRuntimeException - Si le rayon n'a pas été intersecté, il ne peut pas y avoir de coordonnée uv d'attribuée au rayon.
  - intersection
```
public SRay intersection(SGeometry geometry,
                         SVector3d normal,
                         double t,
                         boolean is_inside_intersection)
                  throws SRuntimeException
```
    Méthode pour générer un rayon intersecté à partir d'un rayon lancée et de ses caractéristiques définissant l'intersection.
    
    Parameters:
    
    geometry - - La géométrie qui est en intersection avec le rayon.
    
    normal - - La normale à la surface de la géométrie intersectée.
    
    t - - Le temps requis pour se rendre au lieu de l'intersection sur la géométrie.
    
    is_inside_intersection - - Détermine si l'intersection se fait par l'intérieur de la géométrie (nécessaire s'il y a de la réfraction à évaluer).
    
    Returns:
    
    Le rayon avec les caractéristiques de l'intersection.
    
    Throws:
    
    SRuntimeException - S'il y a déjà eu une intersection avec ce rayon.
  - intersection
```
public SRay intersection(SGeometry geometry,
                         SVector3d normal,
                         SVectorUV uv,
                         double t,
                         boolean is_inside_intersection)
                  throws SRuntimeException
```
    Méthode pour générer un rayon intersecté à partir d'un rayon lancée et de ses caractéristiques définissant l'intersection.
    
    Parameters:
    
    geometry - - La géométrie qui est en intersection avec le rayon.
    
    normal - - La normale à la surface de la géométrie intersectée.
    
    uv - - La coordonnée uv associée à l'intersection.
    
    t - - Le temps requis pour se rendre au lieu de l'intersection sur la géométrie.
    
    is_inside_intersection - - Détermine si l'intersection se fait par l'intérieur de la géométrie (nécessaire s'il y a de la réfraction à évaluer).
    
    Returns:
    
    Le rayon avec les caractéristiques de l'intersection.
    
    Throws:
    
    SRuntimeException - S'il y a déjà eu une intersection avec ce rayon.
  - compareTo
```
public int compareTo(SRay ray)
```
    Specified by:
    
    compareTo in interface java.lang.Comparable<SRay>
  - toString
```
public java.lang.String toString()
```
    Overrides:
    
    toString in class java.lang.Object
  - equals
```
public boolean equals(java.lang.Object obj)
```
    Overrides:
    
    equals in class java.lang.Object

Class SRay

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

MINIMUM_EPSILON

DEFAULT_REFRACTIVE_INDEX

Constructor Detail

SRay

Method Detail

setEpsilon

getEpsilon

getOrigin

getDirection

getPosition

asIntersected

isInsideIntersection

getT

getRefractiveIndex

getIntersectionPosition

getGeometry

getNormal

getUV

asUV

intersection

intersection

compareTo

toString

equals