[Bf-blender-cvs] SVN commit: /data/svn/bf-blender [39716] trunk/blender: correct missing bpy doc references.
Campbell Barton
ideasman42 at gmail.com
Fri Aug 26 20:48:48 CEST 2011
Revision: 39716
http://projects.blender.org/scm/viewvc.php?view=rev&root=bf-blender&revision=39716
Author: campbellbarton
Date: 2011-08-26 18:48:48 +0000 (Fri, 26 Aug 2011)
Log Message:
-----------
correct missing bpy doc references.
Modified Paths:
--------------
trunk/blender/doc/python_api/rst/info_gotcha.rst
trunk/blender/release/scripts/modules/bpy_extras/image_utils.py
trunk/blender/release/scripts/modules/bpy_extras/io_utils.py
trunk/blender/release/scripts/modules/bpy_extras/mesh_utils.py
trunk/blender/release/scripts/modules/bpy_extras/object_utils.py
trunk/blender/release/scripts/modules/bpy_extras/view3d_utils.py
trunk/blender/release/scripts/modules/bpy_types.py
trunk/blender/source/blender/python/intern/bpy_rna.c
Modified: trunk/blender/doc/python_api/rst/info_gotcha.rst
===================================================================
--- trunk/blender/doc/python_api/rst/info_gotcha.rst 2011-08-26 18:32:23 UTC (rev 39715)
+++ trunk/blender/doc/python_api/rst/info_gotcha.rst 2011-08-26 18:48:48 UTC (rev 39716)
@@ -82,7 +82,7 @@
Sometimes you want to modify values from python and immediately access the updated values, eg:
-Once changing the objects :class:`Object.location` you may want to access its transformation right after from :class:`Object.matrix_world`, but this doesn't work as you might expect.
+Once changing the objects :class:`bpy.types.Object.location` you may want to access its transformation right after from :class:`bpy.types.Object.matrix_world`, but this doesn't work as you might expect.
Consider the calculations that might go into working out the objects final transformation, this includes:
Modified: trunk/blender/release/scripts/modules/bpy_extras/image_utils.py
===================================================================
--- trunk/blender/release/scripts/modules/bpy_extras/image_utils.py 2011-08-26 18:32:23 UTC (rev 39715)
+++ trunk/blender/release/scripts/modules/bpy_extras/image_utils.py 2011-08-26 18:48:48 UTC (rev 39716)
@@ -58,7 +58,7 @@
For formats blender can read, simply return the path that is given.
:type convert_callback: function
:return: an image or None
- :rtype: :class:`Image`
+ :rtype: :class:`bpy.types.Image`
"""
import os
import bpy
Modified: trunk/blender/release/scripts/modules/bpy_extras/io_utils.py
===================================================================
--- trunk/blender/release/scripts/modules/bpy_extras/io_utils.py 2011-08-26 18:32:23 UTC (rev 39715)
+++ trunk/blender/release/scripts/modules/bpy_extras/io_utils.py 2011-08-26 18:48:48 UTC (rev 39716)
@@ -252,10 +252,10 @@
def axis_conversion_ensure(operator, forward_attr, up_attr):
"""
Function to ensure an operator has valid axis conversion settings, intended
- to be used from :class:`Operator.check`.
+ to be used from :class:`bpy.types.Operator.check`.
:arg operator: the operator to access axis attributes from.
- :type operator: :class:`Operator`
+ :type operator: :class:`bpy.types.Operator`
:arg forward_attr: attribute storing the forward axis
:type forward_attr: string
:arg up_attr: attribute storing the up axis
Modified: trunk/blender/release/scripts/modules/bpy_extras/mesh_utils.py
===================================================================
--- trunk/blender/release/scripts/modules/bpy_extras/mesh_utils.py 2011-08-26 18:32:23 UTC (rev 39715)
+++ trunk/blender/release/scripts/modules/bpy_extras/mesh_utils.py 2011-08-26 18:48:48 UTC (rev 39716)
@@ -35,7 +35,7 @@
other mesh elements within 1 mesh datablock.
:arg mesh: the mesh used to group with.
- :type mesh: :class:`Mesh`
+ :type mesh: :class:`bpy.types.Mesh`
:return: lists of lists containing faces.
:rtype: list
"""
@@ -125,9 +125,9 @@
[[(0, 1), (4, 8), (3, 8)], ...]
:arg mesh: the mesh used to get edge loops from.
- :type mesh: :class:`Mesh`
+ :type mesh: :class:`bpy.types.Mesh`
:arg faces: optional face list to only use some of the meshes faces.
- :type faces: :class:`MeshFaces`, sequence or or NoneType
+ :type faces: :class:`bpy.types.MeshFaces`, sequence or or NoneType
:return: return a list of edge vertex index lists.
:rtype: list
"""
@@ -450,7 +450,7 @@
:arg num_points: the number of random points to generate on each face.
:type int:
:arg faces: list of the faces to generate points on.
- :type faces: :class:`MeshFaces`, sequence
+ :type faces: :class:`bpy.types.MeshFaces`, sequence
:return: list of random points over all faces.
:rtype: list
"""
Modified: trunk/blender/release/scripts/modules/bpy_extras/object_utils.py
===================================================================
--- trunk/blender/release/scripts/modules/bpy_extras/object_utils.py 2011-08-26 18:32:23 UTC (rev 39715)
+++ trunk/blender/release/scripts/modules/bpy_extras/object_utils.py 2011-08-26 18:48:48 UTC (rev 39716)
@@ -33,11 +33,11 @@
Return a matrix using the operator settings and view context.
:arg context: The context to use.
- :type context: :class:`Context`
+ :type context: :class:`bpy.types.Context`
:arg operator: The operator, checked for location and rotation properties.
- :type operator: :class:`Operator`
+ :type operator: :class:`bpy.types.Operator`
:return: the matrix from the context and settings.
- :rtype: :class:`Matrix`
+ :rtype: :class:`mathutils.Matrix`
"""
from mathutils import Matrix, Vector, Euler
@@ -92,13 +92,13 @@
location, rotation and layer.
:arg context: The context to use.
- :type context: :class:`Context`
+ :type context: :class:`bpy.types.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`
+ :type operator: :class:`bpy.types.Operator`
:return: the newly created object in the scene.
- :rtype: :class:`ObjectBase`
+ :rtype: :class:`bpy.types.ObjectBase`
"""
scene = context.scene
Modified: trunk/blender/release/scripts/modules/bpy_extras/view3d_utils.py
===================================================================
--- trunk/blender/release/scripts/modules/bpy_extras/view3d_utils.py 2011-08-26 18:32:23 UTC (rev 39715)
+++ trunk/blender/release/scripts/modules/bpy_extras/view3d_utils.py 2011-08-26 18:48:48 UTC (rev 39716)
@@ -31,14 +31,14 @@
coordinate.
:arg region: region of the 3D viewport, typically bpy.context.region.
- :type region: :class:`Region`
+ :type region: :class:`bpy.types.Region`
:arg rv3d: 3D region data, typically bpy.context.space_data.region_3d.
- :type rv3d: :class:`RegionView3D`
+ :type rv3d: :class:`bpy.types.RegionView3D`
:arg coord: 2d coordinates relative to the region:
(event.mouse_region_x, event.mouse_region_y) for example.
:type coord: 2d vector
:return: normalized 3d vector.
- :rtype: :class:`Vector`
+ :rtype: :class:`mathutils.Vector`
"""
from mathutils import Vector
@@ -65,9 +65,9 @@
*depth_location*.
:arg region: region of the 3D viewport, typically bpy.context.region.
- :type region: :class:`Region`
+ :type region: :class:`bpy.types.Region`
:arg rv3d: 3D region data, typically bpy.context.space_data.region_3d.
- :type rv3d: :class:`RegionView3D`
+ :type rv3d: :class:`bpy.types.RegionView3D`
:arg coord: 2d coordinates relative to the region;
(event.mouse_region_x, event.mouse_region_y) for example.
:type coord: 2d vector
@@ -75,7 +75,7 @@
there is no defined depth with a 2d region input.
:type depth_location: 3d vector
:return: normalized 3d vector.
- :rtype: :class:`Vector`
+ :rtype: :class:`mathutils.Vector`
"""
from mathutils import Vector
from mathutils.geometry import intersect_point_line
@@ -114,13 +114,13 @@
Return the *region* relative 2d location of a 3d position.
:arg region: region of the 3D viewport, typically bpy.context.region.
- :type region: :class:`Region`
+ :type region: :class:`bpy.types.Region`
:arg rv3d: 3D region data, typically bpy.context.space_data.region_3d.
- :type rv3d: :class:`RegionView3D`
+ :type rv3d: :class:`bpy.types.RegionView3D`
:arg coord: 3d worldspace location.
:type coord: 3d vector
:return: 2d location
- :rtype: :class:`Vector`
+ :rtype: :class:`mathutils.Vector`
"""
from mathutils import Vector
Modified: trunk/blender/release/scripts/modules/bpy_types.py
===================================================================
--- trunk/blender/release/scripts/modules/bpy_types.py 2011-08-26 18:32:23 UTC (rev 39715)
+++ trunk/blender/release/scripts/modules/bpy_types.py 2011-08-26 18:48:48 UTC (rev 39716)
@@ -287,7 +287,7 @@
Transform the the bones head, tail, roll and envalope (when the matrix has a scale component).
:arg matrix: 3x3 or 4x4 transformation matrix.
- :type matrix: :class:`Matrix`
+ :type matrix: :class:`mathutils.Matrix`
:arg scale: Scale the bone envalope by the matrix.
:type scale: bool
:arg roll: Correct the roll to point in the same relative direction to the head and tail.
Modified: trunk/blender/source/blender/python/intern/bpy_rna.c
===================================================================
--- trunk/blender/source/blender/python/intern/bpy_rna.c 2011-08-26 18:32:23 UTC (rev 39715)
+++ trunk/blender/source/blender/python/intern/bpy_rna.c 2011-08-26 18:48:48 UTC (rev 39716)
@@ -6591,9 +6591,9 @@
PyDoc_STRVAR(pyrna_register_class_doc,
".. method:: register_class(cls)\n"
"\n"
-" Register a subclass of a blender type in (:class:`Panel`,\n"
-" :class:`Menu`, :class:`Header`, :class:`Operator`,\n"
-" :class:`KeyingSetInfo`, :class:`RenderEngine`).\n"
+" Register a subclass of a blender type in (:class:`bpy.types.Panel`,\n"
+" :class:`bpy.types.Menu`, :class:`bpy.types.Header`, :class:`bpy.types.Operator`,\n"
+" :class:`bpy.types.KeyingSetInfo`, :class:`bpy.types.RenderEngine`).\n"
"\n"
" If the class has a *register* class method it will be called\n"
" before registration.\n"
More information about the Bf-blender-cvs
mailing list