diff options
author | Ken Hughes <khughes@pacific.edu> | 2005-10-21 21:20:54 +0400 |
---|---|---|
committer | Ken Hughes <khughes@pacific.edu> | 2005-10-21 21:20:54 +0400 |
commit | 233ee5adb7ec881f0d76fcf6ccb51d94b6260e69 (patch) | |
tree | 6481e5c60e5f9d08a1c5b3d1e09991605cf08a6c /source | |
parent | a5c32e13535acf42d0e44a77b29e0b4882164d57 (diff) |
- documentation updates:
-- add Key module to index page
-- include cross references for Object.colbits in material descriptions
within Object, NMesh and Mesh modules
Diffstat (limited to 'source')
-rw-r--r-- | source/blender/python/api2_2x/doc/API_intro.py | 1 | ||||
-rw-r--r-- | source/blender/python/api2_2x/doc/Mesh.py | 5 | ||||
-rw-r--r-- | source/blender/python/api2_2x/doc/NMesh.py | 6 | ||||
-rw-r--r-- | source/blender/python/api2_2x/doc/Object.py | 6 |
4 files changed, 16 insertions, 2 deletions
diff --git a/source/blender/python/api2_2x/doc/API_intro.py b/source/blender/python/api2_2x/doc/API_intro.py index 49d4aaac3f7..dd9300ae6ea 100644 --- a/source/blender/python/api2_2x/doc/API_intro.py +++ b/source/blender/python/api2_2x/doc/API_intro.py @@ -23,6 +23,7 @@ The Blender Python API Reference - L{Effect} - L{Image} - L{Ipo} + - L{Key} (*) - L{Lamp} - L{Lattice} - L{Library} diff --git a/source/blender/python/api2_2x/doc/Mesh.py b/source/blender/python/api2_2x/doc/Mesh.py index 1a8518c9a40..41b10179e11 100644 --- a/source/blender/python/api2_2x/doc/Mesh.py +++ b/source/blender/python/api2_2x/doc/Mesh.py @@ -477,6 +477,9 @@ class Mesh: @ivar materials: The mesh's materials. Each mesh can reference up to 16 materials. Empty slots in the mesh's list are represented by B{None}. + B{Note}: L{Object.colbits<Object.Object.colbits>} needs to be set correctly + for each object in order for these materials to be used instead of + the object's materials. @type materials: list of Materials @ivar degr: The max angle for auto smoothing in [1,80]. @type degr: int @@ -589,7 +592,7 @@ class Mesh: @type edges: tuple(s) of ints or MVerts @param edges: can be tuples of MVerts or integer indexes (B{note:} will not work with PVerts) or a sequence (list or tuple) containing two or - tuples. + more tuples. @rtype: int, None or list @return: if an edge is found, its index is returned; otherwise None is returned. If a sequence of edges is passed, a list is returned. diff --git a/source/blender/python/api2_2x/doc/NMesh.py b/source/blender/python/api2_2x/doc/NMesh.py index 301c9398188..26f72b05648 100644 --- a/source/blender/python/api2_2x/doc/NMesh.py +++ b/source/blender/python/api2_2x/doc/NMesh.py @@ -447,6 +447,9 @@ class NMesh: @note: if a user goes to the material buttons window and removes some mesh's link to a material, that material slot becomes empty. Previously such materials were ignored. + @note: L{Object.colbits<Object.Object.colbits>} needs to be set correctly + for each object in order for these materials to be used instead of + the object's materials. """ def setMaterials(matlist): @@ -457,6 +460,9 @@ class NMesh: @type matlist: list of materials @param matlist: a list with materials, None's also accepted (they become empty material slots in Blender. + @note: L{Object.colbits<Object.Object.colbits>} needs to be set correctly + for each object in order for these materials to be used instead of + the object's materials. """ def hasVertexColours(flag = None): diff --git a/source/blender/python/api2_2x/doc/Object.py b/source/blender/python/api2_2x/doc/Object.py index 52b7defa88e..c9bc4372f90 100644 --- a/source/blender/python/api2_2x/doc/Object.py +++ b/source/blender/python/api2_2x/doc/Object.py @@ -175,6 +175,9 @@ class Object: @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. + Example:: + object.colbits = 0x21 # use mesh materials 0 (0x01) and 5 (0x20) + # use object materials for all others @ivar drawType: The object's drawing type used. 1 - Bounding box, 2 - wire, 3 - Solid, 4- Shaded, 5 - Textured. @ivar drawMode: The object's drawing mode used. The value can be a sum @@ -570,7 +573,8 @@ class Object: def setMaterials(materials): """ - Sets the materials. The argument must be a list 16 items or less. Each list element is either a Material or None. + Sets the materials. The argument must be a list 16 items or less. Each + list element is either a Material or None. Also see L{colbits}. @type materials: Materials list @param materials: A list of Blender material objects. """ |