Package object2d

Classe Object2d

Classes de ce package :

Packages - Hiérarchie - Index - Constantes et fonctions

Ascendants


Object
  |
  +--- Object2d

Description


Représentation en deux dimensions d'un agent.

Cette classe permet de rendre un agent visible, de le positionner et de l'orienter dans l'espace du plan, et de lui affecter une représentation graphique.


Aperçu des attributs


location Localisation et orientation dans le plan de l'agent.


Aperçu des méthodes


attachTo Attache une représentation à une autre de sorte que la modification de la position ou de l'orientation de celle-ci se répercute sur cette représentation.
circle Indique que cet objet est représenté par un cercle.
delete Appelée lors de la destruction de l'instance.
getColor Obtient la couleur actuelle de la représentation.
getContainer Obtient la représentation parente à la représentation actuelle.
getContent Obtient la liste de toutes les représentations ayant cette représentation comme parent.
getFileName Obtient le nom du fichier contenant l'image, si la représentation actuelle est une image.
getGlobalBoundingBox Obtient la zone englobante de cette représentation, exprimée dans le repère global.
getLayer Obtient le numéro de calque utilisée par cette instance.
getLocalBoundingBox Obtient la zone englobante de cette représentation, exprimée dans le repère local.
getLocation Obtient la position et l'orientation de la représentation.
getNbColors Obtient le nombre de couleurs utilisées dans l'image, si la représentation actuelle est une image.
getNbColumns Obtient le nombre de pixels dans une ligne de l'image, si la représentation actuelle est une image.
getNbLines Obtient le nombre de lignes de pixels composant l'image, si la représentation actuelle est une image.
getPixel Obtient la couleur du pixel spécifié de l'image, si la représentation actuelle est une image.
getPixelAt Obtient la couleur du pixel spécifié de l'image, si la représentation actuelle est une image.
getPixelScale Obtient le ratio de l'image, si la représentation actuelle est une image.
getRGB Obtient les composantes rouge, vert et bleu d'une entrée de la palette associée à l'image, si la représentation actuelle est une image.
getTheta Obtient l'orientation de la représentation.
getX Obtient l'abscisse de la représentation.
getY Obtient l'ordonnée de la représentation.
globalToLocalAngle Convertit l'angle exprimé dans le repère global en un angle exprimé dans le repère local à la représentation.
globalToLocalPosition Convertit le point exprimé dans le repère global en un point exprimé dans le repère local à la représentation.
image Indique que cet objet est représenté par une image.
inside Indique si le point spécifié se situe à l'intérieur de cette représentation.
intersectRay Envoie un rayon à partir du point spécifié et dans la direction spécifiée, et indique s'il intersecte cette représentation.
isAttachedTo Indique si cette représentation est attachée ou non à une représentation particulière.
keyPress Appelée lorsqu'une touche a été enfoncée par l'utilisateur pendant que cette représentation est sélectionnée.
line Indique que cet objet est représenté par une ligne à l'écran.
localToGlobalAngle Convertit l'angle exprimé dans le repère local à la représentation en un angle exprimé dans le repère global.
localToGlobalPosition Convertit le point exprimé dans le repère local à la représentation en un point exprimé dans le repère global.
mouseDrag Appelée lorsque cette représentation reçoit un événement de déplacement de la part de la souris.
new Crée une nouvelle représentation.
noShape Indique que cette représentation ne produit aucun dessin à l'écran.
point Indique que cet objet est représenté par un point à l'écran.
polygon Indique que cet objet est représenté par un polygone.
polyline Indique que cet objet est représenté par une polyligne.
rectangle Indique que cet objet est représenté par un rectangle à l'écran.
rotate Effectue une rotation à la représentation.
setColor Fixe la couleur actuelle de la représentation.
setLayer Fixe le numéro de calque qui devra etre utilisé par cette instance.
setLocation Change la position et l'orientation de la représentation.
setPixel Change la couleur du pixel spécifié de l'image, si la représentation actuelle est une image.
setPixelAt Change la couleur du pixel spécifié de l'image, si la représentation actuelle est une image.
setTheta Change l'orientation de la représentation.
setX Change l'abscisse de la représentation.
setY Change l'ordonnée de la représentation.
sortColors Trie la palette de couleurs utilisées dans l'image, si la représentation actuelle est une image.
square Indique que cet objet est représenté par un carré à l'écran.
text Indique que cet objet est représenté par du texte.
throwRay Envoie un rayon imaginaire à partir du centre de cette représentation et suivant son axe des abscisses positives dans son repère local, et obtient la première représentation éventuelle à etre intersectée par ce rayon.
translate Effectue une translation à la représentation.
view Détecte toutes les représentations d'agents de type spécifié ou d'un type dérivé situées dans un cone de visibilité spécifié.
viewFirst Détecte la représentation d'un agent de type spécifié ou d'un type dérivé la plus proche et située dans un cone de visibilité spécifié.


