=ID Properties Python Doc Update=

The epydocs are now updated to have idproperties;
all the modules that have bindings for ID properties
now has docs for them.  E.g Materials have a .properties
members, Image, Texture, Scene, Object, NMEsh, and Mesh.

I realized that .properties was already taken in
Objects, so I renamed it to .idproperties.  There was
also a nasty little problem with an example inside
Object.getType; the entire example was being pasted inside
the return field.  I fixed it by just moving the return
definition to after the example, like it should be.
This commit is contained in:
2006-11-20 11:07:56 +00:00
parent a5a83ecd10
commit 19a4f41172
9 changed files with 66 additions and 17 deletions

View File

@@ -669,15 +669,21 @@ class MFaceSeq:
@rtype: list of ints
"""
from IDProp import IDProperty, IDGroup, IDArray
class Mesh:
"""
The Mesh Data object
====================
This object gives access to mesh data in Blender.
@note: the verts, edges and faces attributes are implemented as sequences.
The operator[] and len() are defined for these sequences. You cannot
assign to an item in the sequence, but you can assign to most of the
attributes of individual items.
@ivar properties: Returns an L{IDProperty<IDProperty>} reference of type L{IDGroup<IDGroup>} to
this mesh's ID Properties. Note that dict access is available for groups on the parent
L{IDProperty<IDProperty>} object, but for everything else you need to get the L{IDGroup<IDGroup>}
object from the L{IDProperty<IDProperty>}'s data member.
@ivar edges: The mesh's edges.
@type edges: sequence of MEdges
@ivar faces: The mesh's faces.