fake-bge-module 20250317__py3-none-any.whl → 20260201__py3-none-any.whl
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- {animsys_refactor → _animsys_refactor}/__init__.pyi +7 -6
- {bl_console_utils → _bl_console_utils}/__init__.pyi +1 -0
- {bl_console_utils → _bl_console_utils}/autocomplete/__init__.pyi +1 -0
- {bl_console_utils → _bl_console_utils}/autocomplete/complete_calltip/__init__.pyi +1 -13
- {bl_console_utils → _bl_console_utils}/autocomplete/complete_import/__init__.pyi +1 -5
- {bl_console_utils → _bl_console_utils}/autocomplete/complete_namespace/__init__.pyi +3 -13
- {bl_console_utils → _bl_console_utils}/autocomplete/intellisense/__init__.pyi +1 -10
- {bl_i18n_utils → _bl_i18n_utils}/__init__.pyi +2 -0
- _bl_i18n_utils/bl_extract_messages/__init__.pyi +28 -0
- {bl_i18n_utils → _bl_i18n_utils}/merge_po/__init__.pyi +2 -1
- {bl_i18n_utils → _bl_i18n_utils}/settings/__init__.pyi +10 -7
- {bl_i18n_utils → _bl_i18n_utils}/utils/__init__.pyi +53 -50
- _bl_i18n_utils/utils_cli/__init__.pyi +11 -0
- _bl_i18n_utils/utils_languages_menu/__init__.pyi +6 -0
- {bl_i18n_utils → _bl_i18n_utils}/utils_rtl/__init__.pyi +3 -2
- _bl_i18n_utils/utils_spell_check/__init__.pyi +22 -0
- {bl_previews_utils → _bl_previews_utils}/__init__.pyi +1 -0
- _bl_previews_utils/bl_previews_render/__init__.pyi +14 -0
- {bl_rna_utils → _bl_rna_utils}/__init__.pyi +1 -0
- {bl_rna_utils → _bl_rna_utils}/data_path/__init__.pyi +3 -2
- {bl_text_utils → _bl_text_utils}/__init__.pyi +1 -0
- _bl_text_utils/external_editor/__init__.pyi +6 -0
- {bl_ui_utils → _bl_ui_utils}/__init__.pyi +1 -0
- {bl_ui_utils → _bl_ui_utils}/layout/__init__.pyi +2 -1
- _blendfile_header/__init__.pyi +48 -0
- _bpy_internal/__init__.pyi +5 -1
- _bpy_internal/addons/__init__.pyi +1 -0
- _bpy_internal/addons/cli/__init__.pyi +2 -1
- _bpy_internal/assets/__init__.pyi +5 -0
- _bpy_internal/assets/remote_library_listing/__init__.pyi +5 -0
- _bpy_internal/assets/remote_library_listing/blender_asset_library_openapi/__init__.pyi +13 -0
- _bpy_internal/disk_file_hash_service/__init__.pyi +19 -0
- _bpy_internal/disk_file_hash_service/backend_sqlite/__init__.pyi +48 -0
- _bpy_internal/disk_file_hash_service/hash_service/__init__.pyi +64 -0
- _bpy_internal/disk_file_hash_service/types/__init__.pyi +53 -0
- _bpy_internal/extensions/__init__.pyi +1 -0
- _bpy_internal/extensions/junction_module/__init__.pyi +8 -7
- _bpy_internal/extensions/stale_file_manager/__init__.pyi +9 -8
- _bpy_internal/extensions/wheel_manager/__init__.pyi +6 -5
- {bl_i18n_utils/utils_languages_menu → _bpy_internal/filesystem}/__init__.pyi +2 -2
- _bpy_internal/filesystem/locking/__init__.pyi +28 -0
- _bpy_internal/grease_pencil/__init__.pyi +1 -0
- _bpy_internal/grease_pencil/stroke/__init__.pyi +22 -6
- _bpy_internal/platform/__init__.pyi +5 -0
- _bpy_internal/platform/freedesktop/__init__.pyi +21 -0
- _bpy_internal/system_info/__init__.pyi +1 -0
- _bpy_internal/system_info/text_generate_runtime/__init__.pyi +2 -1
- _bpy_internal/system_info/url_prefill_runtime/__init__.pyi +2 -1
- _bpy_internal/system_info/url_prefill_startup/__init__.pyi +3 -2
- {bpy_restrict_state → _bpy_restrict_state}/__init__.pyi +1 -0
- _bpy_types/__init__.pyi +1635 -0
- {console_python → _console_python}/__init__.pyi +8 -7
- _console_shell/__init__.pyi +10 -0
- {graphviz_export → _graphviz_export}/__init__.pyi +3 -2
- _keyingsets_utils/__init__.pyi +21 -0
- {rna_info → _rna_info}/__init__.pyi +32 -27
- {rna_xml → _rna_xml}/__init__.pyi +7 -6
- addon_utils/__init__.pyi +13 -25
- aud/__init__.pyi +133 -155
- bge/__init__.pyi +1 -0
- bge/app/__init__.pyi +1 -0
- bge/constraints/__init__.pyi +22 -51
- bge/types/__init__.pyi +618 -1913
- bge_extras/__init__.pyi +1 -0
- bge_extras/logger/__init__.pyi +4 -3
- bgui/__init__.pyi +1 -0
- bgui/frame/__init__.pyi +1 -0
- bgui/frame_button/__init__.pyi +1 -0
- bgui/image/__init__.pyi +1 -1
- bgui/image_button/__init__.pyi +1 -0
- bgui/label/__init__.pyi +1 -0
- bgui/list_box/__init__.pyi +1 -1
- bgui/progress_bar/__init__.pyi +2 -1
- bgui/system/__init__.pyi +3 -5
- bgui/text_block/__init__.pyi +1 -0
- bgui/text_input/__init__.pyi +9 -8
- bgui/theme/__init__.pyi +4 -3
- bgui/widget/__init__.pyi +5 -4
- bl_app_override/__init__.pyi +4 -3
- bl_app_override/helpers/__init__.pyi +3 -2
- bl_app_template_utils/__init__.pyi +5 -4
- bl_app_templates_system/Game_Engine/__init__.pyi +5 -4
- bl_app_templates_system/Storyboarding/__init__.pyi +11 -0
- bl_app_templates_system/__init__.pyi +2 -0
- bl_keymap_utils/__init__.pyi +1 -0
- bl_keymap_utils/io/__init__.pyi +10 -9
- bl_keymap_utils/keymap_from_toolbar/__init__.pyi +2 -1
- bl_keymap_utils/keymap_hierarchy/__init__.pyi +2 -1
- bl_keymap_utils/platform_helpers/__init__.pyi +3 -2
- bl_keymap_utils/versioning/__init__.pyi +2 -1
- bl_math/__init__.pyi +4 -13
- bl_operators/__init__.pyi +4 -2
- bl_operators/add_mesh_torus/__init__.pyi +9 -9
- bl_operators/anim/__init__.pyi +90 -62
- bl_operators/assets/__init__.pyi +14 -18
- bl_operators/bmesh/__init__.pyi +1 -0
- bl_operators/bmesh/find_adjacent/__init__.pyi +12 -9
- bl_operators/bone_selection_sets/__init__.pyi +34 -60
- bl_operators/clip/__init__.pyi +39 -57
- bl_operators/connect_to_output/__init__.pyi +20 -18
- bl_operators/console/__init__.pyi +17 -25
- bl_operators/constraint/__init__.pyi +15 -21
- bl_operators/copy_global_transform/__init__.pyi +261 -0
- bl_operators/file/__init__.pyi +13 -17
- bl_operators/freestyle/__init__.pyi +15 -21
- bl_operators/geometry_nodes/__init__.pyi +30 -36
- bl_operators/grease_pencil/__init__.pyi +5 -5
- bl_operators/image/__init__.pyi +14 -22
- bl_operators/image_as_planes/__init__.pyi +36 -42
- bl_operators/mesh/__init__.pyi +8 -53
- bl_operators/node/__init__.pyi +375 -92
- bl_operators/node_editor/__init__.pyi +1 -0
- bl_operators/node_editor/node_functions/__init__.pyi +10 -9
- bl_operators/object/__init__.pyi +57 -98
- bl_operators/object_align/__init__.pyi +8 -8
- bl_operators/object_quick_effects/__init__.pyi +15 -21
- bl_operators/object_randomize_transform/__init__.pyi +6 -6
- bl_operators/presets/__init__.pyi +46 -94
- bl_operators/rigidbody/__init__.pyi +12 -16
- bl_operators/screen_play_rendered_anim/__init__.pyi +5 -5
- bl_operators/sequencer/__init__.pyi +40 -54
- bl_operators/spreadsheet/__init__.pyi +7 -7
- bl_operators/userpref/__init__.pyi +69 -117
- bl_operators/uvcalc_follow_active/__init__.pyi +8 -8
- bl_operators/uvcalc_lightmap/__init__.pyi +12 -12
- bl_operators/uvcalc_transform/__init__.pyi +39 -28
- bl_operators/vertexpaint_dirt/__init__.pyi +7 -7
- bl_operators/view3d/__init__.pyi +31 -43
- bl_operators/wm/__init__.pyi +139 -231
- bl_operators/world/__init__.pyi +6 -6
- bl_ui/__init__.pyi +18 -17
- bl_ui/anim/__init__.pyi +5 -5
- bl_ui/asset_shelf/__init__.pyi +5 -5
- bl_ui/generic_ui_list/__init__.pyi +11 -25
- bl_ui/node_add_menu/__init__.pyi +281 -12
- bl_ui/node_add_menu_compositor/__init__.pyi +135 -91
- bl_ui/node_add_menu_geometry/__init__.pyi +407 -263
- bl_ui/node_add_menu_shader/__init__.pyi +67 -67
- bl_ui/node_add_menu_texture/__init__.pyi +25 -69
- bl_ui/properties_animviz/__init__.pyi +3 -2
- bl_ui/properties_collection/__init__.pyi +20 -30
- bl_ui/properties_constraint/__init__.pyi +228 -450
- bl_ui/properties_data_armature/__init__.pyi +45 -79
- bl_ui/properties_data_bone/__init__.pyi +33 -51
- bl_ui/properties_data_camera/__init__.pyi +43 -75
- bl_ui/properties_data_curve/__init__.pyi +42 -101
- bl_ui/properties_data_curves/__init__.pyi +21 -35
- bl_ui/properties_data_empty/__init__.pyi +8 -10
- bl_ui/properties_data_grease_pencil/__init__.pyi +49 -87
- bl_ui/properties_data_lattice/__init__.pyi +12 -18
- bl_ui/properties_data_light/__init__.pyi +28 -46
- bl_ui/properties_data_lightprobe/__init__.pyi +35 -61
- bl_ui/properties_data_mesh/__init__.pyi +73 -120
- bl_ui/properties_data_metaball/__init__.pyi +16 -26
- bl_ui/properties_data_modifier/__init__.pyi +34 -39
- bl_ui/properties_data_pointcloud/__init__.pyi +17 -27
- bl_ui/properties_data_shaderfx/__init__.pyi +4 -4
- bl_ui/properties_data_speaker/__init__.pyi +15 -25
- bl_ui/properties_data_volume/__init__.pyi +22 -38
- bl_ui/properties_freestyle/__init__.pyi +79 -127
- bl_ui/properties_game/__init__.pyi +88 -84
- bl_ui/properties_grease_pencil_common/__init__.pyi +33 -190
- bl_ui/properties_mask_common/__init__.pyi +33 -45
- bl_ui/properties_material/__init__.pyi +52 -111
- bl_ui/properties_material_gpencil/__init__.pyi +48 -68
- bl_ui/properties_object/__init__.pyi +123 -93
- bl_ui/properties_output/__init__.pyi +103 -81
- bl_ui/properties_paint_common/__init__.pyi +78 -59
- bl_ui/properties_particle/__init__.pyi +160 -262
- bl_ui/properties_physics_cloth/__init__.pyi +36 -62
- bl_ui/properties_physics_common/__init__.pyi +11 -11
- bl_ui/properties_physics_dynamicpaint/__init__.pyi +81 -123
- bl_ui/properties_physics_field/__init__.pyi +35 -53
- bl_ui/properties_physics_fluid/__init__.pyi +106 -160
- bl_ui/properties_physics_geometry_nodes/__init__.pyi +6 -6
- bl_ui/properties_physics_rigidbody/__init__.pyi +28 -42
- bl_ui/properties_physics_rigidbody_constraint/__init__.pyi +44 -68
- bl_ui/properties_physics_softbody/__init__.pyi +38 -66
- bl_ui/properties_render/__init__.pyi +267 -259
- bl_ui/properties_scene/__init__.pyi +69 -72
- bl_ui/properties_strip/__init__.pyi +744 -0
- bl_ui/properties_strip_modifier/__init__.pyi +45 -0
- bl_ui/properties_texture/__init__.pyi +69 -122
- bl_ui/properties_view_layer/__init__.pyi +97 -51
- bl_ui/properties_workspace/__init__.pyi +12 -18
- bl_ui/properties_world/__init__.pyi +33 -53
- bl_ui/space_clip/__init__.pyi +231 -311
- bl_ui/space_console/__init__.pyi +14 -24
- bl_ui/space_dopesheet/__init__.pyi +193 -125
- bl_ui/space_filebrowser/__init__.pyi +107 -131
- bl_ui/space_graph/__init__.pyi +93 -80
- bl_ui/space_image/__init__.pyi +207 -291
- bl_ui/space_info/__init__.pyi +14 -24
- bl_ui/space_logic/__init__.pyi +14 -22
- bl_ui/space_nla/__init__.pyi +63 -69
- bl_ui/space_node/__init__.pyi +215 -154
- bl_ui/space_outliner/__init__.pyi +65 -61
- bl_ui/space_properties/__init__.pyi +41 -16
- bl_ui/space_sequencer/__init__.pyi +276 -980
- bl_ui/space_spreadsheet/__init__.pyi +27 -23
- bl_ui/space_statusbar/__init__.pyi +4 -4
- bl_ui/space_text/__init__.pyi +39 -73
- bl_ui/space_time/__init__.pyi +33 -78
- bl_ui/space_toolsystem_common/__init__.pyi +31 -28
- bl_ui/space_toolsystem_toolbar/__init__.pyi +67 -43
- bl_ui/space_topbar/__init__.pyi +68 -111
- bl_ui/space_userpref/__init__.pyi +310 -445
- bl_ui/space_view3d/__init__.pyi +667 -1122
- bl_ui/space_view3d_sidebar/__init__.pyi +127 -0
- bl_ui/space_view3d_toolbar/__init__.pyi +237 -966
- bl_ui/utils/__init__.pyi +4 -3
- blend_render_info/__init__.pyi +4 -2
- blf/__init__.pyi +92 -59
- bmesh/__init__.pyi +4 -10
- bmesh/geometry/__init__.pyi +2 -4
- bmesh/ops/__init__.pyi +442 -815
- bmesh/types/__init__.pyi +377 -720
- bmesh/utils/__init__.pyi +20 -45
- bpy/__init__.pyi +2 -1
- bpy/app/__init__.pyi +96 -90
- bpy/app/handlers/__init__.pyi +24 -19
- bpy/app/icons/__init__.pyi +2 -7
- bpy/app/timers/__init__.pyi +5 -18
- bpy/app/translations/__init__.pyi +21 -35
- bpy/msgbus/__init__.pyi +20 -9
- bpy/ops/__init__.pyi +21 -3
- bpy/ops/action/__init__.pyi +121 -226
- bpy/ops/anim/__init__.pyi +204 -358
- bpy/ops/armature/__init__.pyi +129 -249
- bpy/ops/asset/__init__.pyi +82 -111
- bpy/ops/bge_bricknodes/__init__.pyi +61 -0
- bpy/ops/boid/__init__.pyi +44 -50
- bpy/ops/bricknodes/__init__.pyi +37 -0
- bpy/ops/brush/__init__.pyi +33 -120
- bpy/ops/buttons/__init__.pyi +27 -83
- bpy/ops/cachefile/__init__.pyi +16 -74
- bpy/ops/camera/__init__.pyi +3 -13
- bpy/ops/clip/__init__.pyi +278 -558
- bpy/ops/cloth/__init__.pyi +2 -6
- bpy/ops/collection/__init__.pyi +34 -44
- bpy/ops/console/__init__.pyi +70 -111
- bpy/ops/constraint/__init__.pyi +34 -102
- bpy/ops/curve/__init__.pyi +163 -315
- bpy/ops/curves/__init__.pyi +163 -189
- bpy/ops/cycles/__init__.pyi +8 -18
- bpy/ops/dpaint/__init__.pyi +21 -30
- bpy/ops/ed/__init__.pyi +59 -103
- bpy/ops/export_anim/__init__.pyi +4 -11
- bpy/ops/export_scene/__init__.pyi +29 -174
- bpy/ops/extensions/__init__.pyi +102 -194
- bpy/ops/file/__init__.pyi +166 -272
- bpy/ops/fluid/__init__.pyi +78 -86
- bpy/ops/font/__init__.pyi +73 -164
- bpy/ops/geometry/__init__.pyi +33 -144
- bpy/ops/gizmogroup/__init__.pyi +8 -14
- bpy/ops/gpencil/__init__.pyi +31 -58
- bpy/ops/graph/__init__.pyi +176 -411
- bpy/ops/grease_pencil/__init__.pyi +416 -639
- bpy/ops/image/__init__.pyi +148 -492
- bpy/ops/import_anim/__init__.pyi +5 -18
- bpy/ops/import_curve/__init__.pyi +4 -6
- bpy/ops/import_scene/__init__.pyi +22 -49
- bpy/ops/info/__init__.pyi +27 -43
- bpy/ops/lattice/__init__.pyi +26 -43
- bpy/ops/logic/__init__.pyi +49 -122
- bpy/ops/logic_nodes/__init__.pyi +461 -0
- bpy/ops/marker/__init__.pyi +24 -60
- bpy/ops/mask/__init__.pyi +118 -222
- bpy/ops/material/__init__.pyi +19 -18
- bpy/ops/mball/__init__.pyi +13 -39
- bpy/ops/mesh/__init__.pyi +409 -1264
- bpy/ops/nla/__init__.pyi +140 -232
- bpy/ops/node/__init__.pyi +1189 -807
- bpy/ops/object/__init__.pyi +806 -1659
- bpy/ops/outliner/__init__.pyi +284 -432
- bpy/ops/paint/__init__.pyi +189 -381
- bpy/ops/paintcurve/__init__.pyi +29 -44
- bpy/ops/palette/__init__.pyi +23 -34
- bpy/ops/particle/__init__.pyi +135 -201
- bpy/ops/pointcloud/__init__.pyi +23 -42
- bpy/ops/pose/__init__.pyi +195 -310
- bpy/ops/poselib/__init__.pyi +45 -73
- bpy/ops/preferences/__init__.pyi +89 -221
- bpy/ops/ptcache/__init__.pyi +32 -39
- bpy/ops/render/__init__.pyi +36 -83
- bpy/ops/rigidbody/__init__.pyi +47 -78
- bpy/ops/scene/__init__.pyi +169 -222
- bpy/ops/screen/__init__.pyi +146 -259
- bpy/ops/script/__init__.pyi +9 -15
- bpy/ops/sculpt/__init__.pyi +194 -354
- bpy/ops/sculpt_curves/__init__.pyi +21 -29
- bpy/ops/sequencer/__init__.pyi +586 -836
- bpy/ops/sound/__init__.pyi +25 -131
- bpy/ops/spreadsheet/__init__.pyi +34 -21
- bpy/ops/surface/__init__.pyi +7 -54
- bpy/ops/text/__init__.pyi +166 -281
- bpy/ops/text_editor/__init__.pyi +2 -6
- bpy/ops/texture/__init__.pyi +20 -22
- bpy/ops/transform/__init__.pyi +108 -445
- bpy/ops/ui/__init__.pyi +157 -219
- bpy/ops/uilist/__init__.pyi +4 -16
- bpy/ops/uv/__init__.pyi +291 -347
- bpy/ops/view2d/__init__.pyi +29 -88
- bpy/ops/view3d/__init__.pyi +238 -438
- bpy/ops/wm/__init__.pyi +651 -1510
- bpy/ops/workspace/__init__.pyi +42 -44
- bpy/ops/world/__init__.pyi +12 -13
- bpy/path/__init__.pyi +5 -36
- bpy/props/__init__.pyi +395 -259
- bpy/{_typing → stub_internal}/__init__.pyi +1 -0
- bpy/{_typing → stub_internal}/rna_enums/__init__.pyi +214 -114
- bpy/types/__init__.pyi +93285 -103831
- bpy/utils/__init__.pyi +46 -104
- bpy/utils/previews/__init__.pyi +7 -15
- bpy/utils/units/__init__.pyi +6 -15
- bpy_extras/__init__.pyi +1 -0
- bpy_extras/anim_utils/__init__.pyi +32 -23
- bpy_extras/asset_utils/__init__.pyi +1 -0
- bpy_extras/bmesh_utils/__init__.pyi +2 -2
- bpy_extras/id_map_utils/__init__.pyi +15 -6
- bpy_extras/image_utils/__init__.pyi +3 -11
- bpy_extras/io_utils/__init__.pyi +22 -38
- bpy_extras/keyconfig_utils/__init__.pyi +5 -4
- bpy_extras/mesh_utils/__init__.pyi +3 -14
- bpy_extras/node_shader_utils/__init__.pyi +63 -70
- bpy_extras/node_utils/__init__.pyi +4 -3
- bpy_extras/object_utils/__init__.pyi +6 -19
- bpy_extras/view3d_utils/__init__.pyi +1 -18
- bpy_extras/wm_utils/__init__.pyi +1 -0
- bpy_extras/wm_utils/progress_report/__init__.pyi +12 -11
- {fake_bge_module-20250317.dist-info → fake_bge_module-20260201.dist-info}/METADATA +9 -3
- fake_bge_module-20260201.dist-info/RECORD +414 -0
- {fake_bge_module-20250317.dist-info → fake_bge_module-20260201.dist-info}/WHEEL +1 -1
- {fake_bge_module-20250317.dist-info → fake_bge_module-20260201.dist-info}/top_level.txt +16 -16
- freestyle/__init__.pyi +1 -0
- freestyle/chainingiterators/__init__.pyi +41 -60
- freestyle/functions/__init__.pyi +56 -194
- freestyle/predicates/__init__.pyi +11 -61
- freestyle/shaders/__init__.pyi +95 -156
- freestyle/types/__init__.pyi +306 -941
- freestyle/utils/ContextFunctions/__init__.pyi +4 -24
- freestyle/utils/__init__.pyi +46 -36
- gpu/__init__.pyi +84 -5
- gpu/capabilities/__init__.pyi +1 -21
- gpu/matrix/__init__.pyi +16 -24
- gpu/platform/__init__.pyi +3 -7
- gpu/select/__init__.pyi +2 -1
- gpu/shader/__init__.pyi +43 -9
- gpu/state/__init__.pyi +66 -44
- gpu/texture/__init__.pyi +4 -5
- gpu/types/__init__.pyi +216 -216
- gpu_extras/__init__.pyi +1 -0
- gpu_extras/batch/__init__.pyi +2 -5
- gpu_extras/presets/__init__.pyi +9 -10
- idprop/__init__.pyi +17 -0
- idprop/types/__init__.pyi +18 -17
- imbuf/__init__.pyi +13 -9
- imbuf/types/__init__.pyi +10 -23
- keyingsets_builtins/__init__.pyi +51 -93
- mathutils/__init__.pyi +296 -2255
- mathutils/bvhtree/__init__.pyi +22 -29
- mathutils/geometry/__init__.pyi +83 -132
- mathutils/interpolate/__init__.pyi +7 -5
- mathutils/kdtree/__init__.pyi +5 -14
- mathutils/noise/__init__.pyi +62 -106
- nodeitems_builtins/__init__.pyi +5 -4
- nodeitems_utils/__init__.pyi +10 -9
- rna_keymap_ui/__init__.pyi +7 -6
- rna_prop_ui/__init__.pyi +14 -13
- _bpy_internal/freedesktop/__init__.pyi +0 -20
- bgl/__init__.pyi +0 -4235
- bl_i18n_utils/bl_extract_messages/__init__.pyi +0 -24
- bl_i18n_utils/utils_cli/__init__.pyi +0 -10
- bl_previews_utils/bl_previews_render/__init__.pyi +0 -11
- bl_text_utils/external_editor/__init__.pyi +0 -5
- bpy_types/__init__.pyi +0 -29
- console_shell/__init__.pyi +0 -9
- fake_bge_module-20250317.dist-info/RECORD +0 -395
- keyingsets_utils/__init__.pyi +0 -18
- {animsys_refactor → _animsys_refactor}/py.typed +0 -0
- {bgl → _bl_console_utils}/py.typed +0 -0
- {bl_console_utils → _bl_i18n_utils}/py.typed +0 -0
- {bl_i18n_utils → _bl_previews_utils}/py.typed +0 -0
- {bl_previews_utils → _bl_rna_utils}/py.typed +0 -0
- {bl_rna_utils → _bl_text_utils}/py.typed +0 -0
- {bl_text_utils → _bl_ui_utils}/py.typed +0 -0
- {bl_ui_utils → _blendfile_header}/py.typed +0 -0
- {bpy_restrict_state → _bpy_restrict_state}/py.typed +0 -0
- {bpy_types → _bpy_types}/py.typed +0 -0
- {console_python → _console_python}/py.typed +0 -0
- {console_shell → _console_shell}/py.typed +0 -0
- {graphviz_export → _graphviz_export}/py.typed +0 -0
- {keyingsets_utils → _keyingsets_utils}/py.typed +0 -0
- {rna_info → _rna_info}/py.typed +0 -0
- {rna_xml → _rna_xml}/py.typed +0 -0
freestyle/types/__init__.pyi
CHANGED
|
@@ -73,6 +73,7 @@ Class hierarchy:
|
|
|
73
73
|
import typing
|
|
74
74
|
import collections.abc
|
|
75
75
|
import typing_extensions
|
|
76
|
+
import numpy.typing as npt
|
|
76
77
|
import mathutils
|
|
77
78
|
|
|
78
79
|
class AdjacencyIterator:
|
|
@@ -84,29 +85,22 @@ class AdjacencyIterator:
|
|
|
84
85
|
|
|
85
86
|
is_incoming: bool
|
|
86
87
|
""" True if the current ViewEdge is coming towards the iteration vertex, and
|
|
87
|
-
False otherwise.
|
|
88
|
-
|
|
89
|
-
:type: bool
|
|
90
|
-
"""
|
|
88
|
+
False otherwise."""
|
|
91
89
|
|
|
92
90
|
object: ViewEdge
|
|
93
|
-
""" The ViewEdge object currently pointed to by this iterator.
|
|
91
|
+
""" The ViewEdge object currently pointed to by this iterator."""
|
|
94
92
|
|
|
95
|
-
:
|
|
96
|
-
"""
|
|
97
|
-
|
|
98
|
-
def __init__(self):
|
|
93
|
+
def __init__(self) -> None:
|
|
99
94
|
"""Builds an `AdjacencyIterator` using the default constructor,
|
|
100
95
|
copy constructor or the overloaded constructor.
|
|
101
96
|
|
|
102
97
|
"""
|
|
103
98
|
|
|
104
|
-
def __init__(self, brother: typing_extensions.Self):
|
|
99
|
+
def __init__(self, brother: typing_extensions.Self) -> None:
|
|
105
100
|
"""Builds an `AdjacencyIterator` using the default constructor,
|
|
106
101
|
copy constructor or the overloaded constructor.
|
|
107
102
|
|
|
108
103
|
:param brother: An AdjacencyIterator object.
|
|
109
|
-
:type brother: typing_extensions.Self
|
|
110
104
|
"""
|
|
111
105
|
|
|
112
106
|
def __init__(
|
|
@@ -114,24 +108,21 @@ False otherwise.
|
|
|
114
108
|
vertex: ViewVertex,
|
|
115
109
|
restrict_to_selection: bool = True,
|
|
116
110
|
restrict_to_unvisited: bool = True,
|
|
117
|
-
):
|
|
111
|
+
) -> None:
|
|
118
112
|
"""Builds an `AdjacencyIterator` using the default constructor,
|
|
119
113
|
copy constructor or the overloaded constructor.
|
|
120
114
|
|
|
121
115
|
:param vertex: The vertex which is the next crossing.
|
|
122
|
-
:type vertex: ViewVertex
|
|
123
116
|
:param restrict_to_selection: Indicates whether to force the chaining
|
|
124
117
|
to stay within the set of selected ViewEdges or not.
|
|
125
|
-
:type restrict_to_selection: bool
|
|
126
118
|
:param restrict_to_unvisited: Indicates whether a ViewEdge that has
|
|
127
119
|
already been chained must be ignored ot not.
|
|
128
|
-
:type restrict_to_unvisited: bool
|
|
129
120
|
"""
|
|
130
121
|
|
|
131
122
|
class BBox:
|
|
132
123
|
"""Class for representing a bounding box."""
|
|
133
124
|
|
|
134
|
-
def __init__(self):
|
|
125
|
+
def __init__(self) -> None:
|
|
135
126
|
"""Default constructor."""
|
|
136
127
|
|
|
137
128
|
class BinaryPredicate0D:
|
|
@@ -143,12 +134,9 @@ class BinaryPredicate0D:
|
|
|
143
134
|
"""
|
|
144
135
|
|
|
145
136
|
name: str
|
|
146
|
-
""" The name of the binary 0D predicate.
|
|
137
|
+
""" The name of the binary 0D predicate."""
|
|
147
138
|
|
|
148
|
-
:
|
|
149
|
-
"""
|
|
150
|
-
|
|
151
|
-
def __init__(self):
|
|
139
|
+
def __init__(self) -> None:
|
|
152
140
|
"""Default constructor."""
|
|
153
141
|
|
|
154
142
|
def __call__(self, inter1: Interface0D, inter2: Interface0D) -> bool:
|
|
@@ -156,11 +144,8 @@ class BinaryPredicate0D:
|
|
|
156
144
|
between two Interface0D objects.
|
|
157
145
|
|
|
158
146
|
:param inter1: The first Interface0D object.
|
|
159
|
-
:type inter1: Interface0D
|
|
160
147
|
:param inter2: The second Interface0D object.
|
|
161
|
-
:type inter2: Interface0D
|
|
162
148
|
:return: True or false.
|
|
163
|
-
:rtype: bool
|
|
164
149
|
"""
|
|
165
150
|
|
|
166
151
|
class BinaryPredicate1D:
|
|
@@ -172,12 +157,9 @@ class BinaryPredicate1D:
|
|
|
172
157
|
"""
|
|
173
158
|
|
|
174
159
|
name: str
|
|
175
|
-
""" The name of the binary 1D predicate.
|
|
176
|
-
|
|
177
|
-
:type: str
|
|
178
|
-
"""
|
|
160
|
+
""" The name of the binary 1D predicate."""
|
|
179
161
|
|
|
180
|
-
def __init__(self):
|
|
162
|
+
def __init__(self) -> None:
|
|
181
163
|
"""Default constructor."""
|
|
182
164
|
|
|
183
165
|
def __call__(self, inter1: Interface1D, inter2: Interface1D) -> bool:
|
|
@@ -185,11 +167,8 @@ class BinaryPredicate1D:
|
|
|
185
167
|
between two Interface1D objects.
|
|
186
168
|
|
|
187
169
|
:param inter1: The first Interface1D object.
|
|
188
|
-
:type inter1: Interface1D
|
|
189
170
|
:param inter2: The second Interface1D object.
|
|
190
|
-
:type inter2: Interface1D
|
|
191
171
|
:return: True or false.
|
|
192
|
-
:rtype: bool
|
|
193
172
|
"""
|
|
194
173
|
|
|
195
174
|
class Chain:
|
|
@@ -198,46 +177,39 @@ class Chain:
|
|
|
198
177
|
Splitting and Creation processes.
|
|
199
178
|
"""
|
|
200
179
|
|
|
201
|
-
def __init__(self):
|
|
180
|
+
def __init__(self) -> None:
|
|
202
181
|
"""Builds a `Chain` using the default constructor,
|
|
203
182
|
copy constructor or from an `Id`.
|
|
204
183
|
|
|
205
184
|
"""
|
|
206
185
|
|
|
207
|
-
def __init__(self, brother: typing_extensions.Self):
|
|
186
|
+
def __init__(self, brother: typing_extensions.Self) -> None:
|
|
208
187
|
"""Builds a `Chain` using the default constructor,
|
|
209
188
|
copy constructor or from an `Id`.
|
|
210
189
|
|
|
211
190
|
:param brother: A Chain object.
|
|
212
|
-
:type brother: typing_extensions.Self
|
|
213
191
|
"""
|
|
214
192
|
|
|
215
|
-
def __init__(self, id: Id):
|
|
193
|
+
def __init__(self, id: Id) -> None:
|
|
216
194
|
"""Builds a `Chain` using the default constructor,
|
|
217
195
|
copy constructor or from an `Id`.
|
|
218
196
|
|
|
219
197
|
:param id: An Id object.
|
|
220
|
-
:type id: Id
|
|
221
198
|
"""
|
|
222
199
|
|
|
223
|
-
def push_viewedge_back(self, viewedge: ViewEdge, orientation: bool):
|
|
200
|
+
def push_viewedge_back(self, viewedge: ViewEdge, orientation: bool) -> None:
|
|
224
201
|
"""Adds a ViewEdge at the end of the Chain.
|
|
225
202
|
|
|
226
|
-
|
|
227
|
-
|
|
228
|
-
:param orientation: The orientation with which the ViewEdge must be
|
|
229
|
-
processed.
|
|
230
|
-
:type orientation: bool
|
|
203
|
+
:param viewedge: The ViewEdge that must be added.
|
|
204
|
+
:param orientation: The orientation with which the ViewEdge must be processed.
|
|
231
205
|
"""
|
|
232
206
|
|
|
233
|
-
def push_viewedge_front(self, viewedge: ViewEdge, orientation: bool):
|
|
207
|
+
def push_viewedge_front(self, viewedge: ViewEdge, orientation: bool) -> None:
|
|
234
208
|
"""Adds a ViewEdge at the beginning of the Chain.
|
|
235
209
|
|
|
236
210
|
:param viewedge: The ViewEdge that must be added.
|
|
237
|
-
:type viewedge: ViewEdge
|
|
238
211
|
:param orientation: The orientation with which the ViewEdge must be
|
|
239
212
|
processed.
|
|
240
|
-
:type orientation: bool
|
|
241
213
|
"""
|
|
242
214
|
|
|
243
215
|
class ChainingIterator:
|
|
@@ -252,22 +224,13 @@ class ChainingIterator:
|
|
|
252
224
|
"""
|
|
253
225
|
|
|
254
226
|
is_incrementing: bool
|
|
255
|
-
""" True if the current iteration is an incrementation.
|
|
256
|
-
|
|
257
|
-
:type: bool
|
|
258
|
-
"""
|
|
227
|
+
""" True if the current iteration is an incrementation."""
|
|
259
228
|
|
|
260
229
|
next_vertex: ViewVertex
|
|
261
|
-
""" The ViewVertex that is the next crossing.
|
|
262
|
-
|
|
263
|
-
:type: ViewVertex
|
|
264
|
-
"""
|
|
230
|
+
""" The ViewVertex that is the next crossing."""
|
|
265
231
|
|
|
266
232
|
object: ViewEdge
|
|
267
|
-
""" The ViewEdge object currently pointed by this iterator.
|
|
268
|
-
|
|
269
|
-
:type: ViewEdge
|
|
270
|
-
"""
|
|
233
|
+
""" The ViewEdge object currently pointed by this iterator."""
|
|
271
234
|
|
|
272
235
|
def __init__(
|
|
273
236
|
self,
|
|
@@ -275,32 +238,27 @@ class ChainingIterator:
|
|
|
275
238
|
restrict_to_unvisited: bool = True,
|
|
276
239
|
begin: None | ViewEdge | None = None,
|
|
277
240
|
orientation: bool = True,
|
|
278
|
-
):
|
|
241
|
+
) -> None:
|
|
279
242
|
"""Builds a Chaining Iterator from the first ViewEdge used for
|
|
280
243
|
iteration and its orientation or by using the copy constructor.
|
|
281
244
|
|
|
282
245
|
:param restrict_to_selection: Indicates whether to force the chaining
|
|
283
246
|
to stay within the set of selected ViewEdges or not.
|
|
284
|
-
:type restrict_to_selection: bool
|
|
285
247
|
:param restrict_to_unvisited: Indicates whether a ViewEdge that has
|
|
286
248
|
already been chained must be ignored ot not.
|
|
287
|
-
:type restrict_to_unvisited: bool
|
|
288
249
|
:param begin: The ViewEdge from which to start the chain.
|
|
289
|
-
:type begin: None | ViewEdge | None
|
|
290
250
|
:param orientation: The direction to follow to explore the graph. If
|
|
291
251
|
true, the direction indicated by the first ViewEdge is used.
|
|
292
|
-
:type orientation: bool
|
|
293
252
|
"""
|
|
294
253
|
|
|
295
|
-
def __init__(self, brother: typing_extensions.Self):
|
|
254
|
+
def __init__(self, brother: typing_extensions.Self) -> None:
|
|
296
255
|
"""Builds a Chaining Iterator from the first ViewEdge used for
|
|
297
256
|
iteration and its orientation or by using the copy constructor.
|
|
298
257
|
|
|
299
258
|
:param brother:
|
|
300
|
-
:type brother: typing_extensions.Self
|
|
301
259
|
"""
|
|
302
260
|
|
|
303
|
-
def init(self):
|
|
261
|
+
def init(self) -> None:
|
|
304
262
|
"""Initializes the iterator context. This method is called each
|
|
305
263
|
time a new chain is started. It can be used to reset some
|
|
306
264
|
history information that you might want to keep.
|
|
@@ -315,9 +273,7 @@ class ChainingIterator:
|
|
|
315
273
|
:param it: The iterator over the ViewEdges adjacent to the end vertex
|
|
316
274
|
of the current ViewEdge. The adjacency iterator reflects the
|
|
317
275
|
restriction rules by only iterating over the valid ViewEdges.
|
|
318
|
-
:type it: AdjacencyIterator
|
|
319
276
|
:return: Returns the next ViewEdge to follow, or None if chaining ends.
|
|
320
|
-
:rtype: None | ViewEdge
|
|
321
277
|
"""
|
|
322
278
|
|
|
323
279
|
class Curve:
|
|
@@ -327,56 +283,46 @@ class Curve:
|
|
|
327
283
|
"""
|
|
328
284
|
|
|
329
285
|
is_empty: bool
|
|
330
|
-
""" True if the Curve doesn't have any Vertex yet.
|
|
331
|
-
|
|
332
|
-
:type: bool
|
|
333
|
-
"""
|
|
286
|
+
""" True if the Curve doesn't have any Vertex yet."""
|
|
334
287
|
|
|
335
288
|
segments_size: int
|
|
336
|
-
""" The number of segments in the polyline constituting the Curve.
|
|
337
|
-
|
|
338
|
-
:type: int
|
|
339
|
-
"""
|
|
289
|
+
""" The number of segments in the polyline constituting the Curve."""
|
|
340
290
|
|
|
341
|
-
def __init__(self):
|
|
291
|
+
def __init__(self) -> None:
|
|
342
292
|
"""Builds a `FrsCurve` using a default constructor,
|
|
343
293
|
copy constructor or from an `Id`.
|
|
344
294
|
|
|
345
295
|
"""
|
|
346
296
|
|
|
347
|
-
def __init__(self, brother: typing_extensions.Self):
|
|
297
|
+
def __init__(self, brother: typing_extensions.Self) -> None:
|
|
348
298
|
"""Builds a `FrsCurve` using a default constructor,
|
|
349
299
|
copy constructor or from an `Id`.
|
|
350
300
|
|
|
351
301
|
:param brother: A Curve object.
|
|
352
|
-
:type brother: typing_extensions.Self
|
|
353
302
|
"""
|
|
354
303
|
|
|
355
|
-
def __init__(self, id: Id):
|
|
304
|
+
def __init__(self, id: Id) -> None:
|
|
356
305
|
"""Builds a `FrsCurve` using a default constructor,
|
|
357
306
|
copy constructor or from an `Id`.
|
|
358
307
|
|
|
359
308
|
:param id: An Id object.
|
|
360
|
-
:type id: Id
|
|
361
309
|
"""
|
|
362
310
|
|
|
363
|
-
def push_vertex_back(self, vertex: CurvePoint | SVertex):
|
|
311
|
+
def push_vertex_back(self, vertex: CurvePoint | SVertex) -> None:
|
|
364
312
|
"""Adds a single vertex at the end of the Curve.
|
|
365
313
|
|
|
366
314
|
:param vertex: A vertex object.
|
|
367
|
-
:type vertex: CurvePoint | SVertex
|
|
368
315
|
"""
|
|
369
316
|
|
|
370
|
-
def push_vertex_front(self, vertex: CurvePoint | SVertex):
|
|
317
|
+
def push_vertex_front(self, vertex: CurvePoint | SVertex) -> None:
|
|
371
318
|
"""Adds a single vertex at the front of the Curve.
|
|
372
319
|
|
|
373
320
|
:param vertex: A vertex object.
|
|
374
|
-
:type vertex: CurvePoint | SVertex
|
|
375
321
|
"""
|
|
376
322
|
|
|
377
323
|
class CurvePoint:
|
|
378
324
|
"""Class hierarchy: `Interface0D` > `CurvePoint`Class to represent a point of a curve. A CurvePoint can be any point
|
|
379
|
-
of a 1D curve (it
|
|
325
|
+
of a 1D curve (it doesnt have to be a vertex of the curve). Any
|
|
380
326
|
`Interface1D` is built upon ViewEdges, themselves built upon
|
|
381
327
|
FEdges. Therefore, a curve is basically a polyline made of a list of
|
|
382
328
|
`SVertex` objects. Thus, a CurvePoint is built by linearly
|
|
@@ -387,30 +333,18 @@ class CurvePoint:
|
|
|
387
333
|
|
|
388
334
|
fedge: FEdge
|
|
389
335
|
""" Gets the FEdge for the two SVertices that given CurvePoints consists out of.
|
|
390
|
-
A shortcut for CurvePoint.first_svertex.get_fedge(CurvePoint.second_svertex).
|
|
391
|
-
|
|
392
|
-
:type: FEdge
|
|
393
|
-
"""
|
|
336
|
+
A shortcut for CurvePoint.first_svertex.get_fedge(CurvePoint.second_svertex)."""
|
|
394
337
|
|
|
395
338
|
first_svertex: SVertex
|
|
396
|
-
""" The first SVertex upon which the CurvePoint is built.
|
|
397
|
-
|
|
398
|
-
:type: SVertex
|
|
399
|
-
"""
|
|
339
|
+
""" The first SVertex upon which the CurvePoint is built."""
|
|
400
340
|
|
|
401
341
|
second_svertex: SVertex
|
|
402
|
-
""" The second SVertex upon which the CurvePoint is built.
|
|
403
|
-
|
|
404
|
-
:type: SVertex
|
|
405
|
-
"""
|
|
342
|
+
""" The second SVertex upon which the CurvePoint is built."""
|
|
406
343
|
|
|
407
344
|
t2d: float
|
|
408
|
-
""" The 2D interpolation parameter.
|
|
345
|
+
""" The 2D interpolation parameter."""
|
|
409
346
|
|
|
410
|
-
:
|
|
411
|
-
"""
|
|
412
|
-
|
|
413
|
-
def __init__(self):
|
|
347
|
+
def __init__(self) -> None:
|
|
414
348
|
"""Builds a CurvePoint using the default constructor, copy constructor,
|
|
415
349
|
or one of the overloaded constructors. The over loaded constructors
|
|
416
350
|
can either take two `SVertex` or two `CurvePoint`
|
|
@@ -418,29 +352,27 @@ A shortcut for CurvePoint.first_svertex.get_fedge(CurvePoint.second_svertex).
|
|
|
418
352
|
|
|
419
353
|
"""
|
|
420
354
|
|
|
421
|
-
def __init__(self, brother: typing_extensions.Self):
|
|
355
|
+
def __init__(self, brother: typing_extensions.Self) -> None:
|
|
422
356
|
"""Builds a CurvePoint using the default constructor, copy constructor,
|
|
423
357
|
or one of the overloaded constructors. The over loaded constructors
|
|
424
358
|
can either take two `SVertex` or two `CurvePoint`
|
|
425
359
|
objects and an interpolation parameter
|
|
426
360
|
|
|
427
361
|
:param brother: A CurvePoint object.
|
|
428
|
-
:type brother: typing_extensions.Self
|
|
429
362
|
"""
|
|
430
363
|
|
|
431
|
-
def __init__(
|
|
364
|
+
def __init__(
|
|
365
|
+
self, first_vertex: SVertex, second_vertex: SVertex, t2d: float
|
|
366
|
+
) -> None:
|
|
432
367
|
"""Builds a CurvePoint using the default constructor, copy constructor,
|
|
433
368
|
or one of the overloaded constructors. The over loaded constructors
|
|
434
369
|
can either take two `SVertex` or two `CurvePoint`
|
|
435
370
|
objects and an interpolation parameter
|
|
436
371
|
|
|
437
372
|
:param first_vertex: The first SVertex.
|
|
438
|
-
:type first_vertex: SVertex
|
|
439
373
|
:param second_vertex: The second SVertex.
|
|
440
|
-
:type second_vertex: SVertex
|
|
441
374
|
:param t2d: A 2D interpolation parameter used to linearly interpolate
|
|
442
375
|
first_vertex and second_vertex or first_point and second_point.
|
|
443
|
-
:type t2d: float
|
|
444
376
|
"""
|
|
445
377
|
|
|
446
378
|
def __init__(
|
|
@@ -448,19 +380,16 @@ A shortcut for CurvePoint.first_svertex.get_fedge(CurvePoint.second_svertex).
|
|
|
448
380
|
first_point: typing_extensions.Self,
|
|
449
381
|
second_point: typing_extensions.Self,
|
|
450
382
|
t2d: float,
|
|
451
|
-
):
|
|
383
|
+
) -> None:
|
|
452
384
|
"""Builds a CurvePoint using the default constructor, copy constructor,
|
|
453
385
|
or one of the overloaded constructors. The over loaded constructors
|
|
454
386
|
can either take two `SVertex` or two `CurvePoint`
|
|
455
387
|
objects and an interpolation parameter
|
|
456
388
|
|
|
457
389
|
:param first_point: The first CurvePoint.
|
|
458
|
-
:type first_point: typing_extensions.Self
|
|
459
390
|
:param second_point: The second CurvePoint.
|
|
460
|
-
:type second_point: typing_extensions.Self
|
|
461
391
|
:param t2d: A 2D interpolation parameter used to linearly interpolate
|
|
462
392
|
first_vertex and second_vertex or first_point and second_point.
|
|
463
|
-
:type t2d: float
|
|
464
393
|
"""
|
|
465
394
|
|
|
466
395
|
class CurvePointIterator:
|
|
@@ -470,45 +399,34 @@ class CurvePointIterator:
|
|
|
470
399
|
"""
|
|
471
400
|
|
|
472
401
|
object: CurvePoint
|
|
473
|
-
""" The CurvePoint object currently pointed by this iterator.
|
|
474
|
-
|
|
475
|
-
:type: CurvePoint
|
|
476
|
-
"""
|
|
402
|
+
""" The CurvePoint object currently pointed by this iterator."""
|
|
477
403
|
|
|
478
404
|
t: float
|
|
479
|
-
""" The curvilinear abscissa of the current point.
|
|
480
|
-
|
|
481
|
-
:type: float
|
|
482
|
-
"""
|
|
405
|
+
""" The curvilinear abscissa of the current point."""
|
|
483
406
|
|
|
484
407
|
u: float
|
|
485
|
-
""" The point parameter at the current point in the stroke (0 <= u <= 1).
|
|
486
|
-
|
|
487
|
-
:type: float
|
|
488
|
-
"""
|
|
408
|
+
""" The point parameter at the current point in the stroke (0 <= u <= 1)."""
|
|
489
409
|
|
|
490
|
-
def __init__(self):
|
|
410
|
+
def __init__(self) -> None:
|
|
491
411
|
"""Builds a CurvePointIterator object using either the default constructor,
|
|
492
412
|
copy constructor, or the overloaded constructor.
|
|
493
413
|
|
|
494
414
|
"""
|
|
495
415
|
|
|
496
|
-
def __init__(self, brother: typing_extensions.Self):
|
|
416
|
+
def __init__(self, brother: typing_extensions.Self) -> None:
|
|
497
417
|
"""Builds a CurvePointIterator object using either the default constructor,
|
|
498
418
|
copy constructor, or the overloaded constructor.
|
|
499
419
|
|
|
500
420
|
:param brother: A CurvePointIterator object.
|
|
501
|
-
:type brother: typing_extensions.Self
|
|
502
421
|
"""
|
|
503
422
|
|
|
504
|
-
def __init__(self, step: float = 0.0):
|
|
423
|
+
def __init__(self, step: float = 0.0) -> None:
|
|
505
424
|
"""Builds a CurvePointIterator object using either the default constructor,
|
|
506
425
|
copy constructor, or the overloaded constructor.
|
|
507
426
|
|
|
508
427
|
:param step: A resampling resolution with which the curve is resampled.
|
|
509
428
|
If zero, no resampling is done (i.e., the iterator iterates over
|
|
510
429
|
initial vertices).
|
|
511
|
-
:type step: float
|
|
512
430
|
"""
|
|
513
431
|
|
|
514
432
|
class FEdge:
|
|
@@ -524,67 +442,42 @@ class FEdge:
|
|
|
524
442
|
"""
|
|
525
443
|
|
|
526
444
|
first_svertex: SVertex
|
|
527
|
-
""" The first SVertex constituting this FEdge.
|
|
528
|
-
|
|
529
|
-
:type: SVertex
|
|
530
|
-
"""
|
|
445
|
+
""" The first SVertex constituting this FEdge."""
|
|
531
446
|
|
|
532
447
|
id: Id
|
|
533
|
-
""" The Id of this FEdge.
|
|
534
|
-
|
|
535
|
-
:type: Id
|
|
536
|
-
"""
|
|
448
|
+
""" The Id of this FEdge."""
|
|
537
449
|
|
|
538
450
|
is_smooth: bool
|
|
539
|
-
""" True if this FEdge is a smooth FEdge.
|
|
540
|
-
|
|
541
|
-
:type: bool
|
|
542
|
-
"""
|
|
451
|
+
""" True if this FEdge is a smooth FEdge."""
|
|
543
452
|
|
|
544
453
|
nature: Nature
|
|
545
|
-
""" The nature of this FEdge.
|
|
546
|
-
|
|
547
|
-
:type: Nature
|
|
548
|
-
"""
|
|
454
|
+
""" The nature of this FEdge."""
|
|
549
455
|
|
|
550
456
|
next_fedge: typing_extensions.Self
|
|
551
457
|
""" The FEdge following this one in the ViewEdge. The value is None if
|
|
552
|
-
this FEdge is the last of the ViewEdge.
|
|
553
|
-
|
|
554
|
-
:type: typing_extensions.Self
|
|
555
|
-
"""
|
|
458
|
+
this FEdge is the last of the ViewEdge."""
|
|
556
459
|
|
|
557
460
|
previous_fedge: typing_extensions.Self
|
|
558
461
|
""" The FEdge preceding this one in the ViewEdge. The value is None if
|
|
559
|
-
this FEdge is the first one of the ViewEdge.
|
|
560
|
-
|
|
561
|
-
:type: typing_extensions.Self
|
|
562
|
-
"""
|
|
462
|
+
this FEdge is the first one of the ViewEdge."""
|
|
563
463
|
|
|
564
464
|
second_svertex: SVertex
|
|
565
|
-
""" The second SVertex constituting this FEdge.
|
|
566
|
-
|
|
567
|
-
:type: SVertex
|
|
568
|
-
"""
|
|
465
|
+
""" The second SVertex constituting this FEdge."""
|
|
569
466
|
|
|
570
467
|
viewedge: ViewEdge
|
|
571
|
-
""" The ViewEdge to which this FEdge belongs to.
|
|
468
|
+
""" The ViewEdge to which this FEdge belongs to."""
|
|
572
469
|
|
|
573
|
-
:
|
|
574
|
-
"""
|
|
575
|
-
|
|
576
|
-
def FEdge(self):
|
|
470
|
+
def FEdge(self) -> None:
|
|
577
471
|
"""Builds an `FEdge` using the default constructor,
|
|
578
472
|
copy constructor, or between two `SVertex` objects.
|
|
579
473
|
|
|
580
474
|
"""
|
|
581
475
|
|
|
582
|
-
def FEdge(self, brother: typing_extensions.Self):
|
|
476
|
+
def FEdge(self, brother: typing_extensions.Self) -> None:
|
|
583
477
|
"""Builds an `FEdge` using the default constructor,
|
|
584
478
|
copy constructor, or between two `SVertex` objects.
|
|
585
479
|
|
|
586
480
|
:param brother: An FEdge object.
|
|
587
|
-
:type brother: typing_extensions.Self
|
|
588
481
|
"""
|
|
589
482
|
|
|
590
483
|
class FEdgeSharp:
|
|
@@ -592,86 +485,59 @@ class FEdgeSharp:
|
|
|
592
485
|
edge of the input mesh. It can be a silhouette, a crease or a border.
|
|
593
486
|
If it is a crease edge, then it is bordered by two faces of the mesh.
|
|
594
487
|
Face a lies on its right whereas Face b lies on its left. If it is a
|
|
595
|
-
border edge, then it
|
|
488
|
+
border edge, then it doesnt have any face on its right, and thus Face
|
|
596
489
|
a is None.
|
|
597
490
|
"""
|
|
598
491
|
|
|
599
492
|
face_mark_left: bool
|
|
600
|
-
""" The face mark of the face lying on the left of the FEdge.
|
|
601
|
-
|
|
602
|
-
:type: bool
|
|
603
|
-
"""
|
|
493
|
+
""" The face mark of the face lying on the left of the FEdge."""
|
|
604
494
|
|
|
605
495
|
face_mark_right: bool
|
|
606
496
|
""" The face mark of the face lying on the right of the FEdge. If this FEdge
|
|
607
497
|
is a border, it has no face on the right and thus this property is set to
|
|
608
|
-
false.
|
|
609
|
-
|
|
610
|
-
:type: bool
|
|
611
|
-
"""
|
|
498
|
+
false."""
|
|
612
499
|
|
|
613
500
|
material_index_left: int
|
|
614
|
-
""" The index of the material of the face lying on the left of the FEdge.
|
|
615
|
-
|
|
616
|
-
:type: int
|
|
617
|
-
"""
|
|
501
|
+
""" The index of the material of the face lying on the left of the FEdge."""
|
|
618
502
|
|
|
619
503
|
material_index_right: int
|
|
620
504
|
""" The index of the material of the face lying on the right of the FEdge.
|
|
621
505
|
If this FEdge is a border, it has no Face on its right and therefore
|
|
622
|
-
no material.
|
|
623
|
-
|
|
624
|
-
:type: int
|
|
625
|
-
"""
|
|
506
|
+
no material."""
|
|
626
507
|
|
|
627
508
|
material_left: Material
|
|
628
|
-
""" The material of the face lying on the left of the FEdge.
|
|
629
|
-
|
|
630
|
-
:type: Material
|
|
631
|
-
"""
|
|
509
|
+
""" The material of the face lying on the left of the FEdge."""
|
|
632
510
|
|
|
633
511
|
material_right: Material
|
|
634
512
|
""" The material of the face lying on the right of the FEdge. If this FEdge
|
|
635
|
-
is a border, it has no Face on its right and therefore no material.
|
|
636
|
-
|
|
637
|
-
:type: Material
|
|
638
|
-
"""
|
|
513
|
+
is a border, it has no Face on its right and therefore no material."""
|
|
639
514
|
|
|
640
515
|
normal_left: mathutils.Vector
|
|
641
|
-
""" The normal to the face lying on the left of the FEdge.
|
|
642
|
-
|
|
643
|
-
:type: mathutils.Vector
|
|
644
|
-
"""
|
|
516
|
+
""" The normal to the face lying on the left of the FEdge."""
|
|
645
517
|
|
|
646
518
|
normal_right: mathutils.Vector
|
|
647
519
|
""" The normal to the face lying on the right of the FEdge. If this FEdge
|
|
648
|
-
is a border, it has no Face on its right and therefore no normal.
|
|
649
|
-
|
|
650
|
-
:type: mathutils.Vector
|
|
651
|
-
"""
|
|
520
|
+
is a border, it has no Face on its right and therefore no normal."""
|
|
652
521
|
|
|
653
|
-
def __init__(self):
|
|
522
|
+
def __init__(self) -> None:
|
|
654
523
|
"""Builds an `FEdgeSharp` using the default constructor,
|
|
655
524
|
copy constructor, or between two `SVertex` objects.
|
|
656
525
|
|
|
657
526
|
"""
|
|
658
527
|
|
|
659
|
-
def __init__(self, brother: typing_extensions.Self):
|
|
528
|
+
def __init__(self, brother: typing_extensions.Self) -> None:
|
|
660
529
|
"""Builds an `FEdgeSharp` using the default constructor,
|
|
661
530
|
copy constructor, or between two `SVertex` objects.
|
|
662
531
|
|
|
663
532
|
:param brother: An FEdgeSharp object.
|
|
664
|
-
:type brother: typing_extensions.Self
|
|
665
533
|
"""
|
|
666
534
|
|
|
667
|
-
def __init__(self, first_vertex: SVertex, second_vertex: SVertex):
|
|
535
|
+
def __init__(self, first_vertex: SVertex, second_vertex: SVertex) -> None:
|
|
668
536
|
"""Builds an `FEdgeSharp` using the default constructor,
|
|
669
537
|
copy constructor, or between two `SVertex` objects.
|
|
670
538
|
|
|
671
539
|
:param first_vertex: The first SVertex object.
|
|
672
|
-
:type first_vertex: SVertex
|
|
673
540
|
:param second_vertex: The second SVertex object.
|
|
674
|
-
:type second_vertex: SVertex
|
|
675
541
|
"""
|
|
676
542
|
|
|
677
543
|
class FEdgeSmooth:
|
|
@@ -681,81 +547,58 @@ class FEdgeSmooth:
|
|
|
681
547
|
"""
|
|
682
548
|
|
|
683
549
|
face_mark: bool
|
|
684
|
-
""" The face mark of the face that this FEdge is running across.
|
|
685
|
-
|
|
686
|
-
:type: bool
|
|
687
|
-
"""
|
|
550
|
+
""" The face mark of the face that this FEdge is running across."""
|
|
688
551
|
|
|
689
552
|
material: Material
|
|
690
|
-
""" The material of the face that this FEdge is running across.
|
|
691
|
-
|
|
692
|
-
:type: Material
|
|
693
|
-
"""
|
|
553
|
+
""" The material of the face that this FEdge is running across."""
|
|
694
554
|
|
|
695
555
|
material_index: int
|
|
696
|
-
""" The index of the material of the face that this FEdge is running across.
|
|
697
|
-
|
|
698
|
-
:type: int
|
|
699
|
-
"""
|
|
556
|
+
""" The index of the material of the face that this FEdge is running across."""
|
|
700
557
|
|
|
701
558
|
normal: mathutils.Vector
|
|
702
|
-
""" The normal of the face that this FEdge is running across.
|
|
703
|
-
|
|
704
|
-
:type: mathutils.Vector
|
|
705
|
-
"""
|
|
559
|
+
""" The normal of the face that this FEdge is running across."""
|
|
706
560
|
|
|
707
|
-
def __init__(self):
|
|
561
|
+
def __init__(self) -> None:
|
|
708
562
|
"""Builds an `FEdgeSmooth` using the default constructor,
|
|
709
563
|
copy constructor, or between two `SVertex`.
|
|
710
564
|
|
|
711
565
|
"""
|
|
712
566
|
|
|
713
|
-
def __init__(self, brother: typing_extensions.Self):
|
|
567
|
+
def __init__(self, brother: typing_extensions.Self) -> None:
|
|
714
568
|
"""Builds an `FEdgeSmooth` using the default constructor,
|
|
715
569
|
copy constructor, or between two `SVertex`.
|
|
716
570
|
|
|
717
571
|
:param brother: An FEdgeSmooth object.
|
|
718
|
-
:type brother: typing_extensions.Self
|
|
719
572
|
"""
|
|
720
573
|
|
|
721
|
-
def __init__(self, first_vertex: SVertex, second_vertex: SVertex):
|
|
574
|
+
def __init__(self, first_vertex: SVertex, second_vertex: SVertex) -> None:
|
|
722
575
|
"""Builds an `FEdgeSmooth` using the default constructor,
|
|
723
576
|
copy constructor, or between two `SVertex`.
|
|
724
577
|
|
|
725
578
|
:param first_vertex: The first SVertex object.
|
|
726
|
-
:type first_vertex: SVertex
|
|
727
579
|
:param second_vertex: The second SVertex object.
|
|
728
|
-
:type second_vertex: SVertex
|
|
729
580
|
"""
|
|
730
581
|
|
|
731
582
|
class Id:
|
|
732
583
|
"""Class for representing an object Id."""
|
|
733
584
|
|
|
734
585
|
first: int
|
|
735
|
-
""" The first number constituting the Id.
|
|
736
|
-
|
|
737
|
-
:type: int
|
|
738
|
-
"""
|
|
586
|
+
""" The first number constituting the Id."""
|
|
739
587
|
|
|
740
588
|
second: int
|
|
741
|
-
""" The second number constituting the Id.
|
|
742
|
-
|
|
743
|
-
:type: int
|
|
744
|
-
"""
|
|
589
|
+
""" The second number constituting the Id."""
|
|
745
590
|
|
|
746
|
-
def __init__(self, brother):
|
|
591
|
+
def __init__(self, brother) -> None:
|
|
747
592
|
"""Build the Id from two numbers or another `Id` using the copy constructor.
|
|
748
593
|
|
|
749
594
|
:param brother: An Id object.
|
|
750
595
|
"""
|
|
751
596
|
|
|
752
|
-
def __init__(self, first: int = 0, second: int = 0):
|
|
597
|
+
def __init__(self, first: int = 0, second: int = 0) -> None:
|
|
753
598
|
"""Build the Id from two numbers or another `Id` using the copy constructor.
|
|
754
599
|
|
|
755
600
|
:param first:
|
|
756
|
-
:type first: int
|
|
757
601
|
:param second: The second number.
|
|
758
|
-
:type second: int
|
|
759
602
|
"""
|
|
760
603
|
|
|
761
604
|
class IntegrationType:
|
|
@@ -768,54 +611,30 @@ class Interface0D:
|
|
|
768
611
|
"""Base class for any 0D element."""
|
|
769
612
|
|
|
770
613
|
id: Id
|
|
771
|
-
""" The Id of this 0D element.
|
|
772
|
-
|
|
773
|
-
:type: Id
|
|
774
|
-
"""
|
|
614
|
+
""" The Id of this 0D element."""
|
|
775
615
|
|
|
776
616
|
name: str
|
|
777
|
-
""" The string of the name of this 0D element.
|
|
778
|
-
|
|
779
|
-
:type: str
|
|
780
|
-
"""
|
|
617
|
+
""" The string of the name of this 0D element."""
|
|
781
618
|
|
|
782
619
|
nature: Nature
|
|
783
|
-
""" The nature of this 0D element.
|
|
784
|
-
|
|
785
|
-
:type: Nature
|
|
786
|
-
"""
|
|
620
|
+
""" The nature of this 0D element."""
|
|
787
621
|
|
|
788
622
|
point_2d: mathutils.Vector
|
|
789
|
-
""" The 2D point of this 0D element.
|
|
790
|
-
|
|
791
|
-
:type: mathutils.Vector
|
|
792
|
-
"""
|
|
623
|
+
""" The 2D point of this 0D element."""
|
|
793
624
|
|
|
794
625
|
point_3d: mathutils.Vector
|
|
795
|
-
""" The 3D point of this 0D element.
|
|
796
|
-
|
|
797
|
-
:type: mathutils.Vector
|
|
798
|
-
"""
|
|
626
|
+
""" The 3D point of this 0D element."""
|
|
799
627
|
|
|
800
628
|
projected_x: float
|
|
801
|
-
""" The X coordinate of the projected 3D point of this 0D element.
|
|
802
|
-
|
|
803
|
-
:type: float
|
|
804
|
-
"""
|
|
629
|
+
""" The X coordinate of the projected 3D point of this 0D element."""
|
|
805
630
|
|
|
806
631
|
projected_y: float
|
|
807
|
-
""" The Y coordinate of the projected 3D point of this 0D element.
|
|
808
|
-
|
|
809
|
-
:type: float
|
|
810
|
-
"""
|
|
632
|
+
""" The Y coordinate of the projected 3D point of this 0D element."""
|
|
811
633
|
|
|
812
634
|
projected_z: float
|
|
813
|
-
""" The Z coordinate of the projected 3D point of this 0D element.
|
|
635
|
+
""" The Z coordinate of the projected 3D point of this 0D element."""
|
|
814
636
|
|
|
815
|
-
:
|
|
816
|
-
"""
|
|
817
|
-
|
|
818
|
-
def __init__(self):
|
|
637
|
+
def __init__(self) -> None:
|
|
819
638
|
"""Default constructor."""
|
|
820
639
|
|
|
821
640
|
def get_fedge(self, inter: typing_extensions.Self) -> FEdge:
|
|
@@ -823,9 +642,7 @@ class Interface0D:
|
|
|
823
642
|
element given as the argument.
|
|
824
643
|
|
|
825
644
|
:param inter: A 0D element.
|
|
826
|
-
:type inter: typing_extensions.Self
|
|
827
645
|
:return: The FEdge lying between the two 0D elements.
|
|
828
|
-
:rtype: FEdge
|
|
829
646
|
"""
|
|
830
647
|
|
|
831
648
|
class Interface0DIterator:
|
|
@@ -835,85 +652,55 @@ class Interface0DIterator:
|
|
|
835
652
|
|
|
836
653
|
at_last: bool
|
|
837
654
|
""" True if the iterator points to the last valid element.
|
|
838
|
-
For its counterpart (pointing to the first valid element), use it.is_begin.
|
|
839
|
-
|
|
840
|
-
:type: bool
|
|
841
|
-
"""
|
|
655
|
+
For its counterpart (pointing to the first valid element), use it.is_begin."""
|
|
842
656
|
|
|
843
657
|
object: Interface0D
|
|
844
658
|
""" The 0D object currently pointed to by this iterator. Note that the object
|
|
845
659
|
may be an instance of an Interface0D subclass. For example if the iterator
|
|
846
660
|
has been created from the vertices_begin() method of the `Stroke`
|
|
847
|
-
class, the .object property refers to a `StrokeVertex` object.
|
|
848
|
-
|
|
849
|
-
:type: Interface0D
|
|
850
|
-
"""
|
|
661
|
+
class, the .object property refers to a `StrokeVertex` object."""
|
|
851
662
|
|
|
852
663
|
t: float
|
|
853
|
-
""" The curvilinear abscissa of the current point.
|
|
854
|
-
|
|
855
|
-
:type: float
|
|
856
|
-
"""
|
|
664
|
+
""" The curvilinear abscissa of the current point."""
|
|
857
665
|
|
|
858
666
|
u: float
|
|
859
|
-
""" The point parameter at the current point in the 1D element (0 <= u <= 1).
|
|
667
|
+
""" The point parameter at the current point in the 1D element (0 <= u <= 1)."""
|
|
860
668
|
|
|
861
|
-
:
|
|
862
|
-
"""
|
|
863
|
-
|
|
864
|
-
def __init__(self, brother: typing_extensions.Self):
|
|
669
|
+
def __init__(self, brother: typing_extensions.Self) -> None:
|
|
865
670
|
"""Construct a nested Interface0DIterator using either the copy constructor
|
|
866
|
-
or the constructor that takes an
|
|
671
|
+
or the constructor that takes an argument of a Function0D.
|
|
867
672
|
|
|
868
673
|
:param brother: An Interface0DIterator object.
|
|
869
|
-
:type brother: typing_extensions.Self
|
|
870
674
|
"""
|
|
871
675
|
|
|
872
676
|
def __init__(
|
|
873
|
-
self,
|
|
874
|
-
|
|
875
|
-
):
|
|
677
|
+
self, it: CurvePointIterator | SVertexIterator | StrokeVertexIterator
|
|
678
|
+
) -> None:
|
|
876
679
|
"""Construct a nested Interface0DIterator using either the copy constructor
|
|
877
|
-
or the constructor that takes an
|
|
680
|
+
or the constructor that takes an argument of a Function0D.
|
|
878
681
|
|
|
879
682
|
:param it: An iterator object to be nested.
|
|
880
|
-
:type it: CurvePointIterator | SVertexIterator | StrokeVertexIterator | typing.Any
|
|
881
683
|
"""
|
|
882
684
|
|
|
883
685
|
class Interface1D:
|
|
884
686
|
"""Base class for any 1D element."""
|
|
885
687
|
|
|
886
688
|
id: Id
|
|
887
|
-
""" The Id of this Interface1D.
|
|
888
|
-
|
|
889
|
-
:type: Id
|
|
890
|
-
"""
|
|
689
|
+
""" The Id of this Interface1D."""
|
|
891
690
|
|
|
892
691
|
length_2d: float
|
|
893
|
-
""" The 2D length of this Interface1D.
|
|
894
|
-
|
|
895
|
-
:type: float
|
|
896
|
-
"""
|
|
692
|
+
""" The 2D length of this Interface1D."""
|
|
897
693
|
|
|
898
694
|
name: str
|
|
899
|
-
""" The string of the name of the 1D element.
|
|
900
|
-
|
|
901
|
-
:type: str
|
|
902
|
-
"""
|
|
695
|
+
""" The string of the name of the 1D element."""
|
|
903
696
|
|
|
904
697
|
nature: Nature
|
|
905
|
-
""" The nature of this Interface1D.
|
|
906
|
-
|
|
907
|
-
:type: Nature
|
|
908
|
-
"""
|
|
698
|
+
""" The nature of this Interface1D."""
|
|
909
699
|
|
|
910
700
|
time_stamp: int
|
|
911
|
-
""" The time stamp of the 1D element, mainly used for selection.
|
|
912
|
-
|
|
913
|
-
:type: int
|
|
914
|
-
"""
|
|
701
|
+
""" The time stamp of the 1D element, mainly used for selection."""
|
|
915
702
|
|
|
916
|
-
def __init__(self):
|
|
703
|
+
def __init__(self) -> None:
|
|
917
704
|
"""Default constructor."""
|
|
918
705
|
|
|
919
706
|
def points_begin(self, t: float = 0.0) -> Interface0DIterator:
|
|
@@ -924,9 +711,7 @@ class Interface1D:
|
|
|
924
711
|
|
|
925
712
|
:param t: A sampling with which we want to iterate over points of
|
|
926
713
|
this 1D element.
|
|
927
|
-
:type t: float
|
|
928
714
|
:return: An Interface0DIterator pointing to the first point.
|
|
929
|
-
:rtype: Interface0DIterator
|
|
930
715
|
"""
|
|
931
716
|
|
|
932
717
|
def points_end(self, t: float = 0.0) -> Interface0DIterator:
|
|
@@ -937,9 +722,7 @@ class Interface1D:
|
|
|
937
722
|
|
|
938
723
|
:param t: A sampling with which we want to iterate over points of
|
|
939
724
|
this 1D element.
|
|
940
|
-
:type t: float
|
|
941
725
|
:return: An Interface0DIterator pointing after the last point.
|
|
942
|
-
:rtype: Interface0DIterator
|
|
943
726
|
"""
|
|
944
727
|
|
|
945
728
|
def vertices_begin(self) -> Interface0DIterator:
|
|
@@ -947,7 +730,6 @@ class Interface1D:
|
|
|
947
730
|
first vertex.
|
|
948
731
|
|
|
949
732
|
:return: An Interface0DIterator pointing to the first vertex.
|
|
950
|
-
:rtype: Interface0DIterator
|
|
951
733
|
"""
|
|
952
734
|
|
|
953
735
|
def vertices_end(self) -> Interface0DIterator:
|
|
@@ -955,96 +737,64 @@ class Interface1D:
|
|
|
955
737
|
the last vertex.
|
|
956
738
|
|
|
957
739
|
:return: An Interface0DIterator pointing after the last vertex.
|
|
958
|
-
:rtype: Interface0DIterator
|
|
959
740
|
"""
|
|
960
741
|
|
|
961
742
|
class Iterator:
|
|
962
743
|
"""Base class to define iterators."""
|
|
963
744
|
|
|
964
745
|
is_begin: bool
|
|
965
|
-
""" True if the iterator points to the first element.
|
|
966
|
-
|
|
967
|
-
:type: bool
|
|
968
|
-
"""
|
|
746
|
+
""" True if the iterator points to the first element."""
|
|
969
747
|
|
|
970
748
|
is_end: bool
|
|
971
|
-
""" True if the iterator points to the last element.
|
|
972
|
-
|
|
973
|
-
:type: bool
|
|
974
|
-
"""
|
|
749
|
+
""" True if the iterator points to the last element."""
|
|
975
750
|
|
|
976
751
|
name: str
|
|
977
|
-
""" The string of the name of this iterator.
|
|
978
|
-
|
|
979
|
-
:type: str
|
|
980
|
-
"""
|
|
752
|
+
""" The string of the name of this iterator."""
|
|
981
753
|
|
|
982
|
-
def __init__(self):
|
|
754
|
+
def __init__(self) -> None:
|
|
983
755
|
"""Default constructor."""
|
|
984
756
|
|
|
985
|
-
def decrement(self):
|
|
757
|
+
def decrement(self) -> None:
|
|
986
758
|
"""Makes the iterator point the previous element."""
|
|
987
759
|
|
|
988
|
-
def increment(self):
|
|
760
|
+
def increment(self) -> None:
|
|
989
761
|
"""Makes the iterator point the next element."""
|
|
990
762
|
|
|
991
763
|
class Material:
|
|
992
764
|
"""Class defining a material."""
|
|
993
765
|
|
|
994
766
|
ambient: mathutils.Color
|
|
995
|
-
""" RGBA components of the ambient color of the material.
|
|
996
|
-
|
|
997
|
-
:type: mathutils.Color
|
|
998
|
-
"""
|
|
767
|
+
""" RGBA components of the ambient color of the material."""
|
|
999
768
|
|
|
1000
769
|
diffuse: mathutils.Vector
|
|
1001
|
-
""" RGBA components of the diffuse color of the material.
|
|
1002
|
-
|
|
1003
|
-
:type: mathutils.Vector
|
|
1004
|
-
"""
|
|
770
|
+
""" RGBA components of the diffuse color of the material."""
|
|
1005
771
|
|
|
1006
772
|
emission: mathutils.Color
|
|
1007
|
-
""" RGBA components of the emissive color of the material.
|
|
1008
|
-
|
|
1009
|
-
:type: mathutils.Color
|
|
1010
|
-
"""
|
|
773
|
+
""" RGBA components of the emissive color of the material."""
|
|
1011
774
|
|
|
1012
775
|
line: mathutils.Vector
|
|
1013
|
-
""" RGBA components of the line color of the material.
|
|
1014
|
-
|
|
1015
|
-
:type: mathutils.Vector
|
|
1016
|
-
"""
|
|
776
|
+
""" RGBA components of the line color of the material."""
|
|
1017
777
|
|
|
1018
778
|
priority: int
|
|
1019
|
-
""" Line color priority of the material.
|
|
1020
|
-
|
|
1021
|
-
:type: int
|
|
1022
|
-
"""
|
|
779
|
+
""" Line color priority of the material."""
|
|
1023
780
|
|
|
1024
781
|
shininess: float
|
|
1025
|
-
""" Shininess coefficient of the material.
|
|
1026
|
-
|
|
1027
|
-
:type: float
|
|
1028
|
-
"""
|
|
782
|
+
""" Shininess coefficient of the material."""
|
|
1029
783
|
|
|
1030
784
|
specular: mathutils.Vector
|
|
1031
|
-
""" RGBA components of the specular color of the material.
|
|
785
|
+
""" RGBA components of the specular color of the material."""
|
|
1032
786
|
|
|
1033
|
-
:
|
|
1034
|
-
"""
|
|
1035
|
-
|
|
1036
|
-
def __init__(self):
|
|
787
|
+
def __init__(self) -> None:
|
|
1037
788
|
"""Creates a `FrsMaterial` using either default constructor,
|
|
1038
789
|
copy constructor, or an overloaded constructor
|
|
1039
790
|
|
|
1040
791
|
"""
|
|
1041
792
|
|
|
1042
|
-
def __init__(self, brother: typing_extensions.Self):
|
|
793
|
+
def __init__(self, brother: typing_extensions.Self) -> None:
|
|
1043
794
|
"""Creates a `FrsMaterial` using either default constructor,
|
|
1044
795
|
copy constructor, or an overloaded constructor
|
|
1045
796
|
|
|
1046
797
|
:param brother: A Material object to be used as a copy constructor.
|
|
1047
|
-
:type brother: typing_extensions.Self
|
|
1048
798
|
"""
|
|
1049
799
|
|
|
1050
800
|
def __init__(
|
|
@@ -1068,24 +818,17 @@ class Material:
|
|
|
1068
818
|
| tuple[float, float, float, float],
|
|
1069
819
|
shininess: float,
|
|
1070
820
|
priority: int,
|
|
1071
|
-
):
|
|
821
|
+
) -> None:
|
|
1072
822
|
"""Creates a `FrsMaterial` using either default constructor,
|
|
1073
823
|
copy constructor, or an overloaded constructor
|
|
1074
824
|
|
|
1075
825
|
:param line: The line color.
|
|
1076
|
-
:type line: collections.abc.Sequence[float] | list[float] | mathutils.Vector | tuple[float, float, float, float]
|
|
1077
826
|
:param diffuse: The diffuse color.
|
|
1078
|
-
:type diffuse: typing.Any
|
|
1079
827
|
:param ambient: The ambient color.
|
|
1080
|
-
:type ambient: collections.abc.Sequence[float] | list[float] | mathutils.Vector | tuple[float, float, float, float]
|
|
1081
828
|
:param specular: The specular color.
|
|
1082
|
-
:type specular: collections.abc.Sequence[float] | list[float] | mathutils.Vector | tuple[float, float, float, float]
|
|
1083
829
|
:param emission: The emissive color.
|
|
1084
|
-
:type emission: collections.abc.Sequence[float] | list[float] | mathutils.Vector | tuple[float, float, float, float]
|
|
1085
830
|
:param shininess: The shininess coefficient.
|
|
1086
|
-
:type shininess: float
|
|
1087
831
|
:param priority: The line color priority.
|
|
1088
|
-
:type priority: int
|
|
1089
832
|
"""
|
|
1090
833
|
|
|
1091
834
|
class MediumType:
|
|
@@ -1099,22 +842,19 @@ class Nature:
|
|
|
1099
842
|
class Noise:
|
|
1100
843
|
"""Class to provide Perlin noise functionalities.Undocumented, consider contributing.Undocumented, consider contributing."""
|
|
1101
844
|
|
|
1102
|
-
def __init__(self, seed: int = -1):
|
|
845
|
+
def __init__(self, seed: int = -1) -> None:
|
|
1103
846
|
"""Builds a Noise object. Seed is an optional argument. The seed value is used
|
|
1104
847
|
as a seed for random number generation if it is equal to or greater than zero;
|
|
1105
848
|
otherwise, time is used as a seed.
|
|
1106
849
|
|
|
1107
850
|
:param seed: Seed for random number generation.
|
|
1108
|
-
:type seed: int
|
|
1109
851
|
"""
|
|
1110
852
|
|
|
1111
853
|
def smoothNoise1(self, v: float) -> float:
|
|
1112
854
|
"""Returns a smooth noise value for a 1D element.
|
|
1113
855
|
|
|
1114
856
|
:param v: One-dimensional sample point.
|
|
1115
|
-
:type v: float
|
|
1116
857
|
:return: A smooth noise value.
|
|
1117
|
-
:rtype: float
|
|
1118
858
|
"""
|
|
1119
859
|
|
|
1120
860
|
def smoothNoise2(
|
|
@@ -1127,9 +867,7 @@ class Noise:
|
|
|
1127
867
|
"""Returns a smooth noise value for a 2D element.
|
|
1128
868
|
|
|
1129
869
|
:param v: Two-dimensional sample point.
|
|
1130
|
-
:type v: collections.abc.Sequence[float] | list[float] | mathutils.Vector | tuple[float, float]
|
|
1131
870
|
:return: A smooth noise value.
|
|
1132
|
-
:rtype: float
|
|
1133
871
|
"""
|
|
1134
872
|
|
|
1135
873
|
def smoothNoise3(
|
|
@@ -1142,24 +880,17 @@ class Noise:
|
|
|
1142
880
|
"""Returns a smooth noise value for a 3D element.
|
|
1143
881
|
|
|
1144
882
|
:param v: Three-dimensional sample point.
|
|
1145
|
-
:type v: collections.abc.Sequence[float] | list[float] | mathutils.Vector | tuple[float, float, float]
|
|
1146
883
|
:return: A smooth noise value.
|
|
1147
|
-
:rtype: float
|
|
1148
884
|
"""
|
|
1149
885
|
|
|
1150
886
|
def turbulence1(self, v: float, freq: float, amp: float, oct: int = 4) -> float:
|
|
1151
887
|
"""Returns a noise value for a 1D element.
|
|
1152
888
|
|
|
1153
889
|
:param v: One-dimensional sample point.
|
|
1154
|
-
:type v: float
|
|
1155
890
|
:param freq: Noise frequency.
|
|
1156
|
-
:type freq: float
|
|
1157
891
|
:param amp: Amplitude.
|
|
1158
|
-
:type amp: float
|
|
1159
892
|
:param oct: Number of octaves.
|
|
1160
|
-
:type oct: int
|
|
1161
893
|
:return: A noise value.
|
|
1162
|
-
:rtype: float
|
|
1163
894
|
"""
|
|
1164
895
|
|
|
1165
896
|
def turbulence2(
|
|
@@ -1175,15 +906,10 @@ class Noise:
|
|
|
1175
906
|
"""Returns a noise value for a 2D element.
|
|
1176
907
|
|
|
1177
908
|
:param v: Two-dimensional sample point.
|
|
1178
|
-
:type v: collections.abc.Sequence[float] | list[float] | mathutils.Vector | tuple[float, float]
|
|
1179
909
|
:param freq: Noise frequency.
|
|
1180
|
-
:type freq: float
|
|
1181
910
|
:param amp: Amplitude.
|
|
1182
|
-
:type amp: float
|
|
1183
911
|
:param oct: Number of octaves.
|
|
1184
|
-
:type oct: int
|
|
1185
912
|
:return: A noise value.
|
|
1186
|
-
:rtype: float
|
|
1187
913
|
"""
|
|
1188
914
|
|
|
1189
915
|
def turbulence3(
|
|
@@ -1199,15 +925,10 @@ class Noise:
|
|
|
1199
925
|
"""Returns a noise value for a 3D element.
|
|
1200
926
|
|
|
1201
927
|
:param v: Three-dimensional sample point.
|
|
1202
|
-
:type v: collections.abc.Sequence[float] | list[float] | mathutils.Vector | tuple[float, float, float]
|
|
1203
928
|
:param freq: Noise frequency.
|
|
1204
|
-
:type freq: float
|
|
1205
929
|
:param amp: Amplitude.
|
|
1206
|
-
:type amp: float
|
|
1207
930
|
:param oct: Number of octaves.
|
|
1208
|
-
:type oct: int
|
|
1209
931
|
:return: A noise value.
|
|
1210
|
-
:rtype: float
|
|
1211
932
|
"""
|
|
1212
933
|
|
|
1213
934
|
class NonTVertex:
|
|
@@ -1216,19 +937,15 @@ class NonTVertex:
|
|
|
1216
937
|
"""
|
|
1217
938
|
|
|
1218
939
|
svertex: SVertex
|
|
1219
|
-
""" The SVertex on top of which this NonTVertex is built.
|
|
1220
|
-
|
|
1221
|
-
:type: SVertex
|
|
1222
|
-
"""
|
|
940
|
+
""" The SVertex on top of which this NonTVertex is built."""
|
|
1223
941
|
|
|
1224
|
-
def __init__(self):
|
|
942
|
+
def __init__(self) -> None:
|
|
1225
943
|
"""Builds a `NonTVertex` using the default constructor or a `SVertex`."""
|
|
1226
944
|
|
|
1227
|
-
def __init__(self, svertex: SVertex):
|
|
945
|
+
def __init__(self, svertex: SVertex) -> None:
|
|
1228
946
|
"""Builds a `NonTVertex` using the default constructor or a `SVertex`.
|
|
1229
947
|
|
|
1230
948
|
:param svertex: An SVertex object.
|
|
1231
|
-
:type svertex: SVertex
|
|
1232
949
|
"""
|
|
1233
950
|
|
|
1234
951
|
class Operators:
|
|
@@ -1239,7 +956,7 @@ class Operators:
|
|
|
1239
956
|
"""
|
|
1240
957
|
|
|
1241
958
|
@staticmethod
|
|
1242
|
-
def bidirectional_chain(it: ChainingIterator, pred: UnaryPredicate1D):
|
|
959
|
+
def bidirectional_chain(it: ChainingIterator, pred: UnaryPredicate1D) -> None:
|
|
1243
960
|
"""Builds a set of chains from the current set of ViewEdges. Each
|
|
1244
961
|
ViewEdge of the current list potentially starts a new chain. The
|
|
1245
962
|
chaining operator then iterates over the ViewEdges of the ViewMap
|
|
@@ -1254,15 +971,13 @@ class Operators:
|
|
|
1254
971
|
|
|
1255
972
|
:param it: The ChainingIterator on the ViewEdges of the ViewMap. It
|
|
1256
973
|
contains the chaining rule.
|
|
1257
|
-
:type it: ChainingIterator
|
|
1258
974
|
:param pred: The predicate on the ViewEdge that expresses the stopping condition.
|
|
1259
975
|
This parameter is optional, you make not want to pass a stopping criterion
|
|
1260
976
|
when the stopping criterion is already contained in the iterator definition.
|
|
1261
|
-
:type pred: UnaryPredicate1D
|
|
1262
977
|
"""
|
|
1263
978
|
|
|
1264
979
|
@staticmethod
|
|
1265
|
-
def bidirectional_chain(it: ChainingIterator):
|
|
980
|
+
def bidirectional_chain(it: ChainingIterator) -> None:
|
|
1266
981
|
"""Builds a set of chains from the current set of ViewEdges. Each
|
|
1267
982
|
ViewEdge of the current list potentially starts a new chain. The
|
|
1268
983
|
chaining operator then iterates over the ViewEdges of the ViewMap
|
|
@@ -1277,13 +992,12 @@ class Operators:
|
|
|
1277
992
|
|
|
1278
993
|
:param it: The ChainingIterator on the ViewEdges of the ViewMap. It
|
|
1279
994
|
contains the chaining rule.
|
|
1280
|
-
:type it: ChainingIterator
|
|
1281
995
|
"""
|
|
1282
996
|
|
|
1283
997
|
@staticmethod
|
|
1284
998
|
def chain(
|
|
1285
999
|
it: ViewEdgeIterator, pred: UnaryPredicate1D, modifier: UnaryFunction1DVoid
|
|
1286
|
-
):
|
|
1000
|
+
) -> None:
|
|
1287
1001
|
"""Builds a set of chains from the current set of ViewEdges. Each
|
|
1288
1002
|
ViewEdge of the current list starts a new chain. The chaining
|
|
1289
1003
|
operator then iterates over the ViewEdges of the ViewMap using the
|
|
@@ -1292,19 +1006,16 @@ class Operators:
|
|
|
1292
1006
|
|
|
1293
1007
|
:param it: The iterator on the ViewEdges of the ViewMap. It contains
|
|
1294
1008
|
the chaining rule.
|
|
1295
|
-
:type it: ViewEdgeIterator
|
|
1296
1009
|
:param pred: The predicate on the ViewEdge that expresses the
|
|
1297
1010
|
stopping condition.
|
|
1298
|
-
:type pred: UnaryPredicate1D
|
|
1299
1011
|
:param modifier: A function that takes a ViewEdge as argument and
|
|
1300
1012
|
that is used to modify the processed ViewEdge state (the
|
|
1301
1013
|
timestamp incrementation is a typical illustration of such a modifier).
|
|
1302
1014
|
If this argument is not given, the time stamp is automatically managed.
|
|
1303
|
-
:type modifier: UnaryFunction1DVoid
|
|
1304
1015
|
"""
|
|
1305
1016
|
|
|
1306
1017
|
@staticmethod
|
|
1307
|
-
def chain(it: ViewEdgeIterator, pred: UnaryPredicate1D):
|
|
1018
|
+
def chain(it: ViewEdgeIterator, pred: UnaryPredicate1D) -> None:
|
|
1308
1019
|
"""Builds a set of chains from the current set of ViewEdges. Each
|
|
1309
1020
|
ViewEdge of the current list starts a new chain. The chaining
|
|
1310
1021
|
operator then iterates over the ViewEdges of the ViewMap using the
|
|
@@ -1313,22 +1024,18 @@ class Operators:
|
|
|
1313
1024
|
|
|
1314
1025
|
:param it: The iterator on the ViewEdges of the ViewMap. It contains
|
|
1315
1026
|
the chaining rule.
|
|
1316
|
-
:type it: ViewEdgeIterator
|
|
1317
1027
|
:param pred: The predicate on the ViewEdge that expresses the
|
|
1318
1028
|
stopping condition.
|
|
1319
|
-
:type pred: UnaryPredicate1D
|
|
1320
1029
|
"""
|
|
1321
1030
|
|
|
1322
1031
|
@staticmethod
|
|
1323
|
-
def create(pred: UnaryPredicate1D, shaders: list[StrokeShader]):
|
|
1032
|
+
def create(pred: UnaryPredicate1D, shaders: list[StrokeShader]) -> None:
|
|
1324
1033
|
"""Creates and shades the strokes from the current set of chains. A
|
|
1325
1034
|
predicate can be specified to make a selection pass on the chains.
|
|
1326
1035
|
|
|
1327
1036
|
:param pred: The predicate that a chain must verify in order to be
|
|
1328
1037
|
transform as a stroke.
|
|
1329
|
-
:type pred: UnaryPredicate1D
|
|
1330
1038
|
:param shaders: The list of shaders used to shade the strokes.
|
|
1331
|
-
:type shaders: list[StrokeShader]
|
|
1332
1039
|
"""
|
|
1333
1040
|
|
|
1334
1041
|
@staticmethod
|
|
@@ -1336,9 +1043,7 @@ class Operators:
|
|
|
1336
1043
|
"""Returns the Chain at the index in the current set of Chains.
|
|
1337
1044
|
|
|
1338
1045
|
:param i: index (0 <= i < Operators.get_chains_size()).
|
|
1339
|
-
:type i: int
|
|
1340
1046
|
:return: The Chain object.
|
|
1341
|
-
:rtype: Chain
|
|
1342
1047
|
"""
|
|
1343
1048
|
|
|
1344
1049
|
@staticmethod
|
|
@@ -1346,7 +1051,6 @@ class Operators:
|
|
|
1346
1051
|
"""Returns the number of Chains.
|
|
1347
1052
|
|
|
1348
1053
|
:return: The number of Chains.
|
|
1349
|
-
:rtype: int
|
|
1350
1054
|
"""
|
|
1351
1055
|
|
|
1352
1056
|
@staticmethod
|
|
@@ -1354,9 +1058,7 @@ class Operators:
|
|
|
1354
1058
|
"""Returns the Stroke at the index in the current set of Strokes.
|
|
1355
1059
|
|
|
1356
1060
|
:param i: index (0 <= i < Operators.get_strokes_size()).
|
|
1357
|
-
:type i: int
|
|
1358
1061
|
:return: The Stroke object.
|
|
1359
|
-
:rtype: Stroke
|
|
1360
1062
|
"""
|
|
1361
1063
|
|
|
1362
1064
|
@staticmethod
|
|
@@ -1364,7 +1066,6 @@ class Operators:
|
|
|
1364
1066
|
"""Returns the number of Strokes.
|
|
1365
1067
|
|
|
1366
1068
|
:return: The number of Strokes.
|
|
1367
|
-
:rtype: int
|
|
1368
1069
|
"""
|
|
1369
1070
|
|
|
1370
1071
|
@staticmethod
|
|
@@ -1372,7 +1073,6 @@ class Operators:
|
|
|
1372
1073
|
"""Returns the number of ViewEdges.
|
|
1373
1074
|
|
|
1374
1075
|
:return: The number of ViewEdges.
|
|
1375
|
-
:rtype: int
|
|
1376
1076
|
"""
|
|
1377
1077
|
|
|
1378
1078
|
@staticmethod
|
|
@@ -1380,37 +1080,32 @@ class Operators:
|
|
|
1380
1080
|
"""Returns the ViewEdge at the index in the current set of ViewEdges.
|
|
1381
1081
|
|
|
1382
1082
|
:param i: index (0 <= i < Operators.get_view_edges_size()).
|
|
1383
|
-
:type i: int
|
|
1384
1083
|
:return: The ViewEdge object.
|
|
1385
|
-
:rtype: ViewEdge
|
|
1386
1084
|
"""
|
|
1387
1085
|
|
|
1388
1086
|
@staticmethod
|
|
1389
1087
|
def recursive_split(
|
|
1390
1088
|
func: UnaryFunction0DDouble, pred_1d: UnaryPredicate1D, sampling: float = 0.0
|
|
1391
|
-
):
|
|
1089
|
+
) -> None:
|
|
1392
1090
|
"""Splits the current set of chains in a recursive way. We process the
|
|
1393
1091
|
points of each chain (with a specified sampling) to find the point
|
|
1394
1092
|
minimizing a specified function. The chain is split in two at this
|
|
1395
1093
|
point and the two new chains are processed in the same way. The
|
|
1396
1094
|
recursivity level is controlled through a predicate 1D that expresses
|
|
1397
1095
|
a stopping condition on the chain that is about to be processed.The user can also specify a 0D predicate to make a first selection on the points
|
|
1398
|
-
that can potentially be split. A point that
|
|
1399
|
-
predicate
|
|
1096
|
+
that can potentially be split. A point that doesnt verify the 0D
|
|
1097
|
+
predicate wont be candidate in realizing the min.
|
|
1400
1098
|
|
|
1401
1099
|
:param func: The Unary Function evaluated at each point of the chain.
|
|
1402
1100
|
The splitting point is the point minimizing this function.
|
|
1403
|
-
:type func: UnaryFunction0DDouble
|
|
1404
1101
|
:param pred_1d: The Unary Predicate expressing the recursivity stopping
|
|
1405
1102
|
condition. This predicate is evaluated for each curve before it
|
|
1406
|
-
actually gets split. If pred_1d(chain) is true, the curve
|
|
1103
|
+
actually gets split. If pred_1d(chain) is true, the curve wont be
|
|
1407
1104
|
split anymore.
|
|
1408
|
-
:type pred_1d: UnaryPredicate1D
|
|
1409
1105
|
:param sampling: The resolution used to sample the chain for the
|
|
1410
1106
|
predicates evaluation. (The chain is not actually resampled; a
|
|
1411
1107
|
virtual point only progresses along the curve using this
|
|
1412
1108
|
resolution.)
|
|
1413
|
-
:type sampling: float
|
|
1414
1109
|
"""
|
|
1415
1110
|
|
|
1416
1111
|
@staticmethod
|
|
@@ -1419,53 +1114,47 @@ class Operators:
|
|
|
1419
1114
|
pred_0d: UnaryPredicate0D,
|
|
1420
1115
|
pred_1d: UnaryPredicate1D,
|
|
1421
1116
|
sampling: float = 0.0,
|
|
1422
|
-
):
|
|
1117
|
+
) -> None:
|
|
1423
1118
|
"""Splits the current set of chains in a recursive way. We process the
|
|
1424
1119
|
points of each chain (with a specified sampling) to find the point
|
|
1425
1120
|
minimizing a specified function. The chain is split in two at this
|
|
1426
1121
|
point and the two new chains are processed in the same way. The
|
|
1427
1122
|
recursivity level is controlled through a predicate 1D that expresses
|
|
1428
1123
|
a stopping condition on the chain that is about to be processed.The user can also specify a 0D predicate to make a first selection on the points
|
|
1429
|
-
that can potentially be split. A point that
|
|
1430
|
-
predicate
|
|
1124
|
+
that can potentially be split. A point that doesnt verify the 0D
|
|
1125
|
+
predicate wont be candidate in realizing the min.
|
|
1431
1126
|
|
|
1432
1127
|
:param func: The Unary Function evaluated at each point of the chain.
|
|
1433
1128
|
The splitting point is the point minimizing this function.
|
|
1434
|
-
:type func: UnaryFunction0DDouble
|
|
1435
1129
|
:param pred_0d: The Unary Predicate 0D used to select the candidate
|
|
1436
1130
|
points where the split can occur. For example, it is very likely
|
|
1437
1131
|
that would rather have your chain splitting around its middle
|
|
1438
1132
|
point than around one of its extremities. A 0D predicate working
|
|
1439
1133
|
on the curvilinear abscissa allows to add this kind of constraints.
|
|
1440
|
-
:type pred_0d: UnaryPredicate0D
|
|
1441
1134
|
:param pred_1d: The Unary Predicate expressing the recursivity stopping
|
|
1442
1135
|
condition. This predicate is evaluated for each curve before it
|
|
1443
|
-
actually gets split. If pred_1d(chain) is true, the curve
|
|
1136
|
+
actually gets split. If pred_1d(chain) is true, the curve wont be
|
|
1444
1137
|
split anymore.
|
|
1445
|
-
:type pred_1d: UnaryPredicate1D
|
|
1446
1138
|
:param sampling: The resolution used to sample the chain for the
|
|
1447
1139
|
predicates evaluation. (The chain is not actually resampled; a
|
|
1448
1140
|
virtual point only progresses along the curve using this
|
|
1449
1141
|
resolution.)
|
|
1450
|
-
:type sampling: float
|
|
1451
1142
|
"""
|
|
1452
1143
|
|
|
1453
1144
|
@staticmethod
|
|
1454
|
-
def reset(delete_strokes: bool = True):
|
|
1145
|
+
def reset(delete_strokes: bool = True) -> None:
|
|
1455
1146
|
"""Resets the line stylization process to the initial state. The results of
|
|
1456
1147
|
stroke creation are accumulated if delete_strokes is set to False.
|
|
1457
1148
|
|
|
1458
1149
|
:param delete_strokes: Delete the strokes that are currently stored.
|
|
1459
|
-
:type delete_strokes: bool
|
|
1460
1150
|
"""
|
|
1461
1151
|
|
|
1462
1152
|
@staticmethod
|
|
1463
|
-
def select(pred: UnaryPredicate1D):
|
|
1153
|
+
def select(pred: UnaryPredicate1D) -> None:
|
|
1464
1154
|
"""Selects the ViewEdges of the ViewMap verifying a specified
|
|
1465
1155
|
condition.
|
|
1466
1156
|
|
|
1467
1157
|
:param pred: The predicate expressing this condition.
|
|
1468
|
-
:type pred: UnaryPredicate1D
|
|
1469
1158
|
"""
|
|
1470
1159
|
|
|
1471
1160
|
@staticmethod
|
|
@@ -1473,7 +1162,7 @@ class Operators:
|
|
|
1473
1162
|
starting_pred: UnaryPredicate0D,
|
|
1474
1163
|
stopping_pred: UnaryPredicate0D,
|
|
1475
1164
|
sampling: float = 0.0,
|
|
1476
|
-
):
|
|
1165
|
+
) -> None:
|
|
1477
1166
|
"""Splits each chain of the current set of chains in a sequential way.
|
|
1478
1167
|
The points of each chain are processed (with a specified sampling)
|
|
1479
1168
|
sequentially. The first point of the initial chain is the
|
|
@@ -1482,19 +1171,16 @@ class Operators:
|
|
|
1482
1171
|
|
|
1483
1172
|
:param starting_pred: The predicate on a point that expresses the
|
|
1484
1173
|
starting condition. Each time this condition is verified, a new chain begins
|
|
1485
|
-
:type starting_pred: UnaryPredicate0D
|
|
1486
1174
|
:param stopping_pred: The predicate on a point that expresses the
|
|
1487
1175
|
stopping condition. The chain ends as soon as this predicate is verified.
|
|
1488
|
-
:type stopping_pred: UnaryPredicate0D
|
|
1489
1176
|
:param sampling: The resolution used to sample the chain for the
|
|
1490
1177
|
predicates evaluation. (The chain is not actually resampled;
|
|
1491
1178
|
a virtual point only progresses along the curve using this
|
|
1492
1179
|
resolution.)
|
|
1493
|
-
:type sampling: float
|
|
1494
1180
|
"""
|
|
1495
1181
|
|
|
1496
1182
|
@staticmethod
|
|
1497
|
-
def sequential_split(pred: UnaryPredicate0D, sampling: float = 0.0):
|
|
1183
|
+
def sequential_split(pred: UnaryPredicate0D, sampling: float = 0.0) -> None:
|
|
1498
1184
|
"""Splits each chain of the current set of chains in a sequential way.
|
|
1499
1185
|
The points of each chain are processed (with a specified sampling)
|
|
1500
1186
|
sequentially. The first point of the initial chain is the
|
|
@@ -1504,21 +1190,18 @@ class Operators:
|
|
|
1504
1190
|
:param pred: The predicate on a point that expresses the splitting condition.
|
|
1505
1191
|
Each time the condition is verified, the chain is split into two chains.
|
|
1506
1192
|
The resulting set of chains is a partition of the initial chain
|
|
1507
|
-
:type pred: UnaryPredicate0D
|
|
1508
1193
|
:param sampling: The resolution used to sample the chain for the
|
|
1509
1194
|
predicates evaluation. (The chain is not actually resampled;
|
|
1510
1195
|
a virtual point only progresses along the curve using this
|
|
1511
1196
|
resolution.)
|
|
1512
|
-
:type sampling: float
|
|
1513
1197
|
"""
|
|
1514
1198
|
|
|
1515
1199
|
@staticmethod
|
|
1516
|
-
def sort(pred: BinaryPredicate1D):
|
|
1200
|
+
def sort(pred: BinaryPredicate1D) -> None:
|
|
1517
1201
|
"""Sorts the current set of chains (or viewedges) according to the
|
|
1518
1202
|
comparison predicate given as argument.
|
|
1519
1203
|
|
|
1520
1204
|
:param pred: The binary predicate used for the comparison.
|
|
1521
|
-
:type pred: BinaryPredicate1D
|
|
1522
1205
|
"""
|
|
1523
1206
|
|
|
1524
1207
|
class SShape:
|
|
@@ -1527,61 +1210,43 @@ class SShape:
|
|
|
1527
1210
|
"""
|
|
1528
1211
|
|
|
1529
1212
|
bbox: BBox
|
|
1530
|
-
""" The bounding box of the SShape.
|
|
1531
|
-
|
|
1532
|
-
:type: BBox
|
|
1533
|
-
"""
|
|
1213
|
+
""" The bounding box of the SShape."""
|
|
1534
1214
|
|
|
1535
1215
|
edges: list[FEdge]
|
|
1536
|
-
""" The list of edges constituting this SShape.
|
|
1537
|
-
|
|
1538
|
-
:type: list[FEdge]
|
|
1539
|
-
"""
|
|
1216
|
+
""" The list of edges constituting this SShape."""
|
|
1540
1217
|
|
|
1541
1218
|
id: Id
|
|
1542
|
-
""" The Id of this SShape.
|
|
1543
|
-
|
|
1544
|
-
:type: Id
|
|
1545
|
-
"""
|
|
1219
|
+
""" The Id of this SShape."""
|
|
1546
1220
|
|
|
1547
1221
|
name: str
|
|
1548
|
-
""" The name of the SShape.
|
|
1549
|
-
|
|
1550
|
-
:type: str
|
|
1551
|
-
"""
|
|
1222
|
+
""" The name of the SShape."""
|
|
1552
1223
|
|
|
1553
1224
|
vertices: list[SVertex]
|
|
1554
|
-
""" The list of vertices constituting this SShape.
|
|
1555
|
-
|
|
1556
|
-
:type: list[SVertex]
|
|
1557
|
-
"""
|
|
1225
|
+
""" The list of vertices constituting this SShape."""
|
|
1558
1226
|
|
|
1559
|
-
def __init__(self):
|
|
1227
|
+
def __init__(self) -> None:
|
|
1560
1228
|
"""Creates a `SShape` class using either a default constructor or copy constructor."""
|
|
1561
1229
|
|
|
1562
|
-
def __init__(self, brother: typing_extensions.Self):
|
|
1230
|
+
def __init__(self, brother: typing_extensions.Self) -> None:
|
|
1563
1231
|
"""Creates a `SShape` class using either a default constructor or copy constructor.
|
|
1564
1232
|
|
|
1565
1233
|
:param brother: An SShape object.
|
|
1566
|
-
:type brother: typing_extensions.Self
|
|
1567
1234
|
"""
|
|
1568
1235
|
|
|
1569
|
-
def add_edge(self, edge: FEdge):
|
|
1236
|
+
def add_edge(self, edge: FEdge) -> None:
|
|
1570
1237
|
"""Adds an FEdge to the list of FEdges.
|
|
1571
1238
|
|
|
1572
1239
|
:param edge: An FEdge object.
|
|
1573
|
-
:type edge: FEdge
|
|
1574
1240
|
"""
|
|
1575
1241
|
|
|
1576
|
-
def add_vertex(self, vertex: SVertex):
|
|
1242
|
+
def add_vertex(self, vertex: SVertex) -> None:
|
|
1577
1243
|
"""Adds an SVertex to the list of SVertex of this Shape. The SShape
|
|
1578
1244
|
attribute of the SVertex is also set to this SShape.
|
|
1579
1245
|
|
|
1580
1246
|
:param vertex: An SVertex object.
|
|
1581
|
-
:type vertex: SVertex
|
|
1582
1247
|
"""
|
|
1583
1248
|
|
|
1584
|
-
def compute_bbox(self):
|
|
1249
|
+
def compute_bbox(self) -> None:
|
|
1585
1250
|
"""Compute the bbox of the SShape."""
|
|
1586
1251
|
|
|
1587
1252
|
class SVertex:
|
|
@@ -1596,81 +1261,56 @@ three-dimensional vectors representing the first and second principal
|
|
|
1596
1261
|
directions, i.e. the directions of the normal plane where the
|
|
1597
1262
|
curvature takes its maximum and minimum values, respectively; and Kr,
|
|
1598
1263
|
er and dKr are the radial curvature, radial direction, and the
|
|
1599
|
-
derivative of the radial curvature at this SVertex, respectively.
|
|
1600
|
-
|
|
1601
|
-
:type: tuple
|
|
1602
|
-
"""
|
|
1264
|
+
derivative of the radial curvature at this SVertex, respectively."""
|
|
1603
1265
|
|
|
1604
1266
|
id: Id
|
|
1605
|
-
""" The Id of this SVertex.
|
|
1606
|
-
|
|
1607
|
-
:type: Id
|
|
1608
|
-
"""
|
|
1267
|
+
""" The Id of this SVertex."""
|
|
1609
1268
|
|
|
1610
1269
|
normals: list[mathutils.Vector]
|
|
1611
1270
|
""" The normals for this Vertex as a list. In a sharp surface, an SVertex
|
|
1612
1271
|
has exactly one normal. In a smooth surface, an SVertex can have any
|
|
1613
|
-
number of normals.
|
|
1614
|
-
|
|
1615
|
-
:type: list[mathutils.Vector]
|
|
1616
|
-
"""
|
|
1272
|
+
number of normals."""
|
|
1617
1273
|
|
|
1618
1274
|
normals_size: int
|
|
1619
|
-
""" The number of different normals for this SVertex.
|
|
1620
|
-
|
|
1621
|
-
:type: int
|
|
1622
|
-
"""
|
|
1275
|
+
""" The number of different normals for this SVertex."""
|
|
1623
1276
|
|
|
1624
1277
|
point_2d: mathutils.Vector
|
|
1625
|
-
""" The projected 3D coordinates of the SVertex.
|
|
1626
|
-
|
|
1627
|
-
:type: mathutils.Vector
|
|
1628
|
-
"""
|
|
1278
|
+
""" The projected 3D coordinates of the SVertex."""
|
|
1629
1279
|
|
|
1630
1280
|
point_3d: mathutils.Vector
|
|
1631
|
-
""" The 3D coordinates of the SVertex.
|
|
1632
|
-
|
|
1633
|
-
:type: mathutils.Vector
|
|
1634
|
-
"""
|
|
1281
|
+
""" The 3D coordinates of the SVertex."""
|
|
1635
1282
|
|
|
1636
1283
|
viewvertex: ViewVertex
|
|
1637
1284
|
""" If this SVertex is also a ViewVertex, this property refers to the
|
|
1638
|
-
ViewVertex, and None otherwise.
|
|
1639
|
-
|
|
1640
|
-
:type: ViewVertex
|
|
1641
|
-
"""
|
|
1285
|
+
ViewVertex, and None otherwise."""
|
|
1642
1286
|
|
|
1643
|
-
def __init__(self):
|
|
1287
|
+
def __init__(self) -> None:
|
|
1644
1288
|
"""Builds a `SVertex` using the default constructor,
|
|
1645
1289
|
copy constructor or the overloaded constructor which builds a `SVertex` from 3D coordinates and an Id.
|
|
1646
1290
|
|
|
1647
1291
|
"""
|
|
1648
1292
|
|
|
1649
|
-
def __init__(self, brother: typing_extensions.Self):
|
|
1293
|
+
def __init__(self, brother: typing_extensions.Self) -> None:
|
|
1650
1294
|
"""Builds a `SVertex` using the default constructor,
|
|
1651
1295
|
copy constructor or the overloaded constructor which builds a `SVertex` from 3D coordinates and an Id.
|
|
1652
1296
|
|
|
1653
1297
|
:param brother: A SVertex object.
|
|
1654
|
-
:type brother: typing_extensions.Self
|
|
1655
1298
|
"""
|
|
1656
1299
|
|
|
1657
1300
|
def __init__(
|
|
1658
1301
|
self, point_3d: collections.abc.Sequence[float] | mathutils.Vector, id: Id
|
|
1659
|
-
):
|
|
1302
|
+
) -> None:
|
|
1660
1303
|
"""Builds a `SVertex` using the default constructor,
|
|
1661
1304
|
copy constructor or the overloaded constructor which builds a `SVertex` from 3D coordinates and an Id.
|
|
1662
1305
|
|
|
1663
1306
|
:param point_3d: A three-dimensional vector.
|
|
1664
|
-
:type point_3d: collections.abc.Sequence[float] | mathutils.Vector
|
|
1665
1307
|
:param id: An Id object.
|
|
1666
|
-
:type id: Id
|
|
1667
1308
|
"""
|
|
1668
1309
|
|
|
1669
|
-
def add_fedge(self, fedge: FEdge):
|
|
1310
|
+
def add_fedge(self, fedge: FEdge) -> None:
|
|
1670
1311
|
"""Add an FEdge to the list of edges emanating from this SVertex.
|
|
1671
1312
|
|
|
1672
1313
|
:param fedge: An FEdge.
|
|
1673
|
-
:type fedge: FEdge
|
|
1674
1314
|
"""
|
|
1675
1315
|
|
|
1676
1316
|
def add_normal(
|
|
@@ -1679,12 +1319,11 @@ ViewVertex, and None otherwise.
|
|
|
1679
1319
|
| list[float]
|
|
1680
1320
|
| mathutils.Vector
|
|
1681
1321
|
| tuple[float, float, float],
|
|
1682
|
-
):
|
|
1683
|
-
"""Adds a normal to the
|
|
1322
|
+
) -> None:
|
|
1323
|
+
"""Adds a normal to the SVertexs set of normals. If the same normal
|
|
1684
1324
|
is already in the set, nothing changes.
|
|
1685
1325
|
|
|
1686
1326
|
:param normal: A three-dimensional vector.
|
|
1687
|
-
:type normal: collections.abc.Sequence[float] | list[float] | mathutils.Vector | tuple[float, float, float]
|
|
1688
1327
|
"""
|
|
1689
1328
|
|
|
1690
1329
|
class SVertexIterator:
|
|
@@ -1694,31 +1333,21 @@ class SVertexIterator:
|
|
|
1694
1333
|
"""
|
|
1695
1334
|
|
|
1696
1335
|
object: SVertex
|
|
1697
|
-
""" The SVertex object currently pointed by this iterator.
|
|
1698
|
-
|
|
1699
|
-
:type: SVertex
|
|
1700
|
-
"""
|
|
1336
|
+
""" The SVertex object currently pointed by this iterator."""
|
|
1701
1337
|
|
|
1702
1338
|
t: float
|
|
1703
|
-
""" The curvilinear abscissa of the current point.
|
|
1704
|
-
|
|
1705
|
-
:type: float
|
|
1706
|
-
"""
|
|
1339
|
+
""" The curvilinear abscissa of the current point."""
|
|
1707
1340
|
|
|
1708
1341
|
u: float
|
|
1709
|
-
""" The point parameter at the current point in the 1D element (0 <= u <= 1).
|
|
1342
|
+
""" The point parameter at the current point in the 1D element (0 <= u <= 1)."""
|
|
1710
1343
|
|
|
1711
|
-
:
|
|
1712
|
-
"""
|
|
1713
|
-
|
|
1714
|
-
def __init__(self):
|
|
1344
|
+
def __init__(self) -> None:
|
|
1715
1345
|
"""Build an SVertexIterator using either the default constructor, copy constructor,or the overloaded constructor that starts iteration from an SVertex object vertex."""
|
|
1716
1346
|
|
|
1717
|
-
def __init__(self, brother: typing_extensions.Self):
|
|
1347
|
+
def __init__(self, brother: typing_extensions.Self) -> None:
|
|
1718
1348
|
"""Build an SVertexIterator using either the default constructor, copy constructor,or the overloaded constructor that starts iteration from an SVertex object vertex.
|
|
1719
1349
|
|
|
1720
1350
|
:param brother: An SVertexIterator object.
|
|
1721
|
-
:type brother: typing_extensions.Self
|
|
1722
1351
|
"""
|
|
1723
1352
|
|
|
1724
1353
|
def __init__(
|
|
@@ -1728,62 +1357,42 @@ class SVertexIterator:
|
|
|
1728
1357
|
previous_edge: FEdge,
|
|
1729
1358
|
next_edge: FEdge,
|
|
1730
1359
|
t: float,
|
|
1731
|
-
):
|
|
1360
|
+
) -> None:
|
|
1732
1361
|
"""Build an SVertexIterator using either the default constructor, copy constructor,or the overloaded constructor that starts iteration from an SVertex object vertex.
|
|
1733
1362
|
|
|
1734
1363
|
:param vertex: The SVertex from which the iterator starts iteration.
|
|
1735
|
-
:type vertex: SVertex
|
|
1736
1364
|
:param begin: The first SVertex of a ViewEdge.
|
|
1737
|
-
:type begin: SVertex
|
|
1738
1365
|
:param previous_edge: The previous FEdge coming to vertex.
|
|
1739
|
-
:type previous_edge: FEdge
|
|
1740
1366
|
:param next_edge: The next FEdge going out from vertex.
|
|
1741
|
-
:type next_edge: FEdge
|
|
1742
1367
|
:param t: The curvilinear abscissa at vertex.
|
|
1743
|
-
:type t: float
|
|
1744
1368
|
"""
|
|
1745
1369
|
|
|
1746
1370
|
class Stroke:
|
|
1747
1371
|
"""Class hierarchy: `Interface1D` > `Stroke`Class to define a stroke. A stroke is made of a set of 2D vertices
|
|
1748
1372
|
(`StrokeVertex`), regularly spaced out. This set of vertices
|
|
1749
|
-
defines the
|
|
1750
|
-
defines the
|
|
1373
|
+
defines the strokes backbone geometry. Each of these stroke vertices
|
|
1374
|
+
defines the strokes shape and appearance at this vertex position.
|
|
1751
1375
|
"""
|
|
1752
1376
|
|
|
1753
1377
|
id: Id
|
|
1754
|
-
""" The Id of this Stroke.
|
|
1755
|
-
|
|
1756
|
-
:type: Id
|
|
1757
|
-
"""
|
|
1378
|
+
""" The Id of this Stroke."""
|
|
1758
1379
|
|
|
1759
1380
|
length_2d: float
|
|
1760
|
-
""" The 2D length of the Stroke.
|
|
1761
|
-
|
|
1762
|
-
:type: float
|
|
1763
|
-
"""
|
|
1381
|
+
""" The 2D length of the Stroke."""
|
|
1764
1382
|
|
|
1765
1383
|
medium_type: MediumType
|
|
1766
|
-
""" The MediumType used for this Stroke.
|
|
1767
|
-
|
|
1768
|
-
:type: MediumType
|
|
1769
|
-
"""
|
|
1384
|
+
""" The MediumType used for this Stroke."""
|
|
1770
1385
|
|
|
1771
1386
|
texture_id: int
|
|
1772
|
-
""" The ID of the texture used to simulate th marks system for this Stroke.
|
|
1773
|
-
|
|
1774
|
-
:type: int
|
|
1775
|
-
"""
|
|
1387
|
+
""" The ID of the texture used to simulate th marks system for this Stroke."""
|
|
1776
1388
|
|
|
1777
1389
|
tips: bool
|
|
1778
|
-
""" True if this Stroke uses a texture with tips, and false otherwise.
|
|
1779
|
-
|
|
1780
|
-
:type: bool
|
|
1781
|
-
"""
|
|
1390
|
+
""" True if this Stroke uses a texture with tips, and false otherwise."""
|
|
1782
1391
|
|
|
1783
|
-
def Stroke(self):
|
|
1392
|
+
def Stroke(self) -> None:
|
|
1784
1393
|
"""Creates a `Stroke` using the default constructor or copy constructor"""
|
|
1785
1394
|
|
|
1786
|
-
def Stroke(self, brother):
|
|
1395
|
+
def Stroke(self, brother) -> None:
|
|
1787
1396
|
"""Creates a `Stroke` using the default constructor or copy constructor
|
|
1788
1397
|
|
|
1789
1398
|
:param brother:
|
|
@@ -1797,36 +1406,31 @@ class Stroke:
|
|
|
1797
1406
|
|
|
1798
1407
|
:param n: The number of stroke vertices we eventually want
|
|
1799
1408
|
in our Stroke.
|
|
1800
|
-
:type n: int
|
|
1801
1409
|
:return: The sampling that must be used in the Resample(float)
|
|
1802
1410
|
method.
|
|
1803
|
-
:rtype: float
|
|
1804
1411
|
"""
|
|
1805
1412
|
|
|
1806
|
-
def insert_vertex(self, vertex: StrokeVertex, next: StrokeVertexIterator):
|
|
1413
|
+
def insert_vertex(self, vertex: StrokeVertex, next: StrokeVertexIterator) -> None:
|
|
1807
1414
|
"""Inserts the StrokeVertex given as argument into the Stroke before the
|
|
1808
1415
|
point specified by next. The length and curvilinear abscissa are
|
|
1809
1416
|
updated consequently.
|
|
1810
1417
|
|
|
1811
1418
|
:param vertex: The StrokeVertex to insert in the Stroke.
|
|
1812
|
-
:type vertex: StrokeVertex
|
|
1813
1419
|
:param next: A StrokeVertexIterator pointing to the StrokeVertex
|
|
1814
1420
|
before which vertex must be inserted.
|
|
1815
|
-
:type next: StrokeVertexIterator
|
|
1816
1421
|
"""
|
|
1817
1422
|
|
|
1818
|
-
def remove_all_vertices(self):
|
|
1423
|
+
def remove_all_vertices(self) -> None:
|
|
1819
1424
|
"""Removes all vertices from the Stroke."""
|
|
1820
1425
|
|
|
1821
|
-
def remove_vertex(self, vertex: StrokeVertex):
|
|
1426
|
+
def remove_vertex(self, vertex: StrokeVertex) -> None:
|
|
1822
1427
|
"""Removes the StrokeVertex given as argument from the Stroke. The length
|
|
1823
1428
|
and curvilinear abscissa are updated consequently.
|
|
1824
1429
|
|
|
1825
1430
|
:param vertex: the StrokeVertex to remove from the Stroke.
|
|
1826
|
-
:type vertex: StrokeVertex
|
|
1827
1431
|
"""
|
|
1828
1432
|
|
|
1829
|
-
def resample(self, n: int):
|
|
1433
|
+
def resample(self, n: int) -> None:
|
|
1830
1434
|
"""Resamples the stroke so using one of two methods with the goal
|
|
1831
1435
|
of creating a stroke with fewer points and the same shape.
|
|
1832
1436
|
|
|
@@ -1834,16 +1438,14 @@ class Stroke:
|
|
|
1834
1438
|
it is going to add N-vertices_size, where vertices_size is the
|
|
1835
1439
|
number of points we already have. If vertices_size >= N, no
|
|
1836
1440
|
resampling is done.
|
|
1837
|
-
:type n: int
|
|
1838
1441
|
"""
|
|
1839
1442
|
|
|
1840
|
-
def resample(self, sampling: float):
|
|
1443
|
+
def resample(self, sampling: float) -> None:
|
|
1841
1444
|
"""Resamples the stroke so using one of two methods with the goal
|
|
1842
1445
|
of creating a stroke with fewer points and the same shape.
|
|
1843
1446
|
|
|
1844
1447
|
:param sampling: Resamples the stroke with a given sampling value. If the
|
|
1845
1448
|
sampling is smaller than the actual sampling value, no resampling is done.
|
|
1846
|
-
:type sampling: float
|
|
1847
1449
|
"""
|
|
1848
1450
|
|
|
1849
1451
|
def stroke_vertices_begin(self, t: float = 0.0) -> StrokeVertexIterator:
|
|
@@ -1853,9 +1455,7 @@ class Stroke:
|
|
|
1853
1455
|
|
|
1854
1456
|
:param t: The resampling value with which we want our Stroke to be
|
|
1855
1457
|
resampled. If 0 is specified, no resampling is done.
|
|
1856
|
-
:type t: float
|
|
1857
1458
|
:return: A StrokeVertexIterator pointing on the first StrokeVertex.
|
|
1858
|
-
:rtype: StrokeVertexIterator
|
|
1859
1459
|
"""
|
|
1860
1460
|
|
|
1861
1461
|
def stroke_vertices_end(self) -> StrokeVertexIterator:
|
|
@@ -1863,17 +1463,15 @@ class Stroke:
|
|
|
1863
1463
|
of the Stroke.
|
|
1864
1464
|
|
|
1865
1465
|
:return: A StrokeVertexIterator pointing after the last StrokeVertex.
|
|
1866
|
-
:rtype: StrokeVertexIterator
|
|
1867
1466
|
"""
|
|
1868
1467
|
|
|
1869
1468
|
def stroke_vertices_size(self) -> int:
|
|
1870
1469
|
"""Returns the number of StrokeVertex constituting the Stroke.
|
|
1871
1470
|
|
|
1872
1471
|
:return: The number of stroke vertices.
|
|
1873
|
-
:rtype: int
|
|
1874
1472
|
"""
|
|
1875
1473
|
|
|
1876
|
-
def update_length(self):
|
|
1474
|
+
def update_length(self) -> None:
|
|
1877
1475
|
"""Updates the 2D length of the Stroke."""
|
|
1878
1476
|
|
|
1879
1477
|
class StrokeAttribute:
|
|
@@ -1883,45 +1481,32 @@ class StrokeAttribute:
|
|
|
1883
1481
|
"""
|
|
1884
1482
|
|
|
1885
1483
|
alpha: float
|
|
1886
|
-
""" Alpha component of the stroke color.
|
|
1887
|
-
|
|
1888
|
-
:type: float
|
|
1889
|
-
"""
|
|
1484
|
+
""" Alpha component of the stroke color."""
|
|
1890
1485
|
|
|
1891
1486
|
color: mathutils.Color
|
|
1892
|
-
""" RGB components of the stroke color.
|
|
1893
|
-
|
|
1894
|
-
:type: mathutils.Color
|
|
1895
|
-
"""
|
|
1487
|
+
""" RGB components of the stroke color."""
|
|
1896
1488
|
|
|
1897
1489
|
thickness: mathutils.Vector
|
|
1898
1490
|
""" Right and left components of the stroke thickness.
|
|
1899
1491
|
The right (left) component is the thickness on the right (left) of the vertex
|
|
1900
|
-
when following the stroke.
|
|
1901
|
-
|
|
1902
|
-
:type: mathutils.Vector
|
|
1903
|
-
"""
|
|
1492
|
+
when following the stroke."""
|
|
1904
1493
|
|
|
1905
1494
|
visible: bool
|
|
1906
|
-
""" The visibility flag. True if the StrokeVertex is visible.
|
|
1495
|
+
""" The visibility flag. True if the StrokeVertex is visible."""
|
|
1907
1496
|
|
|
1908
|
-
:
|
|
1909
|
-
"""
|
|
1910
|
-
|
|
1911
|
-
def __init__(self):
|
|
1497
|
+
def __init__(self) -> None:
|
|
1912
1498
|
"""Creates a `StrokeAttribute` object using either a default constructor,
|
|
1913
1499
|
copy constructor, overloaded constructor, or and interpolation constructor
|
|
1914
1500
|
to interpolate between two `StrokeAttribute` objects.
|
|
1915
1501
|
|
|
1916
1502
|
"""
|
|
1917
1503
|
|
|
1918
|
-
def __init__(self, brother: typing_extensions.Self):
|
|
1504
|
+
def __init__(self, brother: typing_extensions.Self) -> None:
|
|
1919
1505
|
"""Creates a `StrokeAttribute` object using either a default constructor,
|
|
1920
1506
|
copy constructor, overloaded constructor, or and interpolation constructor
|
|
1921
1507
|
to interpolate between two `StrokeAttribute` objects.
|
|
1922
1508
|
|
|
1923
1509
|
:param brother: A StrokeAttribute object to be used as a copy constructor.
|
|
1924
|
-
:type brother: typing_extensions.Self
|
|
1925
1510
|
"""
|
|
1926
1511
|
|
|
1927
1512
|
def __init__(
|
|
@@ -1932,23 +1517,17 @@ when following the stroke.
|
|
|
1932
1517
|
alpha: float,
|
|
1933
1518
|
thickness_right: float,
|
|
1934
1519
|
thickness_left: float,
|
|
1935
|
-
):
|
|
1520
|
+
) -> None:
|
|
1936
1521
|
"""Creates a `StrokeAttribute` object using either a default constructor,
|
|
1937
1522
|
copy constructor, overloaded constructor, or and interpolation constructor
|
|
1938
1523
|
to interpolate between two `StrokeAttribute` objects.
|
|
1939
1524
|
|
|
1940
1525
|
:param red: Red component of a stroke color.
|
|
1941
|
-
:type red: float
|
|
1942
1526
|
:param green: Green component of a stroke color.
|
|
1943
|
-
:type green: float
|
|
1944
1527
|
:param blue: Blue component of a stroke color.
|
|
1945
|
-
:type blue: float
|
|
1946
1528
|
:param alpha: Alpha component of a stroke color.
|
|
1947
|
-
:type alpha: float
|
|
1948
1529
|
:param thickness_right: Stroke thickness on the right.
|
|
1949
|
-
:type thickness_right: float
|
|
1950
1530
|
:param thickness_left: Stroke thickness on the left.
|
|
1951
|
-
:type thickness_left: float
|
|
1952
1531
|
"""
|
|
1953
1532
|
|
|
1954
1533
|
def __init__(
|
|
@@ -1956,53 +1535,42 @@ when following the stroke.
|
|
|
1956
1535
|
attribute1: typing_extensions.Self,
|
|
1957
1536
|
attribute2: typing_extensions.Self,
|
|
1958
1537
|
t: float,
|
|
1959
|
-
):
|
|
1538
|
+
) -> None:
|
|
1960
1539
|
"""Creates a `StrokeAttribute` object using either a default constructor,
|
|
1961
1540
|
copy constructor, overloaded constructor, or and interpolation constructor
|
|
1962
1541
|
to interpolate between two `StrokeAttribute` objects.
|
|
1963
1542
|
|
|
1964
1543
|
:param attribute1: The first StrokeAttribute object.
|
|
1965
|
-
:type attribute1: typing_extensions.Self
|
|
1966
1544
|
:param attribute2: The second StrokeAttribute object.
|
|
1967
|
-
:type attribute2: typing_extensions.Self
|
|
1968
1545
|
:param t: The interpolation parameter (0 <= t <= 1).
|
|
1969
|
-
:type t: float
|
|
1970
1546
|
"""
|
|
1971
1547
|
|
|
1972
1548
|
def get_attribute_real(self, name: str) -> float:
|
|
1973
1549
|
"""Returns an attribute of float type.
|
|
1974
1550
|
|
|
1975
1551
|
:param name: The name of the attribute.
|
|
1976
|
-
:type name: str
|
|
1977
1552
|
:return: The attribute value.
|
|
1978
|
-
:rtype: float
|
|
1979
1553
|
"""
|
|
1980
1554
|
|
|
1981
1555
|
def get_attribute_vec2(self, name: str) -> mathutils.Vector:
|
|
1982
1556
|
"""Returns an attribute of two-dimensional vector type.
|
|
1983
1557
|
|
|
1984
1558
|
:param name: The name of the attribute.
|
|
1985
|
-
:type name: str
|
|
1986
1559
|
:return: The attribute value.
|
|
1987
|
-
:rtype: mathutils.Vector
|
|
1988
1560
|
"""
|
|
1989
1561
|
|
|
1990
1562
|
def get_attribute_vec3(self, name: str) -> mathutils.Vector:
|
|
1991
1563
|
"""Returns an attribute of three-dimensional vector type.
|
|
1992
1564
|
|
|
1993
1565
|
:param name: The name of the attribute.
|
|
1994
|
-
:type name: str
|
|
1995
1566
|
:return: The attribute value.
|
|
1996
|
-
:rtype: mathutils.Vector
|
|
1997
1567
|
"""
|
|
1998
1568
|
|
|
1999
1569
|
def has_attribute_real(self, name: str) -> bool:
|
|
2000
1570
|
"""Checks whether the attribute name of float type is available.
|
|
2001
1571
|
|
|
2002
1572
|
:param name: The name of the attribute.
|
|
2003
|
-
:type name: str
|
|
2004
1573
|
:return: True if the attribute is available.
|
|
2005
|
-
:rtype: bool
|
|
2006
1574
|
"""
|
|
2007
1575
|
|
|
2008
1576
|
def has_attribute_vec2(self, name: str) -> bool:
|
|
@@ -2010,9 +1578,7 @@ when following the stroke.
|
|
|
2010
1578
|
is available.
|
|
2011
1579
|
|
|
2012
1580
|
:param name: The name of the attribute.
|
|
2013
|
-
:type name: str
|
|
2014
1581
|
:return: True if the attribute is available.
|
|
2015
|
-
:rtype: bool
|
|
2016
1582
|
"""
|
|
2017
1583
|
|
|
2018
1584
|
def has_attribute_vec3(self, name: str) -> bool:
|
|
@@ -2020,20 +1586,16 @@ when following the stroke.
|
|
|
2020
1586
|
type is available.
|
|
2021
1587
|
|
|
2022
1588
|
:param name: The name of the attribute.
|
|
2023
|
-
:type name: str
|
|
2024
1589
|
:return: True if the attribute is available.
|
|
2025
|
-
:rtype: bool
|
|
2026
1590
|
"""
|
|
2027
1591
|
|
|
2028
|
-
def set_attribute_real(self, name: str, value: float):
|
|
1592
|
+
def set_attribute_real(self, name: str, value: float) -> None:
|
|
2029
1593
|
"""Adds a user-defined attribute of float type. If there is no
|
|
2030
1594
|
attribute of the given name, it is added. Otherwise, the new value
|
|
2031
1595
|
replaces the old one.
|
|
2032
1596
|
|
|
2033
1597
|
:param name: The name of the attribute.
|
|
2034
|
-
:type name: str
|
|
2035
1598
|
:param value: The attribute value.
|
|
2036
|
-
:type value: float
|
|
2037
1599
|
"""
|
|
2038
1600
|
|
|
2039
1601
|
def set_attribute_vec2(
|
|
@@ -2043,15 +1605,13 @@ when following the stroke.
|
|
|
2043
1605
|
| list[float]
|
|
2044
1606
|
| mathutils.Vector
|
|
2045
1607
|
| tuple[float, float, float],
|
|
2046
|
-
):
|
|
1608
|
+
) -> None:
|
|
2047
1609
|
"""Adds a user-defined attribute of two-dimensional vector type. If
|
|
2048
1610
|
there is no attribute of the given name, it is added. Otherwise,
|
|
2049
1611
|
the new value replaces the old one.
|
|
2050
1612
|
|
|
2051
1613
|
:param name: The name of the attribute.
|
|
2052
|
-
:type name: str
|
|
2053
1614
|
:param value: The attribute value.
|
|
2054
|
-
:type value: collections.abc.Sequence[float] | list[float] | mathutils.Vector | tuple[float, float, float]
|
|
2055
1615
|
"""
|
|
2056
1616
|
|
|
2057
1617
|
def set_attribute_vec3(
|
|
@@ -2061,15 +1621,13 @@ when following the stroke.
|
|
|
2061
1621
|
| list[float]
|
|
2062
1622
|
| mathutils.Vector
|
|
2063
1623
|
| tuple[float, float, float],
|
|
2064
|
-
):
|
|
1624
|
+
) -> None:
|
|
2065
1625
|
"""Adds a user-defined attribute of three-dimensional vector type.
|
|
2066
1626
|
If there is no attribute of the given name, it is added.
|
|
2067
1627
|
Otherwise, the new value replaces the old one.
|
|
2068
1628
|
|
|
2069
1629
|
:param name: The name of the attribute.
|
|
2070
|
-
:type name: str
|
|
2071
1630
|
:param value: The attribute value as a 3D vector.
|
|
2072
|
-
:type value: collections.abc.Sequence[float] | list[float] | mathutils.Vector | tuple[float, float, float]
|
|
2073
1631
|
"""
|
|
2074
1632
|
|
|
2075
1633
|
class StrokeShader:
|
|
@@ -2083,69 +1641,49 @@ class StrokeShader:
|
|
|
2083
1641
|
"""
|
|
2084
1642
|
|
|
2085
1643
|
name: str
|
|
2086
|
-
""" The name of the stroke shader.
|
|
2087
|
-
|
|
2088
|
-
:type: str
|
|
2089
|
-
"""
|
|
1644
|
+
""" The name of the stroke shader."""
|
|
2090
1645
|
|
|
2091
|
-
def __init__(self):
|
|
1646
|
+
def __init__(self) -> None:
|
|
2092
1647
|
"""Default constructor."""
|
|
2093
1648
|
|
|
2094
|
-
def shade(self, stroke: Stroke):
|
|
1649
|
+
def shade(self, stroke: Stroke) -> None:
|
|
2095
1650
|
"""The shading method. Must be overloaded by inherited classes.
|
|
2096
1651
|
|
|
2097
1652
|
:param stroke: A Stroke object.
|
|
2098
|
-
:type stroke: Stroke
|
|
2099
1653
|
"""
|
|
2100
1654
|
|
|
2101
1655
|
class StrokeVertex:
|
|
2102
1656
|
"""Class hierarchy: `Interface0D` > `CurvePoint` > `StrokeVertex`Class to define a stroke vertex."""
|
|
2103
1657
|
|
|
2104
1658
|
attribute: StrokeAttribute
|
|
2105
|
-
""" StrokeAttribute for this StrokeVertex.
|
|
2106
|
-
|
|
2107
|
-
:type: StrokeAttribute
|
|
2108
|
-
"""
|
|
1659
|
+
""" StrokeAttribute for this StrokeVertex."""
|
|
2109
1660
|
|
|
2110
1661
|
curvilinear_abscissa: float
|
|
2111
|
-
""" Curvilinear abscissa of this StrokeVertex in the Stroke.
|
|
2112
|
-
|
|
2113
|
-
:type: float
|
|
2114
|
-
"""
|
|
1662
|
+
""" Curvilinear abscissa of this StrokeVertex in the Stroke."""
|
|
2115
1663
|
|
|
2116
1664
|
point: mathutils.Vector
|
|
2117
|
-
""" 2D point coordinates.
|
|
2118
|
-
|
|
2119
|
-
:type: mathutils.Vector
|
|
2120
|
-
"""
|
|
1665
|
+
""" 2D point coordinates."""
|
|
2121
1666
|
|
|
2122
1667
|
stroke_length: float
|
|
2123
1668
|
""" Stroke length (it is only a value retained by the StrokeVertex,
|
|
2124
|
-
and it won't change the real stroke length).
|
|
2125
|
-
|
|
2126
|
-
:type: float
|
|
2127
|
-
"""
|
|
1669
|
+
and it won't change the real stroke length)."""
|
|
2128
1670
|
|
|
2129
1671
|
u: float
|
|
2130
|
-
""" Curvilinear abscissa of this StrokeVertex in the Stroke.
|
|
1672
|
+
""" Curvilinear abscissa of this StrokeVertex in the Stroke."""
|
|
2131
1673
|
|
|
2132
|
-
:
|
|
2133
|
-
"""
|
|
2134
|
-
|
|
2135
|
-
def __init__(self):
|
|
1674
|
+
def __init__(self) -> None:
|
|
2136
1675
|
"""Builds a `StrokeVertex` using the default constructor,
|
|
2137
1676
|
copy constructor, from 2 `StrokeVertex` and an interpolation parameter,
|
|
2138
1677
|
from a CurvePoint, from a SVertex, or a `SVertex` and a `StrokeAttribute` object.
|
|
2139
1678
|
|
|
2140
1679
|
"""
|
|
2141
1680
|
|
|
2142
|
-
def __init__(self, brother: typing_extensions.Self):
|
|
1681
|
+
def __init__(self, brother: typing_extensions.Self) -> None:
|
|
2143
1682
|
"""Builds a `StrokeVertex` using the default constructor,
|
|
2144
1683
|
copy constructor, from 2 `StrokeVertex` and an interpolation parameter,
|
|
2145
1684
|
from a CurvePoint, from a SVertex, or a `SVertex` and a `StrokeAttribute` object.
|
|
2146
1685
|
|
|
2147
1686
|
:param brother: A StrokeVertex object.
|
|
2148
|
-
:type brother: typing_extensions.Self
|
|
2149
1687
|
"""
|
|
2150
1688
|
|
|
2151
1689
|
def __init__(
|
|
@@ -2153,46 +1691,39 @@ and it won't change the real stroke length).
|
|
|
2153
1691
|
first_vertex: typing_extensions.Self,
|
|
2154
1692
|
second_vertex: typing_extensions.Self,
|
|
2155
1693
|
t3d: float,
|
|
2156
|
-
):
|
|
1694
|
+
) -> None:
|
|
2157
1695
|
"""Builds a `StrokeVertex` using the default constructor,
|
|
2158
1696
|
copy constructor, from 2 `StrokeVertex` and an interpolation parameter,
|
|
2159
1697
|
from a CurvePoint, from a SVertex, or a `SVertex` and a `StrokeAttribute` object.
|
|
2160
1698
|
|
|
2161
1699
|
:param first_vertex: The first StrokeVertex.
|
|
2162
|
-
:type first_vertex: typing_extensions.Self
|
|
2163
1700
|
:param second_vertex: The second StrokeVertex.
|
|
2164
|
-
:type second_vertex: typing_extensions.Self
|
|
2165
1701
|
:param t3d: An interpolation parameter.
|
|
2166
|
-
:type t3d: float
|
|
2167
1702
|
"""
|
|
2168
1703
|
|
|
2169
|
-
def __init__(self, point: CurvePoint):
|
|
1704
|
+
def __init__(self, point: CurvePoint) -> None:
|
|
2170
1705
|
"""Builds a `StrokeVertex` using the default constructor,
|
|
2171
1706
|
copy constructor, from 2 `StrokeVertex` and an interpolation parameter,
|
|
2172
1707
|
from a CurvePoint, from a SVertex, or a `SVertex` and a `StrokeAttribute` object.
|
|
2173
1708
|
|
|
2174
1709
|
:param point: A CurvePoint object.
|
|
2175
|
-
:type point: CurvePoint
|
|
2176
1710
|
"""
|
|
2177
1711
|
|
|
2178
|
-
def __init__(self, svertex: SVertex):
|
|
1712
|
+
def __init__(self, svertex: SVertex) -> None:
|
|
2179
1713
|
"""Builds a `StrokeVertex` using the default constructor,
|
|
2180
1714
|
copy constructor, from 2 `StrokeVertex` and an interpolation parameter,
|
|
2181
1715
|
from a CurvePoint, from a SVertex, or a `SVertex` and a `StrokeAttribute` object.
|
|
2182
1716
|
|
|
2183
1717
|
:param svertex: An SVertex object.An SVertex object.
|
|
2184
|
-
:type svertex: SVertex
|
|
2185
1718
|
"""
|
|
2186
1719
|
|
|
2187
|
-
def __init__(self, svertex: SVertex, attribute: StrokeAttribute):
|
|
1720
|
+
def __init__(self, svertex: SVertex, attribute: StrokeAttribute) -> None:
|
|
2188
1721
|
"""Builds a `StrokeVertex` using the default constructor,
|
|
2189
1722
|
copy constructor, from 2 `StrokeVertex` and an interpolation parameter,
|
|
2190
1723
|
from a CurvePoint, from a SVertex, or a `SVertex` and a `StrokeAttribute` object.
|
|
2191
1724
|
|
|
2192
1725
|
:param svertex: An SVertex object.An SVertex object.
|
|
2193
|
-
:type svertex: SVertex
|
|
2194
1726
|
:param attribute: A StrokeAttribute object.
|
|
2195
|
-
:type attribute: StrokeAttribute
|
|
2196
1727
|
"""
|
|
2197
1728
|
|
|
2198
1729
|
class StrokeVertexIterator:
|
|
@@ -2211,55 +1742,40 @@ class StrokeVertexIterator:
|
|
|
2211
1742
|
|
|
2212
1743
|
at_last: bool
|
|
2213
1744
|
""" True if the iterator points to the last valid element.
|
|
2214
|
-
For its counterpart (pointing to the first valid element), use it.is_begin.
|
|
2215
|
-
|
|
2216
|
-
:type: bool
|
|
2217
|
-
"""
|
|
1745
|
+
For its counterpart (pointing to the first valid element), use it.is_begin."""
|
|
2218
1746
|
|
|
2219
1747
|
object: StrokeVertex
|
|
2220
|
-
""" The StrokeVertex object currently pointed to by this iterator.
|
|
2221
|
-
|
|
2222
|
-
:type: StrokeVertex
|
|
2223
|
-
"""
|
|
1748
|
+
""" The StrokeVertex object currently pointed to by this iterator."""
|
|
2224
1749
|
|
|
2225
1750
|
t: float
|
|
2226
|
-
""" The curvilinear abscissa of the current point.
|
|
2227
|
-
|
|
2228
|
-
:type: float
|
|
2229
|
-
"""
|
|
1751
|
+
""" The curvilinear abscissa of the current point."""
|
|
2230
1752
|
|
|
2231
1753
|
u: float
|
|
2232
|
-
""" The point parameter at the current point in the stroke (0 <= u <= 1).
|
|
2233
|
-
|
|
2234
|
-
:type: float
|
|
2235
|
-
"""
|
|
1754
|
+
""" The point parameter at the current point in the stroke (0 <= u <= 1)."""
|
|
2236
1755
|
|
|
2237
|
-
def __init__(self):
|
|
1756
|
+
def __init__(self) -> None:
|
|
2238
1757
|
"""Creates a `StrokeVertexIterator` using either the
|
|
2239
1758
|
default constructor or the copy constructor.
|
|
2240
1759
|
|
|
2241
1760
|
"""
|
|
2242
1761
|
|
|
2243
|
-
def __init__(self, brother: typing_extensions.Self):
|
|
1762
|
+
def __init__(self, brother: typing_extensions.Self) -> None:
|
|
2244
1763
|
"""Creates a `StrokeVertexIterator` using either the
|
|
2245
1764
|
default constructor or the copy constructor.
|
|
2246
1765
|
|
|
2247
1766
|
:param brother: A StrokeVertexIterator object.
|
|
2248
|
-
:type brother: typing_extensions.Self
|
|
2249
1767
|
"""
|
|
2250
1768
|
|
|
2251
1769
|
def decremented(self) -> typing_extensions.Self:
|
|
2252
1770
|
"""Returns a copy of a decremented StrokeVertexIterator.
|
|
2253
1771
|
|
|
2254
1772
|
:return: A StrokeVertexIterator pointing the previous StrokeVertex.
|
|
2255
|
-
:rtype: typing_extensions.Self
|
|
2256
1773
|
"""
|
|
2257
1774
|
|
|
2258
1775
|
def incremented(self) -> typing_extensions.Self:
|
|
2259
1776
|
"""Returns a copy of an incremented StrokeVertexIterator.
|
|
2260
1777
|
|
|
2261
1778
|
:return: A StrokeVertexIterator pointing the next StrokeVertex.
|
|
2262
|
-
:rtype: typing_extensions.Self
|
|
2263
1779
|
"""
|
|
2264
1780
|
|
|
2265
1781
|
def reversed(self) -> typing_extensions.Self:
|
|
@@ -2267,7 +1783,6 @@ For its counterpart (pointing to the first valid element), use it.is_begin.
|
|
|
2267
1783
|
reversed order.
|
|
2268
1784
|
|
|
2269
1785
|
:return: A StrokeVertexIterator traversing stroke vertices backward.
|
|
2270
|
-
:rtype: typing_extensions.Self
|
|
2271
1786
|
"""
|
|
2272
1787
|
|
|
2273
1788
|
class TVertex:
|
|
@@ -2279,24 +1794,15 @@ class TVertex:
|
|
|
2279
1794
|
"""
|
|
2280
1795
|
|
|
2281
1796
|
back_svertex: SVertex
|
|
2282
|
-
""" The SVertex that is further away from the viewpoint.
|
|
2283
|
-
|
|
2284
|
-
:type: SVertex
|
|
2285
|
-
"""
|
|
1797
|
+
""" The SVertex that is further away from the viewpoint."""
|
|
2286
1798
|
|
|
2287
1799
|
front_svertex: SVertex
|
|
2288
|
-
""" The SVertex that is closer to the viewpoint.
|
|
2289
|
-
|
|
2290
|
-
:type: SVertex
|
|
2291
|
-
"""
|
|
1800
|
+
""" The SVertex that is closer to the viewpoint."""
|
|
2292
1801
|
|
|
2293
1802
|
id: Id
|
|
2294
|
-
""" The Id of this TVertex.
|
|
1803
|
+
""" The Id of this TVertex."""
|
|
2295
1804
|
|
|
2296
|
-
:
|
|
2297
|
-
"""
|
|
2298
|
-
|
|
2299
|
-
def __init__(self):
|
|
1805
|
+
def __init__(self) -> None:
|
|
2300
1806
|
"""Default constructor."""
|
|
2301
1807
|
|
|
2302
1808
|
def get_mate(self, viewedge: ViewEdge) -> ViewEdge:
|
|
@@ -2305,18 +1811,14 @@ class TVertex:
|
|
|
2305
1811
|
frontEdgeB, frontEdgeA is returned. Same for back edges.
|
|
2306
1812
|
|
|
2307
1813
|
:param viewedge: A ViewEdge object.
|
|
2308
|
-
:type viewedge: ViewEdge
|
|
2309
1814
|
:return: The mate edge of the given ViewEdge.
|
|
2310
|
-
:rtype: ViewEdge
|
|
2311
1815
|
"""
|
|
2312
1816
|
|
|
2313
1817
|
def get_svertex(self, fedge: FEdge) -> SVertex:
|
|
2314
1818
|
"""Returns the SVertex (among the 2) belonging to the given FEdge.
|
|
2315
1819
|
|
|
2316
1820
|
:param fedge: An FEdge object.
|
|
2317
|
-
:type fedge: FEdge
|
|
2318
1821
|
:return: The SVertex belonging to the given FEdge.
|
|
2319
|
-
:rtype: SVertex
|
|
2320
1822
|
"""
|
|
2321
1823
|
|
|
2322
1824
|
class UnaryFunction0D:
|
|
@@ -2324,23 +1826,20 @@ class UnaryFunction0D:
|
|
|
2324
1826
|
`Interface0DIterator`. A unary function will be used by
|
|
2325
1827
|
invoking __call__() on an Interface0DIterator. In Python, several
|
|
2326
1828
|
different subclasses of UnaryFunction0D are used depending on the
|
|
2327
|
-
types of functors
|
|
1829
|
+
types of functors return values. For example, you would inherit from
|
|
2328
1830
|
a `UnaryFunction0DDouble` if you wish to define a function that
|
|
2329
1831
|
returns a double value. Available UnaryFunction0D subclasses are:
|
|
2330
1832
|
"""
|
|
2331
1833
|
|
|
2332
1834
|
name: str
|
|
2333
|
-
""" The name of the unary 0D function.
|
|
2334
|
-
|
|
2335
|
-
:type: str
|
|
2336
|
-
"""
|
|
1835
|
+
""" The name of the unary 0D function."""
|
|
2337
1836
|
|
|
2338
1837
|
class UnaryFunction0DDouble:
|
|
2339
1838
|
"""Class hierarchy: `UnaryFunction0D` > `UnaryFunction0DDouble`Base class for unary functions (functors) that work on
|
|
2340
1839
|
`Interface0DIterator` and return a float value.
|
|
2341
1840
|
"""
|
|
2342
1841
|
|
|
2343
|
-
def __init__(self):
|
|
1842
|
+
def __init__(self) -> None:
|
|
2344
1843
|
"""Default constructor."""
|
|
2345
1844
|
|
|
2346
1845
|
class UnaryFunction0DEdgeNature:
|
|
@@ -2348,7 +1847,7 @@ class UnaryFunction0DEdgeNature:
|
|
|
2348
1847
|
`Interface0DIterator` and return a `Nature` object.
|
|
2349
1848
|
"""
|
|
2350
1849
|
|
|
2351
|
-
def __init__(self):
|
|
1850
|
+
def __init__(self) -> None:
|
|
2352
1851
|
"""Default constructor."""
|
|
2353
1852
|
|
|
2354
1853
|
class UnaryFunction0DFloat:
|
|
@@ -2356,7 +1855,7 @@ class UnaryFunction0DFloat:
|
|
|
2356
1855
|
`Interface0DIterator` and return a float value.
|
|
2357
1856
|
"""
|
|
2358
1857
|
|
|
2359
|
-
def __init__(self):
|
|
1858
|
+
def __init__(self) -> None:
|
|
2360
1859
|
"""Default constructor."""
|
|
2361
1860
|
|
|
2362
1861
|
class UnaryFunction0DId:
|
|
@@ -2364,7 +1863,7 @@ class UnaryFunction0DId:
|
|
|
2364
1863
|
`Interface0DIterator` and return an `Id` object.
|
|
2365
1864
|
"""
|
|
2366
1865
|
|
|
2367
|
-
def __init__(self):
|
|
1866
|
+
def __init__(self) -> None:
|
|
2368
1867
|
"""Default constructor."""
|
|
2369
1868
|
|
|
2370
1869
|
class UnaryFunction0DMaterial:
|
|
@@ -2372,7 +1871,7 @@ class UnaryFunction0DMaterial:
|
|
|
2372
1871
|
`Interface0DIterator` and return a `Material` object.
|
|
2373
1872
|
"""
|
|
2374
1873
|
|
|
2375
|
-
def __init__(self):
|
|
1874
|
+
def __init__(self) -> None:
|
|
2376
1875
|
"""Default constructor."""
|
|
2377
1876
|
|
|
2378
1877
|
class UnaryFunction0DUnsigned:
|
|
@@ -2380,7 +1879,7 @@ class UnaryFunction0DUnsigned:
|
|
|
2380
1879
|
`Interface0DIterator` and return an int value.
|
|
2381
1880
|
"""
|
|
2382
1881
|
|
|
2383
|
-
def __init__(self):
|
|
1882
|
+
def __init__(self) -> None:
|
|
2384
1883
|
"""Default constructor."""
|
|
2385
1884
|
|
|
2386
1885
|
class UnaryFunction0DVec2f:
|
|
@@ -2388,7 +1887,7 @@ class UnaryFunction0DVec2f:
|
|
|
2388
1887
|
`Interface0DIterator` and return a 2D vector.
|
|
2389
1888
|
"""
|
|
2390
1889
|
|
|
2391
|
-
def __init__(self):
|
|
1890
|
+
def __init__(self) -> None:
|
|
2392
1891
|
"""Default constructor."""
|
|
2393
1892
|
|
|
2394
1893
|
class UnaryFunction0DVec3f:
|
|
@@ -2396,7 +1895,7 @@ class UnaryFunction0DVec3f:
|
|
|
2396
1895
|
`Interface0DIterator` and return a 3D vector.
|
|
2397
1896
|
"""
|
|
2398
1897
|
|
|
2399
|
-
def __init__(self):
|
|
1898
|
+
def __init__(self) -> None:
|
|
2400
1899
|
"""Default constructor."""
|
|
2401
1900
|
|
|
2402
1901
|
class UnaryFunction0DVectorViewShape:
|
|
@@ -2405,7 +1904,7 @@ class UnaryFunction0DVectorViewShape:
|
|
|
2405
1904
|
objects.
|
|
2406
1905
|
"""
|
|
2407
1906
|
|
|
2408
|
-
def __init__(self):
|
|
1907
|
+
def __init__(self) -> None:
|
|
2409
1908
|
"""Default constructor."""
|
|
2410
1909
|
|
|
2411
1910
|
class UnaryFunction0DViewShape:
|
|
@@ -2413,24 +1912,21 @@ class UnaryFunction0DViewShape:
|
|
|
2413
1912
|
`Interface0DIterator` and return a `ViewShape` object.
|
|
2414
1913
|
"""
|
|
2415
1914
|
|
|
2416
|
-
def __init__(self):
|
|
1915
|
+
def __init__(self) -> None:
|
|
2417
1916
|
"""Default constructor."""
|
|
2418
1917
|
|
|
2419
1918
|
class UnaryFunction1D:
|
|
2420
1919
|
"""Base class for Unary Functions (functors) working on
|
|
2421
1920
|
`Interface1D`. A unary function will be used by invoking
|
|
2422
1921
|
__call__() on an Interface1D. In Python, several different subclasses
|
|
2423
|
-
of UnaryFunction1D are used depending on the types of functors
|
|
1922
|
+
of UnaryFunction1D are used depending on the types of functors return
|
|
2424
1923
|
values. For example, you would inherit from a
|
|
2425
1924
|
`UnaryFunction1DDouble` if you wish to define a function that
|
|
2426
1925
|
returns a double value. Available UnaryFunction1D subclasses are:
|
|
2427
1926
|
"""
|
|
2428
1927
|
|
|
2429
1928
|
name: str
|
|
2430
|
-
""" The name of the unary 1D function.
|
|
2431
|
-
|
|
2432
|
-
:type: str
|
|
2433
|
-
"""
|
|
1929
|
+
""" The name of the unary 1D function."""
|
|
2434
1930
|
|
|
2435
1931
|
class UnaryFunction1DDouble:
|
|
2436
1932
|
"""Class hierarchy: `UnaryFunction1D` > `UnaryFunction1DDouble`Base class for unary functions (functors) that work on
|
|
@@ -2438,23 +1934,19 @@ class UnaryFunction1DDouble:
|
|
|
2438
1934
|
"""
|
|
2439
1935
|
|
|
2440
1936
|
integration_type: IntegrationType
|
|
2441
|
-
""" The integration method.
|
|
1937
|
+
""" The integration method."""
|
|
2442
1938
|
|
|
2443
|
-
:
|
|
2444
|
-
"""
|
|
2445
|
-
|
|
2446
|
-
def __init__(self):
|
|
1939
|
+
def __init__(self) -> None:
|
|
2447
1940
|
"""Builds a unary 1D function using the default constructor
|
|
2448
1941
|
or the integration method given as an argument.
|
|
2449
1942
|
|
|
2450
1943
|
"""
|
|
2451
1944
|
|
|
2452
|
-
def __init__(self, integration_type: IntegrationType):
|
|
1945
|
+
def __init__(self, integration_type: IntegrationType) -> None:
|
|
2453
1946
|
"""Builds a unary 1D function using the default constructor
|
|
2454
1947
|
or the integration method given as an argument.
|
|
2455
1948
|
|
|
2456
1949
|
:param integration_type: An integration method.
|
|
2457
|
-
:type integration_type: IntegrationType
|
|
2458
1950
|
"""
|
|
2459
1951
|
|
|
2460
1952
|
class UnaryFunction1DEdgeNature:
|
|
@@ -2463,23 +1955,19 @@ class UnaryFunction1DEdgeNature:
|
|
|
2463
1955
|
"""
|
|
2464
1956
|
|
|
2465
1957
|
integration_type: IntegrationType
|
|
2466
|
-
""" The integration method.
|
|
1958
|
+
""" The integration method."""
|
|
2467
1959
|
|
|
2468
|
-
:
|
|
2469
|
-
"""
|
|
2470
|
-
|
|
2471
|
-
def __init__(self):
|
|
1960
|
+
def __init__(self) -> None:
|
|
2472
1961
|
"""Builds a unary 1D function using the default constructor
|
|
2473
1962
|
or the integration method given as an argument.
|
|
2474
1963
|
|
|
2475
1964
|
"""
|
|
2476
1965
|
|
|
2477
|
-
def __init__(self, integration_type: IntegrationType):
|
|
1966
|
+
def __init__(self, integration_type: IntegrationType) -> None:
|
|
2478
1967
|
"""Builds a unary 1D function using the default constructor
|
|
2479
1968
|
or the integration method given as an argument.
|
|
2480
1969
|
|
|
2481
1970
|
:param integration_type: An integration method.
|
|
2482
|
-
:type integration_type: IntegrationType
|
|
2483
1971
|
"""
|
|
2484
1972
|
|
|
2485
1973
|
class UnaryFunction1DFloat:
|
|
@@ -2488,23 +1976,19 @@ class UnaryFunction1DFloat:
|
|
|
2488
1976
|
"""
|
|
2489
1977
|
|
|
2490
1978
|
integration_type: IntegrationType
|
|
2491
|
-
""" The integration method.
|
|
2492
|
-
|
|
2493
|
-
:type: IntegrationType
|
|
2494
|
-
"""
|
|
1979
|
+
""" The integration method."""
|
|
2495
1980
|
|
|
2496
|
-
def __init__(self):
|
|
1981
|
+
def __init__(self) -> None:
|
|
2497
1982
|
"""Builds a unary 1D function using the default constructor
|
|
2498
1983
|
or the integration method given as an argument.
|
|
2499
1984
|
|
|
2500
1985
|
"""
|
|
2501
1986
|
|
|
2502
|
-
def __init__(self, integration_type: IntegrationType):
|
|
1987
|
+
def __init__(self, integration_type: IntegrationType) -> None:
|
|
2503
1988
|
"""Builds a unary 1D function using the default constructor
|
|
2504
1989
|
or the integration method given as an argument.
|
|
2505
1990
|
|
|
2506
1991
|
:param integration_type: An integration method.
|
|
2507
|
-
:type integration_type: IntegrationType
|
|
2508
1992
|
"""
|
|
2509
1993
|
|
|
2510
1994
|
class UnaryFunction1DUnsigned:
|
|
@@ -2513,23 +1997,19 @@ class UnaryFunction1DUnsigned:
|
|
|
2513
1997
|
"""
|
|
2514
1998
|
|
|
2515
1999
|
integration_type: IntegrationType
|
|
2516
|
-
""" The integration method.
|
|
2517
|
-
|
|
2518
|
-
:type: IntegrationType
|
|
2519
|
-
"""
|
|
2000
|
+
""" The integration method."""
|
|
2520
2001
|
|
|
2521
|
-
def __init__(self):
|
|
2002
|
+
def __init__(self) -> None:
|
|
2522
2003
|
"""Builds a unary 1D function using the default constructor
|
|
2523
2004
|
or the integration method given as an argument.
|
|
2524
2005
|
|
|
2525
2006
|
"""
|
|
2526
2007
|
|
|
2527
|
-
def __init__(self, integration_type: IntegrationType):
|
|
2008
|
+
def __init__(self, integration_type: IntegrationType) -> None:
|
|
2528
2009
|
"""Builds a unary 1D function using the default constructor
|
|
2529
2010
|
or the integration method given as an argument.
|
|
2530
2011
|
|
|
2531
2012
|
:param integration_type: An integration method.
|
|
2532
|
-
:type integration_type: IntegrationType
|
|
2533
2013
|
"""
|
|
2534
2014
|
|
|
2535
2015
|
class UnaryFunction1DVec2f:
|
|
@@ -2538,23 +2018,19 @@ class UnaryFunction1DVec2f:
|
|
|
2538
2018
|
"""
|
|
2539
2019
|
|
|
2540
2020
|
integration_type: IntegrationType
|
|
2541
|
-
""" The integration method.
|
|
2542
|
-
|
|
2543
|
-
:type: IntegrationType
|
|
2544
|
-
"""
|
|
2021
|
+
""" The integration method."""
|
|
2545
2022
|
|
|
2546
|
-
def __init__(self):
|
|
2023
|
+
def __init__(self) -> None:
|
|
2547
2024
|
"""Builds a unary 1D function using the default constructor
|
|
2548
2025
|
or the integration method given as an argument.
|
|
2549
2026
|
|
|
2550
2027
|
"""
|
|
2551
2028
|
|
|
2552
|
-
def __init__(self, integration_type: IntegrationType):
|
|
2029
|
+
def __init__(self, integration_type: IntegrationType) -> None:
|
|
2553
2030
|
"""Builds a unary 1D function using the default constructor
|
|
2554
2031
|
or the integration method given as an argument.
|
|
2555
2032
|
|
|
2556
2033
|
:param integration_type: An integration method.
|
|
2557
|
-
:type integration_type: IntegrationType
|
|
2558
2034
|
"""
|
|
2559
2035
|
|
|
2560
2036
|
class UnaryFunction1DVec3f:
|
|
@@ -2563,23 +2039,19 @@ class UnaryFunction1DVec3f:
|
|
|
2563
2039
|
"""
|
|
2564
2040
|
|
|
2565
2041
|
integration_type: IntegrationType
|
|
2566
|
-
""" The integration method.
|
|
2567
|
-
|
|
2568
|
-
:type: IntegrationType
|
|
2569
|
-
"""
|
|
2042
|
+
""" The integration method."""
|
|
2570
2043
|
|
|
2571
|
-
def __init__(self):
|
|
2044
|
+
def __init__(self) -> None:
|
|
2572
2045
|
"""Builds a unary 1D function using the default constructor
|
|
2573
2046
|
or the integration method given as an argument.
|
|
2574
2047
|
|
|
2575
2048
|
"""
|
|
2576
2049
|
|
|
2577
|
-
def __init__(self, integration_type: IntegrationType):
|
|
2050
|
+
def __init__(self, integration_type: IntegrationType) -> None:
|
|
2578
2051
|
"""Builds a unary 1D function using the default constructor
|
|
2579
2052
|
or the integration method given as an argument.
|
|
2580
2053
|
|
|
2581
2054
|
:param integration_type: An integration method.
|
|
2582
|
-
:type integration_type: IntegrationType
|
|
2583
2055
|
"""
|
|
2584
2056
|
|
|
2585
2057
|
class UnaryFunction1DVectorViewShape:
|
|
@@ -2589,23 +2061,19 @@ class UnaryFunction1DVectorViewShape:
|
|
|
2589
2061
|
"""
|
|
2590
2062
|
|
|
2591
2063
|
integration_type: IntegrationType
|
|
2592
|
-
""" The integration method.
|
|
2064
|
+
""" The integration method."""
|
|
2593
2065
|
|
|
2594
|
-
:
|
|
2595
|
-
"""
|
|
2596
|
-
|
|
2597
|
-
def __init__(self):
|
|
2066
|
+
def __init__(self) -> None:
|
|
2598
2067
|
"""Builds a unary 1D function using the default constructor
|
|
2599
2068
|
or the integration method given as an argument.
|
|
2600
2069
|
|
|
2601
2070
|
"""
|
|
2602
2071
|
|
|
2603
|
-
def __init__(self, integration_type: IntegrationType):
|
|
2072
|
+
def __init__(self, integration_type: IntegrationType) -> None:
|
|
2604
2073
|
"""Builds a unary 1D function using the default constructor
|
|
2605
2074
|
or the integration method given as an argument.
|
|
2606
2075
|
|
|
2607
2076
|
:param integration_type: An integration method.
|
|
2608
|
-
:type integration_type: IntegrationType
|
|
2609
2077
|
"""
|
|
2610
2078
|
|
|
2611
2079
|
class UnaryFunction1DVoid:
|
|
@@ -2614,23 +2082,19 @@ class UnaryFunction1DVoid:
|
|
|
2614
2082
|
"""
|
|
2615
2083
|
|
|
2616
2084
|
integration_type: IntegrationType
|
|
2617
|
-
""" The integration method.
|
|
2618
|
-
|
|
2619
|
-
:type: IntegrationType
|
|
2620
|
-
"""
|
|
2085
|
+
""" The integration method."""
|
|
2621
2086
|
|
|
2622
|
-
def __init__(self):
|
|
2087
|
+
def __init__(self) -> None:
|
|
2623
2088
|
"""Builds a unary 1D function using either a default constructor
|
|
2624
2089
|
or the integration method given as an argument.
|
|
2625
2090
|
|
|
2626
2091
|
"""
|
|
2627
2092
|
|
|
2628
|
-
def __init__(self, integration_type: IntegrationType):
|
|
2093
|
+
def __init__(self, integration_type: IntegrationType) -> None:
|
|
2629
2094
|
"""Builds a unary 1D function using either a default constructor
|
|
2630
2095
|
or the integration method given as an argument.
|
|
2631
2096
|
|
|
2632
2097
|
:param integration_type: An integration method.
|
|
2633
|
-
:type integration_type: IntegrationType
|
|
2634
2098
|
"""
|
|
2635
2099
|
|
|
2636
2100
|
class UnaryPredicate0D:
|
|
@@ -2643,12 +2107,9 @@ class UnaryPredicate0D:
|
|
|
2643
2107
|
"""
|
|
2644
2108
|
|
|
2645
2109
|
name: str
|
|
2646
|
-
""" The name of the unary 0D predicate.
|
|
2110
|
+
""" The name of the unary 0D predicate."""
|
|
2647
2111
|
|
|
2648
|
-
:
|
|
2649
|
-
"""
|
|
2650
|
-
|
|
2651
|
-
def __init__(self):
|
|
2112
|
+
def __init__(self) -> None:
|
|
2652
2113
|
"""Default constructor."""
|
|
2653
2114
|
|
|
2654
2115
|
def __call__(self, it: Interface0DIterator) -> bool:
|
|
@@ -2656,9 +2117,7 @@ class UnaryPredicate0D:
|
|
|
2656
2117
|
|
|
2657
2118
|
:param it: The Interface0DIterator pointing onto the Interface0D at
|
|
2658
2119
|
which we wish to evaluate the predicate.
|
|
2659
|
-
:type it: Interface0DIterator
|
|
2660
2120
|
:return: True if the condition is satisfied, false otherwise.
|
|
2661
|
-
:rtype: bool
|
|
2662
2121
|
"""
|
|
2663
2122
|
|
|
2664
2123
|
class UnaryPredicate1D:
|
|
@@ -2671,21 +2130,16 @@ class UnaryPredicate1D:
|
|
|
2671
2130
|
"""
|
|
2672
2131
|
|
|
2673
2132
|
name: str
|
|
2674
|
-
""" The name of the unary 1D predicate.
|
|
2133
|
+
""" The name of the unary 1D predicate."""
|
|
2675
2134
|
|
|
2676
|
-
:
|
|
2677
|
-
"""
|
|
2678
|
-
|
|
2679
|
-
def __init__(self):
|
|
2135
|
+
def __init__(self) -> None:
|
|
2680
2136
|
"""Default constructor."""
|
|
2681
2137
|
|
|
2682
2138
|
def __call__(self, inter: Interface1D) -> bool:
|
|
2683
2139
|
"""Must be overload by inherited classes.
|
|
2684
2140
|
|
|
2685
2141
|
:param inter: The Interface1D on which we wish to evaluate the predicate.
|
|
2686
|
-
:type inter: Interface1D
|
|
2687
2142
|
:return: True if the condition is satisfied, false otherwise.
|
|
2688
|
-
:rtype: bool
|
|
2689
2143
|
"""
|
|
2690
2144
|
|
|
2691
2145
|
class ViewEdge:
|
|
@@ -2695,83 +2149,49 @@ class ViewEdge:
|
|
|
2695
2149
|
"""
|
|
2696
2150
|
|
|
2697
2151
|
chaining_time_stamp: int
|
|
2698
|
-
""" The time stamp of this ViewEdge.
|
|
2699
|
-
|
|
2700
|
-
:type: int
|
|
2701
|
-
"""
|
|
2152
|
+
""" The time stamp of this ViewEdge."""
|
|
2702
2153
|
|
|
2703
2154
|
first_fedge: FEdge
|
|
2704
|
-
""" The first FEdge that constitutes this ViewEdge.
|
|
2705
|
-
|
|
2706
|
-
:type: FEdge
|
|
2707
|
-
"""
|
|
2155
|
+
""" The first FEdge that constitutes this ViewEdge."""
|
|
2708
2156
|
|
|
2709
2157
|
first_viewvertex: ViewVertex
|
|
2710
|
-
""" The first ViewVertex.
|
|
2711
|
-
|
|
2712
|
-
:type: ViewVertex
|
|
2713
|
-
"""
|
|
2158
|
+
""" The first ViewVertex."""
|
|
2714
2159
|
|
|
2715
2160
|
id: Id
|
|
2716
|
-
""" The Id of this ViewEdge.
|
|
2717
|
-
|
|
2718
|
-
:type: Id
|
|
2719
|
-
"""
|
|
2161
|
+
""" The Id of this ViewEdge."""
|
|
2720
2162
|
|
|
2721
2163
|
is_closed: bool
|
|
2722
|
-
""" True if this ViewEdge forms a closed loop.
|
|
2723
|
-
|
|
2724
|
-
:type: bool
|
|
2725
|
-
"""
|
|
2164
|
+
""" True if this ViewEdge forms a closed loop."""
|
|
2726
2165
|
|
|
2727
2166
|
last_fedge: FEdge
|
|
2728
|
-
""" The last FEdge that constitutes this ViewEdge.
|
|
2729
|
-
|
|
2730
|
-
:type: FEdge
|
|
2731
|
-
"""
|
|
2167
|
+
""" The last FEdge that constitutes this ViewEdge."""
|
|
2732
2168
|
|
|
2733
2169
|
last_viewvertex: ViewVertex
|
|
2734
|
-
""" The second ViewVertex.
|
|
2735
|
-
|
|
2736
|
-
:type: ViewVertex
|
|
2737
|
-
"""
|
|
2170
|
+
""" The second ViewVertex."""
|
|
2738
2171
|
|
|
2739
2172
|
nature: Nature
|
|
2740
|
-
""" The nature of this ViewEdge.
|
|
2741
|
-
|
|
2742
|
-
:type: Nature
|
|
2743
|
-
"""
|
|
2173
|
+
""" The nature of this ViewEdge."""
|
|
2744
2174
|
|
|
2745
2175
|
occludee: ViewShape
|
|
2746
2176
|
""" The shape that is occluded by the ViewShape to which this ViewEdge
|
|
2747
|
-
belongs to. If no object is occluded, this property is set to None.
|
|
2748
|
-
|
|
2749
|
-
:type: ViewShape
|
|
2750
|
-
"""
|
|
2177
|
+
belongs to. If no object is occluded, this property is set to None."""
|
|
2751
2178
|
|
|
2752
2179
|
qi: int
|
|
2753
|
-
""" The quantitative invisibility.
|
|
2754
|
-
|
|
2755
|
-
:type: int
|
|
2756
|
-
"""
|
|
2180
|
+
""" The quantitative invisibility."""
|
|
2757
2181
|
|
|
2758
2182
|
viewshape: ViewShape
|
|
2759
|
-
""" The ViewShape to which this ViewEdge belongs to.
|
|
2760
|
-
|
|
2761
|
-
:type: ViewShape
|
|
2762
|
-
"""
|
|
2183
|
+
""" The ViewShape to which this ViewEdge belongs to."""
|
|
2763
2184
|
|
|
2764
|
-
def __init__(self):
|
|
2185
|
+
def __init__(self) -> None:
|
|
2765
2186
|
"""Builds a `ViewEdge` using the default constructor or the copy constructor."""
|
|
2766
2187
|
|
|
2767
|
-
def __init__(self, brother: typing_extensions.Self):
|
|
2188
|
+
def __init__(self, brother: typing_extensions.Self) -> None:
|
|
2768
2189
|
"""Builds a `ViewEdge` using the default constructor or the copy constructor.
|
|
2769
2190
|
|
|
2770
2191
|
:param brother: A ViewEdge object.
|
|
2771
|
-
:type brother: typing_extensions.Self
|
|
2772
2192
|
"""
|
|
2773
2193
|
|
|
2774
|
-
def update_fedges(self):
|
|
2194
|
+
def update_fedges(self) -> None:
|
|
2775
2195
|
"""Sets Viewedge to this for all embedded fedges."""
|
|
2776
2196
|
|
|
2777
2197
|
class ViewEdgeIterator:
|
|
@@ -2782,89 +2202,67 @@ class ViewEdgeIterator:
|
|
|
2782
2202
|
"""
|
|
2783
2203
|
|
|
2784
2204
|
begin: ViewEdge
|
|
2785
|
-
""" The first ViewEdge used for the iteration.
|
|
2786
|
-
|
|
2787
|
-
:type: ViewEdge
|
|
2788
|
-
"""
|
|
2205
|
+
""" The first ViewEdge used for the iteration."""
|
|
2789
2206
|
|
|
2790
2207
|
current_edge: ViewEdge
|
|
2791
|
-
""" The ViewEdge object currently pointed by this iterator.
|
|
2792
|
-
|
|
2793
|
-
:type: ViewEdge
|
|
2794
|
-
"""
|
|
2208
|
+
""" The ViewEdge object currently pointed by this iterator."""
|
|
2795
2209
|
|
|
2796
2210
|
object: ViewEdge
|
|
2797
|
-
""" The ViewEdge object currently pointed by this iterator.
|
|
2798
|
-
|
|
2799
|
-
:type: ViewEdge
|
|
2800
|
-
"""
|
|
2211
|
+
""" The ViewEdge object currently pointed by this iterator."""
|
|
2801
2212
|
|
|
2802
2213
|
orientation: bool
|
|
2803
2214
|
""" The orientation of the pointed ViewEdge in the iteration.
|
|
2804
2215
|
If true, the iterator looks for the next ViewEdge among those ViewEdges
|
|
2805
2216
|
that surround the ending ViewVertex of the "begin" ViewEdge. If false,
|
|
2806
2217
|
the iterator searches over the ViewEdges surrounding the ending ViewVertex
|
|
2807
|
-
of the "begin" ViewEdge.
|
|
2218
|
+
of the "begin" ViewEdge."""
|
|
2808
2219
|
|
|
2809
|
-
|
|
2810
|
-
|
|
2811
|
-
|
|
2812
|
-
def __init__(self, begin: None | ViewEdge | None = None, orientation: bool = True):
|
|
2220
|
+
def __init__(
|
|
2221
|
+
self, begin: None | ViewEdge | None = None, orientation: bool = True
|
|
2222
|
+
) -> None:
|
|
2813
2223
|
"""Builds a ViewEdgeIterator from a starting ViewEdge and its
|
|
2814
2224
|
orientation or the copy constructor.
|
|
2815
2225
|
|
|
2816
2226
|
:param begin: The ViewEdge from where to start the iteration.
|
|
2817
|
-
:
|
|
2818
|
-
:param orientation: If true, we'll look for the next ViewEdge among
|
|
2227
|
+
:param orientation: If true, well look for the next ViewEdge among
|
|
2819
2228
|
the ViewEdges that surround the ending ViewVertex of begin. If
|
|
2820
|
-
false,
|
|
2229
|
+
false, well search over the ViewEdges surrounding the ending
|
|
2821
2230
|
ViewVertex of begin.
|
|
2822
|
-
:type orientation: bool
|
|
2823
2231
|
"""
|
|
2824
2232
|
|
|
2825
|
-
def __init__(self, brother: typing_extensions.Self):
|
|
2233
|
+
def __init__(self, brother: typing_extensions.Self) -> None:
|
|
2826
2234
|
"""Builds a ViewEdgeIterator from a starting ViewEdge and its
|
|
2827
2235
|
orientation or the copy constructor.
|
|
2828
2236
|
|
|
2829
2237
|
:param brother: A ViewEdgeIterator object.
|
|
2830
|
-
:type brother: typing_extensions.Self
|
|
2831
2238
|
"""
|
|
2832
2239
|
|
|
2833
|
-
def change_orientation(self):
|
|
2240
|
+
def change_orientation(self) -> None:
|
|
2834
2241
|
"""Changes the current orientation."""
|
|
2835
2242
|
|
|
2836
2243
|
class ViewMap:
|
|
2837
2244
|
"""Class defining the ViewMap."""
|
|
2838
2245
|
|
|
2839
2246
|
scene_bbox: BBox
|
|
2840
|
-
""" The 3D bounding box of the scene.
|
|
2247
|
+
""" The 3D bounding box of the scene."""
|
|
2841
2248
|
|
|
2842
|
-
:
|
|
2843
|
-
"""
|
|
2844
|
-
|
|
2845
|
-
def __init__(self):
|
|
2249
|
+
def __init__(self) -> None:
|
|
2846
2250
|
"""Default constructor."""
|
|
2847
2251
|
|
|
2848
2252
|
def get_closest_fedge(self, x: float, y: float) -> FEdge:
|
|
2849
2253
|
"""Gets the FEdge nearest to the 2D point specified as arguments.
|
|
2850
2254
|
|
|
2851
2255
|
:param x: X coordinate of a 2D point.
|
|
2852
|
-
:type x: float
|
|
2853
2256
|
:param y: Y coordinate of a 2D point.
|
|
2854
|
-
:type y: float
|
|
2855
2257
|
:return: The FEdge nearest to the specified 2D point.
|
|
2856
|
-
:rtype: FEdge
|
|
2857
2258
|
"""
|
|
2858
2259
|
|
|
2859
2260
|
def get_closest_viewedge(self, x: float, y: float) -> ViewEdge:
|
|
2860
2261
|
"""Gets the ViewEdge nearest to the 2D point specified as arguments.
|
|
2861
2262
|
|
|
2862
2263
|
:param x: X coordinate of a 2D point.
|
|
2863
|
-
:type x: float
|
|
2864
2264
|
:param y: Y coordinate of a 2D point.
|
|
2865
|
-
:type y: float
|
|
2866
2265
|
:return: The ViewEdge nearest to the specified 2D point.
|
|
2867
|
-
:rtype: ViewEdge
|
|
2868
2266
|
"""
|
|
2869
2267
|
|
|
2870
2268
|
class ViewShape:
|
|
@@ -2873,75 +2271,53 @@ class ViewShape:
|
|
|
2873
2271
|
"""
|
|
2874
2272
|
|
|
2875
2273
|
edges: list[ViewEdge]
|
|
2876
|
-
""" The list of ViewEdge objects contained in this ViewShape.
|
|
2877
|
-
|
|
2878
|
-
:type: list[ViewEdge]
|
|
2879
|
-
"""
|
|
2274
|
+
""" The list of ViewEdge objects contained in this ViewShape."""
|
|
2880
2275
|
|
|
2881
2276
|
id: Id
|
|
2882
|
-
""" The Id of this ViewShape.
|
|
2883
|
-
|
|
2884
|
-
:type: Id
|
|
2885
|
-
"""
|
|
2277
|
+
""" The Id of this ViewShape."""
|
|
2886
2278
|
|
|
2887
2279
|
library_path: str | typing.Any
|
|
2888
|
-
""" The library path of the ViewShape.
|
|
2889
|
-
|
|
2890
|
-
:type: str | typing.Any
|
|
2891
|
-
"""
|
|
2280
|
+
""" The library path of the ViewShape."""
|
|
2892
2281
|
|
|
2893
2282
|
name: str
|
|
2894
|
-
""" The name of the ViewShape.
|
|
2895
|
-
|
|
2896
|
-
:type: str
|
|
2897
|
-
"""
|
|
2283
|
+
""" The name of the ViewShape."""
|
|
2898
2284
|
|
|
2899
2285
|
sshape: SShape
|
|
2900
|
-
""" The SShape on top of which this ViewShape is built.
|
|
2901
|
-
|
|
2902
|
-
:type: SShape
|
|
2903
|
-
"""
|
|
2286
|
+
""" The SShape on top of which this ViewShape is built."""
|
|
2904
2287
|
|
|
2905
2288
|
vertices: list[ViewVertex]
|
|
2906
|
-
""" The list of ViewVertex objects contained in this ViewShape.
|
|
2907
|
-
|
|
2908
|
-
:type: list[ViewVertex]
|
|
2909
|
-
"""
|
|
2289
|
+
""" The list of ViewVertex objects contained in this ViewShape."""
|
|
2910
2290
|
|
|
2911
|
-
def __init__(self):
|
|
2291
|
+
def __init__(self) -> None:
|
|
2912
2292
|
"""Builds a `ViewShape` using the default constructor,
|
|
2913
2293
|
copy constructor, or from a `SShape`.
|
|
2914
2294
|
|
|
2915
2295
|
"""
|
|
2916
2296
|
|
|
2917
|
-
def __init__(self, brother: typing_extensions.Self):
|
|
2297
|
+
def __init__(self, brother: typing_extensions.Self) -> None:
|
|
2918
2298
|
"""Builds a `ViewShape` using the default constructor,
|
|
2919
2299
|
copy constructor, or from a `SShape`.
|
|
2920
2300
|
|
|
2921
2301
|
:param brother: A ViewShape object.
|
|
2922
|
-
:type brother: typing_extensions.Self
|
|
2923
2302
|
"""
|
|
2924
2303
|
|
|
2925
|
-
def __init__(self, sshape: SShape):
|
|
2304
|
+
def __init__(self, sshape: SShape) -> None:
|
|
2926
2305
|
"""Builds a `ViewShape` using the default constructor,
|
|
2927
2306
|
copy constructor, or from a `SShape`.
|
|
2928
2307
|
|
|
2929
2308
|
:param sshape: An SShape object.
|
|
2930
|
-
:type sshape: SShape
|
|
2931
2309
|
"""
|
|
2932
2310
|
|
|
2933
|
-
def add_edge(self, edge: ViewEdge):
|
|
2311
|
+
def add_edge(self, edge: ViewEdge) -> None:
|
|
2934
2312
|
"""Adds a ViewEdge to the list of ViewEdge objects.
|
|
2935
2313
|
|
|
2936
2314
|
:param edge: A ViewEdge object.
|
|
2937
|
-
:type edge: ViewEdge
|
|
2938
2315
|
"""
|
|
2939
2316
|
|
|
2940
|
-
def add_vertex(self, vertex: ViewVertex):
|
|
2317
|
+
def add_vertex(self, vertex: ViewVertex) -> None:
|
|
2941
2318
|
"""Adds a ViewVertex to the list of the ViewVertex objects.
|
|
2942
2319
|
|
|
2943
2320
|
:param vertex: A ViewVertex object.
|
|
2944
|
-
:type vertex: ViewVertex
|
|
2945
2321
|
"""
|
|
2946
2322
|
|
|
2947
2323
|
class ViewVertex:
|
|
@@ -2957,10 +2333,7 @@ class ViewVertex:
|
|
|
2957
2333
|
"""
|
|
2958
2334
|
|
|
2959
2335
|
nature: Nature
|
|
2960
|
-
""" The nature of this ViewVertex.
|
|
2961
|
-
|
|
2962
|
-
:type: Nature
|
|
2963
|
-
"""
|
|
2336
|
+
""" The nature of this ViewVertex."""
|
|
2964
2337
|
|
|
2965
2338
|
def edges_begin(self) -> orientedViewEdgeIterator:
|
|
2966
2339
|
"""Returns an iterator over the ViewEdges that goes to or comes from
|
|
@@ -2970,7 +2343,6 @@ class ViewVertex:
|
|
|
2970
2343
|
(incoming/outgoing).
|
|
2971
2344
|
|
|
2972
2345
|
:return: An orientedViewEdgeIterator pointing to the first ViewEdge.
|
|
2973
|
-
:rtype: orientedViewEdgeIterator
|
|
2974
2346
|
"""
|
|
2975
2347
|
|
|
2976
2348
|
def edges_end(self) -> orientedViewEdgeIterator:
|
|
@@ -2978,7 +2350,6 @@ class ViewVertex:
|
|
|
2978
2350
|
ViewVertex, pointing after the last ViewEdge.
|
|
2979
2351
|
|
|
2980
2352
|
:return: An orientedViewEdgeIterator pointing after the last ViewEdge.
|
|
2981
|
-
:rtype: orientedViewEdgeIterator
|
|
2982
2353
|
"""
|
|
2983
2354
|
|
|
2984
2355
|
def edges_iterator(self, edge: ViewEdge) -> orientedViewEdgeIterator:
|
|
@@ -2986,9 +2357,7 @@ class ViewVertex:
|
|
|
2986
2357
|
as argument.
|
|
2987
2358
|
|
|
2988
2359
|
:param edge: A ViewEdge object.
|
|
2989
|
-
:type edge: ViewEdge
|
|
2990
2360
|
:return: An orientedViewEdgeIterator pointing to the given ViewEdge.
|
|
2991
|
-
:rtype: orientedViewEdgeIterator
|
|
2992
2361
|
"""
|
|
2993
2362
|
|
|
2994
2363
|
class orientedViewEdgeIterator:
|
|
@@ -3001,21 +2370,17 @@ class orientedViewEdgeIterator:
|
|
|
3001
2370
|
object: tuple[ViewEdge, bool]
|
|
3002
2371
|
""" The oriented ViewEdge (i.e., a tuple of the pointed ViewEdge and a boolean
|
|
3003
2372
|
value) currently pointed to by this iterator. If the boolean value is true,
|
|
3004
|
-
the ViewEdge is incoming.
|
|
3005
|
-
|
|
3006
|
-
:type: tuple[ViewEdge, bool]
|
|
3007
|
-
"""
|
|
2373
|
+
the ViewEdge is incoming."""
|
|
3008
2374
|
|
|
3009
|
-
def __init__(self):
|
|
2375
|
+
def __init__(self) -> None:
|
|
3010
2376
|
"""Creates an `orientedViewEdgeIterator` using either the
|
|
3011
2377
|
default constructor or the copy constructor.
|
|
3012
2378
|
|
|
3013
2379
|
"""
|
|
3014
2380
|
|
|
3015
|
-
def __init__(self, iBrother: typing_extensions.Self):
|
|
2381
|
+
def __init__(self, iBrother: typing_extensions.Self) -> None:
|
|
3016
2382
|
"""Creates an `orientedViewEdgeIterator` using either the
|
|
3017
2383
|
default constructor or the copy constructor.
|
|
3018
2384
|
|
|
3019
2385
|
:param iBrother: An orientedViewEdgeIterator object.
|
|
3020
|
-
:type iBrother: typing_extensions.Self
|
|
3021
2386
|
"""
|