Référence des attributs


location

float[] location;

Localisation et orientation dans le plan de l'agent.


Référence des méthodes


attachTo

void attachTo(Object2d container);

Attache une représentation à une autre de sorte que la modification de la position ou de l'orientation de celle-ci se répercute sur cette représentation.

Paramètres
container - la représentation parente

circle

void circle(float radius, bool filled);

Indique que cet objet est représenté par un cercle.

Paramètres
radius - le rayon du cercle
filled - true si le cercle doit etre rempli

delete

void delete();

Appelée lors de la destruction de l'instance.

getColor

string getColor();

Obtient la couleur actuelle de la représentation.

Valeur de retour
la couleur

getContainer

Object2d getContainer();

Obtient la représentation parente à la représentation actuelle.

Valeur de retour
la représentation parente, ou NONE si cette représentation n'a aucun parent

getContent

Object2d[] getContent(string className, bool recursive);

Obtient la liste de toutes les représentations ayant cette représentation comme parent.

Paramètres
className - ne renvoie que les représentation du type indiqué ici, ou d'un type dérivé
recursive - true pour lister toutes les instances descendantes, ou false pour lister que les instances filles directes
Valeur de retour
la liste des instances filles

getFileName

string getFileName();

Obtient le nom du fichier contenant l'image, si la représentation actuelle est une image.

Valeur de retour
le nom du fichier

getGlobalBoundingBox

bool getGlobalBoundingBox(float & xmin, float & ymin, float & xmax, float & ymax);

Obtient la zone englobante de cette représentation, exprimée dans le repère global.

Paramètres
xmin - l'abscisse minimum
ymin - l'ordonnée minimum
xmax - l'abscisse maximum
ymax - l'ordonnée maximum
Valeur de retour
true si la représentation possède une boite englobante, false sinon

getLayer

int getLayer();

Obtient le numéro de calque utilisée par cette instance. Les calques sont dessinés dans l'ordre numérique (0, 1, ...).

Valeur de retour
le numéro de calque

getLocalBoundingBox

bool getLocalBoundingBox(float & xmin, float & ymin, float & xmax, float & ymax);

Obtient la zone englobante de cette représentation, exprimée dans le repère local.

Paramètres
xmin - l'abscisse minimum
ymin - l'ordonnée minimum
xmax - l'abscisse maximum
ymax - l'ordonnée maximum
Valeur de retour
true si la représentation possède une boite englobante, false sinon

getLocation

void getLocation(float & x, float & y, float & theta);

Obtient la position et l'orientation de la représentation.

Paramètres
x - l'abscisse
y - l'ordonnée
theta - l'orientation

getNbColors

int getNbColors();

Obtient le nombre de couleurs utilisées dans l'image, si la représentation actuelle est une image.

Valeur de retour
le nombre de couleurs

getNbColumns

int getNbColumns();

Obtient le nombre de pixels dans une ligne de l'image, si la représentation actuelle est une image.

Valeur de retour
le nombre de pixels

getNbLines

int getNbLines();

Obtient le nombre de lignes de pixels composant l'image, si la représentation actuelle est une image.

Valeur de retour
le nombre de lignes

getPixel

int getPixel(int x, int y);

Obtient la couleur du pixel spécifié de l'image, si la représentation actuelle est une image.

Paramètres
x - abscisse du pixel dans l'image
y - ordonnée du pixel dans l'image
Valeur de retour
la couleur du pixel (rang dans la palette)

getPixelAt

int getPixelAt(float x, float y);

Obtient la couleur du pixel spécifié de l'image, si la représentation actuelle est une image.

Paramètres
x - abscisse du pixel dans l'image, exprimée dans le repère local de la représentation
y - ordonnée du pixel dans l'image, exprimée dans le repère local de la représentation
Valeur de retour
la couleur du pixel (rang dans la palette)

getPixelScale

float getPixelScale();

Obtient le ratio de l'image, si la représentation actuelle est une image. Chaque pixel de l'image d'origine a une taille à l'écran définie par la valeur de retour de cette méthode.

Valeur de retour
la taille d'un pixel de l'image à l'écran

getRGB

void getRGB(int pixel, int & r, int & g, int & b);

