move load_image into image_utils and add some docstrings to bpy_extras module.
[blender.git] / release / scripts / modules / bpy_extras / object_utils.py
index 606f8b9f89f6905a7eb570b22ce68752b3100082..51a8d4b5e23288d8bf1a0f6d4792056cd7d08955 100644 (file)
@@ -29,6 +29,16 @@ import mathutils
 
 
 def add_object_align_init(context, operator):
+    """
+    Return a matrix using the operator settings and view context.
+
+    :arg context: The context to use.
+    :type context: :class:`Context`
+    :arg operator: The operator, checked for location and rotation properties.
+    :type operator: :class:`Operator`
+    :return: the matrix from the context and settings.
+    :rtype: :class:`Matrix`
+    """
     space_data = context.space_data
     if space_data.type != 'VIEW_3D':
         space_data = None
@@ -70,7 +80,19 @@ def add_object_align_init(context, operator):
 
 
 def object_data_add(context, obdata, operator=None):
-
+    """
+    Add an object using the view context and preference to to initialize the
+    location, rotation and layer.
+
+    :arg context: The context to use.
+    :type context: :class:`Context`
+    :arg obdata: the data used for the new object.
+    :type obdata: valid object data type or None.
+    :arg operator: The operator, checked for location and rotation properties.
+    :type operator: :class:`Operator`
+    :return: the newly created object in the scene.
+    :rtype: :class:`ObjectBase`
+    """
     scene = context.scene
 
     # ugh, could be made nicer