Base API: Difference between revisions

From FreeCAD Documentation
(Created page with 'The Base module is contained inside the FreeCAD module and contains constructors for different types of objects heavily used in FreeCAD. {{APIClass|BoundBox|[Xmin,Ymin,Zmin,Xma…')
 
No edit summary
 
(15 intermediate revisions by 5 users not shown)
Line 1: Line 1:
<languages/>
<translate>
<!--T:10-->
{{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:1-->
The Base module is contained inside the FreeCAD module and contains constructors for different types of objects heavily used in FreeCAD.
The Base module is contained inside the FreeCAD module and contains constructors for different types of objects heavily used in FreeCAD.


<!--T:2-->
{{APIClass|BoundBox|[Xmin,Ymin,Zmin,Xmax,Ymax,Zmax] ) or ( Tuple, Tuple ) or ( Vector, Vector|Creates a bounding box. A bounding box is an orthographic cube which is a way to describe outer boundaries. You get a bounding box from a lot of 3D types. It is often used to check if a 3D entity lies in the range of another object. Checking for boundig interference first can save a lot of computing time!}}
{{APIClass b|BoundBox|[Xmin,Ymin,Zmin,Xmax,Ymax,Zmax]}}
{{APIClass b|BoundBox|Tuple, Tuple}}
{{APIClass|BoundBox|Vector, Vector|
Creates a bounding box.
A bounding box is an orthographic cube which is a way to describe outer boundaries. You get a bounding box from a lot of 3D types. It is often used to check if a 3D entity lies in the range of another object. Checking for bounding interference first can save a lot of computing time!}}


<!--T:7-->
{{APIClass|Matrix| |Creates a 4x4 [[Matrix_API|Matrix]], that can be used to apply transformations to objects.}}
{{APIClass|Matrix| |Creates a 4x4 [[Matrix_API|Matrix]], that can be used to apply transformations to objects.}}


<!--T:8-->
{{APIClass|Vector|) or ( x,y,z|Creates a FreeCAD 3D [[Vector_API|Vector]], representing a 3D point or a direction.}}
{{APIClass b|Vector| }}
{{APIClass|Vector|x, y, z|Creates a FreeCAD 3D [[Vector_API|Vector]], representing a 3D point or a direction.}}


<!--T:9-->
{{APIClass|Placement| |Creates a [[Placement_API|Placement]].}}
{{APIClass|Placement| |Creates a [[Placement_API|Placement]].}}


</translate>
[[Category:API]]
{{Userdocnavi{{#translation:}}}}
[[Category:API{{#translation:}}]]
[[Category:Poweruser Documentation{{#translation:}}]]
{{clear}}

Latest revision as of 20:52, 27 February 2020

(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.

The Base module is contained inside the FreeCAD module and contains constructors for different types of objects heavily used in FreeCAD.

BoundBox([Xmin,Ymin,Zmin,Xmax,Ymax,Zmax])
BoundBox(Tuple, Tuple)
BoundBox(Vector, Vector)

Description: Creates a bounding box. A bounding box is an orthographic cube which is a way to describe outer boundaries. You get a bounding box from a lot of 3D types. It is often used to check if a 3D entity lies in the range of another object. Checking for bounding interference first can save a lot of computing time!

Matrix( )

Description: Creates a 4x4 Matrix, that can be used to apply transformations to objects.

Vector( )
Vector(x, y, z)

Description: Creates a FreeCAD 3D Vector, representing a 3D point or a direction.

Placement( )

Description: Creates a Placement.