Obtient les composantes rouge, vert et bleu d'une entrée de la palette associée à l'image, si la représentation actuelle est une image.

Paramètres
pixel - le rang dans la palette
r - la composante rouge
g - la composante verte
b - la composante bleue

getTheta

float getTheta();

Obtient l'orientation de la représentation.

Valeur de retour
l'orientation

getX

float getX();

Obtient l'abscisse de la représentation.

Valeur de retour
l'abscisse

getY

float getY();

Obtient l'ordonnée de la représentation.

Valeur de retour
l'ordonnée

globalToLocalAngle

float globalToLocalAngle(float angle);

Convertit l'angle exprimé dans le repère global en un angle exprimé dans le repère local à la représentation.

Paramètres
angle - angle à convertir
Valeur de retour
angle converti

globalToLocalPosition

void globalToLocalPosition(float & x, float & y);

Convertit le point exprimé dans le repère global en un point exprimé dans le repère local à la représentation.

Paramètres
x - abscisse du point à convertir, et abscisse du point converti après appel à cette méthode
y - ordonnée du point à convertir, et ordonnée du point converti après appel à cette méthode

image

void image(string fileName, float pixelScale);

Indique que cet objet est représenté par une image.

Paramètres
fileName - le nom du fichier contenant l'image
pixelScale - un facteur à appliquer sur la taille des pixels (1 pour obtenir l'image d'origine)

inside

bool inside(float x, float y);

Indique si le point spécifié se situe à l'intérieur de cette représentation.

Paramètres
x - l'abscisse du point à tester
y - l'ordonnée du point à tester
Valeur de retour
true si le point est effectivement contenu dans la représentation, ou false dans le cas contraire

intersectRay

bool intersectRay(float & xInter, float & yInter, float xRay, float yRay, float thetaRay);

Envoie un rayon à partir du point spécifié et dans la direction spécifiée, et indique s'il intersecte cette représentation.

Paramètres
xInter - l'abscisse du point d'impact éventuel
yInter - l'ordonnée du point d'impact éventuel
xRay - l'abscisse du point de départ du rayon
yRay - l'ordonnée du point de départ du rayon
thetaRay - l'angle dans le repère global du rayon par rapport à son point de départ
Valeur de retour
true si le rayon intersecte cette représentation, false sinon

isAttachedTo

bool isAttachedTo(Object2d container);

Indique si cette représentation est attachée ou non à une représentation particulière.

Paramètres
container - la représentation susceptible d'etre la parente
Valeur de retour
true si cette représentation est bien attachée à celle passée en paramètre

keyPress

void keyPress(string key);

Appelée lorsqu'une touche a été enfoncée par l'utilisateur pendant que cette représentation est sélectionnée.

Paramètres
key - la touche ayant été actionnée

line

void line(float length);

Indique que cet objet est représenté par une ligne à l'écran.

Paramètres
length - longueur de la ligne

localToGlobalAngle

float localToGlobalAngle(float angle);

Convertit l'angle exprimé dans le repère local à la représentation en un angle exprimé dans le repère global.

Paramètres
angle - angle à convertir
Valeur de retour
angle converti

localToGlobalPosition

void localToGlobalPosition(float & x, float & y);

Convertit le point exprimé dans le repère local à la représentation en un point exprimé dans le repère global.

Paramètres
x - abscisse du point à convertir, et abscisse du point converti après appel à cette méthode
y - ordonnée du point à convertir, et ordonnée du point converti après appel à cette méthode

mouseDrag

void mouseDrag(float dx, float dy);

Appelée lorsque cette représentation reçoit un événement de déplacement de la part de la souris.

Paramètres
dx - la longueur en abscisse du déplacement demandé
dy - la longueur en ordonnée du déplacement demandé

new

void new(float x, float y, float theta);

Crée une nouvelle représentation.

Paramètres
x - l'abscisse initiale de la représentation
y - l'ordonnée initiale de la représentation
theta - l'orientation initiale de la représentation

noShape

void noShape();

Indique que cette représentation ne produit aucun dessin à l'écran.

point

void point();

Indique que cet objet est représenté par un point à l'écran.

polygon

void polygon(float[][] points, bool filled);

Indique que cet objet est représenté par un polygone.

Paramètres
points - les points constituant les extrémités de chaque tronçon de ligne, sachant que le premier et le dernier point sont reliés également
filled - true si le polygone doit etre rempli

polyline

void polyline(float[][] points);

Indique que cet objet est représenté par une polyligne.

Paramètres
points - les points constituant les extrémités de chaque tronçon de ligne

rectangle

