`c4d.BaseContainer` - a container class¶

A container is a collection of individual values. Each value has its own ID and type. Container can also carry any number of child containers. There is no guarantee that a value is there in the container.

Keep in mind that there is no guarantee for a value to be in the container. Use default values whenever possible when accessing the values. Maybe your plugin won’t be able to change some values, but it will work anyway.

It is recommended that you use the available containers to store your own values as well. That way they will be automatically saved. However, if you want to store values in the top level of for example an object container, you’ll have to use a unique id. You can use a plugin id from PluginCafe for this. A good way is to store a sub-container with this id. Inside this sub-container you can use whatever ids you want.

Once you’ve set a container value using one type you must neither try to access it using another type, nor overwrite it with a value of another type! Using the wrong access will not crash, but it is illegal.

class c4d.BaseContainer¶

BaseContainer.__init__()
BaseContainer.__iter__()

BaseContainer.__setitem__()
BaseContainer.__getitem__()
BaseContainer.__eq__()
BaseContainer.__ne__()

BaseContainer.CopyTo()
BaseContainer.FlushAll()

BaseContainer.GetId()
BaseContainer.SetId()

BaseContainer.RemoveData()
BaseContainer.RemoveIndex()

BaseContainer.FindIndex()
BaseContainer.GetIndexId()

BaseContainer.GetType()

BaseContainer.SetData()
BaseContainer.GetData()

BaseContainer.GetBool()
BaseContainer.GetInt()
BaseContainer.GetLLong()
BaseContainer.GetFloat()
BaseContainer.GetVector()
BaseContainer.GetMatrix()
BaseContainer.GetString()
BaseContainer.GetFilename()
BaseContainer.GetTime()
BaseContainer.GetContainer()
BaseContainer.GetLink()
BaseContainer.GetObjectLink()
BaseContainer.GetMaterialLink()
BaseContainer.GetCustomDataType()

BaseContainer.SetBool()
BaseContainer.SetInt()
BaseContainer.SetLLong()
BaseContainer.SetVector()
BaseContainer.SetMatrix()
BaseContainer.SetString()
BaseContainer.SetFilename()
BaseContainer.SetTime()
BaseContainer.SetContainer()
BaseContainer.SetLink()

BaseContainer.MergeContainer()

BaseContainer.Sort()

Methods¶

static BaseContainer.__init__(n)¶

Parameter:	n (`BaseContainer`, int or None) – Use int if you just want to set the ID of the container. Pass a container if you want to clone it, or use `None` to use a standard empty container.
Return type:	`BaseContainer`
Returns:	The new container.

BaseContainer.__iter__()¶

The BaseContainer is iteratable so just use it like in the following example:

def iter_container(bc):
    for element in bc:
        print ">>", element

BaseContainer.__setitem__(self, key, value)¶

Automatically redirect the value to the corresponding Set* method. Its recommended to use the original Set* method to avoid type problems.

Warning

This method can replace types. Please check the types before when a special key is associated with a special type.

To delete a key, call del(bc[i]) or RemoveData().

Parameters:	key (int) – Index of the value. value (any) – It depends on the type which Set* method is internally called.

BaseContainer.__ne__(self, other)¶

BaseContainer.__eq__(self, other)¶

BaseContainer.__ne__(self, other)

Check if the compared containers have the same ID, have the same values, and all values are equal.

Parameter:	other (`BaseContainer`) – Returns `True` if the compared containers are equal.

BaseContainer.CopyTo(dst, flags)¶

Copies all values to dst.

Parameters:

dst (BaseContainer) – The destination container.

flags (int) –

Flags:

BASECONTAINER_COPY_FLAG_COPY_DIRTY	Copies the dirty count of the container.
BASECONTAINER_COPY_FLAG_IDENTICAL_COPY	Internally base containers are either a linear list or a BTree. Since deleting from a BTree is expensive these elements are only marked as deleted but the ID remains in the tree. If this flag is set these marked elements are copied, too. Otherwise only active elements are copied (which will be much slower).

BaseContainer.FlushAll()¶: Clears all values in the container. The container ID is not changed.

BaseContainer.GetId()¶

Returns the ID of the container.

Return type:	int
Returns:	The container ID.

BaseContainer.SetId(id)¶

Sets the ID of the container.

Parameter:	id (int) – The container ID.

BaseContainer.RemoveData(id)¶

Removes the first data item with the specified ID.

Parameter:	id (int) – The container ID.
Return type:	bool
Returns:	`True` if any value was removed, otherwise `False`.

