Vector API

From FreeCAD Documentation
Jump to: navigation, search
Other languages:
Deutsch • ‎English • ‎español • ‎français • ‎italiano • ‎română
(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
Property.png Length

Returns: returns the length of the vector.

Method.png add(Vector)

Description: adds another vector to this one.

Returns: vector

Method.png cross(Vector)

Description: the crossproduct between this vector and another.

Returns: vector

Method.png distanceToLine(Vector1,Vector2)

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

Returns: float

Method.png distanceToLineSegment(Vector1,Vector2)

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

Returns: vector

Method.png distanceToPlane(Vector1,Vector2)

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

Returns: float

Method.png dot(Vector)

Description: the dot product between 2 vectors.

Returns: float

Method.png getAngle(Vector)

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

Returns: float

Method.png multiply(Float)

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

Returns: nothing

Method.png normalize( )

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

Returns: nothing

Method.png projectToLine(Vector1,Vector2)

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

Returns: nothing

Method.png projectToPlane(Vector1,Vector2)

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

Returns: nothing

Method.png scale(Float,Float,Float)

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

Returns: nothing

Method.png sub(Vector)

Description: subtracts another vector from this one.

Returns: vector

Property.png x

Returns: the x coordinate of a vector.

Property.png y

Returns: the y coordinate of a vector.

Property.png z

Returns: the z coordinate of a vector.