Vector API: Difference between revisions
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.| |
{{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
>>>
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
Description: the distance between the vector and a line through Vector1 in direction Vector2.
Returns: float
Description: method of Base.Vector instance distanceToPoint(point2)
Returns: float
Description: a vector to the closest point on a line segment from Vector1 to Vector2.
Returns: Vector
Description: the distance between the vector and a plane defined by a point and a normal.
Returns: float
Description: Checks if the distance between the points represented by this Vector and Vector2 is less or equal to the given tolerance.
Returns: float
Description: Checks if this vector is on the line segment generated by Vector1 and Vector2.
Returns: Vector
Description: multiplies (uniform scale) a vector by the given factor.
Returns: nothing
Description: projects the vector on a line through Vector1 in direction Vector2.
Returns: nothing
Description: projects the vector on a plane defined by a point (Vector1) and a normal (Vector2).
Returns: nothing
Description: Same as multiply but lets specify different values for x, y and z directions. (non-uniform scale)
Returns: nothing
- 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
- Hubs: User hub, Power users hub, Developer hub