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="FacetPy"
6
      Twin="Facet"
7
      TwinPointer="Facet"
8
      Include="Mod/Mesh/App/Facet.h"
9
      FatherInclude="Base/PyObjectBase.h"
10
      Namespace="Mesh"
11
      Constructor="true"
12
      Delete="true"
13
      FatherNamespace="Base">
14
    <Documentation>
15
      <Author Licence="LGPL" Name="Juergen Riegel" EMail="Juergen.Riegel@web.de" />
16
		<DeveloperDocu>Facet in a Mesh</DeveloperDocu>
17
		<UserDocu>Facet in mesh
18
This is a facet in a MeshObject. You can get it by e.g. iterating a
19
mesh. The facet has a connection to its mesh and allows therefore
20
topological operations. It is also possible to create an unbounded facet e.g. to create
21
a mesh. In this case the topological operations will fail. The same is
22
when you cut the bound to the mesh by calling unbound().
23
		</UserDocu>
24
	</Documentation>
25
	  <Methode Name="unbound">
26
		  <Documentation>
27
			  <UserDocu>method unbound()
28
Cut the connection to a MeshObject. The facet becomes
29
free and is more or less a simple facet.
30
After calling unbound() no topological operation will
31
work!
32
			  </UserDocu>
33
		  </Documentation>
34
	  </Methode>
35
	  <Methode Name="intersect">
36
		  <Documentation>
37
			  <UserDocu>intersect(Facet) -> list
38
Get a list of intersection points with another triangle.
39
			  </UserDocu>
40
		  </Documentation>
41
	  </Methode>
42
      <Methode Name="isDegenerated">
43
          <Documentation>
44
              <UserDocu>isDegenerated([float]) -> boolean
45
Returns true if the facet is degenerated, otherwise false.
46
              </UserDocu>
47
          </Documentation>
48
      </Methode>
49
      <Methode Name="isDeformed">
50
          <Documentation>
51
              <UserDocu>isDegenerated(MinAngle, MaxAngle) -> boolean
52
Returns true if the facet is deformed, otherwise false.
53
A triangle is considered deformed if an angle is less than MinAngle
54
or higher than MaxAngle.
55
The two angles are given in radian.
56
              </UserDocu>
57
          </Documentation>
58
      </Methode>
59
      <Methode Name="getEdge">
60
          <Documentation>
61
              <UserDocu>getEdge(int) -> Edge
62
Returns the edge of the facet.
63
              </UserDocu>
64
          </Documentation>
65
      </Methode>
66
      <Attribute Name="Index" ReadOnly="true">
67
		  <Documentation>
68
			  <UserDocu>The index of this facet in the MeshObject</UserDocu>
69
		  </Documentation>
70
		  <Parameter Name="Index" Type="Long"/>
71
	  </Attribute>
72
	  <Attribute Name="Bound" ReadOnly="true">
73
		  <Documentation>
74
			  <UserDocu>Bound state of the facet</UserDocu>
75
		  </Documentation>
76
		  <Parameter Name="Bound" Type="Boolean"/>
77
	  </Attribute>
78
	  <Attribute Name="Normal" ReadOnly="true">
79
		  <Documentation>
80
			  <UserDocu>Normal vector of the facet.</UserDocu>
81
		  </Documentation>
82
		  <Parameter Name="Normal" Type="Object"/>
83
	  </Attribute>
84
	  <Attribute Name="Points" ReadOnly="true">
85
		  <Documentation>
86
			  <UserDocu>A list of points of the facet</UserDocu>
87
		  </Documentation>
88
		  <Parameter Name="Points" Type="List"/>
89
	  </Attribute>
90
	  <Attribute Name="PointIndices" ReadOnly="true">
91
		  <Documentation>
92
			  <UserDocu>The index tuple of point vertices of the mesh this facet is built of</UserDocu>
93
		  </Documentation>
94
		  <Parameter Name="PointIndices" Type="Tuple"/>
95
	  </Attribute>
96
		<Attribute Name="NeighbourIndices" ReadOnly="true">
97
			<Documentation>
98
				<UserDocu>The index tuple of neighbour facets of the mesh this facet is adjacent with</UserDocu>
99
			</Documentation>
100
			<Parameter Name="NeighbourIndices" Type="Tuple"/>
101
		</Attribute>
102
        <Attribute Name="Area" ReadOnly="true">
103
            <Documentation>
104
                <UserDocu>The area of the facet</UserDocu>
105
            </Documentation>
106
            <Parameter Name="Area" Type="Float"/>
107
        </Attribute>
108
        <Attribute Name="AspectRatio" ReadOnly="true">
109
            <Documentation>
110
                <UserDocu>The aspect ratio of the facet computed by longest edge and its height</UserDocu>
111
            </Documentation>
112
            <Parameter Name="AspectRatio" Type="Float"/>
113
        </Attribute>
114
        <Attribute Name="AspectRatio2" ReadOnly="true">
115
            <Documentation>
116
                <UserDocu>The aspect ratio of the facet computed by radius of circum-circle and in-circle</UserDocu>
117
            </Documentation>
118
            <Parameter Name="AspectRatio2" Type="Float"/>
119
        </Attribute>
120
        <Attribute Name="Roundness" ReadOnly="true">
121
            <Documentation>
122
                <UserDocu>The roundness of the facet</UserDocu>
123
            </Documentation>
124
            <Parameter Name="Roundness" Type="Float"/>
125
        </Attribute>
126
        <Attribute Name="CircumCircle" ReadOnly="true">
127
            <Documentation>
128
                <UserDocu>The center and radius of the circum-circle</UserDocu>
129
            </Documentation>
130
            <Parameter Name="CircumCircle" Type="Tuple"/>
131
        </Attribute>
132
        <Attribute Name="InCircle" ReadOnly="true">
133
            <Documentation>
134
                <UserDocu>The center and radius of the in-circle</UserDocu>
135
            </Documentation>
136
            <Parameter Name="InCircle" Type="Tuple"/>
137
        </Attribute>
138
    </PythonExport>
139
</GenerateModel>
140