Welcome to mirror list, hosted at ThFree Co, Russian Federation.

git.blender.org/blender.git - Unnamed repository; edit this file 'description' to name the repository.
summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorStephen Swaney <sswaney@centurytel.net>2005-05-24 19:14:32 +0400
committerStephen Swaney <sswaney@centurytel.net>2005-05-24 19:14:32 +0400
commitbb84abaaa8fb14074f8be722346c6fd610d2f02e (patch)
tree524ff7cd2e43d08fed450ff95432d91764d45094 /source/blender/python/api2_2x/doc
parent8242c5db2b25e8a2a6db9f615a21ee4512d85b9e (diff)
updates to doc strings in code and doc from Ken Hughes.
add alias .recalc() for IpoCurve.Recalc() to match api standard.
Diffstat (limited to 'source/blender/python/api2_2x/doc')
-rw-r--r--source/blender/python/api2_2x/doc/Curve.py22
-rw-r--r--source/blender/python/api2_2x/doc/Ipo.py30
2 files changed, 32 insertions, 20 deletions
diff --git a/source/blender/python/api2_2x/doc/Curve.py b/source/blender/python/api2_2x/doc/Curve.py
index 265768893a8..a123ad1416b 100644
--- a/source/blender/python/api2_2x/doc/Curve.py
+++ b/source/blender/python/api2_2x/doc/Curve.py
@@ -265,8 +265,8 @@ class Curve:
def appendNurb( new_point ):
"""
add a new curve to this Curve. The new point is added to the new curve. Blender does not support a curve with zero points. The new curve is added to the end of the list of curves in the Curve.
- @rtype: PyNone
- @return: PyNone
+ @rtype: CurNurb
+ @return: the newly added spline
@type new_point: BezTriple or list of xyzw coordinates for a Nurb curve.
@param new_point: see L{CurNurb.append} for description of parameter.
"""
@@ -347,7 +347,7 @@ class Curve:
@return: PyNone
"""
- def isNurb( curve_num):
+ def isNurb( curve_num ):
"""
method used to determine whether a CurNurb is of type Bezier or of type Nurb.
@rtype: integer
@@ -368,6 +368,20 @@ class Curve:
@raise AttributeError: throws exception if curve_num is out of range.
"""
+ def getNumCurves():
+ """
+ Get the number of curves in this Curve Data object.
+ @rtype: integer
+ """
+
+ def getNumPoints( curve_num ):
+ """
+ Get the number of control points in the curve.
+ @type curve_num: integer
+ @param curve_num: zero-based index into list of curves in this Curve
+ @rtype: integer
+ """
+
class CurNurb:
"""
The CurNurb Object
@@ -453,5 +467,3 @@ class CurNurb:
@rtype: PyNone
@return: PyNone
"""
-
-
diff --git a/source/blender/python/api2_2x/doc/Ipo.py b/source/blender/python/api2_2x/doc/Ipo.py
index b0b269db6cd..bda2f12a623 100644
--- a/source/blender/python/api2_2x/doc/Ipo.py
+++ b/source/blender/python/api2_2x/doc/Ipo.py
@@ -3,10 +3,10 @@
"""
The Blender.Ipo submodule
-B{New}: Ipo updates to both the program and bpython acess.
+B{New}: Ipo updates to both the program and bpython access.
This module provides access to the Ipo Data in Blender. An Ipo is composed of
-several Ipocurves.
+several IpoCurves.
A datatype is defined : IpoCurve type. The member functions of this data type
are given below.
@@ -258,17 +258,17 @@ class IpoCurve:
This object gives access to generic data from all ipocurves objects in Blender.
Important Notes for Rotation Curves:\n
- For the rotation IpoCurves, the y values for points are in units of 10 degrees. example: 45.0 degrees is stored as 4.50 degrees. These are the same numbers you see in the Transform Properties pupmenu ( NKey ) in the IPO Curve Editor window. Positive rotations are in a counter-clockwise direction, just like in math class.
+ For the rotation IpoCurves, the y values for points are in units of 10 degrees. For example, 45.0 degrees is stored as 4.50 degrees. These are the same numbers you see in the Transform Properties pupmenu ( NKey ) in the IPO Curve Editor window. Positive rotations are in a counter-clockwise direction, just like in math class.
@cvar name: The Curve Data name.
@cvar bezierPoints : The list of the Bezier points.
"""
- def setExtrapolation(extrapolationtype):
+ def setExtrapolation(extendmode):
"""
- Sets the extrapolation type of the curve.
- @type extrapolationtype: string
- @param extrapolationtype: the extrapolatrion type of the curve.
+ Sets the extend mode of the curve.
+ @type extendmode: string
+ @param extendmode: the extend mode of the curve.
Can be Constant, Extrapolation, Cyclic or Cyclic_extrapolation.
@rtype: None
@return: None
@@ -276,25 +276,25 @@ class IpoCurve:
def getExtrapolation():
"""
- Gets the extrapolation type of the curve.
+ Gets the extend mode of the curve.
@rtype: string
- @return: the extrapolation type of the curve.Can be Constant, Extrapolation, Cyclic or Cyclic_extrapolation.
+ @return: the extend mode of the curve. Can be Constant, Extrapolation, Cyclic or Cyclic_extrapolation.
"""
def setInterpolation(interpolationtype):
"""
- Sets the interpolation type of the curve.
+ Sets the interpolation type of the curve.
@type interpolationtype: string
- @param interpolationtype: the interpolatrion type of the curve. Can be Constant, Bezier, or Linear.
+ @param interpolationtype: the interpolation type of the curve. Can be Constant, Bezier, or Linear.
@rtype: None
@return: None
"""
def getInterpolation():
"""
- Gets the interpolation type of the curve.
+ Gets the interpolation type of the curve.
@rtype: string
- @return: the interpolation type of the curve.Can be Constant, Bezier, or Linear.
+ @return: the interpolation type of the curve. Can be Constant, Bezier, or Linear.
"""
def addBezier(coordlist):
@@ -315,9 +315,9 @@ class IpoCurve:
@return: None
"""
- def Recalc():
+ def recalc():
"""
- Recomputes the curent value of the curve.
+ Recomputes the curve after changes to control points.
@rtype: None
@return: None
"""