====== La règle ======
Cette page présente toutes les possibilités d'actions de la règle dans un script Instrumenpoche. Ce sont les nœuds XML de la forme :
<code XML><action objet="regle" mouvement="..." ... /></code>
===== Déplacement, apparition =====

Comme tous les instruments, la règle peut être masquée avec :
<code XML><action objet="regle" mouvement="masquer" /></code>
Elle est montrée avec :
<code XML><action objet="regle" mouvement="montrer" /></code>
Il est possible de faire apparaître la règle à un autre endroit de la scène que celui qui est prévu par défaut en précisant les [[script:coordonnees|coordonnées]] de cet endroit, par exemple :
<code XML><action objet="regle" mouvement="montrer" abscisse="200" ordonnee="350" /></code>
Les coordonnées de la règle sont celles du zéro des graduations.

La règle peut être déplacée jusqu'à un point en utilisant :
<code XML><action objet="regle" mouvement="translation" abscisse="200" ordonnee="350" /></code>
Un attribut ''vitesse'' peut être précisé, il donne le nombre de pixels de déplacement de la règle par dixième de seconde. La valeur par défaut est 8.
<code XML><action objet="regle" mouvement="translation" abscisse="200" ordonnee="350" vitesse="10" /></code>
Elle peut également pivoter autour du zéro :
<code XML><action objet="regle" mouvement="rotation" angle="90" sens="-5" /></code>
L'attribut ''sens'' est similaire à l'attribut ''vitesse'' pour une translation. Cependant, ''sens'' peut être négatif. Une valeur positive permet de faire pivoter la règle dans le sens des aiguilles d'une montre, une valeur négative dans l'autre sens. La valeur absolue de ''sens'' indique le nombre de degrés dont la règle pivote à chaque dixième de seconde. L'attribut ''angle'' donne l'angle que va faire la règle avec l'horizontale à la fin de sa rotation.

Si un [[:script:point]] a été créé auparavant, la règle peut être déplacée jusqu'à ce point en utilisant l'attribut ''cible'' qui devra être égal à l'''id'' du point voulu.

**Exemple**
<code XML>
<?xml version="1.0" encoding="UTF-8"?>
<INSTRUMENPOCHE version="2">
<action ordonnee="243.5" abscisse="292.8" couleur="noir" 
    id="1" mouvement="creer" objet="point" />
<action mouvement="montrer" objet="regle" />
<action cible="1" mouvement="translation" objet="regle" />
</INSTRUMENPOCHE></code>

Ceci est également valable pour la rotation :
<code XML>
<action cible="1" mouvement="rotation" objet="regle" />
</code>



===== Modification : graduations et longueur =====
On peut masquer les graduations de la règle par :
<code XML><action mouvement="vide" objet="regle" />
</code>
et les faire apparaître par :

<code XML>
<action mouvement="graduations" objet="regle" />
</code>

Par défaut, la règle mesure 15 centimètres. On peut modifier cette donnée par 

<code XML>
<action mouvement="modifier_longueur" objet="regle" longueur="..."/>
</code>

où ''longueur'' donne la longueur voulue pour la règle, en centimètres. La valeur maximale est de 30 cm. Cette longueur est celle des graduations de la règle, l'instrument lui-même étant un peu plus long.



===== Voir aussi =====
   * [[:interface:regle]] pour voir comment manipuler la règle avec la souris.
   * [[http://instrumenpoche.sesamath.net/documentation_classes/RegleIep.html|La classe regleIep]] présente les données à connaître pour programmer la règle depuis une autre application.