Provide descriptions to all operators that use fileselect_add #6420

I guess all it takes a persistent Blender crash to fill up operators descriptions 😅
This commit is contained in:
Andrej730
2025-03-24 11:33:10 +05:00
parent c84f8e55a6
commit 595ee3fa47
14 changed files with 31 additions and 1 deletions
@@ -66,6 +66,7 @@ class NewBcfProject(bpy.types.Operator):
class LoadBcfProject(bpy.types.Operator):
bl_idname = "bim.load_bcf_project"
bl_label = "Load BCF Project"
bl_description = "Load the BCF file."
bl_options = {"REGISTER", "UNDO"}
filepath: bpy.props.StringProperty(subtype="FILE_PATH", options={"SKIP_SAVE"})
filter_glob: bpy.props.StringProperty(default="*.bcf;*.bcfzip", options={"HIDDEN"})
@@ -344,6 +345,7 @@ class EditBcfTopic(bpy.types.Operator):
class SaveBcfProject(bpy.types.Operator):
bl_idname = "bim.save_bcf_project"
bl_label = "Save BCF Project"
bl_description = "Save active BCF project by the provided filepath."
bl_options = {"REGISTER", "UNDO"}
filepath: bpy.props.StringProperty(subtype="FILE_PATH")
filter_glob: bpy.props.StringProperty(default="*.bcf;*.bcfzip", options={"HIDDEN"})
@@ -1537,6 +1539,7 @@ class OpenBcfReferenceLink(bpy.types.Operator):
class SelectBcfHeaderFile(bpy.types.Operator):
bl_idname = "bim.select_bcf_header_file"
bl_label = "Select BCF Header File"
bl_description = "Select filepath for BCF header reference."
bl_options = {"REGISTER", "UNDO"}
filepath: bpy.props.StringProperty(subtype="FILE_PATH")
filter_glob: bpy.props.StringProperty(default="*.ifc;*.ifczip;*.ifcxml;*.ifcjson", options={"HIDDEN"})
@@ -1555,6 +1558,7 @@ class SelectBcfHeaderFile(bpy.types.Operator):
class SelectBcfBimSnippetReference(bpy.types.Operator):
bl_idname = "bim.select_bcf_bim_snippet_reference"
bl_label = "Select BCF BIM Snippet Reference"
bl_description = "Select filepath for BCF snippet reference."
bl_options = {"REGISTER", "UNDO"}
filepath: bpy.props.StringProperty(subtype="FILE_PATH")
@@ -1572,6 +1576,7 @@ class SelectBcfBimSnippetReference(bpy.types.Operator):
class SelectBcfDocumentReference(bpy.types.Operator):
bl_idname = "bim.select_bcf_document_reference"
bl_label = "Select BCF Document Reference"
bl_description = "Select filepath for BCF document reference."
bl_options = {"REGISTER", "UNDO"}
filepath: bpy.props.StringProperty(subtype="FILE_PATH")
@@ -243,6 +243,8 @@ class RemoveBrick(bpy.types.Operator, tool.Ifc.Operator):
class SerializeBrick(bpy.types.Operator):
bl_idname = "bim.serialize_brick"
bl_label = "Serialize Brick"
# Prevents crash on Blender 4.4.0.
bl_description = "Save active Brick project by the provided filepath."
filter_glob: bpy.props.StringProperty(default="*.ttl", options={"HIDDEN"})
filepath: bpy.props.StringProperty(subtype="FILE_PATH")
should_save_as: bpy.props.BoolProperty(name="Should Save As", default=False, options={"HIDDEN"})
@@ -173,6 +173,7 @@ class SelectClashSource(bpy.types.Operator):
class SelectClashResults(bpy.types.Operator):
bl_idname = "bim.select_clash_results"
bl_label = "Select Clash Results"
bl_description = "Select filepath for clash results."
bl_options = {"REGISTER", "UNDO"}
filepath: bpy.props.StringProperty(subtype="FILE_PATH")
@@ -188,6 +189,7 @@ class SelectClashResults(bpy.types.Operator):
class SelectSmartGroupedClashesPath(bpy.types.Operator):
bl_idname = "bim.select_smart_grouped_clashes_path"
bl_label = "Select Smart-Grouped Clashes Path"
bl_description = "Select filepath for smart-grouped clashes."
bl_options = {"REGISTER", "UNDO"}
filepath: bpy.props.StringProperty(subtype="FILE_PATH")
@@ -31,6 +31,7 @@ from bonsai.bim.ifc import IfcStore
class LoadClassificationLibrary(bpy.types.Operator, tool.Ifc.Operator):
bl_idname = "bim.load_classification_library"
bl_label = "Load Classification Library"
bl_description = "Load classification library from the provided filepath."
filename_ext = ".ifc"
filter_glob: bpy.props.StringProperty(default="*.ifc;*.ifczip;*.ifcxml", options={"HIDDEN"})
filepath: bpy.props.StringProperty(subtype="FILE_PATH")
@@ -185,6 +185,7 @@ class ExportCsvAttributes(bpy.types.Operator):
class ExportIfcCsv(bpy.types.Operator):
bl_idname = "bim.export_ifccsv"
bl_label = "Export IFC"
bl_description = "Export IFC data as a spreadsheet."
filename_ext = ".csv"
filepath: bpy.props.StringProperty(subtype="FILE_PATH")
@@ -290,6 +291,7 @@ class ExportIfcCsv(bpy.types.Operator):
class ImportIfcCsv(bpy.types.Operator, tool.Ifc.Operator):
bl_idname = "bim.import_ifccsv"
bl_label = "Import to IFC"
bl_description = "Import IFC data from a spreadsheet."
bl_options = {"REGISTER", "UNDO"}
filter_glob: bpy.props.StringProperty(default="*.csv;*.ods;*.xlsx", options={"HIDDEN"})
filepath: bpy.props.StringProperty(subtype="FILE_PATH")
@@ -340,6 +342,7 @@ class ImportIfcCsv(bpy.types.Operator, tool.Ifc.Operator):
class SelectCsvIfcFile(bpy.types.Operator):
bl_idname = "bim.select_csv_ifc_file"
bl_label = "Select CSV IFC File"
bl_description = "Select IFC file for spreadsheet import/export."
bl_options = {"REGISTER", "UNDO"}
filename_ext = ".ifc"
filter_glob: bpy.props.StringProperty(default="*.ifc;*.ifczip;*.ifcxml", options={"HIDDEN"})
@@ -30,6 +30,7 @@ from bonsai.bim.ifc import IfcStore
class SelectDiffJsonFile(bpy.types.Operator):
bl_idname = "bim.select_diff_json_file"
bl_label = "Select Diff JSON File"
bl_description = "Select filepath for IFC diff results."
bl_options = {"REGISTER", "UNDO"}
filepath: bpy.props.StringProperty(subtype="FILE_PATH")
filter_glob: bpy.props.StringProperty(default="*.json", options={"HIDDEN"})
@@ -104,6 +105,7 @@ class VisualiseDiff(bpy.types.Operator):
class SelectDiffOldFile(bpy.types.Operator):
bl_idname = "bim.select_diff_old_file"
bl_label = "Select Diff Old File"
bl_description = "Select filepath for an old IFC file to compare."
bl_options = {"REGISTER", "UNDO"}
filepath: bpy.props.StringProperty(subtype="FILE_PATH")
filter_glob: bpy.props.StringProperty(default="*.ifc", options={"HIDDEN"})
@@ -120,6 +122,7 @@ class SelectDiffOldFile(bpy.types.Operator):
class SelectDiffNewFile(bpy.types.Operator):
bl_idname = "bim.select_diff_new_file"
bl_label = "Select Diff New File"
bl_description = "Select filepath for a new IFC file to compare."
bl_options = {"REGISTER", "UNDO"}
filepath: bpy.props.StringProperty(subtype="FILE_PATH")
filter_glob: bpy.props.StringProperty(default="*.ifc", options={"HIDDEN"})
@@ -136,6 +139,7 @@ class SelectDiffNewFile(bpy.types.Operator):
class ExecuteIfcDiff(bpy.types.Operator):
bl_idname = "bim.execute_ifc_diff"
bl_label = "Execute IFC Diff"
bl_description = "Compare two IFC files and save a json diff report by the provided filepath."
filename_ext = ".json"
filepath: bpy.props.StringProperty(subtype="FILE_PATH")
filter_glob: bpy.props.StringProperty(default="*.json", options={"HIDDEN"})
@@ -2216,6 +2216,7 @@ class ActivateDrawingFromSheet(bpy.types.Operator, ActivateDrawingBase):
return True
# TODO: not exposed to the UI.
class SelectDocIfcFile(bpy.types.Operator):
bl_idname = "bim.select_doc_ifc_file"
bl_label = "Select Documentation IFC File"
@@ -29,6 +29,7 @@ import bonsai.tool as tool
class ExecuteIfcFM(bpy.types.Operator):
bl_idname = "bim.execute_ifcfm"
bl_label = "Execute IfcFM"
bl_description = "Export IfcFM data as a spreadsheet."
file_format: bpy.props.StringProperty()
filter_glob: bpy.props.StringProperty(default="*.csv;*.ods;*.xlsx", options={"HIDDEN"})
filepath: bpy.props.StringProperty(subtype="FILE_PATH")
@@ -85,6 +86,7 @@ class ExecuteIfcFM(bpy.types.Operator):
class SelectFMSpreadsheetFiles(bpy.types.Operator):
bl_idname = "bim.select_fm_spreadsheet_files"
bl_label = "Select FM Spreadsheet Files"
bl_description = "Select FM spreadsheets to merge."
bl_options = {"REGISTER", "UNDO"}
filter_glob: bpy.props.StringProperty(default="*.ods;*.xlsx", options={"HIDDEN"})
filepath: bpy.props.StringProperty(subtype="FILE_PATH")
@@ -107,6 +109,7 @@ class SelectFMSpreadsheetFiles(bpy.types.Operator):
class ExecuteIfcFMFederate(bpy.types.Operator):
bl_idname = "bim.execute_ifcfm_federate"
bl_label = "Merge IfcFM SpreadSheets"
bl_description = "Merge added IfcFM spreadsheets."
filter_glob: bpy.props.StringProperty(default="*.ods;*.xlsx", options={"HIDDEN"})
filepath: bpy.props.StringProperty(subtype="FILE_PATH")
@@ -91,7 +91,7 @@ class ImportPlot(bpy.types.Operator, tool.Ifc.Operator):
bl_idname = "bim.import_plot"
bl_label = "Import Plot"
bl_options = {"REGISTER", "UNDO"}
bl_description = "Import plot"
bl_description = "Import plot from a csv file."
filepath: bpy.props.StringProperty(subtype="FILE_PATH")
filter_glob: bpy.props.StringProperty(default="*.csv", options={"HIDDEN"})
@@ -184,6 +184,7 @@ class UpdateDataFromSverchok(bpy.types.Operator, tool.Ifc.Operator):
class ImportSverchokGraph(bpy.types.Operator, tool.Ifc.Operator):
bl_idname = "bim.import_sverchok_graph"
bl_label = "Import Sverchok Graph"
bl_description = "Import Sverchok graph from a json file."
bl_options = {"REGISTER"}
filepath: bpy.props.StringProperty(
@@ -226,6 +227,7 @@ class ImportSverchokGraph(bpy.types.Operator, tool.Ifc.Operator):
class ExportSverchokGraph(bpy.types.Operator, tool.Ifc.Operator):
bl_idname = "bim.export_sverchok_graph"
bl_label = "Export Sverchok Graph"
bl_description = "Export Sverchok graph to a json file."
bl_options = {"REGISTER"}
filepath: bpy.props.StringProperty(
@@ -34,6 +34,7 @@ if TYPE_CHECKING:
class SelectIfcPatchInput(bpy.types.Operator):
bl_idname = "bim.select_ifc_patch_input"
bl_label = "Select IFC Patch Input"
bl_description = "Select filepath for IFC patch input."
bl_options = {"REGISTER", "UNDO"}
filter_glob: bpy.props.StringProperty(default="*.ifc;*.ifcZIP;*.ifcXML", options={"HIDDEN"})
filepath: bpy.props.StringProperty(subtype="FILE_PATH")
@@ -51,6 +52,7 @@ class SelectIfcPatchInput(bpy.types.Operator):
class SelectIfcPatchOutput(bpy.types.Operator):
bl_idname = "bim.select_ifc_patch_output"
bl_label = "Select IFC Patch Output"
bl_description = "Select filepath for IFC patch output."
bl_options = {"REGISTER", "UNDO"}
filename_ext = ".ifc"
filepath: bpy.props.StringProperty(subtype="FILE_PATH")
@@ -1547,6 +1547,8 @@ class SelectLinkHandle(bpy.types.Operator):
class ExportIFC(bpy.types.Operator):
bl_idname = "bim.save_project"
bl_label = "Save IFC"
# Prevents crash on Blender 4.4.0.
bl_description = "Save active IFC file by the provided filepath."
bl_options = {"REGISTER", "UNDO"}
filename_ext = ".ifc"
filter_glob: bpy.props.StringProperty(default="*.ifc;*.ifczip;*.ifcxml;*.ifcjson", options={"HIDDEN"})
@@ -276,6 +276,7 @@ class SetAssetMaterialToExternalStyle(bpy.types.Operator):
class BrowseExternalStyle(bpy.types.Operator):
bl_idname = "bim.browse_external_style"
bl_label = "Browse External Style"
bl_description = "Select filepath for an external style."
bl_options = {"REGISTER", "UNDO"}
filepath: bpy.props.StringProperty(
@@ -540,6 +541,7 @@ class SelectByStyle(bpy.types.Operator):
class ChooseTextureMapPath(bpy.types.Operator):
bl_idname = "bim.choose_texture_map_path"
bl_label = "Choose Texture Map Path"
bl_description = "Select filepath for a texture map."
bl_options = {"REGISTER", "UNDO", "INTERNAL"}
texture_map_index: bpy.props.IntProperty(default=-1, options={"SKIP_SAVE"})
@@ -189,6 +189,7 @@ class SelectFailedEntities(bpy.types.Operator):
class ExportBcf(bpy.types.Operator):
bl_idname = "bim.export_bcf"
bl_label = "Export BCF"
bl_description = "Save ifctester BCF report by the provided filepath."
bl_options = {"REGISTER", "UNDO"}
filter_glob: bpy.props.StringProperty(default="*.bcf", options={"HIDDEN"})
filepath: bpy.props.StringProperty(subtype="FILE_PATH")