API des vecteurs

From FreeCAD Documentation
This page is a translated version of the page Vector API and the translation is 100% complete.
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.