c4d.InExcludeData

class c4d.InExcludeData

InExclude data type (CUSTOMDATATYPE_INEXCLUDE_LIST) for use with the InExcludeCustomGui GUI.

Methods Signatures

InExcludeData.__init__(self[, v])

type v

Optional[c4d.InExcludeData]

InExcludeData.InsertObject(self, pObject, lFlags)

Inserts an object into the list.

InExcludeData.DeleteObject(self, index)

Removes the object at index from the list.

InExcludeData.GetObjectIndex(self, doc, pObject)

Gets the index of pObject in the list.

InExcludeData.ObjectFromIndex(self, doc, index)

Gets the object at index in the list.

InExcludeData.GetObjectCount(self)

Gets the object count.

InExcludeData.GetFlags(self, index)

Gets the flags for the object at index in the list.

InExcludeData.SetFlags(self, index, flags)

Sets the flags for the object at index in the list.

InExcludeData.GetFlagCount(self)

Gets the number of flags for each object.

InExcludeData.SetFlagCount(self, flagCount)

Sets the number of flags for each object.

InExcludeData.GetDefaultFlag(self)

Gets the default flag for new items in the list.

InExcludeData.SetDefaultFlag(self, defaultFlag)

Sets the default flag for new items in the list.

Inheritance

Parent Class:

Methods Documentation

InExcludeData.__init__(self, v=None)
Parameters

v (Optional[c4d.InExcludeData]) – Copy constructor.

Return type

c4d.InExcludeData

Returns

The new inexclude data.

InExcludeData.InsertObject(self, pObject, lFlags)

Inserts an object into the list.

Parameters
  • pObject (c4d.BaseList2D) – Object to insert.

  • lFlags (int) – A bit field for the initial selection state of pObject. Pass 1 to activate the inserted object.

Return type

bool

Returns

True if successful, otherwise False.

InExcludeData.DeleteObject(self, index)

Removes the object at index from the list.

Parameters

index (int) – Object index. (0 <= index < GetObjectCount())

Return type

bool

Returns

True if successful, otherwise False.

InExcludeData.GetObjectIndex(self, doc, pObject)

Gets the index of pObject in the list.

New in version R18.020.

Parameters
Return type

int

Returns

The object index, or c4d.NOTOK if it was not found.

InExcludeData.ObjectFromIndex(self, doc, index)

Gets the object at index in the list.

Parameters
Return type

c4d.BaseList2D

Returns

The found object, or None.

InExcludeData.GetObjectCount(self)

Gets the object count.

Return type

int

Returns

Number of objects in the list.

InExcludeData.GetFlags(self, index)

Gets the flags for the object at index in the list.

Parameters

index (int) – Object index. (0 <= index < GetObjectCount())

Return type

int

Returns

A bit field for the selection state of the object.

InExcludeData.SetFlags(self, index, flags)

Sets the flags for the object at index in the list.

New in version R18.020.

Parameters
  • index (int) – Object index. (0 <= index < GetObjectCount())

  • flags (int) – A bit field for the selection state of the object.

InExcludeData.GetFlagCount(self)

Gets the number of flags for each object.

New in version R18.020.

Return type

int

Returns

The number of flags for each object.

InExcludeData.SetFlagCount(self, flagCount)

Sets the number of flags for each object.

New in version R18.020.

Parameters

flagCount (int) – The number of flags for each object.

InExcludeData.GetDefaultFlag(self)

Gets the default flag for new items in the list.

New in version R18.020.

Return type

int

Returns

The default flag for new items in the list.

InExcludeData.SetDefaultFlag(self, defaultFlag)

Sets the default flag for new items in the list.

New in version R18.020.

Parameters

defaultFlag (int) – The default flag for new items in the list.