Vector API: Difference between revisions

From FreeCAD Documentation
m (Undo revision 1165448 by Marja1 (talk))
Tag: Undo
(adding 'distanceToPoint', 'isEqual', 'isOnLineSegment', 'negative')
Line 1: Line 1:

>>>

<languages/>
<languages/>
<translate>
<translate>
Line 25: Line 28:
{{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|distanceToPoint|point2|method of Base.Vector instance distanceToPoint(point2) |float}}
{{APIFunction|distanceToLineSegment|Vector1,Vector2|a vector to the closest point on a line segment from Vector1 to Vector2.|vector}}
{{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|Vector|Checks if the distance between the points represented by this Vector and Vector2 is less or equal to the given tolerance.|float}}
{{APIFunction|isOnLineSegment|Vector1,Vector2|Checks if this vector is on the line segment generated by Vector1 and Vector2.|Vector}}
{{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}}

Revision as of 18:49, 16 November 2023

>>>

(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

distanceToPoint(point2)

Description: method of Base.Vector instance distanceToPoint(point2)

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(Vector)

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

Returns: float

isOnLineSegment(Vector1,Vector2)

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

Returns: Vector

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.