BaseContainer.RemoveIndex(i)¶

Removes the data item at the specified index i.

Parameter:	i (int) – The index of the value to be removed.
Return type:	bool
Returns:	`True` if any value was removed, otherwise `False`.

BaseContainer.FindIndex(i)¶

Returns the index for the value with the specified ID, or -1 if no such value exists.

Parameter:	id (int) – The ID of the value.
Return type:	bool
Returns:	The index of the value, or -1.

BaseContainer.GetIndexId(index)¶

Returns the ID of the element at the specified index, or NOTOK if it doesn’t exist. Used to browse through the container.

Parameter:

index (int) – The index of the value.

Return type:

bool

Returns:

The ID of the value, or -1.

DA_NIL	No value.
DA_VOID	PyCObject
DA_INT	int
DA_FLOAT	float
DA_TIME	`BaseTime`
DA_VECTOR	`Vector`
DA_MATRIX	`Matrix`
DA_LLONG	long
DA_STRING	str
DA_FILENAME	str
DA_CONTAINER	`BaseContainer`
DA_ALIASLINK	`BaseList2D`
DA_MARKER	Not used.
DA_MISSINGPLUG	Denotes a missing datatype plugin.
DA_CUSTOMDATATYPE	Anything larger than this value are custom.

BaseContainer.GetType(id)¶: Returns the type of a container element by ID. :type id: int :param id: The type of the element. :rtype: int :return: The type.

BaseContainer.SetData(id, n)¶

Sets an arbitrary data value at the specified ID. If a value exists under the same ID, its content will be changed.

Parameters:	id (int) – The ID of the element to set. n (any) – The data value to set.

BaseContainer.GetData(id)¶

Returns the data for an element by ID.

Parameter:	id (int) – The ID of the element.
Return type:	any
Returns:	The data or None if it wasn’t found.

BaseContainer.GetBool(id[, preset=False])¶

Returns a bool value with the specified ID, or preset if it doesn’t exist.

Parameters:	id (int) – The ID of the requested value. preset (bool) – Returned if the value isn’t available.
Return type:	bool
Returns:	The value.

BaseContainer.GetInt(id[, preset=0])¶

Returns a int value with the specified ID, or preset if it doesn’t exist.

Parameters:	id (int) – The ID of the requested value. preset (int) – Returned if the value isn’t available.
Return type:	int
Returns:	The value.

BaseContainer.GetLLong(id[, preset=0L])¶

Returns a long value with the specified ID, or preset if it doesn’t exist.

Parameters:	id (int) – The ID of the requested value. preset (long) – Returned if the value isn’t available.
Return type:	long
Returns:	The value.

BaseContainer.GetFloat(id[, preset=0.0])¶

Returns a float value with the specified ID, or preset if it doesn’t exist.

Parameters:	id (int) – The ID of the requested value. preset (float) – Returned if the value isn’t available.
Return type:	float
Returns:	The value.

BaseContainer.GetVector(id[, preset=c4d.Vector()])¶

Returns a Vector value with the specified ID, or preset if it doesn’t exist.

Parameters:	id (int) – The ID of the requested value. preset (`Vector`) – Returned if the value isn’t available.
Return type:	`Vector`
Returns:	The value.

BaseContainer.GetMatrix(id[, preset=c4d.Matrix()])¶

Returns a Matrix value with the specified ID, or preset if it doesn’t exist.

Parameters:	id (int) – The ID of the requested value. preset (`Matrix`) – Returned if the value isn’t available.
Return type:	`Matrix`
Returns:	The value.

BaseContainer.GetString(id[, preset=""])¶

Returns a string value with the specified ID, or preset if it doesn’t exist.

Parameters:	id (int) – The ID of the requested value. preset (str) – Returned if the value isn’t available.
Return type:	str
Returns:	The value.

BaseContainer.GetFilename(id[, preset=""])¶

Returns a string value with the specified ID, or preset if it doesn’t exist.

Parameters:	id (int) – The ID of the requested value. preset (str) – Returned if the value isn’t available.
Return type:	str
Returns:	The value.

BaseContainer.GetTime(id[, preset=c4d.BaseTime()])¶

Returns a BaseTime value with the specified ID, or preset if it doesn’t exist.

Parameters:	id (int) – The ID of the requested value. preset (`BaseTime`) – Returned if the value isn’t available.
Return type:	`BaseTime`
Returns:	The value.

BaseContainer.GetContainer(id)¶

