Files
create/src/Mod/Mesh/App/MeshPointPy.xml
2017-02-24 14:20:50 +01:00

92 lines
3.4 KiB
XML

<?xml version="1.0" encoding="UTF-8"?>
<GenerateModel xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="generateMetaModel_Module.xsd">
<PythonExport
Father="PyObjectBase"
Name="MeshPointPy"
Twin="MeshPoint"
TwinPointer="MeshPoint"
Include="Mod/Mesh/App/MeshPoint.h"
FatherInclude="Base/PyObjectBase.h"
Namespace="Mesh"
Constructor="true"
Delete="true"
FatherNamespace="Base">
<Documentation>
<Author Licence="LGPL" Name="Juergen Riegel" EMail="FreeCAD@juergen-riegel.net" />
<DeveloperDocu>Point in a Mesh</DeveloperDocu>
<UserDocu> Point in mesh
This is a point in a MeshObject. You can get it by e.g. iterating a
mesh. The point has a connection to its mesh and allows therefore
topological operations. It is also possible to create an unbounded mesh point e.g. to create
a mesh. In this case the topological operations will fail. The same is
when you cut the bound to the mesh by calling unbound().
</UserDocu>
</Documentation>
<Methode Name="unbound">
<Documentation>
<UserDocu> method unbound()
Cut the connection to a MeshObject. The point becomes
free and is more or less a simple vector/point.
After calling unbound() no topological operation will
work!
</UserDocu>
</Documentation>
</Methode>
<Methode Name="move">
<Documentation>
<UserDocu>method move(Vector)
This method moves the point in the mesh along the
given vector. This affects the geometry of the mesh.
Be aware that after moving point(s) the mesh can
have self intersections!
</UserDocu>
</Documentation>
</Methode>
<Attribute Name="Index" ReadOnly="true">
<Documentation>
<UserDocu>The index of this point in the MeshObject</UserDocu>
</Documentation>
<Parameter Name="Index" Type="Long"/>
</Attribute>
<Attribute Name="Bound" ReadOnly="true">
<Documentation>
<UserDocu>Bound state of the point</UserDocu>
</Documentation>
<Parameter Name="Bound" Type="Boolean"/>
</Attribute>
<Attribute Name="Normal" ReadOnly="true">
<Documentation>
<UserDocu>Normal vector of the point computed by the surrounding mesh.</UserDocu>
</Documentation>
<Parameter Name="Normal" Type="Object"/>
</Attribute>
<Attribute Name="Vector" ReadOnly="true">
<Documentation>
<UserDocu>Vector of the point.</UserDocu>
</Documentation>
<Parameter Name="Normal" Type="Object"/>
</Attribute>
<Attribute Name="x" ReadOnly="false">
<Documentation>
<UserDocu>The X component of the point.
Setting this value also affects the mesh if this point is connected to it.</UserDocu>
</Documentation>
<Parameter Name="x" Type="Float"/>
</Attribute>
<Attribute Name="y" ReadOnly="false">
<Documentation>
<UserDocu>The Y component of the point.
Setting this value also affects the mesh if this point is connected to it.</UserDocu>
</Documentation>
<Parameter Name="y" Type="Float"/>
</Attribute>
<Attribute Name="z" ReadOnly="false">
<Documentation>
<UserDocu>The Z component of the point.
Setting this value also affects the mesh if this point is connected to it.</UserDocu>
</Documentation>
<Parameter Name="z" Type="Float"/>
</Attribute>
</PythonExport>
</GenerateModel>