more spell checking.

This commit is contained in:
Stephen Swaney
2006-07-12 14:27:13 +00:00
parent cfeaf8dfdf
commit aa42dc28f1
7 changed files with 73 additions and 73 deletions

View File

@@ -68,14 +68,14 @@ Example::
@type Shaders: readonly dictionary @type Shaders: readonly dictionary
@var Shaders: The available Material Shaders. @var Shaders: The available Material Shaders.
- DIFFUSE_LAMBERT - Make Material use the lambert diffuse shader. - DIFFUSE_LAMBERT - Make Material use the lambert diffuse shader.
- DIFFUSE_ORENNAYAR - Make Material use the orennayar diffuse shader. - DIFFUSE_ORENNAYAR - Make Material use the Oren-Nayer diffuse shader.
- DIFFUSE_TOON - Make Material use the toon diffuse shader. - DIFFUSE_TOON - Make Material use the toon diffuse shader.
- DIFFUSE_MINNAERT - Make Material use the minnaert diffuse shader. - DIFFUSE_MINNAERT - Make Material use the minnaert diffuse shader.
- SPEC_COOKTORR - Make Material use the cooktorr specular shader. - SPEC_COOKTORR - Make Material use the Cook-Torr specular shader.
- SPEC_PHONG - Make Material use the phong specular shader. - SPEC_PHONG - Make Material use the Phong specular shader.
- SPEC_BLINN - Make Material use the blinn specular shader. - SPEC_BLINN - Make Material use the Blinn specular shader.
- SPEC_TOON - Make Material use the toon specular shader. - SPEC_TOON - Make Material use the toon specular shader.
- SPEC_WARDISO - Make Material use the wardiso specular shader. - SPEC_WARDISO - Make Material use the Ward-iso specular shader.
""" """
def New (name = 'Mat'): def New (name = 'Mat'):
@@ -209,7 +209,7 @@ class Material:
@type nStars: int @type nStars: int
@ivar name: Material data name. @ivar name: Material data name.
@type name: str @type name: str
@ivar oopsLoc: Material OOPs location. Returns None if materal not found in list. @ivar oopsLoc: Material OOPs location. Returns None if material not found in list.
@type oopsLoc: list of 2 floats @type oopsLoc: list of 2 floats
@ivar oopsSel: Material OOPs selection flag. @ivar oopsSel: Material OOPs selection flag.
Value must be in the range [0,1]. Value must be in the range [0,1].
@@ -538,14 +538,14 @@ class Material:
def setSpecSize(specSize): def setSpecSize(specSize):
""" """
Set the material's size of speculara area (applies to the \"Toon\" Specular Shader only) Set the material's size of specular area (applies to the \"Toon\" Specular Shader only)
@type specSize: float @type specSize: float
@param specSize: The new value in [0.0, 1.53]. @param specSize: The new value in [0.0, 1.53].
""" """
def getSpecSize(): def getSpecSize():
""" """
Get the material's size of speculara area (applies to the \"Toon\" Specular Shader only) Get the material's size of specular area (applies to the \"Toon\" Specular Shader only)
@rtype specSize: float @rtype specSize: float
""" """
@@ -934,9 +934,9 @@ class Material:
@type texture: Blender Texture @type texture: Blender Texture
@param texture: a Blender Texture object. @param texture: a Blender Texture object.
@type texco: int @type texco: int
@param texco: optional or'ed bitflag -- defaults to TexCo.ORCO. See TexCo var in L{Texture}. @param texco: optional ORed bitflag -- defaults to TexCo.ORCO. See TexCo var in L{Texture}.
@type mapto: int @type mapto: int
@param mapto: optional or'ed bitflag -- defaults to MapTo.COL. See MapTo var in L{Texture}. @param mapto: optional ORed bitflag -- defaults to MapTo.COL. See MapTo var in L{Texture}.
""" """
def clearTexture(index): def clearTexture(index):

View File

@@ -116,7 +116,7 @@ class Modifiers:
""" """
Moves the modifier up in the object's modifier stack. Moves the modifier up in the object's modifier stack.
@type modifier: a modifier from this sequence to remove. @type modifier: a modifier from this sequence to remove.
@rtype: PyNone @rtype: None
@raise RuntimeError: request to move above another modifier requiring @raise RuntimeError: request to move above another modifier requiring
original data original data
@note: Accessing attributes of the modifier after removing will raise an error. @note: Accessing attributes of the modifier after removing will raise an error.
@@ -126,7 +126,7 @@ class Modifiers:
""" """
Moves the modifier down in the object's modifier stack. Moves the modifier down in the object's modifier stack.
@type modifier: a modifier from this sequence to remove. @type modifier: a modifier from this sequence to remove.
@rtype: PyNone @rtype: None
@raise RuntimeError: request to move modifier beyond a non-deforming @raise RuntimeError: request to move modifier beyond a non-deforming
modifier modifier
@note: Accessing attributes of the modifier after removing will raise an error. @note: Accessing attributes of the modifier after removing will raise an error.

View File

@@ -60,7 +60,7 @@ Example::
@var Flags: Constant dict used by the L{ActionStrip.flag} attribute. @var Flags: Constant dict used by the L{ActionStrip.flag} attribute.
It is a bitmask and settings are ORed together. It is a bitmask and settings are ORed together.
- SELECT: action strip is selected in NLA window - SELECT: action strip is selected in NLA window
- STRIDE_PATH: play action nased on path position and stride. - STRIDE_PATH: play action based on path position and stride.
- HOLD: continue displaying the last frame past the end of the strip - HOLD: continue displaying the last frame past the end of the strip
- ACTIVE: action strip is active in NLA window - ACTIVE: action strip is active in NLA window
- LOCK_ACTION: action start/end are automatically mapped to strip duration - LOCK_ACTION: action start/end are automatically mapped to strip duration
@@ -182,7 +182,7 @@ class ActionStrips:
def append(action): def append(action):
""" """
Appends a new action to the end of the actionstrip sequence. Appends a new action to the end of the action strip sequence.
@type action: L{Action<NLA.Action>} @type action: L{Action<NLA.Action>}
@param action: the action to use in the action strip @param action: the action to use in the action strip
@rtype: Constraint @rtype: Constraint
@@ -252,14 +252,14 @@ class ActionStrip:
Start/End". This method restores the values of ActionStart and Start/End". This method restores the values of ActionStart and
ActionEnd to their defaults, usually the first and last frames within ActionEnd to their defaults, usually the first and last frames within
an action that contain keys. an action that contain keys.
@rtype: PyNone @rtype: None
""" """
def resetStripSize(): def resetStripSize():
""" """
Activates the functionality found in NLA Strip menu under "Reset Strip Activates the functionality found in NLA Strip menu under "Reset Strip
Size". This method resets the Action Strip size to its creation values. Size". This method resets the Action Strip size to its creation values.
@rtype: PyNone @rtype: None
""" """
def snapToFrame(): def snapToFrame():
@@ -267,5 +267,5 @@ class ActionStrip:
Activates the functionality found in NLA Strip menu under "Snap to Frame". Activates the functionality found in NLA Strip menu under "Snap to Frame".
This function snaps the ends of the action strip to the nearest whole This function snaps the ends of the action strip to the nearest whole
numbered frame. numbered frame.
@rtype: PyNone @rtype: None
""" """

View File

@@ -72,7 +72,7 @@ Example::
- TILES - uses tiled image. - TILES - uses tiled image.
- TWOSIDE - two-sided face. - TWOSIDE - two-sided face.
@var FaceTranspModes: The available face transparency modes. Note: these are @var FaceTranspModes: The available face transparency modes. Note: these are
enumerated values (enums), they can't be combined (and'ed, or'ed, etc) like a bit vector. enumerated values (enums), they can't be combined (ANDed, ORed, etc) like a bit vector.
- SOLID - draw solid. - SOLID - draw solid.
- ADD - add to background (halo). - ADD - add to background (halo).
- ALPHA - draw with transparency. - ALPHA - draw with transparency.
@@ -433,7 +433,7 @@ class NMesh:
Get this NMesh's list of materials. Get this NMesh's list of materials.
@type what: int @type what: int
@param what: determines the list's contents: @param what: determines the list's contents:
- -1: return the current nmesh's list; - -1: return the current NMesh's list;
- 0: retrieve a fresh list from the Blender mesh -- eventual - 0: retrieve a fresh list from the Blender mesh -- eventual
modifications made by the script not included, unless modifications made by the script not included, unless
L{update} is called before this method; L{update} is called before this method;
@@ -652,7 +652,7 @@ class NMesh:
""" """
Get this mesh's mode flags. Get this mesh's mode flags.
@rtype: int @rtype: int
@return: Or'ed value. See L{Modes}. @return: ORed value. See L{Modes}.
""" """
def setMode(m=None, m1=None, m2=None): def setMode(m=None, m1=None, m2=None):
@@ -724,7 +724,7 @@ class NMesh:
@type assignmode: string @type assignmode: string
@param assignmode: Three choices: @param assignmode: Three choices:
- 'add' - 'add'
- 'substract' - 'subtract'
- 'replace'\n - 'replace'\n
'B{add}': if the vertex in the list is not assigned to the group 'B{add}': if the vertex in the list is not assigned to the group

View File

@@ -439,7 +439,7 @@ class RenderData:
def enableOversampling(toggle): def enableOversampling(toggle):
""" """
Enable/disable oversampling (anit-aliasing). Enable/disable oversampling (anti-aliasing).
@type toggle: int @type toggle: int
@param toggle: pass 1 for on / 0 for off @param toggle: pass 1 for on / 0 for off
""" """
@@ -497,7 +497,7 @@ class RenderData:
def enableKey(): def enableKey():
""" """
Enable alpha and colour values remain unchanged. Enable alpha and color values remain unchanged.
""" """
def enableShadow(toggle): def enableShadow(toggle):
@@ -572,7 +572,7 @@ class RenderData:
def enableGaussFilter(toggle): def enableGaussFilter(toggle):
""" """
Enable/disable Gauss sampling filter for antialiasing. Enable/disable Gauss sampling filter for anti-aliasing.
@type toggle: int @type toggle: int
@param toggle: pass 1 for on / 0 for off @param toggle: pass 1 for on / 0 for off
""" """
@@ -691,15 +691,15 @@ class RenderData:
Set the type of image to output from the render. Set the type of image to output from the render.
@type type: enum constant @type type: enum constant
@param type: must be one of 13 constants: @param type: must be one of 13 constants:
- AVIRAW: Uncompressed AVI files. AVI is a commonly used format on Windows plattforms - AVIRAW: Uncompressed AVI files. AVI is a commonly used format on Windows platforms
- AVIJPEG: AVI movie w/ Jpeg images - AVIJPEG: AVI movie w/ JPEG images
- AVICODEC: AVI using win32 codec - AVICODEC: AVI using win32 codec
- QUICKTIME: Quicktime movie (if enabled) - QUICKTIME: Quicktime movie (if enabled)
- TARGA: Targa files - TARGA: Targa files
- RAWTGA: Raw Targa files - RAWTGA: Raw Targa files
- PNG: Png files - PNG: Png files
- BMP: Bitmap files - BMP: Bitmap files
- JPEG90: Jpeg files - JPEG90: JPEG files
- HAMX: Hamx files - HAMX: Hamx files
- IRIS: Iris files - IRIS: Iris files
- IRIZ: Iris + z-buffer files - IRIZ: Iris + z-buffer files
@@ -708,7 +708,7 @@ class RenderData:
def quality(qual = None): def quality(qual = None):
""" """
Get/set quality get/setting for JPEG images, AVI Jpeg and SGI movies. Get/set quality get/setting for JPEG images, AVI JPEG and SGI movies.
@type qual: int (optional) @type qual: int (optional)
@param qual: must be between 10 - 100 @param qual: must be between 10 - 100
@rtype: int (if prototype is empty) @rtype: int (if prototype is empty)
@@ -726,7 +726,7 @@ class RenderData:
def enableGrayscale(): def enableGrayscale():
""" """
Images are saved with BW (grayscale) data. Images are saved with black and white (grayscale) data.
""" """
def enableRGBColor(): def enableRGBColor():
@@ -779,7 +779,7 @@ class RenderData:
Set yafray global Illumination method. Set yafray global Illumination method.
@type type: enum constant @type type: enum constant
@param type: must be one of 3 constants: @param type: must be one of 3 constants:
- NONE: Dont use GI illumination - NONE: Do not use GI illumination
- SKYDOME: Use Skydome method - SKYDOME: Use Skydome method
- GIFULL: Use Full method - GIFULL: Use Full method
""" """
@@ -873,7 +873,7 @@ class RenderData:
def enableYafrayGITunePhotons(toggle): def enableYafrayGITunePhotons(toggle):
""" """
Enable/disable show the photonmap directly in the render for tuning. Enable/disable show the photon map directly in the render for tuning.
YafrayMethod must be GIFULL and Photons enabled. YafrayMethod must be GIFULL and Photons enabled.
@type toggle: int @type toggle: int
@param toggle: pass 1 for on / 0 for off @param toggle: pass 1 for on / 0 for off
@@ -964,7 +964,7 @@ class RenderData:
def enableGameFrameStretch(): def enableGameFrameStretch():
""" """
Enble stretch or squeeze the viewport to fill the display window. Enable stretch or squeeze the viewport to fill the display window.
""" """
def enableGameFrameExpose(): def enableGameFrameExpose():

View File

@@ -62,7 +62,7 @@ class Text3d:
Set the name of this Text3d object. Set the name of this Text3d object.
@type name: string @type name: string
@param name: The new name. @param name: The new name.
@returns: PyNone @returns: None
""" """
def getText(): def getText():
@@ -76,7 +76,7 @@ class Text3d:
Set the text string in this Text3d object Set the text string in this Text3d object
@type name: string @type name: string
@param name: The new text string for this object. @param name: The new text string for this object.
@returns: PyNone @returns: None
""" """
def getDrawMode(): def getDrawMode():
@@ -95,7 +95,7 @@ class Text3d:
- DRAW3D - DRAW3D
- DRAWFRONT - DRAWFRONT
- DRAWBACK - DRAWBACK
@rtype: PyNone @rtype: None
@type val: single module constant or tuple of module constants @type val: single module constant or tuple of module constants
@param val : The Text3d's modes. See L{getDrawMode} for the meaning of @param val : The Text3d's modes. See L{getDrawMode} for the meaning of
the constants. the constants.
@@ -120,7 +120,7 @@ class Text3d:
def setBevelAmount(bevelresol): def setBevelAmount(bevelresol):
""" """
Set the Text3d's bevel resolution value. Set the Text3d's bevel resolution value.
@rtype: PyNone @rtype: None
@type bevelresol: float @type bevelresol: float
@param bevelresol: The new Curve's bevel resolution value. @param bevelresol: The new Curve's bevel resolution value.
""" """
@@ -134,7 +134,7 @@ class Text3d:
def setDefaultResolution(resolu): def setDefaultResolution(resolu):
""" """
Sets Default text Resolution. Sets Default text Resolution.
@rtype: PyNone @rtype: None
@type resolu: float @type resolu: float
@param resolu: The new Curve's U-resolution value. @param resolu: The new Curve's U-resolution value.
""" """
@@ -148,7 +148,7 @@ class Text3d:
def setWidth(width): def setWidth(width):
""" """
Set the Text3d's width value. Set the Text3d's width value.
@rtype: PyNone @rtype: None
@type width: float @type width: float
@param width: The new text3d's width value. @param width: The new text3d's width value.
""" """
@@ -162,7 +162,7 @@ class Text3d:
def setgetExtrudeDepth(ext1): def setgetExtrudeDepth(ext1):
""" """
Set the text3d's ext1 value. Set the text3d's ext1 value.
@rtype: PyNone @rtype: None
@type ext1: float @type ext1: float
@param ext1: The new text3d's ext1 value. @param ext1: The new text3d's ext1 value.
""" """
@@ -176,7 +176,7 @@ class Text3d:
def setExtrudeBevelDepth(ext2): def setExtrudeBevelDepth(ext2):
""" """
Set the text3d's ext2 value. Set the text3d's ext2 value.
@rtype: PyNone @rtype: None
@type ext2: float @type ext2: float
@param ext2: The new text3d's ext2 value. @param ext2: The new text3d's ext2 value.
""" """
@@ -190,7 +190,7 @@ class Text3d:
def setShear(shear): def setShear(shear):
""" """
Set the text3d's shear value. Set the text3d's shear value.
@rtype: PyNone @rtype: None
@type shear: float @type shear: float
@param shear: The new text3d's shear value. @param shear: The new text3d's shear value.
""" """
@@ -204,7 +204,7 @@ class Text3d:
def setSize(size): def setSize(size):
""" """
Set the text3d's size value. Set the text3d's size value.
@rtype: PyNone @rtype: None
@type size: float @type size: float
@param size: The new text3d's size value. @param size: The new text3d's size value.
""" """
@@ -218,7 +218,7 @@ class Text3d:
def setLineSeparation(sep): def setLineSeparation(sep):
""" """
Set the text3d's ext2 value. Set the text3d's ext2 value.
@rtype: PyNone @rtype: None
@type sep: float @type sep: float
@param sep: The new text3d's separation value. @param sep: The new text3d's separation value.
""" """
@@ -232,7 +232,7 @@ class Text3d:
def setSpacing(spacing): def setSpacing(spacing):
""" """
Set the text3d's spacing value. Set the text3d's spacing value.
@rtype: PyNone @rtype: None
@type spacing: float @type spacing: float
@param spacing: The new text3d's spacing value. @param spacing: The new text3d's spacing value.
""" """
@@ -246,7 +246,7 @@ class Text3d:
def setXoffset(xof): def setXoffset(xof):
""" """
Set the text3d's Xoffset value. Set the text3d's Xoffset value.
@rtype: PyNone @rtype: None
@type xof: float @type xof: float
@param xof: The new text3d's Xoffset value. @param xof: The new text3d's Xoffset value.
""" """
@@ -260,7 +260,7 @@ class Text3d:
def setYoffset(yof): def setYoffset(yof):
""" """
Set the text3d's Yoffset value. Set the text3d's Yoffset value.
@rtype: PyNone @rtype: None
@type yof: float @type yof: float
@param yof: The new text3d's Yoffset value. @param yof: The new text3d's Yoffset value.
""" """
@@ -282,7 +282,7 @@ class Text3d:
- RIGHT - RIGHT
- MIDDLE - MIDDLE
- FLUSH - FLUSH
@rtype: PyNone @rtype: None
@type align: module constant @type align: module constant
@param align: The new text3d's Alignment value. @param align: The new text3d's Alignment value.
""" """

View File

@@ -21,7 +21,7 @@ Example::
import Blender import Blender
from Blender import * from Blender import *
AllWorlds = Blender.World.Get() # returns a list of created world obejcts AllWorlds = Blender.World.Get() # returns a list of created world objects
AvailWorlds = len(AllWorlds) # returns the number of available world objects AvailWorlds = len(AllWorlds) # returns the number of available world objects
PropWorld = dir(AllWorlds[0]) # returns the properties of the class world PropWorld = dir(AllWorlds[0]) # returns the properties of the class world
NameWorld = AllWorlds[0].getName() # get name of the first world object NameWorld = AllWorlds[0].getName() # get name of the first world object
@@ -32,8 +32,8 @@ Example::
HorColor = AllWorlds[0].getHor() # horizon color of the first world object HorColor = AllWorlds[0].getHor() # horizon color of the first world object
HorColorR = HorColor[0] # get the red channel (RGB) of the horizon color HorColorR = HorColor[0] # get the red channel (RGB) of the horizon color
ZenColor = AllWorlds[0].getZen() # zenit color of the first world object ZenColor = AllWorlds[0].getZen() # zenith color of the first world object
ZenColorB = ZenColor[2] # get the blue channel (RGB) of the Zenit color ZenColorB = ZenColor[2] # get the blue channel (RGB) of the Zenith color
blending = AllWorlds[0].getSkytype() # get the blending modes (real, blend, paper) of the first world object blending = AllWorlds[0].getSkytype() # get the blending modes (real, blend, paper) of the first world object
""" """
@@ -42,7 +42,7 @@ def New (name):
""" """
Creates a new World. Creates a new World.
@type name: string @type name: string
@param name: World's name (optionnal). @param name: World's name (optional).
@rtype: Blender World @rtype: Blender World
@return: The created World. If the "name" parameter has not been provided, it will be automatically be set by blender. @return: The created World. If the "name" parameter has not been provided, it will be automatically be set by blender.
""" """
@@ -97,8 +97,8 @@ class World:
Sets the range parameter of a world object. Sets the range parameter of a world object.
@type range: float @type range: float
@param range: the new range parameter @param range: the new range parameter
@rtype: PyNone @rtype: None
@return: PyNone @return: None
""" """
def getName(): def getName():
@@ -113,8 +113,8 @@ class World:
Sets the name of a world object. Sets the name of a world object.
@type name: string @type name: string
@param name : the new name. @param name : the new name.
@rtype: PyNone @rtype: None
@return: PyNone @return: None
""" """
def getIpo(): def getIpo():
@@ -151,8 +151,8 @@ class World:
See getSkytype for the semantics of the parameter. See getSkytype for the semantics of the parameter.
@type skytype: int @type skytype: int
@param skytype : the new skytype. @param skytype : the new skytype.
@rtype: PyNone @rtype: None
@return: PyNone @return: None
""" """
def getMode(): def getMode():
@@ -173,8 +173,8 @@ class World:
See getMode for the semantics of the parameter. See getMode for the semantics of the parameter.
@type mode: int @type mode: int
@param mode : the new mode. @param mode : the new mode.
@rtype: PyNone @rtype: None
@return: PyNone @return: None
""" """
def getMistype(): def getMistype():
@@ -191,8 +191,8 @@ class World:
See getMistype for the semantics of the parameter. See getMistype for the semantics of the parameter.
@type mistype: int @type mistype: int
@param mistype : the new mist type. @param mistype : the new mist type.
@rtype: PyNone @rtype: None
@return: PyNone @return: None
""" """
def getHor(): def getHor():
@@ -208,8 +208,8 @@ class World:
Sets the horizon color of a world object. Sets the horizon color of a world object.
@type hor: list of three floats @type hor: list of three floats
@param hor : the new hor. @param hor : the new hor.
@rtype: PyNone @rtype: None
@return: PyNone @return: None
""" """
def getZen(): def getZen():
@@ -225,8 +225,8 @@ class World:
Sets the zenith color of a world object. Sets the zenith color of a world object.
@type zen: list of three floats @type zen: list of three floats
@param zen : the new zenith color. @param zen : the new zenith color.
@rtype: PyNone @rtype: None
@return: PyNone @return: None
""" """
def getAmb(): def getAmb():
@@ -242,8 +242,8 @@ class World:
Sets the ambient color of a world object. Sets the ambient color of a world object.
@type amb: list of three floats @type amb: list of three floats
@param amb : the new ambient color. @param amb : the new ambient color.
@rtype: PyNone @rtype: None
@return: PyNone @return: None
""" """
def getStar(): def getStar():
@@ -267,8 +267,8 @@ class World:
See getStar for the semantics of the parameter. See getStar for the semantics of the parameter.
@type star: list of 9 floats @type star: list of 9 floats
@param star : the new star parameters. @param star : the new star parameters.
@rtype: PyNone @rtype: None
@return: PyNone @return: None
""" """
def getMist(): def getMist():
@@ -289,8 +289,8 @@ class World:
See getMist for the semantics of the parameter. See getMist for the semantics of the parameter.
@type mist: list of 4 floats @type mist: list of 4 floats
@param mist : the new mist parameters. @param mist : the new mist parameters.
@rtype: PyNone @rtype: None
@return: PyNone @return: None
""" """
def getScriptLinks (event): def getScriptLinks (event):
@@ -323,8 +323,8 @@ class World:
def setCurrent (): def setCurrent ():
""" """
Make this world active in the current scene. Make this world active in the current scene.
@rtype: PyNone @rtype: None
@return: PyNone @return: None
""" """
def insertIpoKey(keytype): def insertIpoKey(keytype):