CADPyRxDoc/PyRx.html at main · CEXT-Dan/CADPyRxDoc · GitHub

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
<!DOCTYPE html>
<html>
<head>
    <meta charset="UTF-8">
    <title>PyRx.pyi</title>
    <style>
        body {
            background-color: #1e1e1e;
            color: #d4d4d4;
            font-family: Consolas, monospace;
            margin: 2em;
        }
        a {
            color: #569cd6;
        }
        .class {
            margin-bottom: 1em;
        }
        summary {
            font-weight: bold;
            font-size: 1.1em;
            cursor: pointer;
            padding: 0.2em 0.4em;
            border-radius: 4px;
        }
        details {
            margin-left: 0.5em;
            background-color: #252526;
            border: 1px solid #3c3c3c;
            border-radius: 6px;
            padding: 0.5em;
        }
        code {
            display: block;
            margin: 0.3em 0;
            white-space: pre;
            background-color: #1e1e1e;
            color: #dcdcdc;
            padding: 0.4em 0.6em;
            border-left: 4px solid #007acc;
            font-size: 1.2em;
        }
        .kw {
            color: #569cd6;
            font-weight: bold;
        }
        .ds {
            color: #FF8787;
            opacity: 0.7;
        }
        h1 {
            color: #569cd6;
        }
        .tag {
            background: #007acc;
            color: #fff;
            border-radius: 4px;
            padding: 0.1em 0.5em;
            font-size: 0.9em;
            margin-left: 0.5em;
        }
        .toc {
            margin-bottom: 2em;
        }
    </style>
</head>
<body>
    <h1>PyRx.pyi</h1>
    <div class="toc">
        <h2>Classes</h2>
        <ul>
            <li><a href="#LispType">LispType</a></li>
            <li><a href="#Ordering">Ordering</a></li>
            <li><a href="#Overrule">Overrule</a></li>
            <li><a href="#RxClass">RxClass</a></li>
            <li><a href="#RxObject">RxObject</a></li>
            <li><a href="#stderr">stderr</a></li>
            <li><a href="#stdout">stdout</a></li>
        </ul>
    </div>

    <div class="class" id="LispType">
        <details>
            <summary>class LispType <span class="tag">Class</span></summary>
            <code>kAngle: ClassVar[Self]</code>
            <code>kDottedPair: ClassVar[Self]</code>
            <code>kDouble: ClassVar[Self]</code>
            <code>kInt16: ClassVar[Self]</code>
            <code>kInt32: ClassVar[Self]</code>
            <code>kListBegin: ClassVar[Self]</code>
            <code>kListEnd: ClassVar[Self]</code>
            <code>kNil: ClassVar[Self]</code>
            <code>kNone: ClassVar[Self]</code>
            <code>kObjectId: ClassVar[Self]</code>
            <code>kOrientation: ClassVar[Self]</code>
            <code>kPoint2d: ClassVar[Self]</code>
            <code>kVector2d: ClassVar[Self]</code>
            <code>kPoint3d: ClassVar[Self]</code>
            <code>kVector3d: ClassVar[Self]</code>
            <code>kT_atom: ClassVar[Self]</code>
            <code>kText: ClassVar[Self]</code>
            <code>kVoid: ClassVar[Self]</code>
            <code>kSelectionSet: ClassVar[Self]</code>
        </details>
    </div>

    <div class="class" id="Ordering">
        <details>
            <summary>class Ordering <span class="tag">Class</span></summary>
            <code>kLessThan: ClassVar[Self]</code>
            <code>kEqual: ClassVar[Self]</code>
            <code>kGreaterThan: ClassVar[Self]</code>
            <code>kNotOrderable: ClassVar[Self]</code>
        </details>
    </div>

    <div class="class" id="Overrule">
        <details>
            <summary>class Overrule <span class="tag">Class</span></summary>
            <code><span class="kw">def</span> __init__() -&gt; None:
    <span class="ds">Raises an exception.
This class cannot be instantiated from Python.</span></code>
            <code><span class="kw">def</span> __reduce__(self) -&gt; Any:</code>
            <code><span class="kw">def</span> addOverrule(rxClass: PyRx.RxClass, overrule: PyRx.Overrule) -&gt; None:</code>
            <code><span class="kw">def</span> addOverruleLast(rxClass: PyRx.RxClass, overrule: PyRx.Overrule, addLast: bool) -&gt; None:</code>
            <code><span class="kw">def</span> className() -&gt; str:</code>
            <code><span class="kw">def</span> desc() -&gt; RxClass:
    <span class="ds">Returns a pointer to the AcRxClass object representing the specific class, or most recent
