FreeCAD

1
<?xml version="1.0" encoding="UTF-8"?>
2
<GenerateModel xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="generateMetaModel_Module.xsd">
3
  <PythonExport
4
      Father="PyObjectBase"
5
      Name="CoordinateSystemPy"
6
      Twin="CoordinateSystem"
7
      TwinPointer="CoordinateSystem"
8
      Include="Base/CoordinateSystem.h"
9
      FatherInclude="Base/PyObjectBase.h"
10
      Namespace="Base"
11
      Constructor="true"
12
      Delete="true"
13
      FatherNamespace="Base">
14
    <Documentation>
15
      <Author Licence="LGPL" Name="Juergen Riegel" EMail="FreeCAD@juergen-riegel.net" />
16
      <DeveloperDocu>This is the CoordinateSystem export class</DeveloperDocu>
17
      <UserDocu>Base.CoordinateSystem class.
18

19
An orthonormal right-handed coordinate system in 3D space.
20

21
CoordinateSystem()
22
Empty constructor.</UserDocu>
23
    </Documentation>
24
    <Methode Name="setAxes">
25
      <Documentation>
26
        <UserDocu>setAxes(axis, xDir) -> None
27

28
Set axis or Z-direction, and X-direction.
29
The X-direction is determined from the orthonormal compononent of `xDir`
30
with respect to `axis` direction.
31

32
axis : Base.Axis, Base.Vector
33
xDir : Base.Vector</UserDocu>
34
      </Documentation>
35
    </Methode>
36
    <Methode Name="displacement" Const="true">
37
      <Documentation>
38
        <UserDocu>displacement(coordSystem2) -> Base.Placement
39

40
Computes the placement from this to the passed coordinate system `coordSystem2`.
41

42
coordSystem2 : Base.CoordinateSystem</UserDocu>
43
      </Documentation>
44
    </Methode>
45
    <Methode Name="transformTo">
46
      <Documentation>
47
        <UserDocu>transformTo(vector) -> Base.Vector
48

49
Computes the coordinates of the point in coordinates of this coordinate system.
50

51
vector : Base.Vector</UserDocu>
52
      </Documentation>
53
    </Methode>
54
    <Methode Name="transform">
55
      <Documentation>
56
        <UserDocu>transform(trans) -> None
57

58
Applies a transformation on this coordinate system.
59

60
trans : Base.Rotation, Base.Placement</UserDocu>
61
      </Documentation>
62
    </Methode>
63
    <Methode Name="setPlacement">
64
      <Documentation>
65
        <UserDocu>setPlacment(placement) -> None
66

67
Set placement to the coordinate system.
68

69
placement : Base.Placement</UserDocu>
70
      </Documentation>
71
    </Methode>
72
    <Attribute Name="Axis" ReadOnly="false">
73
      <Documentation>
74
        <UserDocu>Set or get axis.</UserDocu>
75
      </Documentation>
76
      <Parameter Name="Axis" Type="Object" />
77
    </Attribute>
78
    <Attribute Name="XDirection" ReadOnly="false">
79
      <Documentation>
80
        <UserDocu>Set or get X-direction.</UserDocu>
81
      </Documentation>
82
      <Parameter Name="XDirection" Type="Object" />
83
    </Attribute>
84
    <Attribute Name="YDirection" ReadOnly="false">
85
      <Documentation>
86
        <UserDocu>Set or get Y-direction.</UserDocu>
87
      </Documentation>
88
      <Parameter Name="YDirection" Type="Object" />
89
    </Attribute>
90
    <Attribute Name="ZDirection" ReadOnly="false">
91
      <Documentation>
92
        <UserDocu>Set or get Z-direction.</UserDocu>
93
        </Documentation>
94
        <Parameter Name="ZDirection" Type="Object" />
95
    </Attribute>
96
    <Attribute Name="Position" ReadOnly="false">
97
      <Documentation>
98
        <UserDocu>Set or get position.</UserDocu>
99
      </Documentation>
100
      <Parameter Name="Position" Type="Object" />
101
    </Attribute>
102
  </PythonExport>
103
</GenerateModel>
104