void rectangle(float length, float width, bool filled);

Indique que cet objet est représenté par un rectangle à l'écran.

Paramètres
length - la hauteur du rectangle
width - la largeur du rectangle
filled - true si le carré doit etre rempli

rotate

void rotate(float dtheta);

Effectue une rotation à la représentation.

Paramètres
dtheta - la rotation à appliquer

setColor

void setColor(string color);

Fixe la couleur actuelle de la représentation.

Paramètres
color - la nuovelle couleur de la représentation

setLayer

void setLayer(int layer);

Fixe le numéro de calque qui devra etre utilisé par cette instance. Les calques sont dessinés dans l'ordre numérique (0, 1, ...).

Paramètres
layer - le numéro de calque

setLocation

void setLocation(float x, float y, float theta);

Change la position et l'orientation de la représentation.

Paramètres
x - la nouvelle abscisse
y - la nouvelle ordonnée
theta - la nouvelle orientation

setPixel

void setPixel(int x, int y, int color);

Change la couleur du pixel spécifié de l'image, si la représentation actuelle est une image.

Paramètres
x - abscisse du pixel dans l'image
y - ordonnée du pixel dans l'image
color - la nouvelle couleur du pixel (rang dans la palette)

setPixelAt

void setPixelAt(float x, float y, int color);

Change la couleur du pixel spécifié de l'image, si la représentation actuelle est une image.

Paramètres
x - abscisse du pixel dans l'image, exprimée dans le repère local de la représentation
y - ordonnée du pixel dans l'image, exprimée dans le repère local de la représentation
color - la nouvelle couleur du pixel (rang dans la palette)

setTheta

void setTheta(float theta);

Change l'orientation de la représentation.

Paramètres
theta - la nouvelle orientation

setX

void setX(float x);

Change l'abscisse de la représentation.

Paramètres
x - la nouvelle abscisse

setY

void setY(float y);

Change l'ordonnée de la représentation.

Paramètres
y - la nouvelle ordonnée

sortColors

void sortColors();

Trie la palette de couleurs utilisées dans l'image, si la représentation actuelle est une image. Les couleurs les plus sombres seront situées en début de palette et les plus claires en fin.

square

void square(float side, bool filled);

Indique que cet objet est représenté par un carré à l'écran.

Paramètres
side - la longueur d'un coté
filled - true si le carré doit etre rempli

text

void text(string text);

Indique que cet objet est représenté par du texte.

Paramètres
text - le texte associé à la représentation

throwRay

Object2d throwRay(float & xInter, float & yInter, string className);

Envoie un rayon imaginaire à partir du centre de cette représentation et suivant son axe des abscisses positives dans son repère local, et obtient la première représentation éventuelle à etre intersectée par ce rayon.

Paramètres
xInter - l'abscisse du point d'impact du rayon et de la représentation détectée
yInter - l'ordonnée du point d'impact du rayon et de la représentation détectée
className - type de représentations à détecter (filtre)
Valeur de retour
l'objet détecté

translate

void translate(float dx, float dy);

Effectue une translation à la représentation.

Paramètres
dx - déplacement sur les abscisses
dy - déplacement sur les ordonnées

view

Object2d[] view(float[] & angle, float[] & distance, string className, float vision, float range, float turn);

Détecte toutes les représentations d'agents de type spécifié ou d'un type dérivé situées dans un cone de visibilité spécifié.

Paramètres
angle - les angles relatifs entre chaque représentation détectée et cette représentation
distance - les distances relatives entre chaque représentation détectée et cette représentation
className - le type de la représentation à détecter
vision - l'angle d'ouverture du cone du champ de perception
range - la portée du cone du champ de perception
turn - l'orientation du champ par rapport à celle de cette représentation
Valeur de retour
toutes les représentations détectées, ou un tableau vide si aucune représentation n'a été trouvée

viewFirst

Object2d viewFirst(float & angle, float & distance, string className, float vision, float range, float turn);

Détecte la représentation d'un agent de type spécifié ou d'un type dérivé la plus proche et située dans un cone de visibilité spécifié.

Paramètres
angle - l'angle relatif entre la représentation détectée et cette représentation
distance - la distance relative entre la représentation détectée et cette représentation
className - le type de la représentation à détecter
vision - l'angle d'ouverture du cone du champ de perception
range - la portée du cone du champ de perception
turn - l'orientation du champ par rapport à celle de cette représentation
Valeur de retour
la représentation détectée, ou NONE si aucune représentation n'a été trouvée


© Virtualys / E.N.I.B. / LI2 - Tous droits réservés
Dernières modifications :