sim.geometry

Interface SGeometry

All Superinterfaces:

SWriteable

All Known Implementing Classes:

SAbstractGeometry, SAbstractPlanarGeometry, SBTriangleGeometry, SConeGeometry, SCubeGeometry, SCylinderGeometry, SDiskGeometry, SLens, SPlaneGeometry, SSphereGeometry, SSphericalCapGeometry, STransformableGeometry, STriangleGeometry, STubeGeometry

public interface SGeometry
extends SWriteable

Interface représentant le mandat d'une géométrie. Une géométrie doit être intersectable par une rayon, définir si elle représente une surface fermée et identifier si un vecteur position se trouve à l'intérieur d'elle (possible si elle est une surface fermée).

Since:

2015-01-10

Version:

2015-07-26

Author:

Simon Vézina

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.
long	getID() Méthode pour obtenir le numéro d'identification unique ID de la géométrie.
SPrimitive	getPrimitiveParent() Méthode pour obtenir la primitive parent dont cette géométrie fait partie.
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.
boolean	isTransparent() Méthode qui détermine si la géométrie est transparente.
void	setPrimitiveParent(SPrimitive parent) Méthode pour affecter primitive commet parent à la géométrie.

Methods inherited from interface sim.util.SWriteable

write

Method Detail

getID

long getID()

Méthode pour obtenir le numéro d'identification unique ID de la géométrie.

Returns:

Le numéro d'identification ID.

getCodeName

int getCodeName()

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.

getPrimitiveParent

SPrimitive getPrimitiveParent()
                       throws SRuntimeException

Méthode pour obtenir la primitive parent dont cette géométrie fait partie.

Returns:

La primitive parent de cette géométrie.

Throws:

SRuntimeException - Si la géométrie ne possède pas de primitive comme parent.

setPrimitiveParent

void setPrimitiveParent(SPrimitive parent)
                 throws SRuntimeException

Méthode pour affecter primitive commet parent à la géométrie.

Parameters:

parent - - La primitive parent de la géométrie.

Throws:

SRuntimeException - Si la géométrie possède déjà un parent (n'est pas préalablement 'null').

isTransparent

boolean isTransparent()

Méthode qui détermine si la géométrie est transparente.

Returns:

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

isClosedGeometry

boolean isClosedGeometry()

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

boolean isInside(SVector3d v)

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.

intersection

SRay intersection(SRay ray)
           throws SRuntimeException

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.