Module Group :: Class Group
[hide private]
[frames] | no frames]

Class Group

source code

The Group object

This object gives access to Groups in Blender.

Instance Methods [hide private]
Group
__copy__()
Make a copy of this group
source code
Group
copy()
Make a copy of this group
source code
Instance Variables [hide private]
vector dupliOffset
Object offset when instanced as a dupligroup
bool fakeUser
When set to True, this datablock wont be removed, even if nothing is using it.
int layers
Layer bitmask for this group.
string or None lib
path to the blend file this datablock is stored in (readonly).
string name
unique name within each blend file.
custom object sequence objects
Objects that this group uses.
IDGroup properties
Returns an IDGroup reference to this datablocks's ID Properties.
bool tag
A temporary tag that to flag data as being used within a loop.
int users
The number of users this datablock has.
Method Details [hide private]

__copy__()

source code 

Make a copy of this group

Returns: Group
a copy of this group

copy()

source code 

Make a copy of this group

Returns: Group
a copy of this group

Instance Variable Details [hide private]

fakeUser

When set to True, this datablock wont be removed, even if nothing is using it. All data has this disabled by default except for Actions.
Type:
bool

lib

path to the blend file this datablock is stored in (readonly).

lib will be None unless you are using external blend files with (File, Append/Link)

Note: the path may be relative, to get the full path use Blender.sys.expandpath

Type:
string or None

name

unique name within each blend file.

The name is case sensitive and 21 characters maximum length.

Note: a blend file may have naming collisions when external library data is used, be sure to check the value of lib.

Note: Setting a value longer then 21 characters will be shortened

Type:
string

objects

Objects that this group uses. This is a sequence with-list like access so use list(grp.objects) if you need to use a list (where grp is a group). The groups objects can be set by assigning a list or iterator of objects to the groups objects. objects.link() and objects.unlink() also work with the the objects iterator just like with lists.

Note: append() and remove() have been deprecated and replaced by link() and unlink(), after Blender 2.43 append() and remove() will not be available.

Type:
custom object sequence

tag

A temporary tag that to flag data as being used within a loop. always set all tags to True or False before using since blender uses this flag for its own internal operations.
Type:
bool

users

The number of users this datablock has. (readonly) Zero user datablocks are de-allocated after reloading and saving.
Type:
int