sim.geometry

Class STubeGeometry

java.lang.Object

sim.util.SAbstractReadable

sim.util.SAbstractReadableWriteable

sim.geometry.SAbstractGeometry

sim.geometry.STubeGeometry

All Implemented Interfaces:

SGeometry, SReadable, SWriteable

Direct Known Subclasses:

SConeGeometry, SCylinderGeometry, SLens

public class STubeGeometry
extends SAbstractGeometry

La classe STubeGeometry représente la géométrie d'un tube. Un tube correspond à un cylindre sans les extrémités en forme de cercle. Il est donc un rectangle refermé sur lui-même sans épaisseur. Il n'est donc pas une géométrie volumique (avec zone intérieure). Le tube sera définit à l'aide de deux points correspondant à la ligne passant par le centre du tube et d'un rayon.

Since:

2015-06-21

Version:

2016-02-16

Author:

Simon Vézina

Field Summary

Fields inherited from class sim.geometry.SAbstractGeometry

BTRIANGLE_CODE, CONE_CODE, CUBE_CODE, CYLINDER_CODE, DISK_CODE, LENS_CODE, PLANE_CODE, SPHERE_CODE, SPHERICAL_CAP_CODE, TRANSFORMABLE_CODE, TRIANGLE_CODE, TUBE_CODE

Constructor Summary

Constructors

Constructor and Description
STubeGeometry() Construction d'un tube par défaut.
STubeGeometry(SBufferedReader sbr, SPrimitive parent) Constructeur du tube à partir d'information lue dans un fichier de format txt.
STubeGeometry(SVector3d P1, SVector3d P2, double R) Constructeur d'un tube.
STubeGeometry(SVector3d P1, SVector3d P2, double R, SPrimitive parent) Constructeur d'un tube avec une primitive comme parent.

Method Summary

Modifier and Type	Method and Description
int	getCodeName() Méthode pour obtenir le numéro correspondant au nom de la géométrie.
SVector3d	getP1() Méthode pour obtenir le 1ier point définissant l'extrémité du tube.
SVector3d	getP2() Méthode pour obtenir le 2ième point définissant l'extrémité du tube.
double	getRay() Méthode pour obtenir le rayon du tube.
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.
SRay	intersection(SRay ray) Méthode permettant d'effectuer le calcul de l'intersection (s'il y a) entre un rayon et une géométrie.
boolean	isClosedGeometry() Méthode qui détermine si la géométrie est une surface fermée.
boolean	isInside(SVector3d v) Méthode qui détermine si un vecteur point à l'intérieur de la géométrie.
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.geometry.SAbstractGeometry

equals, getID, getPrimitiveParent, hashCode, isTransparent, setPrimitiveParent, toString

Methods inherited from class sim.util.SAbstractReadableWriteable

write

Methods inherited from class sim.util.SAbstractReadable

read

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

STubeGeometry

public STubeGeometry()

Construction d'un tube par défaut.

STubeGeometry

public STubeGeometry(SVector3d P1,
                     SVector3d P2,
                     double R)

Constructeur d'un tube.

Parameters:

P1 - - Le 1ier point du tube.

P2 - - Le 2ième point du tube.

R - - Le rayon du tube.

STubeGeometry

public STubeGeometry(SVector3d P1,
                     SVector3d P2,
                     double R,
                     SPrimitive parent)
              throws SConstructorException

Constructeur d'un tube avec une primitive comme parent.

Parameters:

P1 - - Le 1ier point du tube.

P2 - - Le 2ième point du tube.

R - - Le rayon du tube.

parent - - La primitive en parent.

Throws:

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

STubeGeometry

public STubeGeometry(SBufferedReader sbr,
                     SPrimitive parent)
              throws java.io.IOException,
                     SConstructorException

Constructeur du tube à partir d'information lue dans un fichier de format txt. Puisqu'une géométrie est construite à l'intérieure d'une primitive, une référence à celle-ci doit être intégrée au constructeur pour y a voir accès.

Parameters:

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

parent - - La primitive qui fait la construction de cette géométrie (qui est le parent).

Throws:

java.io.IOException - Si une erreur de de type I/O est lancée.

SConstructorException - Si une erreur est survenue à la construction.

See Also:

SBufferedReader, SPrimitive

Method Detail

getP1

public SVector3d getP1()

Méthode pour obtenir le 1ier point définissant l'extrémité du tube.

Returns:

le 1ier point du tube.

getP2

public SVector3d getP2()

Méthode pour obtenir le 2ième point définissant l'extrémité du tube.

Returns:

le 2ième point du tube.

getRay

public double getRay()

Méthode pour obtenir le rayon du tube.

Returns:

le rayon du tube.

getCodeName

public int getCodeName()

Description copied from interface: SGeometry

Méthode pour obtenir le numéro correspondant au nom de la géométrie.

Returns:

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

intersection

public SRay intersection(SRay ray)
                  throws SRuntimeException

Description copied from interface: SGeometry

Méthode permettant d'effectuer le calcul de l'intersection (s'il y a) entre un rayon et une géométrie.

Parameters:

ray - - Le rayon à intersecter avec la géométrie.

Returns:

Un rayon avec les caractéristiques de l'intersection avec la géométrie. Une référence sur le rayon en paramètre sera renvoyé s'il n'y a pas eu d'intersection.

Throws:

SRuntimeException - S'il y a déjà eu intersection avec ce rayon.

isClosedGeometry

public boolean isClosedGeometry()

Description copied from interface: SGeometry

Méthode qui détermine si la géométrie est une surface fermée. Ainsi, on peut y définir l'intérieur et l'extérieur.

Returns:

true si la géométrie est fermée et false sinon.

isInside

public boolean isInside(SVector3d v)

Description copied from interface: SGeometry

Méthode qui détermine si un vecteur point à l'intérieur de la géométrie. Si la géométrie n'est pas fermée, le vecteur point automatiquement à l'extérieur de la géométrie.

Parameters:

v - - Le vecteur.

Returns:

true si le vecteur point à l'intérieur de la géométrie et false sinon.

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.