Skip to content

Commit 1ddddb8

Browse files
ucupumarucupumar
committed
Add more descriptions to many properties
1 parent 6e5a93c commit 1ddddb8

File tree

4 files changed

+172
-53
lines changed

4 files changed

+172
-53
lines changed

‎BakeToLayer.py‎

Lines changed: 58 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -143,9 +143,19 @@ class YBakeToLayer(bpy.types.Operator, BaseBakeOperator):
143143
bl_description = "Bake something as layer/mask"
144144
bl_options = {'REGISTER', 'UNDO'}
145145

146-
name : StringProperty(default='')
146+
name : StringProperty(
147+
name = 'Image Name',
148+
description = 'Baked image name',
149+
default = ''
150+
)
151+
152+
uv_map : StringProperty(
153+
name = 'UV Map',
154+
description = 'UV Map to use for baked image coordinate',
155+
default = '',
156+
update = update_bake_to_layer_uv_map
157+
)
147158

148-
uv_map : StringProperty(default='', update=update_bake_to_layer_uv_map)
149159
uv_map_coll : CollectionProperty(type=bpy.types.PropertyGroup)
150160

151161
uv_map_1 : StringProperty(default='')
@@ -159,15 +169,19 @@ class YBakeToLayer(bpy.types.Operator, BaseBakeOperator):
159169

160170
# For choosing overwrite entity from list
161171
overwrite_choice : BoolProperty(
162-
name = 'Overwrite available layer',
163-
description = 'Overwrite available layer',
172+
name = 'Overwrite existing layer',
173+
description = 'Overwrite existing layer',
164174
default = False
165175
)
166176

167177
# For rebake button
168178
overwrite_current : BoolProperty(default=False)
169179

170-
overwrite_name : StringProperty(default='')
180+
overwrite_name : StringProperty(
181+
name = 'Overwritten Image Name',
182+
description = 'Image name that will be overwritten',
183+
default = ''
184+
)
171185
overwrite_coll : CollectionProperty(type=bpy.types.PropertyGroup)
172186

173187
overwrite_image_name : StringProperty(default='')
@@ -221,11 +235,24 @@ class YBakeToLayer(bpy.types.Operator, BaseBakeOperator):
221235
)
222236

223237
# AO Props
224-
ao_distance : FloatProperty(default=1.0)
238+
ao_distance : FloatProperty(
239+
name = 'AO Distance',
240+
description = 'Ambient occlusion distance',
241+
default = 1.0
242+
)
225243

226244
# Bevel Props
227-
bevel_samples : IntProperty(default=4, min=2, max=16)
228-
bevel_radius : FloatProperty(default=0.05, min=0.0, max=1000.0)
245+
bevel_samples : IntProperty(
246+
name = 'Bevel Samples',
247+
description = 'Bevel samples',
248+
default=4, min=2, max=16
249+
)
250+
251+
bevel_radius : FloatProperty(
252+
name = 'Bevel Radius',
253+
description = 'Bevel distance radius',
254+
default=0.05, min=0.0, max=1000.0
255+
)
229256

230257
edge_detect_method : EnumProperty(
231258
name = 'Edge Detection Method',
@@ -284,6 +311,7 @@ class YBakeToLayer(bpy.types.Operator, BaseBakeOperator):
284311

285312
normal_blend_type : EnumProperty(
286313
name = 'Normal Blend Type',
314+
description = 'Normal blend type',
287315
items = normal_blend_items,
288316
default = 'MIX'
289317
)
@@ -294,7 +322,11 @@ class YBakeToLayer(bpy.types.Operator, BaseBakeOperator):
294322
items = Layer.get_normal_map_type_items
295323
)
296324

297-
hdr : BoolProperty(name='32 bit Float', default=True)
325+
hdr : BoolProperty(
326+
name = '32-bit Float',
327+
description = 'Use 32-bit float image',
328+
default = True
329+
)
298330