parent class explicitly registered with ObjectARX of either the pointer type used to invoke
it or the class qualifier used with it. (Remember that when a static member function is
invoked via a pointer, the pointer type, not the object type, determines which
implementation of the function is invoked.) When working with a pointer to an object and
the proper AcRxClass object for the class of the object pointed to is desired, the
AcRxObject::isA() function should be used, since it is a virtual non-static method and is
therefore not pointer type dependent. Caching the value of the pointer returned by this
method is acceptable, provided the application knows that the AcRxClass object pointed to
by the returned pointer was created by an ObjectARX application that will not be unloaded.</span></code>
            <code><span class="kw">def</span> hasOverrule(subject: PyRx.RxObject, rxClass: PyRx.RxClass) -&gt; bool:</code>
            <code><span class="kw">def</span> isOverruling() -&gt; bool:</code>
            <code><span class="kw">def</span> removeOverrule(rxClass: PyRx.RxClass, overrule: PyRx.Overrule) -&gt; None:</code>
            <code><span class="kw">def</span> setIsOverruling(flag: bool) -&gt; None:</code>
        </details>
    </div>

    <div class="class" id="RxClass">
        <details>
            <summary>class RxClass <span class="tag">Class</span></summary>
            <code><span class="kw">def</span> __init__() -&gt; None:
    <span class="ds">Raises an exception.
This class cannot be instantiated from Python.</span></code>
            <code><span class="kw">def</span> __reduce__(self) -&gt; Any:</code>
            <code><span class="kw">def</span> appName(self) -&gt; str:
    <span class="ds">Returns a pointer to the application name string which is the last parameter in the
ACRX_DXF_DEFINE_MEMBERS macro and is also the last parameter to the global newAcRxClass()
pseudo-constructor. This string is used as the application identifier in the error dialog
that is displayed whenever an object of the class is loaded and the application is not
present. WarningAs the const qualifier indicates, no attempt should be made to deallocate
the returned string.</span></code>
            <code><span class="kw">def</span> className() -&gt; str:</code>
            <code><span class="kw">def</span> desc() -&gt; RxClass:
    <span class="ds">Returns a pointer to the AcRxClass object representing the specific class, or most recent
parent class explicitly registered with ObjectARX of either the pointer type used to invoke
it or the class qualifier used with it. (Remember that when a static member function is
invoked via a pointer, the pointer type, not the object type, determines which
implementation of the function is invoked.) When working with a pointer to an object and
the proper AcRxClass object for the class of the object pointed to is desired, the
AcRxObject::isA() function should be used, since it is a virtual non-static method and is
therefore not pointer type dependent. Caching the value of the pointer returned by this
method is acceptable, provided the application knows that the AcRxClass object pointed to
by the returned pointer was created by an ObjectARX application that will not be unloaded.</span></code>
            <code><span class="kw">def</span> dxfName(self) -&gt; str:
    <span class="ds">This function returns a pointer to the DXF name for the class. This string is only required
to be non-NULL for classes derived from AcDbObject. Other classes may set this via the
second to the last parameter of the global newAcRxClass() pseudo-constructor. If the
dxfName string has not been set, then this function will return NULL. WarningAs the const
qualifier indicates, no attempt should be made to deallocate the string.</span></code>
            <code><span class="kw">def</span> isDerivedFrom(self, other: PyRx.RxClass) -&gt; bool:
    <span class="ds">Static method for checking if first (left) class arg is derived from second (right) one.</span></code>
            <code><span class="kw">def</span> myParent(self) -&gt; RxClass:
    <span class="ds">This function returns a pointer to the AcRxClass object associated with the base class of
the class that is represented by the AcRxClass object on which this method is called.</span></code>
            <code><span class="kw">def</span> name(self) -&gt; str:
    <span class="ds">This function returns a pointer to a string that is the name of the C++ class represented
by this AcRxClass object. WarningAs the const qualifier indicates, no attempt should be
made to deallocate the string.</span></code>
            <code><span class="kw">def</span> queryX(self, rhs: PyRx.RxClass) -&gt; RxObject:
    <span class="ds">This function returns the protocol extension object stored with the key pProtocolClass. If
there is no such object specific to the class represented by this AcRxClass object, then
the protocol extension object for the parent class is used, or its parent class, or on up
the hierarchy as far as needed to obtain the protocol extension object sought. If the
pProtocolClass key is not present in this AcRxClass object nor in any of the base class&#x27;s
AcRxClass objects, then this function will return NULL. This function does the real work
for AcRxObject::queryX() and is invoked from it.</span></code>
        </details>
    </div>

    <div class="class" id="RxObject">
        <details>
            <summary>class RxObject <span class="tag">Class</span></summary>
            <code><span class="kw">def</span> __hash__(self) -&gt; int:</code>
            <code><span class="kw">def</span> __init__() -&gt; None:
    <span class="ds">Raises an exception.
This class cannot be instantiated from Python.</span></code>
            <code><span class="kw">def</span> __ne__(self, rhs: PyRx.RxObject) -&gt; bool:</code>
            <code><span class="kw">def</span> __reduce__(self) -&gt; Any:</code>
            <code><span class="kw">def</span> className() -&gt; str:</code>
            <code><span class="kw">def</span> comparedTo(self, other: PyRx.RxObject) -&gt; Ordering:
    <span class="ds">Function usage: This function is intended to allow classes to provide a means to compare
