Skip to content

Visualization Controller

clear_errors()

clear errors

Returns:

Type Description
None

None
Source code in src/visualization_controller/__init__.pyi 
322
323
324
325
326
327
def clear_errors() -> None:
    """clear errors

    Returns:
        None
    """

get_camera_data()

Get the camera data

Returns:

Type Description
camera_data

camera data
Source code in src/visualization_controller/__init__.pyi 
473
474
475
476
477
478
def get_camera_data() -> camera_data:
    """Get the camera data

    Returns:
        camera data
    """

get_color(element_id)

Gets the element color

Parameters:

Name Type Description Default
element_id int

element_id

 required

Returns:

Type Description
int

color ID
Source code in src/visualization_controller/__init__.pyi 
423
424
425
426
427
428
429
430
431
def get_color(element_id: int) -> int:
    """Gets the element color

    Parameters:
        element_id: element_id

    Returns:
        color ID
    """

get_last_error(error_code)

Gets the last error

Parameters:

Name Type Description Default
error_code int

error_code

 required

Returns:

Type Description
str

error string
Source code in src/visualization_controller/__init__.pyi 
 6
 7
 8
 9
10
11
12
13
14
def get_last_error(error_code: int) -> str:
    """Gets the last error

    Parameters:
        error_code: error_code

    Returns:
        error string
    """

get_material(element_id)

Gets the element material

Parameters:

Name Type Description Default
element_id int

element_id

 required

Returns:

Type Description
int

material ID
Source code in src/visualization_controller/__init__.pyi 
443
444
445
446
447
448
449
450
451
def get_material(element_id: int) -> int:
    """Gets the element material

    Parameters:
        element_id: element_id

    Returns:
        material ID
    """

get_opengl_color(element_id)

Gets the element OpenGL color

Parameters:

Name Type Description Default
element_id int

element_id

 required

Returns:

Type Description
rgb_color

RBG color
Source code in src/visualization_controller/__init__.pyi 
433
434
435
436
437
438
439
440
441
def get_opengl_color(element_id: int) -> rgb_color:
    """Gets the element OpenGL color

    Parameters:
        element_id: element_id

    Returns:
        RBG color
    """

get_rgb_from_cadwork_color_id(color_id)

get rgb from cadwork color id

Parameters:

Name Type Description Default
color_id None

color_id

 required

Returns:

Type Description
rgb_color

colorRGB
Source code in src/visualization_controller/__init__.pyi 
453
454
455
456
457
458
459
460
461
def get_rgb_from_cadwork_color_id(color_id: None) -> rgb_color:
    """get rgb from cadwork color id

    Parameters:
        color_id: color_id

    Returns:
        colorRGB
    """

hide_all_elements()

Hides all elements

Returns:

Type Description
None

None
Source code in src/visualization_controller/__init__.pyi 
135
136
137
138
139
140
def hide_all_elements() -> None:
    """Hides all elements

    Returns:
        None
    """

is_active(element_id)

Tests if element is active

Parameters:

Name Type Description Default
element_id int

element_id

 required

Returns:

Type Description
bool

is element active
Source code in src/visualization_controller/__init__.pyi 
38
39
40
41
42
43
44
45
46
def is_active(element_id: int) -> bool:
    """Tests if element is active

    Parameters:
        element_id: element_id

    Returns:
        is element active
    """

is_cadwork_window_in_dark_mode()

Check if Cadwork window is in dark mode

Returns:

Type Description
bool

window is in dark mode
Source code in src/visualization_controller/__init__.pyi 
497
498
499
500
501
502
def is_cadwork_window_in_dark_mode() -> bool:
    """Check if Cadwork window is in dark mode

    Returns:
        window is in dark mode
    """

is_cadwork_window_in_light_mode()

Check if Cadwork window is in light mode

Returns:

Type Description
bool

window is in light mode
Source code in src/visualization_controller/__init__.pyi 
490
491
492
493
494
495
def is_cadwork_window_in_light_mode() -> bool:
    """Check if Cadwork window is in light mode

    Returns:
        window is in light mode
    """

is_immutable(element_id)

Tests if the element is immutable

Parameters:

Name Type Description Default
element_id int

