Vector API/fr: Difference between revisions

From FreeCAD Documentation
(Created page with "Vector API")
 
No edit summary
 
(37 intermediate revisions by 6 users not shown)
Line 1: Line 1:
⚫
<languages/>
Vectors are used everywhere in FreeCAD.

{{VeryImportantMessage|(Octobre 2019) Ne modifiez pas cette page. L'information est incomplète et obsolète. Pour la dernière API, consultez la [https://www.freecadweb.org/api documentation de l'API générée automatiquement], ou générez la documentation vous-même, voir [[Source_documentation/fr|Documentation du code source]].}}

Les vecteurs sont utilisés partout dans FreeCAD.


Exemple :
Example:
{{Code|code=
<pre>
v=FreeCAD.Vector()
v=FreeCAD.Vector()
v=FreeCAD.Vector(1,0,0)
v=FreeCAD.Vector(1,0,0)
Line 9: Line 13:
v3 = v.add(v2)
v3 = v.add(v2)
print v3.Length
print v3.Length
}}
</pre>


⚫
{{APIProperty|Length|renvoie la longueur du vecteur.}}
{{APIFunction|add|Vector|ajoute un autre vecteur à celui-ci|vecteur}}
{{APIFunction|distanceToPoint|Vector|la distance entre ce vecteur et un autre.|virgule flottante}}
{{APIFunction |cross|Vector|le produit croisé entre ce vecteur et un autre.|vecteur}}
⚫
{{APIFunction|distanceToLine|Vector1, Vector2|la distance entre le vecteur et une ligne passant par Vecteur1 dans la direction Vecteur2.|virgule flottante}}
{{APIFunction|distanceToLineSegment|Vector1,Vector2|un vecteur au point le plus proche sur un segment de ligne de Vector1 à Vector2.|vecteur}}
⚫
{{APIFunction|distanceToPlane|Vector1, Vector2|la distance entre le vecteur et un plan défini par un point et une normale.|virgule flottante}}
{{APIFunction|dot|Vector|le produit scalaire entre deux vecteurs.|virgule flottante}}
⚫
{{APIFunction|getAngle|Vector|l'angle en radians entre ce vecteur et un autre.|virgule flottante}}
{{APIFunction|isEqual|Vector2,tolerance|vérifie si la distance entre les points représentés par ce Vector et Vector2 est inférieure ou égale à la tolérance donnée.|vrai/faux}}
{{APIFunction|isNormal|Vector2,tolerance|vérifie si ce vecteur est normal à Vector2 dans les limites de la tolérance.|vrai/faux}}
{{APIFunction|isOnLineSegment|Vector1,Vector2|vérifie si ce vecteur est sur le segment de ligne généré par Vector1 et Vector2.|vecteur}}
{{APIFunction|isParallel|Vector2,tolerance|vérifie si ce vecteur est parallèle à Vector2 dans la limite de la tolérance.|vrai/faux}}
⚫
{{APIFunction|multiply|Float|multiplie (échelles) un vecteur par le facteur donné.|rien}}
{{APIFunction|negative|Vector|renvoie le négatif (opposé) de ce vecteur.|vecteur}}
⚫
{{APIFunction|normalize| |normalise un vecteur (fixe sa longueur à 1,0).|rien}}
⚫
{{APIFunction|projectToLine|Vector1, Vector2 |projette le vecteur sur une ligne entre Vecteur1 et Vector2.|rien}}
⚫
{{APIFunction|projectToPlan|Vector1, Vector2| projette le vecteur sur un plan défini par un point et un normal|rien}}
{{APIFunction|scale|Float,Float,Float|comme multiply, mais permet de spécifier des valeurs différentes pour les directions x, y et z. (échelle non uniforme)|rien}}
{{APIFunction |sub|Vector|soustrait un autre vecteur du premier.|vecteur}}
{{APIProperty|x|la coordonnée x d'un vecteur.}}
{{APIProperty |y|la coordonnée y d'un vecteur.}}
{{APIProperty|z|la coordonnée z d'un vecteur.}}


{{Userdocnavi{{#translation:}}}}
⚫
{{APIProperty|Length|returns the length of the vector.}}
⚫
[[Category:API{{#translation:}}]]
{{APIFunction|add|Vector|adds another vector to this one|the sum of both vectors.}}
[[Category:Poweruser Documentation{{#translation:}}]]
{{APIFunction|cross|Vector| |the crossproduct between two vectors.}}
⚫
{{APIFunction|distanceToLine|Vector1,Vector2| |the distance between the vector and a line between Vector1 and Vector2.}}
⚫
{{APIFunction|distanceToPlane|Vector1,Vector2| |the distance between the vector and a plane defined by a point and a normal.}}
{{APIFunction|dot|Vector| |the dot product between 2 vectors.}}
⚫
{{APIFunction|getAngle|Vector| |the angle in radians between 2 vectors.}}
⚫
{{APIFunction|multiply|Float|multiplies (scales) a vector by the given factor|nothing.}}
⚫
{{APIFunction|normalize| |normalizes a vector (sets its length to 1.0).|nothing.}}
⚫
{{APIFunction|projectToLine|Vector1,Vector2|projects the vector on a line between Vector1 and Vector2.|nothing.}}
⚫
{{APIFunction|projectToPlane|Vector1,Vector2|projects the vector on a plane defined by a point and a normal.|nothing.}}
{{APIFunction|scale|Float,Float,Float|Same as multiply but lets specify different values for x, y and z directions.|nothing.}}
{{APIFunction|sub|Vector|subtracts another vector from the first one.|the resulting vector.}}
{{APIProperty|x|the x coordinate of a vector.}}
{{APIProperty|y|the y coordinate of a vector.}}
{{APIProperty|z|the z coordinate of a vector.}}

⚫
[[Category:API]]

{{clear}}
{{clear}}
⚫
<languages/>

Latest revision as of 20:40, 16 January 2024

Other languages:
(Octobre 2019) Ne modifiez pas cette page. L'information est incomplète et obsolète. Pour la dernière API, consultez la documentation de l'API générée automatiquement, ou générez la documentation vous-même, voir Documentation du code source.

Les vecteurs sont utilisés partout dans FreeCAD.

Exemple : 

v=FreeCAD.Vector()
v=FreeCAD.Vector(1,0,0)
v=FreeCAD.Base.Vector()
v2 = FreeCAD.Vector(3,2,-5)
v3 = v.add(v2)
print v3.Length
Length

Returns: renvoie la longueur du vecteur.

add(Vector)

Description: ajoute un autre vecteur à celui-ci

Returns: vecteur

distanceToPoint(Vector)

Description: la distance entre ce vecteur et un autre.

Returns: virgule flottante

cross(Vector)

Description: le produit croisé entre ce vecteur et un autre.

Returns: vecteur

distanceToLine(Vector1, Vector2)

Description: la distance entre le vecteur et une ligne passant par Vecteur1 dans la direction Vecteur2.

Returns: virgule flottante

distanceToLineSegment(Vector1,Vector2)

Description: un vecteur au point le plus proche sur un segment de ligne de Vector1 à Vector2.

Returns: vecteur

distanceToPlane(Vector1, Vector2)

Description: la distance entre le vecteur et un plan défini par un point et une normale.

Returns: virgule flottante

dot(Vector)

Description: le produit scalaire entre deux vecteurs.

Returns: virgule flottante

getAngle(Vector)

Description: l'angle en radians entre ce vecteur et un autre.

Returns: virgule flottante

isEqual(Vector2,tolerance)

Description: vérifie si la distance entre les points représentés par ce Vector et Vector2 est inférieure ou égale à la tolérance donnée.

Returns: vrai/faux

isNormal(Vector2,tolerance)

Description: vérifie si ce vecteur est normal à Vector2 dans les limites de la tolérance.

Returns: vrai/faux

isOnLineSegment(Vector1,Vector2)

Description: vérifie si ce vecteur est sur le segment de ligne généré par Vector1 et Vector2.

Returns: vecteur

isParallel(Vector2,tolerance)

Description: vérifie si ce vecteur est parallèle à Vector2 dans la limite de la tolérance.

Returns: vrai/faux

multiply(Float)

Description: multiplie (échelles) un vecteur par le facteur donné.

Returns: rien

negative(Vector)

Description: renvoie le négatif (opposé) de ce vecteur.

Returns: vecteur

normalize( )

Description: normalise un vecteur (fixe sa longueur à 1,0).

Returns: rien

projectToLine(Vector1, Vector2 )

Description: projette le vecteur sur une ligne entre Vecteur1 et Vector2.

Returns: rien

projectToPlan(Vector1, Vector2)

Description: projette le vecteur sur un plan défini par un point et un normal

Returns: rien

scale(Float,Float,Float)

Description: comme multiply, mais permet de spécifier des valeurs différentes pour les directions x, y et z. (échelle non uniforme)

Returns: rien

sub(Vector)

Description: soustrait un autre vecteur du premier.

Returns: vecteur

x

Returns: la coordonnée x d'un vecteur.

y

Returns: la coordonnée y d'un vecteur.

z

Returns: la coordonnée z d'un vecteur.

Hub utilisateurs
Retrieved from "http://wiki.freecad.org/index.php?title=Vector_API/fr&oldid=1356226"