c4d.BaseContainer

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.

Definition

class c4d.BaseContainer

• BaseContainer.__init__()
• BaseContainer.__iter__()

• BaseContainer.__setitem__()
• BaseContainer.__getitem__()

• BaseContainer.__eq__()
• BaseContainer.__ne__()

• BaseContainer.GetClone() NEW
• BaseContainer.CopyTo()
• BaseContainer.FlushAll()

• BaseContainer.GetId()
• BaseContainer.SetId()
• BaseContainer.GetDirty() NEW

• BaseContainer.RemoveData()
• BaseContainer.RemoveIndex()

• BaseContainer.FindIndex()
• BaseContainer.GetIndexId()

• BaseContainer.GetType()

• BaseContainer.InsData()
• BaseContainer.InsDataAfter()
• BaseContainer.SetData()
• BaseContainer.GetData()

• BaseContainer.GetBool()
• BaseContainer.GetLong()
• BaseContainer.GetLLong()
• BaseContainer.GetReal()
• BaseContainer.GetVector()
• BaseContainer.GetMatrix()
• BaseContainer.GetString()
• BaseContainer.GetFilename()
• BaseContainer.GetTime()
• BaseContainer.GetContainer()
• BaseContainer.GetContainerInstance() NEW
• BaseContainer.GetLink()
• BaseContainer.GetObjectLink()
• BaseContainer.GetMaterialLink()
• BaseContainer.GetCustomDataType()

• BaseContainer.SetBool()
• BaseContainer.SetLong()
• BaseContainer.SetReal()
• BaseContainer.SetLLong()
• BaseContainer.SetVector()
• BaseContainer.SetMatrix()
• BaseContainer.SetString()
• BaseContainer.SetFilename()
• BaseContainer.SetTime()
• BaseContainer.SetContainer()
• BaseContainer.SetLink()

• BaseContainer.IsInstance()

• BaseContainer.MergeContainer()

• BaseContainer.Sort()

Members

BaseContainer.__init__([n])

Initializes a new container.

Parameters: 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 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 index, value in bc:
        print "Index: %i, Value: %s" % (index, str(value))

BaseContainer.__getitem__(self, key)

Returns a value with the specified ID.

Parameters: key (int) – Index of the value. Return type: any Returns: Any value.

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)

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

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

BaseContainer.GetClone(flags)

New in version R13.058.

Returns a copy of the container including all values.

Parameters: flags (int) –

Flags:

COPYFLAGS_0	None
COPYFLAGS_PRIVATE_CONTAINER_COPY_DIRTY	Copies the diry count of the container
COPYFLAGS_PRIVATE_CONTAINER_COPY_IDENTICAL	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).

Return type: BaseContainer Returns: The cloned container.

BaseContainer.CopyTo(dst, flags)

Copies all values to dst.

Parameters:

• dst (BaseContainer) – The destination container.
• flags (int) –

  Flags:

  COPYFLAGS_0	None
  COPYFLAGS_PRIVATE_CONTAINER_COPY_DIRTY	Copies the diry count of the container
  COPYFLAGS_PRIVATE_CONTAINER_COPY_IDENTICAL	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.

Parameters: id (int) – The container ID.

BaseContainer.GetDirty()

New in version R13.016.

Returns the dirty count. Can be used to check if the container has changed.

Return type: int Returns: Dirty counter. It is incremented when the container changes.

BaseContainer.RemoveData(id)

Removes the first data item with the specified ID.

Parameters: 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.

Parameters: 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.

Parameters: 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.

Parameters: 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_LONG	int
DA_REAL	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.

Parameters: id (int) – The type of the element. Return type: int Returns: The type.

BaseContainer.InsData(id, n)

Inserts an arbitrary data value at the specified ID.

Warning

This function doesn’t check if the ID already exists in the container!

Parameters:

• id (int) – The ID to insert at.
• n (any) – The value to insert.

Return type:

any

Returns:

The inserted data.

BaseContainer.InsDataAfter(id, n, after)

Inserts an arbitrary data value at the specified ID after the desired value.

Warning

This function doesn’t check if the ID already exists in the container!

Parameters:

• id (int) – The ID to insert at.
• n (any) – The value to insert.
• after (any) – The value to insert after.

Return type:

any

Returns:

The inserted data.

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.

Parameters: 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.GetLong(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.GetReal(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.

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

BaseContainer.GetContainerInstance(id)

New in version R13.029.

Returns the sub-container with the specified ID, or None if it doesn’t exist. Changes to the container are reflected in the stored sub-container.

Parameters: id (int) – The ID of the requested sub-container. Return type: BaseContainer Returns: The sub-container, or None.

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.

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

BaseContainer.SetBool(id, b)

Sets a bool value and changes the data type accordingly.

Parameters:

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

BaseContainer.SetLong(id, l)

Sets an int value and changes the data type accordingly.

Parameters:

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

BaseContainer.SetReal(id, v)

Sets a real value and changes the data type accordingly.

Parameters:

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

BaseContainer.SetLLong(id, l)

Sets a long value and changes the data type accordingly.

Parameters:

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

BaseContainer.SetVector(id, v)

Sets a Vector value and changes the data type accordingly.

Parameters:

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

BaseContainer.SetMatrix(id, m)

Sets a Matrix value and changes the data type accordingly.

Parameters:

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

BaseContainer.SetString(id, s)

Sets a string value and changes the data type accordingly.

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 a BaseTime value and changes the data type accordingly.

Parameters:

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

BaseContainer.SetContainer(id, s)

Sets a BaseContainer value and changes the data type accordingly.

Parameters:

• id (int) – The ID of the value to set.
• s (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.
• link (C4DAtom) – The link to store.

BaseContainer.IsInstance()

Checks if the container is an instance.

Return type: bool Returns: True if the container is an instance, otherwise False.

BaseContainer.MergeContainer(src)

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

Parameters: src (BaseContainer) – The source container.

BaseContainer.Sort()

Sorts the container entries by ID.