element_id

 required

Returns:

Type Description
bool

is element immutable
Source code in src/visualization_controller/__init__.pyi 
 98
 99
100
101
102
103
104
105
106
def is_immutable(element_id: int) -> bool:
    """Tests if the element is immutable

    Parameters:
        element_id: element_id

    Returns:
        is element immutable
    """

is_plane_2d()

returns if plane 2d is active

Returns:

Type Description
bool

bool
Source code in src/visualization_controller/__init__.pyi 
339
340
341
342
343
344
def is_plane_2d() -> bool:
    """returns if plane 2d is active

    Returns:
        bool
    """

is_selectable(element_id)

Returns if the element is selectable

Parameters:

Name Type Description Default
element_id int

element_id

 required

Returns:

Type Description
bool

bool
Source code in src/visualization_controller/__init__.pyi 
292
293
294
295
296
297
298
299
300
def is_selectable(element_id: int) -> bool:
    """Returns if the element is selectable

    Parameters:
        element_id: element_id

    Returns:
        bool
    """

is_texture_rotated(a0)

is texture rotated

Parameters:

Name Type Description Default
a0 int

a0

 required

Returns:

Type Description
bool

bool
Source code in src/visualization_controller/__init__.pyi 
463
464
465
466
467
468
469
470
471
def is_texture_rotated(a0: int) -> bool:
    """is texture rotated

    Parameters:
        a0: a0

    Returns:
        bool
    """

is_visible(element_id)

Tests if element is visible

Parameters:

Name Type Description Default
element_id int

element_id

 required

Returns:

Type Description
bool

is element visible
Source code in src/visualization_controller/__init__.pyi 
68
69
70
71
72
73
74
75
76
def is_visible(element_id: int) -> bool:
    """Tests if element is visible

    Parameters:
        element_id: element_id

    Returns:
        is element visible
    """

load_marking_settings(settings_file_path)

Loads marking settings file

Parameters:

Name Type Description Default
settings_file_path str

settings_file_path

 required

Returns:

Type Description
None

None
Source code in src/visualization_controller/__init__.pyi 
329
330
331
332
333
334
335
336
337
def load_marking_settings(settings_file_path: str) -> None:
    """Loads marking settings file

    Parameters:
        settings_file_path: settings_file_path

    Returns:
        None
    """

refresh()

Refresh the drawing area

Returns:

Type Description
None

None
Source code in src/visualization_controller/__init__.pyi 
156
157
158
159
160
161
def refresh() -> None:
    """Refresh the drawing area

    Returns:
        None
    """

restore_activation_state(state)

Restores the activation state

Parameters:

Name Type Description Default
state None

state

 required

Returns:

Type Description
None

None
Source code in src/visualization_controller/__init__.pyi 
198
199
200
201
202
203
204
205
206
def restore_activation_state(state: None) -> None:
    """Restores the activation state

    Parameters:
        state: state

    Returns:
        None
    """

restore_visibility_state(state)

Restores the visibility state

Parameters:

Name Type Description Default
state None

state

 required

Returns:

Type Description
None

None
Source code in src/visualization_controller/__init__.pyi 
181
182
183
184
185
186
187
188
189
def restore_visibility_state(state: None) -> None:
    """Restores the visibility state

    Parameters:
        state: state

    Returns:
        None
    """

save_activation_state()

Saves the activation state

Returns:

Type Description
activation_state

activation state
Source code in src/visualization_controller/__init__.pyi 
191
192
193
194
195
196
def save_activation_state() -> activation_state:
    """Saves the activation state

    Returns:
        activation state
    """

save_visibility_state()

Saves the visibility state

Returns:

Type Description
visibility_state

visibility state
Source code in src/visualization_controller/__init__.pyi 
174
175
176
177
178
179
def save_visibility_state() -> visibility_state:
    """Saves the visibility state

    Returns:
        visibility state
    """

set_active(element_id_list)

Sets element active

Parameters:

Name Type Description Default
element_id_list List[int]

element_id_list

 required

Returns:

Type Description
None

None
Source code in src/visualization_controller/__init__.pyi 
48
49
50
51
52
53
54
55
56
def set_active(element_id_list: List[int]) -> None:
    """Sets element active

    Parameters:
        element_id_list: element_id_list

    Returns:
        None
    """