class objects much the way strcmp() compares character strings. The object pointed to by
other is compared with this object. The result of the comparison is returned. The possible
AcRx::Ordering types are: AcRx::kLessThan AcRx::kEqual AcRx::kGreaterThan
AcRx::kNotOrderable The AcRx::kNotOrderable type is there because C++ classes often cannot
support object value comparison. Function implementation in derived classes: There are no
restrictions or expectations on how this function is implemented. Each class will have its
own requirements for comparison. Default implementation: Simply returns AcRx::kNotOrderable
since many C++ classes cannot support object value comparison.</span></code>
            <code><span class="kw">def</span> copyFrom(self, other: PyRx.RxObject) -&gt; None:
    <span class="ds">Function usage: Copies the contents of other into the messaged object, whenever feasible.
Function implementation in derived classes: If implemented, this function needs to be able
to read the data in the object pointed to by other and copy any or all data as appropriate
into this object. There is no requirement that the object pointed to by other and this
object be of the same class, but that is the generally assumed condition. Default
implementation: Because this function must be overridden to have any meaning, a fatal error
will be caused when calling the default implementation.</span></code>
            <code><span class="kw">def</span> desc() -&gt; RxClass:
    <span class="ds">Returns a pointer to the AcRxClass object representing the specific class, or most recent
parent class explicitly registered with ObjectARX of either the pointer type used to invoke
it or the class qualifier used with it. (Remember that when a static member function is
invoked via a pointer, the pointer type, not the object type, determines which
implementation of the function is invoked.) When working with a pointer to an object and
the proper AcRxClass object for the class of the object pointed to is desired, the
AcRxObject::isA() function should be used, since it is a virtual non-static method and is
therefore not pointer type dependent. Caching the value of the pointer returned by this
method is acceptable, provided the application knows that the AcRxClass object pointed to
by the returned pointer was created by an ObjectARX application that will not be unloaded.</span></code>
            <code><span class="kw">def</span> dispose(self) -&gt; None:</code>
            <code><span class="kw">def</span> implRefCount(self) -&gt; int:</code>
            <code><span class="kw">def</span> intPtr(self) -&gt; int:</code>
            <code><span class="kw">def</span> isA(self) -&gt; RxClass:
    <span class="ds">Function usage: For each class registered with ObjectARX, the implementation of this
function is to return a pointer to the AcRxClass object for the class of the object in
which this method is called. For classes not registered with ObjectARX, this method has no
meaning. Function implementation in derived classes: This function is overridden in all
derived classes. The AcRx macros declare and define this function, so that the override is
taken care of as part of using the macros. The implementation of this function is simply to
return ::desc(). For example. the implementation for AcDbLine would be: return
AcDbLine::desc(); Default implementation for AcRxObject: { return AcRxObject::desc(); }</span></code>
            <code><span class="kw">def</span> isDerivedFrom(self, other: PyRx.RxClass) -&gt; bool:
    <span class="ds">Static method for checking if first (left) class arg is derived from second (right) one.</span></code>
            <code><span class="kw">def</span> isKindOf(self, rhs: PyRx.RxClass) -&gt; bool:
    <span class="ds">Returns true if &#x27;this&#x27; object is of a member of either the class represented by aClass, or
a class derived from aClass.</span></code>
            <code><span class="kw">def</span> isNullObj(self) -&gt; bool:</code>
            <code><span class="kw">def</span> keepAlive(self, flag: bool) -&gt; None:</code>
            <code><span class="kw">def</span> queryX(self, rhs: PyRx.RxClass) -&gt; RxObject:
    <span class="ds">This method searches for a protocol extension object associated with this object. The
method begins the search by examining the AcRxClass object associated with this object, and
if no protocol extension object is found, the search continues in the base class of the
object&#x27;s class and so on up the inheritance tree for the class. This procedure provides a
form of protocol extension inheritance. An object&#x27;s AcRxClass member may be found by using
the class&#x27;s isA() method. If the search for a protocol extension object is unsuccessful,
then NULL is returned.</span></code>
        </details>
    </div>

    <div class="class" id="stderr">
        <details>
            <summary>class stderr <span class="tag">Class</span></summary>
            <code><span class="kw">def</span> __init__(self) -&gt; None:</code>
            <code><span class="kw">def</span> __reduce__(self) -&gt; Any:</code>
            <code><span class="kw">def</span> flush(self) -&gt; None:</code>
            <code><span class="kw">def</span> write(self) -&gt; None:</code>
        </details>
    </div>

    <div class="class" id="stdout">
        <details>
            <summary>class stdout <span class="tag">Class</span></summary>
            <code><span class="kw">def</span> __init__(self) -&gt; None:</code>
            <code><span class="kw">def</span> __reduce__(self) -&gt; Any:</code>
            <code><span class="kw">def</span> flush(self) -&gt; None:</code>
            <code><span class="kw">def</span> write(self) -&gt; None:</code>
        </details>
    </div>
</body>
</html>