Module IDProp :: Class IDGroup

Class IDGroup

The IDGroup Type

This type supports both iteration and the [] operator to get child ID properties.

You can also add new properties using the [] operator. For example:

       group['a float!'] = 0.0
       group['an int!'] = 0
       group['a string!'] = "hi!"
       group['an array!'] = [0, 0, 1.0, 0]
       
       group['a subgroup!] = {"float": 0.0, "an int": 1.0, "an array": [1, 2],
         "another subgroup": {"a": 0.0, "str": "bleh"}}

Note that for arrays, the array type defaults to int unless a float is found while scanning the template list; if any floats are found, then the whole array is float.

You can also delete properties with the del operator. For example:

del group['property']

To get the type of a property, use the type() operator, for example:

       if type(group['bleh']) == str: pass

To tell if the property is a group or array type, import the Blender.Types module and test against IDGroupType and IDArrayType, like so:

       from Blender.Types import IDGroupType, IDArrayType.

       if type(group['bleghr']) == IDGroupType:
               (do something)

Method Summary
dict	`convert_to_pyobject()` Converts the entire property group to a purely python form.
an iterator that spits out items of the form [key, value]	`iteritems()` Implements the python dictionary iteritmes method.
list of strings.	`keys()` Returns a list of the keys in this property group.
can be dict, list, int, float or string.	`pop(item)` Pop an item from the group property.
None	`update(updatedict)` Updates items in the dict, similar to normal python dictionary method .update().
list of strings.	`values()` Returns a list of the values in this property group.

Instance Variable Summary
string	`name`: The name of the property

Method Details

convert_to_pyobject()

Converts the entire property group to a purely python form.

Returns:: A python dictionary representing the property group
(type=dict)

iteritems()

Implements the python dictionary iteritmes method.

For example:

       for k, v in group.iteritems():
               print "Property name: " + k
               print "Property value: " + str(v)

Returns:: an iterator.
(type=an iterator that spits out items of the form [key, value])

keys()

Returns a list of the keys in this property group.

Returns:: a list of the keys in this property group.
(type=list of strings.)

pop(item)

Pop an item from the group property.

Parameters:: item - The item name.
(type=string)

Returns:: The removed property.
(type=can be dict, list, int, float or string.)

update(updatedict)

Updates items in the dict, similar to normal python dictionary method .update().

Parameters:: updatedict - A dict of simple types to derive updated/new IDProperties from.
(type=dict)

Returns:: None
(type=None)

values()

Returns a list of the values in this property group.

Note that unless a value is itself a property group or an array, you cannot change it by changing the values in this list, you must change them in the parent property group.

For example,

group['some_property'] = new_value

. . .is correct, while,

values = group.values() values[0] = new_value

. . .is wrong.

Returns:: a list of the values in this property group.
(type=list of strings.)

Instance Variable Details

name

The name of the property

Type:: string

Generated by Epydoc 2.1 on Sun Feb 11 13:30:18 2007

http://epydoc.sf.net