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