diff options
author | Joseph Gilbert <ascotan@gmail.com> | 2004-05-25 07:26:29 +0400 |
---|---|---|
committer | Joseph Gilbert <ascotan@gmail.com> | 2004-05-25 07:26:29 +0400 |
commit | 779d0d02213c8a783a4f5a3935c0a7d96c4b3850 (patch) | |
tree | 97995ed4ec0993f42d72b86faef654e022ed9778 /source/blender | |
parent | 130878697436aeae0fe06fbf249dd6b483f2e0f5 (diff) |
- documentation update for new functions
- error corrections in NLA about dictionaries
Diffstat (limited to 'source/blender')
-rw-r--r-- | source/blender/python/api2_2x/doc/Bone.py | 54 | ||||
-rw-r--r-- | source/blender/python/api2_2x/doc/NLA.py | 6 | ||||
-rw-r--r-- | source/blender/python/api2_2x/doc/Render.py | 16 |
3 files changed, 73 insertions, 3 deletions
diff --git a/source/blender/python/api2_2x/doc/Bone.py b/source/blender/python/api2_2x/doc/Bone.py index 4263638fdc4..c7cc1629766 100644 --- a/source/blender/python/api2_2x/doc/Bone.py +++ b/source/blender/python/api2_2x/doc/Bone.py @@ -52,6 +52,23 @@ Example:: - ROT - add bone's rotation to keyframe - LOC - add bone's location to keyframe - SIZE- add bone's size to keyframe + +@var BoneclassFlags: The available flags for setting boneclass. + - SKINNABLE + - UNSKINNABLE + - HEAD + - NECK + - BACK + - SHOULDER + - ARM + - HAND + - FINGER + - THUMB + - PELVIS + - LEG + - FOOT + - TOE + - TENTACLE """ class Bone: @@ -69,6 +86,8 @@ class Bone: @cvar parent: The parent Bone. @cvar children: The children bones. @cvar weight: The bone's weight. + @cvar ik: Whether the bone is set to IK. + @cvar boneclass: The boneclass of this bone. """ def getName(): @@ -258,4 +277,39 @@ class Bone: will set information about the rotation, and/or location, and/or size of the bone. @type Action: PyAction @param Action: a python action that has either been created or returned from an object + """ + + def setBoneclass(boneclass): + """ + Set the bones's boneclass. + @type boneclass: Enumeration constant. See above. + @param boneclass: The boneclass of this bone. + """ + + def getBoneclass(): + """ + Get this Bone's boneclass. + @rtype: Enumeration const (string) + """ + + def hasIK(): + """ + Determines whether or not this bone as flaged as IK. + @rtype: true (1) or false (0) + """ + + def getRestMatrix(locale = 'worldspace'): + """ + Return a matrix that represents the rotation and position + of this bone. There are two types of matrices that can be + returned - bonespace (in the coord. system of parent) or + worldspace (in the coord system of blender). The rotation will + be in either worldspace or bonespace. Translaction vectors (row 4) + will be the bone's head position (if worldspace) or the difference + from this bone's head to the parent head (if bonespace). + @type locale: string Values are: + - worldspace + - bonespace + @param locale: default is worldspace + @rtype: 4x4 PyMatrix """
\ No newline at end of file diff --git a/source/blender/python/api2_2x/doc/NLA.py b/source/blender/python/api2_2x/doc/NLA.py index f668ae4e068..1de1cdad577 100644 --- a/source/blender/python/api2_2x/doc/NLA.py +++ b/source/blender/python/api2_2x/doc/NLA.py @@ -76,8 +76,8 @@ def CopyAction (action): def GetActions (): """ - Get all actions and return them as a list. - @rtype: PyList of PyActions + Get all actions and return them as a Key : Value Dictionary. + @rtype: Dictionary of PyActions @return: All the actions in blender """ @@ -127,6 +127,6 @@ class Action: def getAllChannelIpos(): """ Get the all the Ipos for this action - @rtype: PyDict [channel : PyIpo] + @rtype: Dictionary [channel : PyIpo] @return: the Ipos for all the channels in the action """
\ No newline at end of file diff --git a/source/blender/python/api2_2x/doc/Render.py b/source/blender/python/api2_2x/doc/Render.py index e113f1b9140..c743aa36d8d 100644 --- a/source/blender/python/api2_2x/doc/Render.py +++ b/source/blender/python/api2_2x/doc/Render.py @@ -389,6 +389,22 @@ class RenderData: @param toggle: pass 1 for on / 0 for off """ + def setBorder(left,bottom,right,top): + """ + Set a border for rendering from cameras in the scene. + The left,bottom coordinates and right,top coordinates + define the size of the border. (0,0,1,1) will set the border + to the whole camera. (0,0) lower left and (1,1) upper right. + @type left: float + @param left: float between 0 and 1 + @type right: float + @param right: float between 0 and 1 + @type bottom: float + @param bottom: float between 0 and 1 + @type top: float + @param top: float between 0 and 1 + """ + def enableGammaCorrection(toggle): """ Enable/disable gamma correction. |