Vector API/de: Difference between revisions

From FreeCAD Documentation
(Updating to match new version of source page)
(Updating to match new version of source page)
 
(6 intermediate revisions by 2 users not shown)
Line 1: Line 1:
<languages/>
<languages/>
<div class="mw-translate-fuzzy">
{{VeryImportantMessage|(November 2018) Diese Information kann unvollständig und veraltet sein. Für die letzte API siehe die (engl.) [https://www.freecadweb.org/api autogenerierte API-Dokumentation].}}


{{VeryImportantMessage|(Oktober 2019) Bearbeite diese Seiten nicht. Die Informationen sind unvollständig und veraltet. Die neueste API findest Du in der [https://www.freecadweb.org/api autogenerierten API-Dokumentation] oder generiere die Dokumentation selbst, siehe [[Source documentation/de|Quelldokumentation]].}}
Vektoren werden überall in FreeCAD benutzt.
</div>


Vectors are used everywhere in FreeCAD.
Vektoren werden überall in FreeCAD benutzt.


Beispiel:
Beispiel:
Line 22: Line 19:
{{APIFunction|cross|Vector|the crossproduct between this vector and another.|vector}}
{{APIFunction|cross|Vector|the crossproduct between this vector and another.|vector}}
{{APIFunction|distanceToLine|Vector1,Vector2|the distance between the vector and a line through Vector1 in direction Vector2.|float}}
{{APIFunction|distanceToLine|Vector1,Vector2|the distance between the vector and a line through Vector1 in direction Vector2.|float}}
{{APIFunction|distanceToLineSegment|Vector1,Vector2|a vector to the closest point on a line segment from Vector1 to Vector2.|vector}}
{{APIFunction|distanceToPoint|Vector|the distance between this vector and another.|float}}
{{APIFunction|distanceToLineSegment|Vector1,Vector2|a vector to the closest point on a line segment from Vector1 to Vector2.|Vector}}
{{APIFunction|distanceToPlane|Vector1,Vector2|the distance between the vector and a plane defined by a point and a normal.|float}}
{{APIFunction|distanceToPlane|Vector1,Vector2|the distance between the vector and a plane defined by a point and a normal.|float}}
{{APIFunction|dot|Vector|the dot product between 2 vectors.|float}}
{{APIFunction|dot|Vector|the dot product between 2 vectors.|float}}
{{APIFunction|getAngle|Vector|the angle in radians between this vector and another.|float}}
{{APIFunction|getAngle|Vector|the angle in radians between this vector and another.|float}}
{{APIFunction|isEqual|Vector2,tolerance|Checks if the distance between the points represented by this Vector and Vector2 is less than or equal to the given tolerance.|True/False}}
{{APIFunction|isNormal|Vector2,tolerance|Checks if this Vector is normal to Vector2 within the tolerance.|True/False}}
{{APIFunction|isOnLineSegment|Vector1,Vector2|Checks if this vector is on the line segment generated by Vector1 and Vector2.|Vector}}
{{APIFunction|isParallel|Vector2,tolerance|Checks if this Vector is parallel to Vector2 within the tolerance.|True/False}}
{{APIFunction|multiply|Float|multiplies (uniform scale) a vector by the given factor.|nothing}}
{{APIFunction|multiply|Float|multiplies (uniform scale) a vector by the given factor.|nothing}}
{{APIFunction|negative|Vector|Returns the negative (opposite) of this vector.|Vector}}
{{APIFunction|normalize| |normalizes a vector (sets its length to 1.0).|nothing}}
{{APIFunction|normalize| |normalizes a vector (sets its length to 1.0).|nothing}}
{{APIFunction|projectToLine|Vector1,Vector2|projects the vector on a line through Vector1 in direction Vector2.|nothing}}
{{APIFunction|projectToLine|Vector1,Vector2|projects the vector on a line through Vector1 in direction Vector2.|nothing}}
Line 36: Line 39:
{{APIProperty|z|the z coordinate of a vector.}}
{{APIProperty|z|the z coordinate of a vector.}}


{{Userdocnavi{{#translation:}}}}
[[Category:API/de]]
[[Category:API{{#translation:}}]]

[[Category:Poweruser Documentation{{#translation:}}]]
{{clear}}
{{clear}}

Latest revision as of 16:51, 15 January 2024

(Oktober 2019) Bearbeite diese Seiten nicht. Die Informationen sind unvollständig und veraltet. Die neueste API findest Du in der autogenerierten API-Dokumentation oder generiere die Dokumentation selbst, siehe Quelldokumentation.

Vektoren werden überall in FreeCAD benutzt.

Beispiel:

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: returns the length of the vector.

add(Vector)

Description: adds another vector to this one.

Returns: vector

cross(Vector)

Description: the crossproduct between this vector and another.

Returns: vector

distanceToLine(Vector1,Vector2)

Description: the distance between the vector and a line through Vector1 in direction Vector2.

Returns: float

distanceToPoint(Vector)

Description: the distance between this vector and another.

Returns: float

distanceToLineSegment(Vector1,Vector2)

Description: a vector to the closest point on a line segment from Vector1 to Vector2.

Returns: Vector

distanceToPlane(Vector1,Vector2)

Description: the distance between the vector and a plane defined by a point and a normal.

Returns: float

dot(Vector)

Description: the dot product between 2 vectors.

Returns: float

getAngle(Vector)

Description: the angle in radians between this vector and another.

Returns: float

isEqual(Vector2,tolerance)

Description: Checks if the distance between the points represented by this Vector and Vector2 is less than or equal to the given tolerance.

Returns: True/False

isNormal(Vector2,tolerance)

Description: Checks if this Vector is normal to Vector2 within the tolerance.

Returns: True/False

isOnLineSegment(Vector1,Vector2)

Description: Checks if this vector is on the line segment generated by Vector1 and Vector2.

Returns: Vector

isParallel(Vector2,tolerance)

Description: Checks if this Vector is parallel to Vector2 within the tolerance.

Returns: True/False

multiply(Float)

Description: multiplies (uniform scale) a vector by the given factor.

Returns: nothing

negative(Vector)

Description: Returns the negative (opposite) of this vector.

Returns: Vector

normalize( )

Description: normalizes a vector (sets its length to 1.0).

Returns: nothing

projectToLine(Vector1,Vector2)

Description: projects the vector on a line through Vector1 in direction Vector2.

Returns: nothing

projectToPlane(Vector1,Vector2)

Description: projects the vector on a plane defined by a point (Vector1) and a normal (Vector2).

Returns: nothing

scale(Float,Float,Float)

Description: Same as multiply but lets specify different values for x, y and z directions. (non-uniform scale)

Returns: nothing

sub(Vector)

Description: subtracts another vector from this one.

Returns: vector

x

Returns: the x coordinate of a vector.

y

Returns: the y coordinate of a vector.

z

Returns: the z coordinate of a vector.