Add Tooltips

oscurart_tools/oscurart_animation.py

@@ -54,6 +54,7 @@ def DefQuickParent(inf, out):
 
 
 class QuickParent (bpy.types.Operator):
+    """Creates a parent from one object to other in a selected frame range."""
     bl_idname = "anim.quick_parent_osc"
     bl_label = "Quick Parent"
     bl_options = {"REGISTER", "UNDO"}

oscurart_tools/oscurart_files.py

@@ -27,6 +27,7 @@ import os
 
 
 class reloadImages (Operator):
+    """Reloads all bitmaps in the scene."""
     bl_idname = "image.reload_images_osc"
     bl_label = "Reload Images"
     bl_options = {"REGISTER", "UNDO"}
@@ -40,6 +41,7 @@ class reloadImages (Operator):
 # ------------------------ SAVE INCREMENTAL ------------------------
 
 class saveIncremental(Operator):
+    """Saves incremental version of the blend file Ex: “_v01” "_v02"."""
     bl_idname = "file.save_incremental_osc"
     bl_label = "Save Incremental File"
     bl_options = {"REGISTER", "UNDO"}
@@ -70,6 +72,7 @@ bpy.types.Scene.oscReplaceText = bpy.props.StringProperty(
 
 
 class replaceFilePath(Operator):
+    """Replace the paths set on the “search test” field by the ones in “replace” field. "_v01" »» "_v02" /folder1/render_v01.png  »» /folder1/render_v02.png"""
     bl_idname = "file.replace_file_path_osc"
     bl_label = "Replace File Path"
     bl_options = {"REGISTER", "UNDO"}
@@ -87,6 +90,7 @@ class replaceFilePath(Operator):
 # ---------------------- SYNC MISSING GROUPS --------------------------
 
 class reFreshMissingGroups(Operator):
+    """Search on the libraries of the linked source and relink groups and link newones if there are. Usefull to use with the mesh cache tools."""
     bl_idname = "file.sync_missing_groups"
     bl_label = "Sync Missing Groups"
     bl_options = {"REGISTER", "UNDO"}

oscurart_tools/oscurart_meshes.py

@@ -77,6 +77,7 @@ def defReconst(self, OFFSET):
 
 
 class reConst (Operator):
+    """Erase vertices bellow cero X position value and rebuilds the symmetry. It also creates two uv channels, one simmetrical and one asymmetrical."""
     bl_idname = "mesh.reconst_osc"
     bl_label = "ReConst Mesh"
     bl_options = {"REGISTER", "UNDO"}
@@ -120,6 +121,7 @@ def side(self, nombre, offset):
 
 
 class SelectMenor (Operator):
+    """Selects the vetex with an N position value on the X axis."""
     bl_idname = "mesh.select_side_osc"
     bl_label = "Select Side"
     bl_options = {"REGISTER", "UNDO"}
@@ -149,6 +151,7 @@ class SelectMenor (Operator):
 
 
 class resymVertexGroups (Operator):
+    """Copies the symetrical weight value of the vertices on the X axys. It needs the XML map."""
     bl_idname = "mesh.resym_vertex_weights_osc"
     bl_label = "Resym Vertex Weights"
     bl_options = {"REGISTER", "UNDO"}
@@ -251,6 +254,7 @@ def reSymMesh(self, SELECTED, SIDE):
 
 
 class OscResymSave (Operator):
+    """Creates a file on disk that saves the info of every vertex but in simmetry, this info its going to be later used by “Resym Mesh” and “Resym Vertex Weights” """
     bl_idname = "mesh.resym_save_map"
     bl_label = "Resym save XML Map"
     bl_options = {"REGISTER", "UNDO"}
@@ -271,6 +275,7 @@ class OscResymSave (Operator):
 
 
 class OscResymMesh (Operator):
+    """Copies the symetrical position of the vertices on the X axys. It needs the XML map."""
     bl_idname = "mesh.resym_mesh"
     bl_label = "Resym save Apply XML"
     bl_options = {"REGISTER", "UNDO"}
@@ -310,11 +315,11 @@ def DefOscObjectToMesh():
 
 
 class OscObjectToMesh(Operator):
+    """It creates a copy of the final state of the object as it being see in the viewport."""
     bl_idname = "mesh.object_to_mesh_osc"
     bl_idname = "mesh.object_to_mesh_osc"
     bl_label = "Object To Mesh"
     bl_label = "Object To Mesh"
-    bl_description = "Works on Meshes, Meta objects, Curves and Surfaces"
 
     
     @classmethod
@@ -386,6 +391,7 @@ def DefOscOverlapUv(valpresicion):
 
 
 class OscOverlapUv(Operator):
+    """Overlaps the uvs on one side of the model symmetry plane. Usefull to get more detail on fixed resolution bitmaps."""
     bl_idname = "mesh.overlap_uv_faces"
     bl_label = "Overlap Uvs"
     bl_options = {"REGISTER", "UNDO"}
@@ -426,6 +432,7 @@ def dibuja_callback(self, context):
 
 
 class ModalIndexOperator(Operator):
+    """Allow to visualize the index number for vertices in the viewport."""
     bl_idname = "view3d.modal_operator"
     bl_label = "Print Vertices"
 
@@ -491,6 +498,7 @@ def SelDoubles(self, context):
     
 
 class SelectDoubles(Operator):
+    """Selects duplicated vertex without merge them."""
     bl_idname = "mesh.select_doubles"
     bl_label = "Select Doubles"
     bl_options = {"REGISTER", "UNDO"}

oscurart_tools/oscurart_objects.py

@@ -28,6 +28,7 @@ from bpy_extras.object_utils import world_to_camera_view
 
 
 class SearchAndSelectOt(bpy.types.Operator):
+    """Search and select objects, by name."""
     bl_idname = "object.search_and_select_osc"
     bl_label = "Search And Select"
     bl_options = {"REGISTER", "UNDO"}
@@ -58,6 +59,7 @@ bpy.types.Scene.RenameObjectOt = bpy.props.StringProperty(default="Type here")
 
 
 class renameObjectsOt (Operator):
+    """Batch rename objects, supports selection order."""
     bl_idname = "object.rename_objects_osc"
     bl_label = "Rename Objects"
     bl_options = {"REGISTER", "UNDO"}
@@ -74,6 +76,7 @@ class renameObjectsOt (Operator):
 # ---------------------------REMOVE MODIFIERS Y APPLY MODIFIERS-----------
 
 class oscRemModifiers (Operator):
+    """Removes all modifiers in the selected objects."""
     bl_idname = "object.modifiers_remove_osc"
     bl_label = "Remove modifiers"
     bl_options = {"REGISTER", "UNDO"}
@@ -88,6 +91,7 @@ class oscRemModifiers (Operator):
 
 
 class oscApplyModifiers (Operator):
+    """Applys all the modifiers in the selected objects.(This does not work in objects with shapekeys)."""
     bl_idname = "object.modifiers_apply_osc"
     bl_label = "Apply modifiers"
     bl_options = {"REGISTER", "UNDO"}
@@ -157,6 +161,7 @@ def relinkObjects(self):
 
 
 class OscRelinkObjectsBetween (Operator):
+    """Copies from the selected object the scenes where this is. Its similar to "Objects to Scene"."""
     bl_idname = "object.relink_objects_between_scenes"
     bl_label = "Relink Objects Between Scenes"
     bl_options = {"REGISTER", "UNDO"}
@@ -206,6 +211,7 @@ def CopyObjectGroupsAndLayers(self):
 
 
 class OscCopyObjectGAL (Operator):
+    """Copies to scenes the layers setup in the active scene of the selected object."""
     bl_idname = "object.copy_objects_groups_layers"
     bl_label = "Copy Groups And Layers"
     bl_options = {"REGISTER", "UNDO"}
@@ -284,6 +290,7 @@ def ObjectDistributeOscurart(self, X, Y, Z):
 
 
 class DialogDistributeOsc(Operator):
+    """Distribute evenly the selected objects in x y z""" 
     bl_idname = "object.distribute_osc"
     bl_label = "Distribute Objects"
     Boolx = BoolProperty(name="X")
@@ -320,6 +327,7 @@ def DefSetLayersToOtherScenes():
 
 
 class SetLayersToOtherScenes (Operator):
+    """Copies to scenes the layers setup in the active scene of the selected object."""
     bl_idname = "object.set_layers_to_other_scenes"
     bl_label = "Copy actual Layers to Other Scenes"
     bl_options = {"REGISTER", "UNDO"}
@@ -368,6 +376,7 @@ def DefRenderOnlyInCamera():
 
 
 class RenderOnlyInCamera (Operator):
+    """Create two different groups, one group contains the objetcs that are in the camera frame, those that camera can see, and then a second group that contains the object that the camera can`t see."""
     bl_idname = "group.group_in_out_camera"
     bl_label = "Make a group for objects in outer camera"
     bl_options = {"REGISTER", "UNDO"}
@@ -499,6 +508,7 @@ def duplicateSymmetrical(self, disconect):
 
 
 class oscDuplicateSymmetricalOp (Operator):
+    """Creates a symmetrical copy on the X axys, also Links by drivers position, rotation and scale."""
     bl_idname = "object.duplicate_object_symmetry_osc"
     bl_label = "Oscurart Duplicate Symmetrical"
     bl_options = {"REGISTER", "UNDO"}
@@ -526,6 +536,7 @@ def DefObjectToGroups():
 
 
 class ObjectsToGroups (Operator):
+    """Creates a group("_MESH") containing all the mesh type objects in the scene. Creates a group(“object_name”) per mesh type object."""
     bl_idname = "object.objects_to_groups"
     bl_label = "Objects to Groups"
     bl_options = {"REGISTER", "UNDO"}

oscurart_tools/oscurart_overrides.py

@@ -62,6 +62,7 @@ def DefOscRestoreOverrides(self):
 # HAND OPERATOR
 
 class OscApplyOverrides(Operator):
+    """>>>Danger Option<<<  Apply and restore override materials, similar as ON/OFF its basically the same, save before try it."""
     bl_idname = "render.apply_overrides"
     bl_label = "Apply Overrides in this Scene"
     bl_options = {"REGISTER", "UNDO"}
@@ -72,6 +73,7 @@ class OscApplyOverrides(Operator):
 
 
 class OscRestoreOverrides(Operator):
+    """>>>Danger Option<<<  Apply and restore override materials, similar as ON/OFF its basically the same, save before try it."""
     bl_idname = "render.restore_overrides"
     bl_label = "Restore Overrides in this Scene"
     bl_options = {"REGISTER", "UNDO"}
@@ -84,6 +86,7 @@ bpy.use_overrides = False
 
 
 class OscOverridesOn(Operator):
+    """>>>Danger Option<<< its recommended to save before try it, it replace all materials by the override materials, its posible once active to see the objects rendering as override render by pressing F12."""
     bl_idname = "render.overrides_on"
     bl_label = "Turn On Overrides"
     bl_options = {"REGISTER", "UNDO"}
@@ -105,6 +108,7 @@ class OscOverridesOn(Operator):
 # -------------------- CHECK OVERRIDES -------------------
 
 class OscCheckOverrides(Operator):
+    """Check all overrides to verify if there is all set up properly, info its display in the console."""
     bl_idname = "render.check_overrides"
     bl_label = "Check Overrides"
     bl_options = {"REGISTER", "UNDO"}
@@ -206,6 +210,7 @@ class OscOverridesGUI(Panel):
 
 
 class OscOverridesUp(Operator):
+    """Move override slot up"""
     bl_idname = 'ovlist.move_up'
     bl_label = 'Move Override up'
     bl_options = {'INTERNAL'}
@@ -224,6 +229,7 @@ class OscOverridesUp(Operator):
 
 
 class OscOverridesDown(Operator):
+    """Move override slot down"""
     bl_idname = 'ovlist.move_down'
     bl_label = 'Move Override down'
     bl_options = {'INTERNAL'}
@@ -241,6 +247,7 @@ class OscOverridesDown(Operator):
 
 
 class OscOverridesKill(Operator):
+    """Remove override slot"""
     bl_idname = 'ovlist.kill'
     bl_label = 'Kill Override'
     bl_options = {'INTERNAL'}
@@ -258,7 +265,7 @@ class OscOverridesKill(Operator):
 
 
 class OscTransferOverrides(Operator):
-    """Tooltip"""
+    """Applies the previously configured slots (Groups < Material) to the Scene.This should be transfer once the override groups are set."""
     bl_idname = "render.overrides_transfer"
     bl_label = "Transfer Overrides"
 
@@ -273,7 +280,7 @@ class OscTransferOverrides(Operator):
 
 
 class OscAddOverridesSlot(Operator):
-    """Tooltip"""
+    """Add override slot."""
     bl_idname = "render.overrides_add_slot"
     bl_label = "Add Override Slot"
 
@@ -285,7 +292,7 @@ class OscAddOverridesSlot(Operator):
 
 
 class OscRemoveOverridesSlot(Operator):
-    """Tooltip"""
+    """Remove override slot."""
     bl_idname = "render.overrides_remove_slot"
     bl_label = "Remove Override Slot"
 

oscurart_tools/oscurart_render.py

@@ -101,6 +101,7 @@ def defRenderAll(frametype, scenes):
 
 
 class renderAll (Operator):
+    """Renders all scenes executing the Oscurart overrides if those are set up. Saves the renders in their respective folders using the scenes and render layers names."""
     bl_idname = "render.render_all_scenes_osc"
     bl_label = "Render All Scenes"
 
@@ -117,6 +118,7 @@ bpy.types.Scene.use_render_scene = bpy.props.BoolProperty()
 
 
 class renderSelected (Operator):
+    """Renders the seleccted scenes on the checkboxes, executing the Oscurart overrides if it was set up. Saves the renders in their respective folders using the scenes and render layers names."""
     bl_idname = "render.render_selected_scenes_osc"
     bl_label = "Render Selected Scenes"
 
@@ -132,6 +134,7 @@ class renderSelected (Operator):
 
 
 class renderCurrent (Operator):
+    """Renders the active scene executing the Oscurart overrides if it was set up. Saves the renders in their respective folders using the scenes and render layers names."""
     bl_idname = "render.render_current_scene_osc"
     bl_label = "Render Current Scene"
 
@@ -173,6 +176,7 @@ def OscRenderCropFunc():
 
 
 class renderCrop (Operator):
+    """It renders croping the image in to a X number of pieces. Usefull for rendering really big images."""
     bl_idname = "render.render_crop_osc"
     bl_label = "Render Crop: Render!"
 
@@ -256,6 +260,7 @@ def defoscBatchMaker(TYPE, BIN):
 
 
 class oscBatchMaker (Operator):
+    """It creates .bat(win) or .sh(unix) file, to execute and render from Console/Terminal."""
     bl_idname = "file.create_batch_maker_osc"
     bl_label = "Make render batch"
     bl_options = {'REGISTER', 'UNDO'}
@@ -376,6 +381,7 @@ while REPITE:
 
 
 class oscPythonBatchMaker (Operator):
+    """It creates a file as “Make Render Batch” but it requires Phyton installed and the respective environment variables set up. If the render crahses, the batch automatically erase the broken frame and writes it again. Its not recommended if there is more than one machine rendering."""
     bl_idname = "file.create_batch_python"
     bl_label = "Make Batch Python"
     bl_options = {'REGISTER', 'UNDO'}
@@ -406,6 +412,7 @@ bpy.utils.register_class(VarColArchivos)
 
 
 class SumaFile(Operator):
+    """Look for broken rendered files and shows it."""
     bl_idname = "object.add_broken_file"
     bl_label = "Add Broken Files"
 
@@ -428,6 +435,7 @@ class SumaFile(Operator):
 
 
 class ClearFile(Operator):
+    """Erase the list of broken frames.""" 
     bl_idname = "object.clear_broken_file"
     bl_label = "Clear Broken Files"
 
@@ -437,6 +445,7 @@ class ClearFile(Operator):
 
 
 class DeleteFiles(Operator):
+    """Erase the broken frames files from Disk."""
     bl_idname = "object.delete_broken_file"
     bl_label = "Delete Broken Files"
 

oscurart_tools/oscurart_shapes.py

@@ -69,6 +69,7 @@ def DefSplitShapes(self, ACTIVESHAPE, LAYOUTCOMPAT):
 
 
 class CreaShapes(Operator):
+    """Divide on left and right the diffenrent Shapekeys. “Create Mix Groups” its required."""
     bl_idname = "mesh.split_lr_shapes_osc"
     bl_label = "Split LR Shapes"
     bl_options = {"REGISTER", "UNDO"}
@@ -102,6 +103,7 @@ class CreaShapes(Operator):
 # ----------------------------SHAPES LAYOUT-----------------------
 
 class CreaShapesLayout(Operator):
+    """Creates an interface to control the Shapekeys of symmetrical Objects. “Create Mix Groups” its required."""
     bl_idname = "mesh.create_symmetrical_layout_osc"
     bl_label = "Symmetrical Layout"
     bl_options = {"REGISTER", "UNDO"}
@@ -273,9 +275,9 @@ def createLMRGroups(self, FACTORVG, ADDVG):
 
 
 class CreaGrupos(Operator):
+    """It creates a vertex group in symmetrical objects, ideal for smoothly mixing shapekeys."""
     bl_idname = "mesh.create_lmr_groups_osc"
     bl_label = "Create Mix groups"
-    bl_description = "Create Mix groups"
     bl_options = {'REGISTER', 'UNDO'}
 
     FACTORVG = FloatProperty(
@@ -306,6 +308,7 @@ class CreaGrupos(Operator):
 # ------------------------ SHAPES LAYOUT SYMMETRICA ------------------------
 
 class CreateLayoutAsymmetrical(Operator):
+    """Creates an interface to control the Shapekeys of symmetrical Objects. “Create Mix Groups” its required."""
     bl_idname = "mesh.create_asymmetrical_layout_osc"
     bl_label = "Asymmetrical Layout"
     bl_options = {"REGISTER", "UNDO"}
@@ -441,6 +444,7 @@ class CreateLayoutAsymmetrical(Operator):
 # ---------------------------SHAPES TO OBJECTS------------------
 
 class ShapeToObjects(Operator):
+    """It creates a new object for every shapekey in the selected object, ideal to export to other 3D software Apps."""
     bl_idname = "object.shape_key_to_objects_osc"
     bl_label = "Shapes To Objects"
     bl_options = {"REGISTER", "UNDO"}