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="BaseClassPy"
5
        Name="LinkViewPy"
6
        Twin="LinkView"
7
        TwinPointer="LinkView"
8
        Include="Gui/ViewProviderLink.h"
9
        Namespace="Gui"
10
        FatherInclude="Base/BaseClass.h"
11
        FatherNamespace="Base"
12
        Constructor="true"
13
        Delete="true">
14
        <Documentation>
15
            <Author Licence="LGPL" Name="Zheng, Lei" EMail="realthunder.dev@gmail.com" />
16
            <UserDocu>Helper class to link to a view object</UserDocu>
17
        </Documentation>
18
        <Methode Name="reset">
19
            <Documentation>
20
                <UserDocu>Reset the link view and clear the links</UserDocu>
21
            </Documentation>
22
        </Methode>
23
        <Methode Name="setMaterial">
24
            <Documentation>
25
                <UserDocu>
26
setMaterial(Material): set the override material of the entire linked object
27

28
setMaterial([Material,...]): set the materials for the elements of the link
29
                             array/group.
30

31
setMaterial({Int:Material,...}): set the material for the elements of the
32
                                 link array/group by index.
33

34
If material is None, then the material is unset. If the material of an element
35
is unset, it defaults to the override material of the linked object, if there
36
is one
37
                </UserDocu>
38
            </Documentation>
39
        </Methode>
40
        <Methode Name="setType">
41
            <Documentation>
42
                <UserDocu>
43
setType(type, sublink=True): set the link type.
44

45
type=0:  override transformation and visibility
46
type=1:  override visibility
47
type=2:  no override
48
type=-1: sub-object link with override visibility
49
type=-2: sub-object link with override transformation and visibility
50

51
sublink: auto delegate to the sub-object references in the link, if there is
52
         one and only one.
53
                </UserDocu>
54
            </Documentation>
55
        </Methode>
56
        <Methode Name="setTransform">
57
            <Documentation>
58
                <UserDocu>
59
setTransform(matrix): set transformation of the linked object
60

61
setTransform([matrix,...]): set transformation for the elements of the link
62
                            array/group
63

64
setTransform({index:matrix,...}): set transformation for elements of the link
65
                                  array/group by index
66
                </UserDocu>
67
            </Documentation>
68
        </Methode>
69
        <Methode Name="setChildren">
70
            <Documentation>
71
                <UserDocu>
72
setChildren([obj...],vis=[],type=0)
73
Group a list of children objects. Note, this mode of operation is incompatible
74
with link array. Calling this function will deactivate link array. And calling
75
setSize() will reset all linked children.
76

77
vis: initial visibility status of the children
78

79
type: children linking type,
80
   0: override transformation and visibility,
81
   1: override visibility,
82
   2: override none.
83
                </UserDocu>
84
            </Documentation>
85
        </Methode>
86
        <Methode Name="setLink">
87
            <Documentation>
88
                <UserDocu>
89
setLink(object): Set the link
90

91
setLink(object, subname): Set the link with a sub-object reference
92

93
setLink(object, [subname,...]): Set the link with a list of sub object references
94

95
object: The linked document object or its view object
96

97
subname: a string or tuple/list of strings sub-name references to sub object
98
         or sub elements (e.g. Face1, Edge2) belonging to the linked object.
99
         The sub-name must end with a '.' if it is referencing an sub-object,
100
         or else it is considered a sub-element reference.
101
                </UserDocu>
102
            </Documentation>
103
        </Methode>
104
        <Methode Name="getDetailPath">
105
            <Documentation>
106
                <UserDocu>
107
getDetailPath(element): get the 3d path an detail of an element.
108

109
Return a tuple(path,detail) for the coin3D SoPath and SoDetail of the element
110
                </UserDocu>
111
            </Documentation>
112
        </Methode>
113
        <Methode Name="getElementPicked">
114
            <Documentation>
115
                <UserDocu>getElementPicked(pickPoint): get the element under a 3d pick point. </UserDocu>
116
            </Documentation>
117
        </Methode>
118
        <Methode Name="getBoundBox">
119
            <Documentation>
120
                <UserDocu>getBoundBox(vobj=None): get the bounding box. </UserDocu>
121
            </Documentation>
122
        </Methode>
123
        <Attribute Name="LinkedView" ReadOnly="true">
124
            <Documentation>
125
                <UserDocu>The linked view object</UserDocu>
126
            </Documentation>
127
            <Parameter Name="LinkedView" Type="Object" />
128
        </Attribute>
129
        <Attribute Name="SubNames" ReadOnly="true">
130
            <Documentation>
131
                <UserDocu>The sub-object reference of the link</UserDocu>
132
            </Documentation>
133
            <Parameter Name="SubNames" Type="Object" />
134
        </Attribute>
135
        <Attribute Name="RootNode" ReadOnly="true">
136
            <Documentation>
137
                <UserDocu>A pivy node holding the cloned representation of the linked view object</UserDocu>
138
            </Documentation>
139
            <Parameter Name="RootNode" Type="Object" />
140
        </Attribute>
141
        <Attribute Name="Owner">
142
            <Documentation>
143
                <UserDocu>The owner view object of this link handle</UserDocu>
144
            </Documentation>
145
            <Parameter Name="Owner" Type="Object" />
146
        </Attribute>
147
        <Attribute Name="Visibilities">
148
            <Documentation>
149
                <UserDocu>Get/set the child element visibility</UserDocu>
150
            </Documentation>
151
            <Parameter Name="Visibilities" Type="Object" />
152
        </Attribute>
153
        <Attribute Name="Count">
154
            <Documentation>
155
                <UserDocu>Set the element size to create an array of linked object</UserDocu>
156
            </Documentation>
157
            <Parameter Name="Count" Type="Int" />
158
        </Attribute>
159
        <Methode Name="getChildren" Const="true">
160
            <Documentation>
161
                <UserDocu>Get children view objects</UserDocu>
162
            </Documentation>
163
        </Methode>
164
    </PythonExport>
165
</GenerateModel>
166