set_camera(position, target)

Sets the position of the camera, pointing to a target.

Parameters:

Name Type Description Default
position point_3d

position

 required
target point_3d

target

 required

Returns:

Type Description
None

None
Source code in src/visualization_controller/__init__.pyi 
346
347
348
349
350
351
352
353
354
355
def set_camera(position: point_3d, target: point_3d) -> None:
    """Sets the position of the camera, pointing to a target.

    Parameters:
        position: position
        target: target

    Returns:
        None
    """

set_camera_data(camera_data)

Set the camera data - this will override the current camera data

Parameters:

Name Type Description Default
camera_data None

camera_data

 required

Returns:

Type Description
None

None
Source code in src/visualization_controller/__init__.pyi 
480
481
482
483
484
485
486
487
488
def set_camera_data(camera_data: None) -> None:
    """Set the camera data - this will override the current camera data

    Parameters:
        camera_data: camera_data

    Returns:
        None
    """

set_color(element_id_list, color_id)

Sets the element color

Parameters:

Name Type Description Default
element_id_list List[int]

element_id_list

 required
color_id int

color_id

 required

Returns:

Type Description
None

None
Source code in src/visualization_controller/__init__.pyi 
16
17
18
19
20
21
22
23
24
25
def set_color(element_id_list: List[int], color_id: int) -> None:
    """Sets the element color

    Parameters:
        element_id_list: element_id_list
        color_id: color_id

    Returns:
        None
    """

set_color_without_material(a0, a1)

set color without material

Parameters:

Name Type Description Default
a0 List[int]

a0

 required
a1 int

a1

 required

Returns:

Type Description
None

None
Source code in src/visualization_controller/__init__.pyi 
364
365
366
367
368
369
370
371
372
373
def set_color_without_material(a0: List[int], a1: int) -> None:
    """set color without material

    Parameters:
        a0: a0
        a1: a1

    Returns:
        None
    """

set_immutable(element_id_list)

Sets the element immutable

Parameters:

Name Type Description Default
element_id_list List[int]

element_id_list

 required

Returns:

Type Description
None

None
Source code in src/visualization_controller/__init__.pyi 
108
109
110
111
112
113
114
115
116
def set_immutable(element_id_list: List[int]) -> None:
    """Sets the element immutable

    Parameters:
        element_id_list: element_id_list

    Returns:
        None
    """

set_inactive(element_id_list)

Sets the element inactive

Parameters:

Name Type Description Default
element_id_list List[int]

element_id_list

 required

Returns:

Type Description
None

None
Source code in src/visualization_controller/__init__.pyi 
58
59
60
61
62
63
64
65
66
def set_inactive(element_id_list: List[int]) -> None:
    """Sets the element inactive

    Parameters:
        element_id_list: element_id_list

    Returns:
        None
    """

set_invisible(element_id_list)

Sets the element invisible

Parameters:

Name Type Description Default
element_id_list List[int]

element_id_list

 required

Returns:

Type Description
None

None
Source code in src/visualization_controller/__init__.pyi 
88
89
90
91
92
93
94
95
96
def set_invisible(element_id_list: List[int]) -> None:
    """Sets the element invisible

    Parameters:
        element_id_list: element_id_list

    Returns:
        None
    """

set_material(element_id_list, element_id)

Sets the element material

Parameters:

Name Type Description Default
element_id_list List[int]

element_id_list

 required
element_id int

element_id

 required

Returns:

Type Description
None

None
Source code in src/visualization_controller/__init__.pyi 
163
164
165
166
167
168
169
170
171
172
def set_material(element_id_list: List[int], element_id: int) -> None:
    """Sets the element material

    Parameters:
        element_id_list: element_id_list
        element_id: element_id

    Returns:
        None
    """

set_mutable(element_id_list)

Sets the element mutable

Parameters:

Name Type Description Default
element_id_list List[int]

element_id_list

 required

Returns:

Type Description
None

