Exppython:

- A few more changes to integrate the documentation:
    Instructions to build it with epydoc are on the file Blender.py.
This commit is contained in:
2003-07-12 18:21:07 +00:00
parent c467b19c75
commit 6046d05a7e
3 changed files with 89 additions and 70 deletions

View File

@@ -2,9 +2,11 @@
# The module files in this folder are used to create the API documentation. # The module files in this folder are used to create the API documentation.
# Doc system used: epydoc - http://epydoc.sf.net # Doc system used: epydoc - http://epydoc.sf.net
# command line: epydoc -t Blender.py -n "Blender" --no-private MODULES # command line:
# where MODULES is a list of all such modules in this folder, like:
# Blender.py Camera.py Lamp.py BGL.py etc. # epydoc -t Blender.py -n "Blender" --no-private --no-frames Blender.py \
# Camera.py Lamp.py Material.py BGL.py Window.py Text.py Image.py NMesh.py \
# Scene.py Draw.py Armature.py Types.py Curve.py Effect.py Ipo.py Metaball.py
""" """
This is the main Blender module. This is the main Blender module.
@@ -19,11 +21,16 @@ Blender Python
- L{Types} - L{Types}
- L{Scene} - L{Scene}
- L{Object}
- L{NMesh} - L{NMesh}
- L{Material} - L{Material}
- L{Armature}
- L{Camera} - L{Camera}
- L{Lamp} - L{Lamp}
- L{Armature}
- L{Metaball}
- L{Effect}
- L{Curve}
- L{Ipo}
- L{BGL} - L{BGL}
- L{Window} - L{Window}
- L{Draw} - L{Draw}

View File

@@ -209,7 +209,8 @@ class Curve:
Get the curve's control point value. Get the curve's control point value.
@type numcurve: int @type numcurve: int
@type numpoint: int @type numpoint: int
@rtype: depends upon the curve's type.\n @rtype: list
@return: depends upon the curve's type.\n
type bezier : a list of three coordinates\n type bezier : a list of three coordinates\n
type nurbs : a list of nine coordinates. type nurbs : a list of nine coordinates.
""" """

View File

@@ -20,9 +20,11 @@ def New (type, name='type'):
""" """
Creates a new Object. Creates a new Object.
@type type: string @type type: string
@param type: The Object type: 'Armature', 'Camera', 'Curve', 'Lamp', 'Mesh' or 'Empty'. @param type: The Object type: 'Armature', 'Camera', 'Curve', 'Lamp', 'Mesh'
or 'Empty'.
@type name: string @type name: string
@param name: The name of the object. By default, the name will be the same as the object type. @param name: The name of the object. By default, the name will be the same
as the object type.
@rtype: Blender Object @rtype: Blender Object
@return: The created Object. @return: The created Object.
""" """
@@ -65,7 +67,8 @@ class Object:
@cvar dRotX: The delta X rotation angle (in radians) of the object. @cvar dRotX: The delta X rotation angle (in radians) of the object.
@cvar dRotY: The delta Y rotation angle (in radians) of the object. @cvar dRotY: The delta Y rotation angle (in radians) of the object.
@cvar dRotZ: The delta Z rotation angle (in radians) of the object. @cvar dRotZ: The delta Z rotation angle (in radians) of the object.
@cvar drot: The delta (X,Y,Z) rotation angles (in radians) of the object (vector). @cvar drot: The delta (X,Y,Z) rotation angles (in radians) of the object
(vector).
@cvar SizeX: The X size of the object. @cvar SizeX: The X size of the object.
@cvar SizeY: The Y size of the object. @cvar SizeY: The Y size of the object.
@cvar SizeZ: The Z size of the object. @cvar SizeZ: The Z size of the object.
@@ -84,9 +87,14 @@ class Object:
@cvar ipo: The ipo data associated with the object. (Read-only) @cvar ipo: The ipo data associated with the object. (Read-only)
@cvar mat: The actual matrix of the object. (Read-only) @cvar mat: The actual matrix of the object. (Read-only)
@cvar matrix: The actual matrix of the object. (Read-only) @cvar matrix: The actual matrix of the object. (Read-only)
@cvar colbits: The Material usage mask. A set bit #n means: the Material #n in the Object's material list is used. Otherwise, the Material #n of the Objects Data material list is displayed. @cvar colbits: The Material usage mask. A set bit #n means: the Material
@cvar drawType: The object's drawing type used. 1 - Bounding box, 2 - wire, 3 - Solid, 4- Shaded, 5 - Textured. #n in the Object's material list is used. Otherwise, the Material #n
@cvar drawMode: The object's drawing mode used. The value can be a sum of: 2 - axis, 4 - texspace, 8 - drawname, 16 - drawimage, 32 - drawwire. of the Objects Data material list is displayed.
@cvar drawType: The object's drawing type used. 1 - Bounding box,
2 - wire, 3 - Solid, 4- Shaded, 5 - Textured.
@cvar drawMode: The object's drawing mode used. The value can be a sum
of: 2 - axis, 4 - texspace, 8 - drawname, 16 - drawimage,
32 - drawwire.
@cvar name: The name of the object. @cvar name: The name of the object.
""" """
@@ -95,8 +103,11 @@ class Object:
Clears parent object. Clears parent object.
@type mode: int @type mode: int
@type fast: int @type fast: int
@param mode: A mode flag. If mode flag is 2, then the object transform will be kept. Any other value, or no value at all will update the object transform. @param mode: A mode flag. If mode flag is 2, then the object transform will
@param fast: If the value is 0, the scene hierarchy will not be updated. Any other value, or no value at all will update the scene hierarchy. be kept. Any other value, or no value at all will update the object
transform.
@param fast: If the value is 0, the scene hierarchy will not be updated. Any
other value, or no value at all will update the scene hierarchy.
""" """
def getData(): def getData():
@@ -163,7 +174,7 @@ class Object:
""" """
""" """
def setDeltaLocation(float, float, float): def setDeltaLocation(float1, float2, float3):
""" """
""" """
@@ -175,11 +186,11 @@ class Object:
""" """
""" """
def setEuler(float, float, float): def setEuler(float1, float2, float3):
""" """
""" """
def setLocation(float, float, float): def setLocation(float1, float2, float3):
""" """
""" """