diff options
| author | Stephen Swaney <sswaney@centurytel.net> | 2005-06-15 10:22:26 +0400 |
|---|---|---|
| committer | Stephen Swaney <sswaney@centurytel.net> | 2005-06-15 10:22:26 +0400 |
| commit | 401dfba3051856906c487c4adb85b09358d57f7d (patch) | |
| tree | d6e2358d847bc8385756f17655248751e5a11dc0 | |
| parent | 7eee2e7f8a38aa72695f13a21fe82906a6104cda (diff) | |
Changes to Documentation Format ONLY.v2.37a
no executable code.
Martin noticed many of our bpy instance variables were
incorrectly marked as class variables in the doc. This
commit essentially changes the title of sections of the doc
from Class Variables to Instance Variables. Now that we are
adding class or module dictionaries for constants, etc. this is
a distinction worth making. Plus it is right.
24 files changed, 351 insertions, 351 deletions
diff --git a/source/blender/python/api2_2x/doc/Armature.py b/source/blender/python/api2_2x/doc/Armature.py index 7ca77e36417..4c07b48493c 100644 --- a/source/blender/python/api2_2x/doc/Armature.py +++ b/source/blender/python/api2_2x/doc/Armature.py @@ -45,8 +45,8 @@ class Armature: The Armature object =================== This object gives access to Armature-specific data in Blender. - @cvar name: The Armature name. - @cvar bones: A List of Bones that make up this armature. + @ivar name: The Armature name. + @ivar bones: A List of Bones that make up this armature. """ def getName(): @@ -91,4 +91,4 @@ class Armature: Set whether or not to draw the armature's names per bone. @type bool: boolean (true or false) @param bool: specifies whether or not to draw names - """
\ No newline at end of file + """ diff --git a/source/blender/python/api2_2x/doc/BGL.py b/source/blender/python/api2_2x/doc/BGL.py index d9a06d836bf..2bed4380b44 100644 --- a/source/blender/python/api2_2x/doc/BGL.py +++ b/source/blender/python/api2_2x/doc/BGL.py @@ -1716,8 +1716,8 @@ class Buffer: sliceBuffer = myByteBuffer[0:16] print sliceBuffer - @cvar list: The contents of the Buffer. - @cvar dimensions: The size of the Buffer. + @ivar list: The contents of the Buffer. + @ivar dimensions: The size of the Buffer. """ def __init__(type, dimensions, template = None): diff --git a/source/blender/python/api2_2x/doc/Bone.py b/source/blender/python/api2_2x/doc/Bone.py index 894eb681ed2..e0df69b3c67 100644 --- a/source/blender/python/api2_2x/doc/Bone.py +++ b/source/blender/python/api2_2x/doc/Bone.py @@ -76,18 +76,18 @@ class Bone: The Bone object =============== This object gives access to Bone-specific data in Blender. - @cvar name: The name of this Bone. - @cvar roll: This Bone's roll value. - @cvar head: This Bone's "head" ending position when in rest state. - @cvar tail: This Bone's "tail" ending position when in rest state. - @cvar loc: This Bone's location. - @cvar size: This Bone's size. - @cvar quat: This Bone's quaternion. - @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. + @ivar name: The name of this Bone. + @ivar roll: This Bone's roll value. + @ivar head: This Bone's "head" ending position when in rest state. + @ivar tail: This Bone's "tail" ending position when in rest state. + @ivar loc: This Bone's location. + @ivar size: This Bone's size. + @ivar quat: This Bone's quaternion. + @ivar parent: The parent Bone. + @ivar children: The children bones. + @ivar weight: The bone's weight. + @ivar ik: Whether the bone is set to IK. + @ivar boneclass: The boneclass of this bone. """ def getName(): diff --git a/source/blender/python/api2_2x/doc/Camera.py b/source/blender/python/api2_2x/doc/Camera.py index ac0319f8fff..57a4da9b18e 100644 --- a/source/blender/python/api2_2x/doc/Camera.py +++ b/source/blender/python/api2_2x/doc/Camera.py @@ -49,18 +49,18 @@ class Camera: The Camera Data object ====================== This object gives access to Camera-specific data in Blender. - @cvar name: The Camera Data name. - @cvar type: The Camera type: 'persp':0 or 'ortho':1. - @cvar mode: The mode flags: B{or'ed value}: 'showLimits':1, 'showMist':2. - @cvar lens: The lens value in [1.0, 250.0], only relevant to *persp* + @ivar name: The Camera Data name. + @ivar type: The Camera type: 'persp':0 or 'ortho':1. + @ivar mode: The mode flags: B{or'ed value}: 'showLimits':1, 'showMist':2. + @ivar lens: The lens value in [1.0, 250.0], only relevant to *persp* cameras. - @cvar scale: The scale value in [0.01, 1000.00], only relevant to *ortho* + @ivar scale: The scale value in [0.01, 1000.00], only relevant to *ortho* cameras. - @cvar clipStart: The clip start value in [0.0, 100.0]. - @cvar clipEnd: The clip end value in [1.0, 5000.0]. - @cvar drawSize: The draw size value in [0.1, 10.0]. + @ivar clipStart: The clip start value in [0.0, 100.0]. + @ivar clipEnd: The clip end value in [1.0, 5000.0]. + @ivar drawSize: The draw size value in [0.1, 10.0]. @type ipo: Blender Ipo - @cvar ipo: The "camera data" ipo linked to this camera data object. + @ivar ipo: The "camera data" ipo linked to this camera data object. @warning: Most member variables assume values in some [Min, Max] interval. When trying to set them, the given parameter will be clamped to lie in that range: if val < Min, then val = Min, if val > Max, then val = Max. diff --git a/source/blender/python/api2_2x/doc/Curve.py b/source/blender/python/api2_2x/doc/Curve.py index b708ec7fc4b..9a345df5f5a 100644 --- a/source/blender/python/api2_2x/doc/Curve.py +++ b/source/blender/python/api2_2x/doc/Curve.py @@ -34,7 +34,7 @@ Iterator Example:: """ -def New ( name = 'CurData'): +def New ( name): """ Create a new Curve Data object. @type name: string @@ -60,20 +60,20 @@ class Curve: ===================== This object gives access to Curve-specific data in Blender. - @cvar name: The Curve Data name. - @cvar pathlen: The Curve Data path length. - @cvar totcol: The Curve Data maximal number of linked materials. - @cvar flag: The Curve Data flag value; see function getFlag for the semantics. - @cvar bevresol: The Curve Data bevel resolution. - @cvar resolu: The Curve Data U-resolution. - @cvar resolv: The Curve Data V-resolution. - @cvar width: The Curve Data width. - @cvar ext1: The Curve Data extent 1(for bevels). - @cvar ext2: The Curve Data extent2 (for bevels). - @cvar loc: The Curve Data location(from the center). - @cvar rot: The Curve Data rotation(from the center). - @cvar size: The Curve Data size(from the center). - @cvar bevob: The Curve Bevel Object + @ivar name: The Curve Data name. + @ivar pathlen: The Curve Data path length. + @ivar totcol: The Curve Data maximal number of linked materials. + @ivar flag: The Curve Data flag value; see function getFlag for the semantics. + @ivar bevresol: The Curve Data bevel resolution. + @ivar resolu: The Curve Data U-resolution. + @ivar resolv: The Curve Data V-resolution. + @ivar width: The Curve Data width. + @ivar ext1: The Curve Data extent 1(for bevels). + @ivar ext2: The Curve Data extent2 (for bevels). + @ivar loc: The Curve Data location(from the center). + @ivar rot: The Curve Data rotation(from the center). + @ivar size: The Curve Data size(from the center). + @ivar bevob: The Curve Bevel Object """ def getName(): @@ -392,9 +392,9 @@ class CurNurb: The CurNurb also supports the sequence protocol which means you can access the control points of a CurNurb using the [] operator. - @cvar flagU: The CurNurb knot flag U (0: uniform, 1: endpoints, 2: bezier) - @cvar flagV: The CurNurb knot flag V (0: uniform, 1: endpoints, 2: bezier) - @cvar type: The type of the curve (Poly: 0, Bezier: 1, NURBS: 4) + @ivar flagU: The CurNurb knot flag U (0: uniform, 1: endpoints, 2: bezier) + @ivar flagV: The CurNurb knot flag V (0: uniform, 1: endpoints, 2: bezier) + @ivar type: The type of the curve (Poly: 0, Bezier: 1, NURBS: 4) """ def __setitem__( n, point ): diff --git a/source/blender/python/api2_2x/doc/Draw.py b/source/blender/python/api2_2x/doc/Draw.py index 9988cceb3d5..c97331c5cfe 100644 --- a/source/blender/python/api2_2x/doc/Draw.py +++ b/source/blender/python/api2_2x/doc/Draw.py @@ -681,5 +681,5 @@ class Button: ================= This object represents a button in Blender's GUI. @type val: int or float or string (depends on button type). - @cvar val: The button's value. + @ivar val: The button's value. """ diff --git a/source/blender/python/api2_2x/doc/Effect.py b/source/blender/python/api2_2x/doc/Effect.py index b503523d3ec..8b4a65cd2f5 100644 --- a/source/blender/python/api2_2x/doc/Effect.py +++ b/source/blender/python/api2_2x/doc/Effect.py @@ -63,34 +63,34 @@ class Effect: This object gives access to generic data from all effects in Blender. Its attributes depend upon its type. - @cvar seed: (Particle effects) seed of the RNG. - @cvar nabla: (Particle effects) The nabla value . - @cvar sta: (Particle effects) start time of the effect. - @cvar end: (Particle effects) end time of the effect - @cvar lifetime: (Particle and Wave effects)lifetime of the effect - @cvar normfac: (Particle effects) normal strength of the particles (relatively to mesh). - @cvar obfac: (Particle effects)initial strength of the particles relatively to objects. - @cvar randfac: (Particle effects) initial random speed of the particles. - @cvar texfac: (Particle effects) initial speed of the particles caused by the texture. - @cvar randlife: (Particle effects) variability of the life of the particles. - @cvar vectsize: (Particle effects) size of vectors associated to the particles (if any). - @cvar totpart: (Particle effects) total number of particles. - @cvar force: (Particle effects) constant force applied to the parts. - @cvar mult: (Particle effects) probabilities of a particle having a child. - @cvar child: (Particle effects) number of children a particle may have. - @cvar mat: (Particle effects) materials used by the 4 generation particles. - @cvar defvec: (Particle effects)x, y and z axis of the force defined by the texture. - @cvar sfra: (Build effects) starting frame of the build effect. - @cvar len: (Build effects) length of the build effect. - @cvar timeoffs: (Wave effects) time offset of the wave effect. - @cvar damp: (Wave effects) damp factor of the wave effect. - @cvar minfac: (Wave effects) - @cvar speed: (Wave effects) speed of the wave effect. - @cvar narrow: (Wave effects)narrowness of the wave effect. - @cvar width: (Wave effects) width of the wave effect. - @cvar height: (Wave effects) height of the wave effect. - @cvar startx: (Wave effects) x-position of the origin of the wave effect. - @cvar starty: (Wave effects) y-position of the origin of the wave effect. + @ivar seed: (Particle effects) seed of the RNG. + @ivar nabla: (Particle effects) The nabla value . + @ivar sta: (Particle effects) start time of the effect. + @ivar end: (Particle effects) end time of the effect + @ivar lifetime: (Particle and Wave effects)lifetime of the effect + @ivar normfac: (Particle effects) normal strength of the particles (relatively to mesh). + @ivar obfac: (Particle effects)initial strength of the particles relatively to objects. + @ivar randfac: (Particle effects) initial random speed of the particles. + @ivar texfac: (Particle effects) initial speed of the particles caused by the texture. + @ivar randlife: (Particle effects) variability of the life of the particles. + @ivar vectsize: (Particle effects) size of vectors associated to the particles (if any). + @ivar totpart: (Particle effects) total number of particles. + @ivar force: (Particle effects) constant force applied to the parts. + @ivar mult: (Particle effects) probabilities of a particle having a child. + @ivar child: (Particle effects) number of children a particle may have. + @ivar mat: (Particle effects) materials used by the 4 generation particles. + @ivar defvec: (Particle effects)x, y and z axis of the force defined by the texture. + @ivar sfra: (Build effects) starting frame of the build effect. + @ivar len: (Build effects) length of the build effect. + @ivar timeoffs: (Wave effects) time offset of the wave effect. + @ivar damp: (Wave effects) damp factor of the wave effect. + @ivar minfac: (Wave effects) + @ivar speed: (Wave effects) speed of the wave effect. + @ivar narrow: (Wave effects)narrowness of the wave effect. + @ivar width: (Wave effects) width of the wave effect. + @ivar height: (Wave effects) height of the wave effect. + @ivar startx: (Wave effects) x-position of the origin of the wave effect. + @ivar starty: (Wave effects) y-position of the origin of the wave effect. """ def getType(): diff --git a/source/blender/python/api2_2x/doc/Font.py b/source/blender/python/api2_2x/doc/Font.py index 54167b9c268..e1e164ec3a7 100644 --- a/source/blender/python/api2_2x/doc/Font.py +++ b/source/blender/python/api2_2x/doc/Font.py @@ -47,10 +47,10 @@ class Font: The Text3d.Font object ====================== This object gives access Blender's B{Font} objects - @cvar name: The Text3d name. - @cvar filename: The filename of the file loaded into this Text. - @cvar mode: The follow_mode flag: if 1 it is 'on'; if 0, 'off'. - @cvar nlines: The number of lines in this Text. + @ivar name: The Text3d name. + @ivar filename: The filename of the file loaded into this Text. + @ivar mode: The follow_mode flag: if 1 it is 'on'; if 0, 'off'. + @ivar nlines: The number of lines in this Text. """ def getName(): diff --git a/source/blender/python/api2_2x/doc/Image.py b/source/blender/python/api2_2x/doc/Image.py index a7b2cb693eb..1f604767aca 100644 --- a/source/blender/python/api2_2x/doc/Image.py +++ b/source/blender/python/api2_2x/doc/Image.py @@ -58,16 +58,16 @@ class Image: The Image object ================ This object gives access to Images in Blender. - @cvar name: The name of this Image object. - @cvar filename: The filename (path) to the image file loaded into this Image + @ivar name: The name of this Image object. + @ivar filename: The filename (path) to the image file loaded into this Image object. - @cvar size: The [width, height] dimensions of the image (in pixels). - @cvar depth: The pixel depth of the image. - @cvar xrep: Texture tiling: the number of repetitions in the x (horizontal) + @ivar size: The [width, height] dimensions of the image (in pixels). + @ivar depth: The pixel depth of the image. + @ivar xrep: Texture tiling: the number of repetitions in the x (horizontal) axis. - @cvar yrep: Texture tiling: the number of repetitions in the y (vertical) + @ivar yrep: Texture tiling: the number of repetitions in the y (vertical) axis. - @cvar bindcode: Texture's bind code (readonly). + @ivar bindcode: Texture's bind code (readonly). """ def getName(): diff --git a/source/blender/python/api2_2x/doc/Ipo.py b/source/blender/python/api2_2x/doc/Ipo.py index bda2f12a623..8d2ee47b324 100644 --- a/source/blender/python/api2_2x/doc/Ipo.py +++ b/source/blender/python/api2_2x/doc/Ipo.py @@ -260,8 +260,8 @@ class IpoCurve: Important Notes for Rotation Curves:\n 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. + @ivar name: The Curve Data name. + @ivar bezierPoints : The list of the Bezier points. """ def setExtrapolation(extendmode): @@ -378,8 +378,8 @@ class BezTriple: The BezTriple object ==================== This object gives access to generic data from all beztriple objects in Blender. If an attribute is listed as being 'read-only' that means you cannot write to it. Use the set*() methods instead. - @cvar pt : a list of the [x,y] coordinates for knot point of this BezTriple. read-only. - @cvar vec : a list of the 3 points [ handle, knot, handle ] that comprise a BezTriple. See the getTriple() method for an example of the format. read-only. + @ivar pt : a list of the [x,y] coordinates for knot point of this BezTriple. read-only. + @ivar vec : a list of the 3 points [ handle, knot, handle ] that comprise a BezTriple. See the getTriple() method for an example of the format. read-only. """ def getPoints(): diff --git a/source/blender/python/api2_2x/doc/Lamp.py b/source/blender/python/api2_2x/doc/Lamp.py index 7c8aa9dedc7..98a1d223e55 100644 --- a/source/blender/python/api2_2x/doc/Lamp.py +++ b/source/blender/python/api2_2x/doc/Lamp.py @@ -46,8 +46,8 @@ class Lamp: The Lamp Data object ==================== This object gives access to Lamp-specific data in Blender. - @cvar name: The Lamp Data name. - @cvar type: The Lamp type (see the Types dict). + @ivar name: The Lamp Data name. + @ivar type: The Lamp type (see the Types dict). @cvar Types: The Types dictionary. - 'Lamp': 0 - 'Sun' : 1 @@ -55,7 +55,7 @@ class Lamp: - 'Hemi': 3 - 'Area': 4 - 'Photon': 5 - @cvar mode: The mode flags: B{or'ed value} of the flags in the Modes dict. + @ivar mode: The mode flags: B{or'ed value} of the flags in the Modes dict. @cvar Modes: The Modes dictionary. - 'Shadows' - 'Halo' @@ -65,21 +65,21 @@ class Lamp: - 'OnlyShadow' - 'Sphere' - 'Square' - @cvar samples: The number of shadow map samples in [1, 16]. - @cvar bufferSize: The size of the shadow buffer in [512, 5120]. - @cvar haloStep: Volumetric halo sampling frequency in [0, 12]. - @cvar energy: The intensity of the light in [0.0, 10.0]. - @cvar dist: The distance value in [0.1, 5000.0]. - @cvar spotSize: The angle of the spot beam in degrees in [1.0, 180.0]. - @cvar spotBlend: The softness of the spot edge in [0.0, 1.0]. - @cvar clipStart: The shadow map clip start in [0.1, 1000.0]. - @cvar clipEnd: The shadow map clip end in [1.0, 5000.0]. - @cvar bias: The shadow map sampling bias in [0.01, 5.00]. - @cvar softness: The size of the shadow sample area in [1.0, 100.0]. - @cvar haloInt: The intensity of the spot halo in [0.0, 5.0]. - @cvar quad1: Light intensity value 1 for a Quad lamp in [0.0, 1.0]. - @cvar quad2: Light intensity value 2 for a Quad lamp in [0.0, 1.0]. - @cvar col: The color of the light, with each rgb component in [0.0, 1.0]. + @ivar samples: The number of shadow map samples in [1, 16]. + @ivar bufferSize: The size of the shadow buffer in [512, 5120]. + @ivar haloStep: Volumetric halo sampling frequency in [0, 12]. + @ivar energy: The intensity of the light in [0.0, 10.0]. + @ivar dist: The distance value in [0.1, 5000.0]. + @ivar spotSize: The angle of the spot beam in degrees in [1.0, 180.0]. + @ivar spotBlend: The softness of the spot edge in [0.0, 1.0]. + @ivar clipStart: The shadow map clip start in [0.1, 1000.0]. + @ivar clipEnd: The shadow map clip end in [1.0, 5000.0]. + @ivar bias: The shadow map sampling bias in [0.01, 5.00]. + @ivar softness: The size of the shadow sample area in [1.0, 100.0]. + @ivar haloInt: The intensity of the spot halo in [0.0, 5.0]. + @ivar quad1: Light intensity value 1 for a Quad lamp in [0.0, 1.0]. + @ivar quad2: Light intensity value 2 for a Quad lamp in [0.0, 1.0]. + @ivar col: The color of the light, with each rgb component in [0.0, 1.0]. This is an rgb tuple whose values can be accessed in many ways: - as a tuple: lamp.col, lamp.col[0], same for 1 and 2. - as a dictionary: lamp.col['R'], same for 'G' and 'B'. diff --git a/source/blender/python/api2_2x/doc/Lattice.py b/source/blender/python/api2_2x/doc/Lattice.py index 9f8bf76c336..3723e290491 100644 --- a/source/blender/python/api2_2x/doc/Lattice.py +++ b/source/blender/python/api2_2x/doc/Lattice.py @@ -67,15 +67,15 @@ class Lattice: The Lattice object ================== This object gives access to Lattices in Blender. - @cvar name: The Lattice name. - @cvar width: The number of x dimension partitions. - @cvar height: The number of y dimension partitions. - @cvar depth: The number of z dimension partitions. - @cvar widthType: The x dimension key type. - @cvar heightType: The y dimension key type. - @cvar depthType: The z dimension key type. - @cvar mode: The current mode of the Lattice. - @cvar latSize: The number of points in this Lattice. + @ivar name: The Lattice name. + @ivar width: The number of x dimension partitions. + @ivar height: The number of y dimension partitions. + @ivar depth: The number of z dimension partitions. + @ivar widthType: The x dimension key type. + @ivar heightType: The y dimension key type. + @ivar depthType: The z dimension key type. + @ivar mode: The current mode of the Lattice. + @ivar latSize: The number of points in this Lattice. """ def getName(): diff --git a/source/blender/python/api2_2x/doc/Material.py b/source/blender/python/api2_2x/doc/Material.py index 59914a32d53..936154c0c29 100644 --- a/source/blender/python/api2_2x/doc/Material.py +++ b/source/blender/python/api2_2x/doc/Material.py @@ -83,47 +83,47 @@ class Material: The Material object =================== This object gives access to Materials in Blender. - @cvar name: Material's name. + @ivar name: Material's name. @type mode: int - @cvar mode: Mode flags as an or'ed int value. See the Modes dictionary keys + @ivar mode: Mode flags as an or'ed int value. See the Modes dictionary keys and descriptions in L{Modes}. - @cvar rgbCol: Material's RGB color triplet sequence. - @cvar specCol: Specular color rgb triplet sequence. - @cvar mirCol: Mirror color rgb triplet sequence. - @cvar R: Red component of L{rgbCol} - [0.0, 1.0]. - @cvar G: Green component of L{rgbCol} - [0.0, 1.0]. - @cvar B: Blue component of L{rgbCol} - [0.0, 1.0]. - @cvar alpha: Alpha (translucency) component of the Material - [0.0, 1.0]. - @cvar amb: Ambient factor - [0.0, 1.0]. - @cvar emit: Emitting light intensity - [0.0, 1.0]. - @cvar ref: Reflectivity - [0.0, 1.0]. - @cvar spec: Specularity - [0.0, 2.0]. - @cvar specTransp: Specular transparency - [0.0, 1.0]. - @cvar add: Glow factor - [0.0, 1.0]. - @cvar zOffset: Artificial Z offset for faces - [0.0, 10.0]. - @cvar haloSize: Dimension of the halo - [0.0, 100.0]. - @cvar flareSize: Factor the flare is larger than the halo - [0.1, 25.0]. - @cvar flareBoost: Flare's extra strength - [0.1, 10.0]. - @cvar haloSeed: To use random values for ring dimension and line location - + @ivar rgbCol: Material's RGB color triplet sequence. + @ivar specCol: Specular color rgb triplet sequence. + @ivar mirCol: Mirror color rgb triplet sequence. + @ivar R: Red component of L{rgbCol} - [0.0, 1.0]. + @ivar G: Green component of L{rgbCol} - [0.0, 1.0]. + @ivar B: Blue component of L{rgbCol} - [0.0, 1.0]. + @ivar alpha: Alpha (translucency) component of the Material - [0.0, 1.0]. + @ivar amb: Ambient factor - [0.0, 1.0]. + @ivar emit: Emitting light intensity - [0.0, 1.0]. + @ivar ref: Reflectivity - [0.0, 1.0]. + @ivar spec: Specularity - [0.0, 2.0]. + @ivar specTransp: Specular transparency - [0.0, 1.0]. + @ivar add: Glow factor - [0.0, 1.0]. + @ivar zOffset: Artificial Z offset for faces - [0.0, 10.0]. + @ivar haloSize: Dimension of the halo - [0.0, 100.0]. + @ivar flareSize: Factor the flare is larger than the halo - [0.1, 25.0]. + @ivar flareBoost: Flare's extra strength - [0.1, 10.0]. + @ivar haloSeed: To use random values for ring dimension and line location - [0, 255]. - @cvar flareSeed: Offset in the seed table - [0, 255]. - @cvar subSize: Dimension of subflares, dots and circles - [0.1, 25.0]. - @cvar hard: Hardness of the specularity - [1, 255]. - @cvar nFlares: Number of halo subflares - [1, 32]. - @cvar nStars: Number of points on the halo stars - [3, 50]. - @cvar nLines: Number of star shaped lines on each halo - [0, 250]. - @cvar nRings: Number of halo rings - [0, 24]. + @ivar flareSeed: Offset in the seed table - [0, 255]. + @ivar subSize: Dimension of subflares, dots and circles - [0.1, 25.0]. + @ivar hard: Hardness of the specularity - [1, 255]. + @ivar nFlares: Number of halo subflares - [1, 32]. + @ivar nStars: Number of points on the halo stars - [3, 50]. + @ivar nLines: Number of star shaped lines on each halo - [0, 250]. + @ivar nRings: Number of halo rings - [0, 24]. @type ipo: Blender Ipo - @cvar ipo: This Material's ipo. - @cvar rayMirr: Amount mirror reflection for raytrace. - @cvar rayMirrDepth: Amount of inter-reflections calculated maximal. - @cvar fresnelDepth: Power of Fresnel for mirror reflection. - @cvar fresnelDepthFac: Blending factor for Fresnel. - @cvar IOR: Sets the angular index of refraction for raytrace. - @cvar transDepth: Amount of refractions calculated maximal. - @cvar fresnelTrans: Power of Fresnel for transparency. - @cvar fresnelTransFac: Blending factor for Fresnel. - @cvar specTrans: Makes specular areas opaque on transparent materials. + @ivar ipo: This Material's ipo. + @ivar rayMirr: Amount mirror reflection for raytrace. + @ivar rayMirrDepth: Amount of inter-reflections calculated maximal. + @ivar fresnelDepth: Power of Fresnel for mirror reflection. + @ivar fresnelDepthFac: Blending factor for Fresnel. + @ivar IOR: Sets the angular index of refraction for raytrace. + @ivar transDepth: Amount of refractions calculated maximal. + @ivar fresnelTrans: Power of Fresnel for transparency. + @ivar fresnelTransFac: Blending factor for Fresnel. + @ivar specTrans: Makes specular areas opaque on transparent materials. @warning: Most member variables assume values in some [Min, Max] interval. When trying to set them, the given parameter will be clamped to lie in that range: if val < Min, then val = Min, if val > Max, then val = Max. diff --git a/source/blender/python/api2_2x/doc/Mathutils.py b/source/blender/python/api2_2x/doc/Mathutils.py index 70427b6c074..0319553c6e6 100644 --- a/source/blender/python/api2_2x/doc/Mathutils.py +++ b/source/blender/python/api2_2x/doc/Mathutils.py @@ -304,11 +304,11 @@ class Vector: The Vector object ================= This object gives access to Vectors in Blender. - @cvar x: The x value. - @cvar y: The y value. - @cvar z: The z value (if any). - @cvar w: The w value (if any). - @cvar length: The magnitude of the vector. + @ivar x: The x value. + @ivar y: The y value. + @ivar z: The z value (if any). + @ivar w: The w value (if any). + @ivar length: The magnitude of the vector. """ def __init__(list = None): @@ -361,9 +361,9 @@ class Euler: The Euler object ================ This object gives access to Eulers in Blender. - @cvar x: The heading value in degrees. - @cvar y: The pitch value in degrees. - @cvar z: The roll value in degrees. + @ivar x: The heading value in degrees. + @ivar y: The pitch value in degrees. + @ivar z: The roll value in degrees. """ def __init__(list = None): @@ -410,13 +410,13 @@ class Quaternion: The Quaternion object ===================== This object gives access to Quaternions in Blender. - @cvar w: The w value. - @cvar x: The x value. - @cvar y: The y value. - @cvar z: The z value. - @cvar magnitude: The magnitude of the quaternion. - @cvar axis: Vector representing the axis of rotation. - @cvar angle: A scalar representing the amount of rotation + @ivar w: The w value. + @ivar x: The x value. + @ivar y: The y value. + @ivar z: The z value. + @ivar magnitude: The magnitude of the quaternion. + @ivar axis: Vector representing the axis of rotation. + @ivar angle: A scalar representing the amount of rotation in degrees. """ @@ -485,8 +485,8 @@ class Matrix: The Matrix Object ================= This object gives access to Matrices in Blender. - @cvar rowsize: The row size of the matrix. - @cvar colsize: The column size of the matrix. + @ivar rowsize: The row size of the matrix. + @ivar colsize: The column size of the matrix. """ def __init__(list1 = None, list2 = None, list3 = None, list4 = None): diff --git a/source/blender/python/api2_2x/doc/Metaball.py b/source/blender/python/api2_2x/doc/Metaball.py index 7e00cabe051..cb2fb0a5a65 100644 --- a/source/blender/python/api2_2x/doc/Metaball.py +++ b/source/blender/python/api2_2x/doc/Metaball.py @@ -43,10 +43,10 @@ class Metaball: The Metaball object =================== This metaball gives access to generic data from all metaballs in Blender. - @cvar name: The name of the metaball. - @cvar loc: The location of the metaball. - @cvar rot: The rotation of the metaball. - @cvar size: The size of the metaball. + @ivar name: The name of the metaball. + @ivar loc: The location of the metaball. + @ivar rot: The rotation of the metaball. + @ivar size: The size of the metaball. """ def addMetaelem(paramslist): diff --git a/source/blender/python/api2_2x/doc/NMesh.py b/source/blender/python/api2_2x/doc/NMesh.py index 212feb24a2b..c2f7df2a311 100644 --- a/source/blender/python/api2_2x/doc/NMesh.py +++ b/source/blender/python/api2_2x/doc/NMesh.py @@ -197,10 +197,10 @@ class NMCol: ================ This object is a list of ints: [r, g, b, a] representing an rgba color. - @cvar r: The Red component in [0, 255]. - @cvar g: The Green component in [0, 255]. - @cvar b: The Blue component in [0, 255]. - @cvar a: The Alpha (transparency) component in [0, 255]. + @ivar r: The Red component in [0, 255]. + @ivar g: The Green component in [0, 255]. + @ivar b: The Blue component in [0, 255]. + @ivar a: The Alpha (transparency) component in [0, 255]. """ class NMVert: @@ -209,15 +209,15 @@ class NMVert: ================= This object holds mesh vertex data. @type co: 3D Vector object. - @cvar co: The vertex coordinates (x, y, z). + @ivar co: The vertex coordinates (x, y, z). @type no: 3D Vector object. (unit length) - @cvar no: The vertex normal vector (x, y, z). + @ivar no: The vertex normal vector (x, y, z). @type uvco: 3D Vector object. - @cvar uvco: The vertex texture "sticky" coordinates. The Z value of the Vector is ignored. + @ivar uvco: The vertex texture "sticky" coordinates. The Z value of the Vector is ignored. @type index: int - @cvar index: The vertex index, if owned by a mesh. + @ivar index: The vertex index, if owned by a mesh. @type sel: int - @cvar sel: The selection state (selected:1, unselected:0) of this vertex.\n + @ivar sel: The selection state (selected:1, unselected:0) of this vertex.\n Note: An NMesh will return the selection state of the mesh when EditMod was last exited. A python script operating in EditMode must exit edit mode, before getting the current selection state of the mesh. @warn: There are two kinds of uv texture coordinates in Blender: per vertex ("sticky") and per face vertex (uv in L{NMFace}). In the first, there's @@ -234,13 +234,13 @@ class NMEdge: ================= This object holds mesh edge data. @type v1: NMVert - @cvar v1: The first vertex of the edge. + @ivar v1: The first vertex of the edge. @type v2: NMVert - @cvar v2: The second vertex of the edge. + @ivar v2: The second vertex of the edge. @type crease: int - @cvar crease: The crease value of the edge. It is in the range [0,255]. + @ivar crease: The crease value of the edge. It is in the range [0,255]. @type flag: int - @cvar flag: The bitmask describing edge properties. See L{NMesh.EdgeFlags<EdgeFlags>}. + @ivar flag: The bitmask describing edge properties. See L{NMesh.EdgeFlags<EdgeFlags>}. """ class NMFace: @@ -286,30 +286,30 @@ class NMFace: Blender.Redraw() @type v: list - @cvar v: The list of face vertices (B{up to 4}). + @ivar v: The list of face vertices (B{up to 4}). @type sel: bool - @cvar sel: The selection state (1: selected, 0: unselected) of this NMesh's + @ivar sel: The selection state (1: selected, 0: unselected) of this NMesh's faces *in edit mode*. This is not the same as the selection state of the textured faces (see L{NMesh.NMFace.flag}). @type hide: bool - @cvar hide: The visibility state (1: hidden, 0: visible) of this NMesh's + @ivar hide: The visibility state (1: hidden, 0: visible) of this NMesh's faces *in edit mode*. This is not the same as the visibility state of the textured faces (see L{NMesh.NMFace.flag}). - @cvar col: The list of vertex colours. - @cvar mat: Same as I{materialIndex} below. - @cvar materialIndex: The index of this face's material in its NMesh materials + @ivar col: The list of vertex colours. + @ivar mat: Same as I{materialIndex} below. + @ivar materialIndex: The index of this face's material in its NMesh materials list. - @cvar smooth: If non-zero, the vertex normals are averaged to make this + @ivar smooth: If non-zero, the vertex normals are averaged to make this face look smooth. - @cvar image: The Image used as a texture for this face. - @cvar mode: The display mode (see L{Mesh.FaceModes<FaceModes>}) - @cvar flag: Bit vector specifying selection / visibility flags for uv + @ivar image: The Image used as a texture for this face. + @ivar mode: The display mode (see L{Mesh.FaceModes<FaceModes>}) + @ivar flag: Bit vector specifying selection / visibility flags for uv textured faces (visible in Face Select mode, see L{NMesh.FaceFlags<FaceFlags>}). - @cvar transp: Transparency mode bit vector + @ivar transp: Transparency mode bit vector (see L{NMesh.FaceTranspModes<FaceTranspModes>}). - @cvar uv: List of per-face UV coordinates: [(u0, v0), (u1, v1), ...]. - @cvar normal: (or just B{no}) The normal vector for this face: [x,y,z]. + @ivar uv: List of per-face UV coordinates: [(u0, v0), (u1, v1), ...]. + @ivar normal: (or just B{no}) The normal vector for this face: [x,y,z]. @note: there are normal faces and textured faces in Blender, both currently with their own selection and visibility states, due to a mix of old and new code. To (un)select or (un)hide normal faces (visible in editmode), use @@ -340,17 +340,17 @@ class NMesh: ===================== This object gives access to mesh data in Blender. We refer to mesh as the object in Blender and NMesh as its Python counterpart. - @cvar name: The NMesh name. It's common to use this field to store extra + @ivar name: The NMesh name. It's common to use this field to store extra data about the mesh (to be exported to another program, for example). - @cvar materials: The list of materials used by this NMesh. See + @ivar materials: The list of materials used by this NMesh. See L{NMesh.getMaterials} for important details. - @cvar verts: The list of NMesh vertices (NMVerts). - @cvar users: The number of Objects using (linked to) this mesh. - @cvar faces: The list of NMesh faces (NMFaces). - @cvar edges: None if mesh has no edge data, else a list of L{NMEdge} edges. Use L{addEdgesData} to create edge data if it do not exist. - @cvar mode: The mode flags for this mesh. See L{setMode}. - @cvar subDivLevels: The [display, rendering] subdivision levels in [1, 6]. - @cvar maxSmoothAngle: The max angle for auto smoothing. See L{setMode}. + @ivar verts: The list of NMesh vertices (NMVerts). + @ivar users: The number of Objects using (linked to) this mesh. + @ivar faces: The list of NMesh faces (NMFaces). + @ivar edges: None if mesh has no edge data, else a list of L{NMEdge} edges. Use L{addEdgesData} to create edge data if it do not exist. + @ivar mode: The mode flags for this mesh. See L{setMode}. + @ivar subDivLevels: The [display, rendering] subdivision levels in [1, 6]. + @ivar maxSmoothAngle: The max angle for auto smoothing. See L{setMode}. """ def addEdge(v1, v2): diff --git a/source/blender/python/api2_2x/doc/Object.py b/source/blender/python/api2_2x/doc/Object.py index ef8e31aa415..1247aa576e8 100644 --- a/source/blender/python/api2_2x/doc/Object.py +++ b/source/blender/python/api2_2x/doc/Object.py @@ -104,44 +104,44 @@ class Object: The Object object ================= This object gives access to generic data from all objects in Blender. - @cvar LocX: The X location coordinate of the object. - @cvar LocY: The Y location coordinate of the object. - @cvar LocZ: The Z location coordinate of the object. - @cvar loc: The (X,Y,Z) location coordinates of the object (vector). - @cvar dLocX: The delta X location coordinate of the object. + @ivar LocX: The X location coordinate of the object. + @ivar LocY: The Y location coordinate of the object. + @ivar LocZ: The Z location coordinate of the object. + @ivar loc: The (X,Y,Z) location coordinates of the object (vector). + @ivar dLocX: The delta X location coordinate of the object. This variable applies to IPO Objects only. - @cvar dLocY: The delta Y location coordinate of the object. + @ivar dLocY: The delta Y location coordinate of the object. This variable applies to IPO Objects only. - @cvar dLocZ: The delta Z location coordinate of the object. + @ivar dLocZ: The delta Z location coordinate of the object. This variable applies to IPO Objects only. - @cvar dloc: The delta (X,Y,Z) location coordinates of the object (vector). + @ivar dloc: The delta (X,Y,Z) location coordinates of the object (vector). This variable applies to IPO Objects only. - @cvar RotX: The X rotation angle (in radians) of the object. - @cvar RotY: The Y rotation angle (in radians) of the object. - @cvar RotZ: The Z rotation angle (in radians) of the object. - @cvar rot: The (X,Y,Z) rotation angles (in radians) of the object (vector). - @cvar dRotX: The delta X rotation angle (in radians) of the object. + @ivar RotX: The X rotation angle (in radians) of the object. + @ivar RotY: The Y rotation angle (in radians) of the object. + @ivar RotZ: The Z rotation angle (in radians) of the object. + @ivar rot: The (X,Y,Z) rotation angles (in radians) of the object (vector). + @ivar dRotX: The delta X rotation angle (in radians) of the object. This variable applies to IPO Objects only. - @cvar dRotY: The delta Y rotation angle (in radians) of the object. + @ivar dRotY: The delta Y rotation angle (in radians) of the object. This variable applies to IPO Objects only. - @cvar dRotZ: The delta Z rotation angle (in radians) of the object. + @ivar dRotZ: The delta Z rotation angle (in radians) of the object. This variable applies to IPO Objects only. - @cvar drot: The delta (X,Y,Z) rotation angles (in radians) of the object + @ivar drot: The delta (X,Y,Z) rotation angles (in radians) of the object (vector). This variable applies to IPO Objects only. - @cvar SizeX: The X size of the object. - @cvar SizeY: The Y size of the object. - @cvar SizeZ: The Z size of the object. - @cvar size: The (X,Y,Z) size of the object (vector). - @cvar dSizeX: The delta X size of the object. - @cvar dSizeY: The delta Y size of the object. - @cvar dSizeZ: The delta Z size of the object. - @cvar dsize: The delta (X,Y,Z) size of the object. - @cvar EffX: The X effector coordinate of the object. Only applies to IKA. - @cvar EffY: The Y effector coordinate of the object. Only applies to IKA. - @cvar EffZ: The Z effector coordinate of the object. Only applies to IKA. + @ivar SizeX: The X size of the object. + @ivar SizeY: The Y size of the object. + @ivar SizeZ: The Z size of the object. + @ivar size: The (X,Y,Z) size of the object (vector). + @ivar dSizeX: The delta X size of the object. + @ivar dSizeY: The delta Y size of the object. + @ivar dSizeZ: The delta Z size of the object. + @ivar dsize: The delta (X,Y,Z) size of the object. + @ivar EffX: The X effector coordinate of the object. Only applies to IKA. + @ivar EffY: The Y effector coordinate of the object. Only applies to IKA. + @ivar EffZ: The Z effector coordinate of the object. Only applies to IKA. @type Layers: integer (bitmask) - @cvar Layers: The object layers (also check the newer attribute + @ivar Layers: The object layers (also check the newer attribute L{layers<Object.Object.layers>}). This value is a bitmask with at least one position set for the 20 possible layers starting from the low order bit. The easiest way to deal with these values in in hexadecimal @@ -151,7 +151,7 @@ class Object: After setting the Layer value, call Blender.Redraw( -1 ) to update the interface. @type layers: list of integers - @cvar layers: The layers this object is visible in (also check the older + @ivar layers: The layers this object is visible in (also check the older attribute L{Layers<Object.Object.Layers>}). This returns a list of integers in the range [1, 20], each number representing the respective layer. Setting is done by passing a list of ints or an empty list for @@ -165,24 +165,24 @@ class Object: print ob.layers # will print: [1, 4, 10] B{Note}: changes will only be visible after the screen (at least the 3d View and Buttons windows) is redrawn. - @cvar parent: The parent object of the object. (Read-only) - @cvar track: The object tracking this object. (Read-only) - @cvar data: The data of the object. (Read-only) - @cvar ipo: The ipo data associated with the object. (Read-only) - @cvar mat: The matrix of the object relative to its parent. (Read-only) - @cvar matrix: The matrix of the object in world space. (Read-only) - @cvar matrixLocal: The matrix of the object relative to its parent. (Read-only) - @cvar matrixWorld: The matrix of the object in world space. (Read-only) - @cvar colbits: The Material usage mask. A set bit #n means: the Material + @ivar parent: The parent object of the object. (Read-only) + @ivar track: The object tracking this object. (Read-only) + @ivar data: The data of the object. (Read-only) + @ivar ipo: The ipo data associated with the object. (Read-only) + @ivar mat: The matrix of the object relative to its parent. (Read-only) + @ivar matrix: The matrix of the object in world space. (Read-only) + @ivar matrixLocal: The matrix of the object relative to its parent. (Read-only) + @ivar matrixWorld: The matrix of the object in world space. (Read-only) + @ivar 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 drawType: The object's drawing type used. 1 - Bounding box, + @ivar 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 + @ivar 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 sel: The selection state of the object, 1/0. + @ivar name: The name of the object. + @ivar sel: The selection state of the object, 1/0. """ def buildParts(): @@ -730,9 +730,9 @@ class Property: The Property object =================== This property gives access to object property data in Blender. - @cvar name: The property name. - @cvar data: Data for this property. Depends on property type. - @cvar type: The property type. + @ivar name: The property name. + @ivar data: Data for this property. Depends on property type. + @ivar type: The property type. @warn: Comparisons between properties will only be true when both the name and data pairs are the same. """ diff --git a/source/blender/python/api2_2x/doc/Scene.py b/source/blender/python/api2_2x/doc/Scene.py index d9846086317..8314c2beaa7 100644 --- a/source/blender/python/api2_2x/doc/Scene.py +++ b/source/blender/python/api2_2x/doc/Scene.py @@ -80,9 +80,9 @@ class Scene: ================ This object gives access to Scene data in Blender. @type name: string - @cvar name: The Scene name. + @ivar name: The Scene name. @type Layers: integer (bitmask) - @cvar Layers: The Scene layers (check also the easier to use + @ivar Layers: The Scene layers (check also the easier to use L{layers<Scene.Scene.layers>}). This value is a bitmask with at least one position set for the 20 possible layers starting from the low order bit. The easiest way to deal with these values in in hexadecimal @@ -94,7 +94,7 @@ class Scene: After setting the Layers value, the interface (at least the 3d View and the Buttons window) needs to be redrawn to show the changes. @type layers: list of integers - @cvar layers: The Scene layers (check also L{Layers<Scene.Scene.Layers>}). + @ivar layers: The Scene layers (check also L{Layers<Scene.Scene.Layers>}). This attribute accepts and returns a list of integer values in the range [1, 20]. Example:: diff --git a/source/blender/python/api2_2x/doc/Sound.py b/source/blender/python/api2_2x/doc/Sound.py index 6cc72f471cf..0e262663bd8 100644 --- a/source/blender/python/api2_2x/doc/Sound.py +++ b/source/blender/python/api2_2x/doc/Sound.py @@ -44,8 +44,8 @@ class Sound: The Sound object ================ This object gives access to Sounds in Blender. - @cvar name: The name of this Sound object. - @cvar filename: The filename (path) to the sound file loaded into this Sound + @ivar name: The name of this Sound object. + @ivar filename: The filename (path) to the sound file loaded into this Sound object. """ diff --git a/source/blender/python/api2_2x/doc/Text.py b/source/blender/python/api2_2x/doc/Text.py index 6f417df3cd2..edb88d0f3f0 100644 --- a/source/blender/python/api2_2x/doc/Text.py +++ b/source/blender/python/api2_2x/doc/Text.py @@ -65,10 +65,10 @@ class Text: The Text object =============== This object gives access to Texts in Blender. - @cvar name: The Text name. - @cvar filename: The filename of the file loaded into this Text. - @cvar mode: The follow_mode flag: if 1 it is 'on'; if 0, 'off'. - @cvar nlines: The number of lines in this Text. + @ivar name: The Text name. + @ivar filename: The filename of the file loaded into this Text. + @ivar mode: The follow_mode flag: if 1 it is 'on'; if 0, 'off'. + @ivar nlines: The number of lines in this Text. """ def getName(): diff --git a/source/blender/python/api2_2x/doc/Text3d.py b/source/blender/python/api2_2x/doc/Text3d.py index b60eff0a78e..c130b562fb4 100644 --- a/source/blender/python/api2_2x/doc/Text3d.py +++ b/source/blender/python/api2_2x/doc/Text3d.py @@ -45,10 +45,10 @@ class Text3d: The Text3d object ================= This object gives access Blender's B{Font} objects - @cvar name: The Text3d name. - @cvar filename: The filename of the file loaded into this Text. - @cvar mode: The follow_mode flag: if 1 it is 'on'; if 0, 'off'. - @cvar nlines: The number of lines in this Text. + @ivar name: The Text3d name. + @ivar filename: The filename of the file loaded into this Text. + @ivar mode: The follow_mode flag: if 1 it is 'on'; if 0, 'off'. + @ivar nlines: The number of lines in this Text. """ def getName(): diff --git a/source/blender/python/api2_2x/doc/Texture.py b/source/blender/python/api2_2x/doc/Texture.py index 49289c2fc5c..e05d81fb1b7 100644 --- a/source/blender/python/api2_2x/doc/Texture.py +++ b/source/blender/python/api2_2x/doc/Texture.py @@ -169,32 +169,32 @@ class Texture: Note that many of the attributes of this object are only relevant if specific modes are enabled. - @cvar name: The Texture name. - @cvar type: The Texture type. See L{Types} - @cvar flags: The texture flags (OR'd together). See L{Flags} - @cvar imageFlags: The texture image flags (OR'd tegether). + @ivar name: The Texture name. + @ivar type: The Texture type. See L{Types} + @ivar flags: The texture flags (OR'd together). See L{Flags} + @ivar imageFlags: The texture image flags (OR'd tegether). See L{ImageFlags} - @cvar stype: Texture-type specific data. See L{STypes} - @cvar image: The image associated with this texture, or None. + @ivar stype: Texture-type specific data. See L{STypes} + @ivar image: The image associated with this texture, or None. @type image: Blender Image - @cvar rgbCol: The texture's RGB color triplet. - @cvar brightness: The brightness in range [0,2]. - @cvar contrast: The contrast in range [0,2]. - @cvar filterSize: The filter size for the image. - @cvar extend: Texture extend/repeat mode. See L{ExtendModes} - @cvar crop: Tuple of image crop values as floats, + @ivar rgbCol: The texture's RGB color triplet. + @ivar brightness: The brightness in range [0,2]. + @ivar contrast: The contrast in range [0,2]. + @ivar filterSize: The filter size for the image. + @ivar extend: Texture extend/repeat mode. See L{ExtendModes} + @ivar crop: Tuple of image crop values as floats, like C{(xmin, ymin, xmax, ymax)} - @cvar repeat: Tuple of image repeat values as ints, like + @ivar repeat: Tuple of image repeat values as ints, like C{(xrepeat, yrepeat)} - @cvar noiseSize: The noise size. - @cvar noiseDepth: The noise depth. - @cvar noiseType: The noise type: 'soft' or 'hard'. - @cvar animLength: Length of the animation. - @cvar animFrames: Frames of the animation. - @cvar animOffset: The number of the first picture of the animation. - @cvar animStart: Start frame of the animation. - @cvar fieldsPerImage: The number of fields per rendered frame. - @cvar animMontage: Montage mode data as a tuple of tuples, like + @ivar noiseSize: The noise size. + @ivar noiseDepth: The noise depth. + @ivar noiseType: The noise type: 'soft' or 'hard'. + @ivar animLength: Length of the animation. + @ivar animFrames: Frames of the animation. + @ivar animOffset: The number of the first picture of the animation. + @ivar animStart: Start frame of the animation. + @ivar fieldsPerImage: The number of fields per rendered frame. + @ivar animMontage: Montage mode data as a tuple of tuples, like C{( (fra1,dur1), (fra2,dur2), (fra3,dur3), (fra4,dur4) )} """ @@ -297,10 +297,10 @@ class MTex: This object links a material to a texture. It allows the same texture to be used in several different ways. - @cvar tex: The Texture this is linked to. + @ivar tex: The Texture this is linked to. @type tex: Blender Texture - @cvar texco: Texture coordinates ("Map input"). See L{TexCo} - @cvar mapto: "Map to" field of texture. OR'd values of L{MapTo} + @ivar texco: Texture coordinates ("Map input"). See L{TexCo} + @ivar mapto: "Map to" field of texture. OR'd values of L{MapTo} """ def getIpo(): diff --git a/source/blender/python/api2_2x/doc/Theme.py b/source/blender/python/api2_2x/doc/Theme.py index d8be2074741..bd7371106ad 100644 --- a/source/blender/python/api2_2x/doc/Theme.py +++ b/source/blender/python/api2_2x/doc/Theme.py @@ -74,7 +74,7 @@ class Theme: This object gives access to Themes in Blender. Each Theme object is composed of one UI (Use Interface) theme and many Space themes (3d view, Text Editor, Buttons window, etc). - @cvar name: The name of this Theme object. + @ivar name: The name of this Theme object. """ def getName(): @@ -121,25 +121,25 @@ class Theme: outline[0] = 94 # 0 for red, 1 for green, ... outline = [200, 200, 200, 255] # setting all components at once @type theme: string - @cvar theme: the parent Theme for this object. - @cvar outline: theme rgba var. - @cvar neutral: theme rgba var. - @cvar action: theme rgba var. - @cvar setting: theme rgba var. - @cvar setting1: theme rgba var. - @cvar setting2: theme rgba var. - @cvar num: theme rgba var. - @cvar textfield: theme rgba var. - @cvar popup: theme rgba var. - @cvar text: theme rgba var. - @cvar text_hi: theme rgba var. - @cvar menu_back: theme rgba var. - @cvar menu_item: theme rgba var. - @cvar menu_hilite: theme rgba var. - @cvar menu_text: theme rgba var. - @cvar menu_text_hi: theme rgba var. + @ivar theme: the parent Theme for this object. + @ivar outline: theme rgba var. + @ivar neutral: theme rgba var. + @ivar action: theme rgba var. + @ivar setting: theme rgba var. + @ivar setting1: theme rgba var. + @ivar setting2: theme rgba var. + @ivar num: theme rgba var. + @ivar textfield: theme rgba var. + @ivar popup: theme rgba var. + @ivar text: theme rgba var. + @ivar text_hi: theme rgba var. + @ivar menu_back: theme rgba var. + @ivar menu_item: theme rgba var. + @ivar menu_hilite: theme rgba var. + @ivar menu_text: theme rgba var. + @ivar menu_text_hi: theme rgba var. @type drawType: int - @cvar drawType: the draw type (minimal, rounded, etc) in the range [1, 4]. + @ivar drawType: the draw type (minimal, rounded, etc) in the range [1, 4]. """ class ThemeSpace: @@ -159,38 +159,38 @@ class Theme: on the top of this page) can help you finding out any specific info you may need. @type theme: string - @cvar theme: the parent Theme for this object. - @cvar back: theme rgba var. - @cvar text: theme rgba var. - @cvar text_hi: theme rgba var. - @cvar header: theme rgba var. - @cvar panel: theme rgba var. - @cvar shade1: theme rgba var. - @cvar shade2: theme rgba var. - @cvar hilite: theme rgba var. - @cvar grid: theme rgba var. - @cvar wire: theme rgba var. - @cvar select: theme rgba var. - @cvar active: theme rgba var. - @cvar transform: theme rgba var. - @cvar vertex: theme rgba var. - @cvar vertex_select: theme rgba var. - @cvar edge: theme rgba var. - @cvar edge_select: theme rgba var. - @cvar edge_seam: theme rgba var. - @cvar edge_facesel: theme rgba var. - @cvar face: theme rgba var. - @cvar face_select: theme rgba var. - @cvar face_dot: theme rgba var. - @cvar normal: theme rgba var. - @cvar syntaxl: theme rgba var. - @cvar syntaxn: theme rgba var. - @cvar syntaxb: theme rgba var. - @cvar syntaxv: theme rgba var. - @cvar syntaxc: theme rgba var. + @ivar theme: the parent Theme for this object. + @ivar back: theme rgba var. + @ivar text: theme rgba var. + @ivar text_hi: theme rgba var. + @ivar header: theme rgba var. + @ivar panel: theme rgba var. + @ivar shade1: theme rgba var. + @ivar shade2: theme rgba var. + @ivar hilite: theme rgba var. + @ivar grid: theme rgba var. + @ivar wire: theme rgba var. + @ivar select: theme rgba var. + @ivar active: theme rgba var. + @ivar transform: theme rgba var. + @ivar vertex: theme rgba var. + @ivar vertex_select: theme rgba var. + @ivar edge: theme rgba var. + @ivar edge_select: theme rgba var. + @ivar edge_seam: theme rgba var. + @ivar edge_facesel: theme rgba var. + @ivar face: theme rgba var. + @ivar face_select: theme rgba var. + @ivar face_dot: theme rgba var. + @ivar normal: theme rgba var. + @ivar syntaxl: theme rgba var. + @ivar syntaxn: theme rgba var. + @ivar syntaxb: theme rgba var. + @ivar syntaxv: theme rgba var. + @ivar syntaxc: theme rgba var. @type vertex_size: int - @cvar vertex_size: size of the vertices dots on screen in the range [1, 10]. + @ivar vertex_size: size of the vertices dots on screen in the range [1, 10]. @type facedot_size: int - @cvar facedot_size: size of the face dots on screen in the range [1, 10]. + @ivar facedot_size: size of the face dots on screen in the range [1, 10]. """ diff --git a/source/blender/python/api2_2x/doc/World.py b/source/blender/python/api2_2x/doc/World.py index 8dbf8dfb951..4cb1b2bb3a4 100644 --- a/source/blender/python/api2_2x/doc/World.py +++ b/source/blender/python/api2_2x/doc/World.py @@ -72,17 +72,17 @@ class World: This object gives access to generic data from all worlds in Blender. Its attributes depend upon its type. - @cvar name: the name of the world. - @cvar skytype: type of the sky. Bit 0 : Blend; Bit 1 : Real; Bit 2 : paper. - @cvar mode: - @cvar mistype: type of mist : O : quadratic; 1 : linear; 2 : square - @cvar hor: the horizon color of a world object. - @cvar zen: the zenith color of a world object. - @cvar amb: the ambient color of a world object. - @cvar star: the star parameters of a world object. See getStar for the semantics of these parameters. - @cvar mist: the mist parameters of a world object. See getMist for the semantics of these parameters. + @ivar name: the name of the world. + @ivar skytype: type of the sky. Bit 0 : Blend; Bit 1 : Real; Bit 2 : paper. + @ivar mode: + @ivar mistype: type of mist : O : quadratic; 1 : linear; 2 : square + @ivar hor: the horizon color of a world object. + @ivar zen: the zenith color of a world object. + @ivar amb: the ambient color of a world object. + @ivar star: the star parameters of a world object. See getStar for the semantics of these parameters. + @ivar mist: the mist parameters of a world object. See getMist for the semantics of these parameters. @type ipo: Blender Ipo - @cvar ipo: The world type ipo linked to this world object. + @ivar ipo: The world type ipo linked to this world object. """ def getRange(): |