None
Source code in src/visualization_controller/__init__.pyi 
118
119
120
121
122
123
124
125
126
def set_mutable(element_id_list: List[int]) -> None:
    """Sets the element mutable

    Parameters:
        element_id_list: element_id_list

    Returns:
        None
    """

set_opengl_color(element_id_list, color)

Sets the element OpenGL color

Parameters:

Name Type Description Default
element_id_list List[int]

element_id_list

 required
color None

color

 required

Returns:

Type Description
None

None
Source code in src/visualization_controller/__init__.pyi 
27
28
29
30
31
32
33
34
35
36
def set_opengl_color(element_id_list: List[int], color: None) -> None:
    """Sets the element OpenGL color

    Parameters:
        element_id_list: element_id_list
        color: color

    Returns:
        None
    """

set_selectable(element_id_list)

Sets a list of elements selectable

Parameters:

Name Type Description Default
element_id_list List[int]

element_id_list

 required

Returns:

Type Description
None

None
Source code in src/visualization_controller/__init__.pyi 
312
313
314
315
316
317
318
319
320
def set_selectable(element_id_list: List[int]) -> None:
    """Sets a list of elements selectable

    Parameters:
        element_id_list: element_id_list

    Returns:
        None
    """

set_texture_rotated(a0, a1)

set texture rotated

Parameters:

Name Type Description Default
a0 List[int]

a0

 required
a1 bool

a1

 required

Returns:

Type Description
None

None
Source code in src/visualization_controller/__init__.pyi 
375
376
377
378
379
380
381
382
383
384
def set_texture_rotated(a0: List[int], a1: bool) -> None:
    """set texture rotated

    Parameters:
        a0: a0
        a1: a1

    Returns:
        None
    """

set_unselectable(element_id_list)

Sets a list of elements unselectable

Parameters:

Name Type Description Default
element_id_list List[int]

element_id_list

 required

Returns:

Type Description
None

None
Source code in src/visualization_controller/__init__.pyi 
302
303
304
305
306
307
308
309
310
def set_unselectable(element_id_list: List[int]) -> None:
    """Sets a list of elements unselectable

    Parameters:
        element_id_list: element_id_list

    Returns:
        None
    """

set_visible(element_id_list)

Sets the element visible

Parameters:

Name Type Description Default
element_id_list List[int]

element_id_list

 required

Returns:

Type Description
None

None
Source code in src/visualization_controller/__init__.pyi 
78
79
80
81
82
83
84
85
86
def set_visible(element_id_list: List[int]) -> None:
    """Sets the element visible

    Parameters:
        element_id_list: element_id_list

    Returns:
        None
    """

show_all_elements()

Shows all elements

Returns:

Type Description
None

None
Source code in src/visualization_controller/__init__.pyi 
128
129
130
131
132
133
def show_all_elements() -> None:
    """Shows all elements

    Returns:
        None
    """

show_perspective_central()

changes the viewmode to Perpective

Returns:

Type Description
None

None
Source code in src/visualization_controller/__init__.pyi 
357
358
359
360
361
362
def show_perspective_central() -> None:
    """changes the viewmode to Perpective

    Returns:
        None
    """

show_reference_side_beam(show)

show reference side beam

Parameters:

Name Type Description Default
show bool

show

 required

Returns:

Type Description
None

None
Source code in src/visualization_controller/__init__.pyi 
386
387
388
389
390
391
392
393
394
def show_reference_side_beam(show: bool) -> None:
    """show reference side beam

    Parameters:
        show: show

    Returns:
        None
    """

show_reference_side_panel(show)

show reference side panel

Parameters:

Name Type Description Default
show bool

show

 required

Returns:

Type Description
None

None
Source code in src/visualization_controller/__init__.pyi 
396
397
398
399
400
401
402
403
404
def show_reference_side_panel(show: bool) -> None:
    """show reference side panel

    Parameters:
        show: show

    Returns:
        None
    """

show_reference_side_wall(show)

show reference side wall

Parameters:

Name Type Description Default
show bool

show

 required

Returns:

Type Description
None

None
Source code in src/visualization_controller/__init__.pyi 
406
407
408
409
410
411
412
413
414
def show_reference_side_wall(show: bool) -> None:
    """show reference side wall

    Parameters:
        show: show

    Returns:
        None
    """

