Module NLA :: Class Action

Class Action

The Action object

This object gives access to Action-specific data in Blender.

Method Summary
Dictionary [channel : PyIpo or None]	`getAllChannelIpos()` Get the all the Ipos for this action
PyIpo or None	`getChannelIpo(channel)` Get the Ipo for the named channel in this action
list	`getChannelNames()` Returns a list of channel names
PyList	`getFrameNumbers()` Gets the frame numbers at which a key was inserted into this action
string	`getName()` Get the name of this Action.
	`removeChannel(channel)` Remove a named channel from this action
	`renameChannel(nameFrom, nameTo)` rename an existing channel to a new name.
	`setActive(object)` Set this action as the current action for an object.
	`setName(name)` Set the name of this Action.

Instance Variable Summary
bool	`fakeUser`: When set to True, this datablock wont be removed, even if nothing is using it.
string or None	`lib`: path to the blend file this datablock is stored in (readonly).
string	`name`: unique name within each blend file.
`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

getAllChannelIpos()

Get the all the Ipos for this action

Returns:: the Ipos for all the channels in the action
(type=Dictionary [channel : PyIpo or None])

getChannelIpo(channel)

Get the Ipo for the named channel in this action

Parameters:: channel - The name of a channel in this action
(type=string)

Returns:: the Ipo for the channel
(type=PyIpo or None)

getChannelNames()

Returns a list of channel names

Returns:: the channel names that match bone and constraint names.
(type=list)

getFrameNumbers()

Gets the frame numbers at which a key was inserted into this action

Returns:: a list of ints
(type=PyList)

getName()

Get the name of this Action.

Returns:: string

removeChannel(channel)

Remove a named channel from this action

Parameters:: channel - The name of a channel in this action to be removed
(type=string)

renameChannel(nameFrom, nameTo)

rename an existing channel to a new name.

if the nameFrom channel dosnt exist or the nameTo exists, an error will be raised.

Returns:: None

setActive(object)

Set this action as the current action for an object.

Parameters:: object - The object whose action is to be set
(type=PyObject)

setName(name)

Set the name of this Action.

Parameters:: name - The new name
(type=string)

Instance Variable Details

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

properties

Returns an IDGroup reference to this datablocks's ID Properties.

Type:: IDGroup

users

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

Type:: int

Generated by Epydoc 2.1 on Thu May 10 20:32:01 2007

http://epydoc.sf.net