299331
use_baked_disp : BoolProperty(
300332
name = 'Use Displacement Setup',
@@ -918,12 +950,26 @@ class YBakeEntityToImage(bpy.types.Operator, BaseBakeOperator):
918950
bl_description = "Bake Layer/Mask to an image"
919951
bl_options = {'UNDO'}
920952

921-
name : StringProperty(default='')
953+
name : StringProperty(
954+
name = 'Image Name',
955+
description = 'Baked Image Name',
956+
default = ''
957+
)
958+
959+
uv_map : StringProperty(
960+
name = 'UV Map',
961+
description = 'UV Map to use for baked image coordinate',
962+
default = '',
963+
update = update_bake_to_layer_uv_map
964+
)
922965

923-
uv_map : StringProperty(default='', update=update_bake_to_layer_uv_map)
924966
uv_map_coll : CollectionProperty(type=bpy.types.PropertyGroup)
925967

926-
hdr : BoolProperty(name='32 bit Float', default=False)
968+
hdr : BoolProperty(
969+
name = '32-bit Float',
970+
description = 'Use 32-bit float image',
971+
default = False
972+
)
927973

928974
fxaa : BoolProperty(
929975
name = 'Use FXAA',

‎Layer.py‎

Lines changed: 73 additions & 23 deletions
Original file line numberDiff line numberDiff line change
@@ -593,7 +593,7 @@ class YNewVDMLayer(bpy.types.Operator):
593593
bl_description = "New Vector Displacement Layer"
594594
bl_options = {'UNDO'}
595595

596-
name : StringProperty(default='')
596+
name : StringProperty(name='Layer Name', default='')
597597

598598
width : IntProperty(name='Width', default=1024, min=1, max=16384)
599599
height : IntProperty(name='Height', default=1024, min=1, max=16384)
@@ -629,7 +629,10 @@ class YNewVDMLayer(bpy.types.Operator):
629629
)
630630

631631
# NOTE: UDIM is not supported yet, so no UDIM checking
632-
uv_map : StringProperty(default='') #, update=update_new_layer_uv_map)
632+
uv_map : StringProperty(
633+
name = 'UV Map',
634+
description = 'UV Map to use for layer coordinate',
635+
default = '') #, update=update_new_layer_uv_map)
633636
uv_map_coll : CollectionProperty(type=bpy.types.PropertyGroup)
634637

635638
@classmethod
@@ -819,7 +822,7 @@ class YNewLayer(bpy.types.Operator):
819822
bl_description = "New Layer"
820823
bl_options = {'REGISTER', 'UNDO'}
821824

822-
name : StringProperty(default='')
825+
name : StringProperty(name='Layer Name', default='')
823826

824827
type : EnumProperty(
825828
name = 'Layer Type',
@@ -832,7 +835,11 @@ class YNewLayer(bpy.types.Operator):
832835
height : IntProperty(name='Height', default=1024, min=1, max=16384)
833836
#color : FloatVectorProperty(name='Color', size=4, subtype='COLOR', default=(0.0,0.0,0.0,0.0), min=0.0, max=1.0)
834837
#alpha : BoolProperty(name='Alpha', default=True)
835-
hdr : BoolProperty(name='32 bit Float', default=False)
838+
hdr : BoolProperty(
839+
name = '32-bit Float',
840+
description = 'Use 32-bit float image',
841+
default = False
842+
)
836843

837844
interpolation : EnumProperty(
838845
name = 'Image Interpolation Type',
@@ -863,6 +870,7 @@ class YNewLayer(bpy.types.Operator):
863870

864871
normal_blend_type : EnumProperty(
865872
name = 'Normal Blend Type',
873+
description = 'Normal blend type',
866874
items = normal_blend_items,
867875
default = 'MIX'
868876
)
@@ -931,8 +939,17 @@ class YNewLayer(bpy.types.Operator):
931939
default = 'UV'
932940
)
933941

934-
mask_uv_name : StringProperty(default='', update=update_new_layer_mask_uv_map)
935-
mask_use_hdr : BoolProperty(name='32 bit Float', default=False)
942+
mask_uv_name : StringProperty(
943+
name='UV Map for Mask',
944+
description = 'UV Map to use for mask coordinate',
945+
default='', update=update_new_layer_mask_uv_map
946+
)
947+
948+
mask_use_hdr : BoolProperty(
949+
name = '32-bit Float',
950+
description = 'Use 32-bit float image for mask',
951+
default = False
952+
)
936953

937954
mask_color_id : FloatVectorProperty(
938955
name = 'Color ID',
@@ -957,7 +974,12 @@ class YNewLayer(bpy.types.Operator):
957974

958975
mask_relative : BoolProperty(name="Relative Mask Path", default=True, description="Apply relative paths")
959976

960-
uv_map : StringProperty(default='', update=update_new_layer_uv_map)
977+
uv_map : StringProperty(
978+
name = 'UV Map',
979+
description = 'UV Map to use for layer coordinate',
980+
default = '',
981+
update = update_new_layer_uv_map
982+
)
961983

962984
normal_map_type : EnumProperty(
963985
name = 'Normal Map Type',
@@ -1038,7 +1060,7 @@ class YNewLayer(bpy.types.Operator):
10381060

10391061
# For edge detection
10401062
edge_detect_radius : FloatProperty(
1041-
name = 'Detect Mask Radius',
1063+
name = 'Edge Detect Radius',
10421064
description = 'Edge detect radius',
10431065
default=0.05, min=0.0, max=10.0
10441066
)
@@ -1990,7 +2012,10 @@ class BaseMultipleImagesLayer(BaseOperator.OpenImage):
19902012
default = 'UV'
19912013
)
19922014

1993-
uv_map : StringProperty(default='')
2015+
uv_map : StringProperty(
2016+
name = 'UV Map',
2017+
description = 'UV Map to use for layer coordinate',
2018+
default = '')
19942019
uv_map_coll : CollectionProperty(type=bpy.types.PropertyGroup)
19952020

19962021
add_mask : BoolProperty(
@@ -2034,8 +2059,17 @@ class BaseMultipleImagesLayer(BaseOperator.OpenImage):
20342059
default = False
20352060
)
20362061

2037-
mask_uv_name : StringProperty(default='', update=update_new_layer_mask_uv_map)
2038-
mask_use_hdr : BoolProperty(name='32 bit Float', default=False)
2062+
mask_uv_name : StringProperty(
2063+
name='UV Map for Mask',
2064+
description = 'UV Map to use for mask coordinate',
2065+
default='', update=update_new_layer_mask_uv_map
2066+
)
2067+
2068+
mask_use_hdr : BoolProperty(
2069+
name = '32-bit Float',
2070+
description = 'Use 32-bit float image for mask',
2071+
default = False
2072+
)
20392073

20402074
use_udim_for_mask : BoolProperty(
20412075
name = 'Use UDIM Tiles for Mask',
@@ -2528,7 +2562,7 @@ class YOpenImagesFromMaterialToLayer(bpy.types.Operator, ImportHelper, BaseMulti
25282562
bl_description = "Open images inside material node tree to single " + get_addon_title() + " layer"
25292563
bl_options = {'REGISTER', 'UNDO'}
25302564

2531-
mat_name : StringProperty(default='')
2565+
mat_name : StringProperty(name='Material', default='')
25322566
mat_coll : CollectionProperty(type=bpy.types.PropertyGroup)
25332567
asset_library_path : StringProperty(default='')
25342568

@@ -2756,7 +2790,7 @@ class YOpenLayersFromMaterial(bpy.types.Operator):
27562790
bl_description = "Open layers from material to current " + get_addon_title() + " material"
27572791
bl_options = {'REGISTER', 'UNDO'}
27582792

2759-
mat_name : StringProperty(default='')
2793+
mat_name : StringProperty(name='Material', default='')
27602794
asset_library_path : StringProperty(default='')
27612795

27622796
@classmethod
@@ -2898,7 +2932,11 @@ class YOpenImageToLayer(bpy.types.Operator, ImportHelper, BaseOperator.OpenImage
28982932
default = 'UV'
28992933
)
29002934

2901-
uv_map : StringProperty(default='')
2935+
uv_map : StringProperty(
2936+
name = 'UV Map',
2937+
description = 'UV Map to use for layer coordinate',
2938+
default = ''
2939+
)
29022940

29032941
channel_idx : EnumProperty(
29042942
name = 'Channel',
@@ -2914,6 +2952,7 @@ class YOpenImageToLayer(bpy.types.Operator, ImportHelper, BaseOperator.OpenImage
29142952

29152953
normal_blend_type : EnumProperty(
29162954
name = 'Normal Blend Type',
2955+
description = 'Normal blend type',
29172956
items = normal_blend_items,
29182957
default = 'MIX'
29192958
)
@@ -3426,7 +3465,11 @@ class YOpenExistingDataToLayer(bpy.types.Operator):
34263465
default = 'UV'
34273466
)
34283467

3429-
uv_map : StringProperty(default='')
3468+
uv_map : StringProperty(
3469+
name = 'UV Map',
3470+
description = 'UV Map to use for layer coordinate',
3471+
default = ''
3472+
)
34303473

34313474
channel_idx : EnumProperty(
34323475
name = 'Channel',
@@ -3442,6 +3485,7 @@ class YOpenExistingDataToLayer(bpy.types.Operator):
34423485

34433486
normal_blend_type : EnumProperty(
34443487
name = 'Normal Blend Type',
3488+
description = 'Normal blend type',
34453489
items = normal_blend_items,
34463490
default = 'MIX'
34473491
)
@@ -4596,9 +4640,11 @@ class YSetLayerChannelNormalBlendType(bpy.types.Operator):
45964640
bl_options = {'UNDO'}
45974641

45984642
normal_blend_type : EnumProperty(
4599-
name = 'Normal Blend Type',
4600-
items = normal_blend_items,
4601-
default = 'MIX')
4643+
name = 'Normal Blend Type',
4644+
description = 'Normal blend type',
4645+
items = normal_blend_items,
4646+
default = 'MIX'
4647+
)
46024648

46034649
@classmethod
46044650
def poll(cls, context):
@@ -7213,15 +7259,15 @@ class YLayer(bpy.types.PropertyGroup, Decal.BaseDecal):
72137259
baked_segment_name : StringProperty(default='')
72147260

72157261
uv_name : StringProperty(
7216-
name = 'UV Name',
7217-
description = 'UV Name to use for layer coordinate',
7262+
name = 'UV Map',
7263+
description = 'UV Map to use for layer coordinate',
72187264
default = '',
72197265
update = update_uv_name
72207266
)
72217267

72227268
baked_uv_name : StringProperty(
7223-
name = 'Baked UV Name',
7224-
description = 'UV Name to use for layer coordinate',
7269+
name = 'Baked UV Map',
7270+
description = 'UV Map to use for layer coordinate',
72257271
default = ''
72267272
)
72277273

@@ -7313,7 +7359,11 @@ class YLayer(bpy.types.PropertyGroup, Decal.BaseDecal):
73137359
# UV
73147360
uv_neighbor : StringProperty(default='')
73157361
uv_neighbor_1 : StringProperty(default='')
7316-
uv_map : StringProperty(default='')
7362+
uv_map : StringProperty(
7363+
name = 'UV Map',
7364+
description = 'UV Map to use for layer coordinate',
7365+
default = ''
7366+
)
73177367
mapping : StringProperty(default='')
73187368
baked_mapping : StringProperty(default='')
73197369
texcoord : StringProperty(default='')

0 commit comments

Comments
 (0)