show_view_axo()

changes the viewmode to Axo

Returns:

Type Description
None

None
Source code in src/visualization_controller/__init__.pyi 
416
417
418
419
420
421
def show_view_axo() -> None:
    """changes the viewmode to Axo

    Returns:
        None
    """

show_view_dashed_hidden_lines()

Sets the view to dashed hidden lines

Returns:

Type Description
None

None
Source code in src/visualization_controller/__init__.pyi 
271
272
273
274
275
276
def show_view_dashed_hidden_lines() -> None:
    """Sets the view to dashed hidden lines

    Returns:
        None
    """

show_view_hidden_lines()

Sets the view to hidden lines

Returns:

Type Description
None

None
Source code in src/visualization_controller/__init__.pyi 
264
265
266
267
268
269
def show_view_hidden_lines() -> None:
    """Sets the view to hidden lines

    Returns:
        None
    """

show_view_negative_x()

Sets the view to -X

Returns:

Type Description
None

None
Source code in src/visualization_controller/__init__.pyi 
215
216
217
218
219
220
def show_view_negative_x() -> None:
    """Sets the view to -X

    Returns:
        None
    """

show_view_negative_y()

Sets the view to -Y

Returns:

Type Description
None

None
Source code in src/visualization_controller/__init__.pyi 
229
230
231
232
233
234
def show_view_negative_y() -> None:
    """Sets the view to -Y

    Returns:
        None
    """

show_view_negative_z()

Sets the view to -Z

Returns:

Type Description
None

None
Source code in src/visualization_controller/__init__.pyi 
243
244
245
246
247
248
def show_view_negative_z() -> None:
    """Sets the view to -Z

    Returns:
        None
    """

show_view_positive_x()

Sets the view to +X

Returns:

Type Description
None

None
Source code in src/visualization_controller/__init__.pyi 
208
209
210
211
212
213
def show_view_positive_x() -> None:
    """Sets the view to +X

    Returns:
        None
    """

show_view_positive_y()

Sets the view to +Y

Returns:

Type Description
None

None
Source code in src/visualization_controller/__init__.pyi 
222
223
224
225
226
227
def show_view_positive_y() -> None:
    """Sets the view to +Y

    Returns:
        None
    """

show_view_positive_z()

Sets the view to +Z

Returns:

Type Description
None

None
Source code in src/visualization_controller/__init__.pyi 
236
237
238
239
240
241
def show_view_positive_z() -> None:
    """Sets the view to +Z

    Returns:
        None
    """

show_view_shaded1()

Sets the view to shaded 1

Returns:

Type Description
None

None
Source code in src/visualization_controller/__init__.pyi 
285
286
287
288
289
290
def show_view_shaded1() -> None:
    """Sets the view to shaded 1

    Returns:
        None
    """

show_view_shaded2()

Sets the view to shaded 2

Returns:

Type Description
None

None
Source code in src/visualization_controller/__init__.pyi 
278
279
280
281
282
283
def show_view_shaded2() -> None:
    """Sets the view to shaded 2

    Returns:
        None
    """

show_view_standard_axo()

Sets the view to standard axonometry

Returns:

Type Description
None

None
Source code in src/visualization_controller/__init__.pyi 
250
251
252
253
254
255
def show_view_standard_axo() -> None:
    """Sets the view to standard axonometry

    Returns:
        None
    """

show_view_wireframe()

Sets the view to wireframe

Returns:

Type Description
None

None
Source code in src/visualization_controller/__init__.pyi 
257
258
259
260
261
262
def show_view_wireframe() -> None:
    """Sets the view to wireframe

    Returns:
        None
    """

zoom_active_elements()

Zooms on all active elements

Returns:

Type Description
None

None
Source code in src/visualization_controller/__init__.pyi 
149
150
151
152
153
154
def zoom_active_elements() -> None:
    """Zooms on all active elements

    Returns:
        None
    """

zoom_all_elements()

Zooms on all elements

Returns:

Type Description
None

None
Source code in src/visualization_controller/__init__.pyi 
142
143
144
145
146
147
def zoom_all_elements() -> None:
    """Zooms on all elements

    Returns:
        None
    """