Returns a copy of the sub-container with the specified ID, or an empty container if it doesn’t exist.

Parameter:	id (int) – The ID of the requested sub-container.
Return type:	`BaseContainer`
Returns:	The Sub-container.

BaseContainer.GetLink(id[, doc=None][, isinstanceof=0])¶

Returns a linked object, evaluated in the attached document. If instanceof is specified, None is returned if the object isn’t of this type.

Parameters:	id (int) – The ID of the requested sub-container. doc (`BaseDocument`) – The document to evalulate the link in or `None`. isinstanceof (int) – Set this to a node type to only return the link if it’s of this type.
Return type:	`BaseList2D`
Returns:	The linked object, or `None` if the link is broken.

BaseContainer.GetObjectLink(id[, doc=None])¶

Returns a linked base object, evaluated in the attached document. Returns None if the link doesn’t point to a base object.

Parameters:	id (int) – The ID of the requested sub-container. doc (`BaseDocument`) – The document to evalulate the link in.
Return type:	`BaseObject`
Returns:	The linked base object, or `None` if the link is broken.

BaseContainer.GetMaterialLink(id[, doc=None])¶

Returns a linked material object, evaluated in the attached document. Returns None if the link doesn’t point to a base object.

Parameters:	id (int) – The ID of the requested sub-container. doc (`BaseDocument`) – The document to evalulate the link in.
Return type:	`BaseMaterial`
Returns:	The linked material object, or `None` if the link is broken.

BaseContainer.GetCustomDataType(id)¶

Returns a copy of the custom data type or None if it doesn’t exist.

Parameter:	id (int) – The ID of the requested sub-container.
Returns:	The custom data type.

BaseContainer.SetBool(id, b)¶

Sets the bool value with the specified ID to b, or inserts it if it didn’t exist.

Parameters:	id (int) – The ID of the value to set. b (bool) – The new value.

BaseContainer.SetInt(id, l)¶

Sets the int value with the specified ID to l, or inserts it if it didn’t exist.

Parameters:	id (int) – The ID of the value to set. l (int) – The new value.

BaseContainer.SetLLong(id, l)¶

Sets the long value with the specified ID to l, or inserts it if it didn’t exist.

Parameters:	id (int) – The ID of the value to set. l (long) – The new value.

BaseContainer.SetFloat(id, r)¶

Sets the float value with the specified ID to r, or inserts it if it didn’t exist.

Parameters:	id (int) – The ID of the value to set. r (long) – The new value.

BaseContainer.SetVector(id, v)¶

Sets a new vector value with the specified ID to v, or inserts it if it didn’t exist.

Parameters:	id (int) – The ID of the value to set. v (`Vector`) – The new value.

BaseContainer.SetMatrix(id, m)¶

Sets a new matrix value with the specified ID to m, or inserts it if it didn’t exist.

Parameters:	id (int) – The ID of the value to set. m (`Matrix`) – The new value.

BaseContainer.SetString(id, s)¶

Sets a new string value with the specified ID to s, or inserts it if it didn’t exist.

Parameters:	id (int) – The ID of the value to set. s (str) – The new value.

BaseContainer.SetFilename(id, f)¶

Sets a new string value with the specified ID to s as a filepath, or inserts it if it didn’t exist.

Parameters:	id (int) – The ID of the value to set. f (str) – The new value.

BaseContainer.SetTime(id, b)¶

Sets the BaseTime value with the specified ID to b as a filepath, or inserts it if it didn’t exist.

Parameters:	id (int) – The ID of the value to set. b (`BaseTime`) – The new value.

BaseContainer.SetContainer(id, s)¶

Sets the sub-container with the specified ID to b as a filepath, or inserts it if it didn’t exist.

Parameters:	id (int) – The ID of the value to set. b (`BaseContainer`) – The sub-container

BaseContainer.SetLink(id, link)¶

Stores a link to an atom object with the specified ID.

Parameters:	id (int) – The ID of the value to set. b (`C4DAtom`) – The link to store.

BaseContainer.MergeContainer(src)¶

Stores the values in src in this container, overwriting any elements with colliding IDs and keeping the rest.

Parameter:	src (`BaseContainer`) – The source container.

BaseContainer.Sort()¶: Sorts the container entries by ID.

`c4d.BaseContainer` - a container class¶

Methods¶

Table Of Contents

This Page

Navigation

c4d.BaseContainer - a container class¶

Methods¶

Table Of Contents

This Page

Quick search

Navigation

`c4d.BaseContainer` - a container class¶