Vector API: Difference between revisions

Revision as of 13:07, 25 July 2022

Other languages:

(October 2019) Do not edit this page. The information is incomplete and outdated. For the latest API, see the autogenerated API documentation, or generate the documentation yourself, see Source documentation.

Vectors are used everywhere in FreeCAD.

Example:

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

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

multiply(Float)

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

Returns: nothing

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.

User documentation

Getting started
Installation: Download, Windows, Linux, Mac, Additional components, Docker, AppImage, Ubuntu Snap
Basics: About FreeCAD, Interface, Mouse navigation, Selection methods, Object name, Preferences, Workbenches, Document structure, Properties, Help FreeCAD, Donate

Help: Tutorials, Video tutorials
Workbenches: Std Base, Arch, Assembly, CAM, Draft, FEM, Inspection, Mesh, OpenSCAD, Part, PartDesign, Points, Reverse Engineering, Robot, Sketcher, Spreadsheet, Start, Surface, TechDraw, Test Framework, Web

Addons: Addon Manager, External workbenches, Scripting and macros

Hubs: User hub, Power users hub, Developer hub

@@ Line 1: / Line 1: @@
+<languages/>
 <translate>
 <!--T:1-->
+{{VeryImportantMessage|(October 2019) Do not edit this page. The information is incomplete and outdated. For the latest API, see the [https://www.freecadweb.org/api autogenerated API documentation], or generate the documentation yourself, see [[Source documentation|Source documentation]].}}
+<!--T:20-->
 Vectors are used everywhere in FreeCAD.
@@ Line 6: / Line 10: @@
 Example:
 </translate>
+{{Code|code=
-<pre>
 v=FreeCAD.Vector()
 v=FreeCAD.Vector(1,0,0)
@@ Line 13: / Line 17: @@
 v3 = v.add(v2)
 print v3.Length
+}}
-</pre>
 <translate>
 <!--T:3-->
 {{APIProperty|Length|returns the length of the vector.}}
+{{APIFunction|add|Vector|adds another vector to this one.|vector}}
+{{APIFunction|cross|Vector|the crossproduct between this vector and another.|vector}}
-<!--T:4-->
-{{APIFunction|add|Vector|adds another vector to this one|the sum of both vectors.}}
+{{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|distanceToPlane|Vector1,Vector2|the distance between the vector and a plane defined by a point and a normal.|float}}
-<!--T:5-->
-{{APIFunction|cross|Vector| |the crossproduct between two vectors.}}
+{{APIFunction|dot|Vector|the dot product between 2 vectors.|float}}
+{{APIFunction|getAngle|Vector|the angle in radians between this vector and another.|float}}
+{{APIFunction|multiply|Float|multiplies (uniform scale) a vector by the given factor.|nothing}}
-<!--T:6-->
-{{APIFunction|distanceToLine|Vector1,Vector2| |the distance between the vector and a line between Vector1 and Vector2.}}
+{{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|projectToPlane|Vector1,Vector2|projects the vector on a plane defined by a point (Vector1) and a normal (Vector2).|nothing}}
-<!--T:7-->
-{{APIFunction|distanceToPlane|Vector1,Vector2| |the distance between the vector and a plane defined by a point and a normal.}}
+{{APIFunction|scale|Float,Float,Float|Same as multiply but lets specify different values for x, y and z directions. (non-uniform scale)|nothing}}
+{{APIFunction|sub|Vector|subtracts another vector from this one.|vector}}
-<!--T:8-->
-{{APIFunction|dot|Vector| |the dot product between 2 vectors.}}
-<!--T:9-->
-{{APIFunction|getAngle|Vector| |the angle in radians between 2 vectors.}}
-<!--T:10-->
-{{APIFunction|multiply|Float|multiplies (scales) a vector by the given factor|nothing.}}
-<!--T:11-->
-{{APIFunction|normalize| |normalizes a vector (sets its length to 1.0).|nothing.}}
-<!--T:12-->
-{{APIFunction|projectToLine|Vector1,Vector2|projects the vector on a line between Vector1 and Vector2.|nothing.}}
-<!--T:13-->
-{{APIFunction|projectToPlane|Vector1,Vector2|projects the vector on a plane defined by a point and a normal.|nothing.}}
-<!--T:14-->
-{{APIFunction|scale|Float,Float,Float|Same as multiply but lets specify different values for x, y and z directions.|nothing.}}
-<!--T:15-->
-{{APIFunction|sub|Vector|subtracts another vector from the first one.|the resulting vector.}}
-<!--T:16-->
 {{APIProperty|x|the x coordinate of a vector.}}
-<!--T:17-->
 {{APIProperty|y|the y coordinate of a vector.}}
-<!--T:18-->
 {{APIProperty|z|the z coordinate of a vector.}}
-<!--T:19-->
-[[Category:API]]
 </translate>
+{{Userdocnavi{{#translation:}}}}
+[[Category:API{{#translation:}}]]
+[[Category:Poweruser Documentation{{#translation:}}]]
 {{clear}}
-<languages/>