c4d.InExcludeData

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

Inheritance

Members

InExcludeData.__init__(v)
Parameters:v (c4d.InExcludeData) – Copy constructor.
Return type:c4d.InExcludeData
Returns:The new inexclude data.
InExcludeData.InsertObject(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(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(doc, pObject)

New in version R18.020.

Gets the index of pObject in the list.

Parameters:
Return type:

int

Returns:

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

InExcludeData.ObjectFromIndex(doc, index)

Gets the object at index in the list.

Parameters:
Return type:

c4d.BaseList2D

Returns:

The found object, or None.

InExcludeData.GetObjectCount()

Gets the object count.

Return type:int
Returns:Number of objects in the list.
InExcludeData.GetFlags(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(index, flags)

New in version R18.020.

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

Parameters:
  • index (int) – Object index. (0 <= index < GetObjectCount())
  • flags (int) – A bit field for the selection state of the object.
InExcludeData.GetFlagCount()

New in version R18.020.

Gets the number of flags for each object.

Return type:int
Returns:The number of flags for each object.
InExcludeData.SetFlagCount(flagCount)

New in version R18.020.

Sets the number of flags for each object.

Parameters:flagCount (int) – The number of flags for each object.
InExcludeData.GetDefaultFlag()

New in version R18.020.

Gets the default flag for new items in the list.

Return type:int
Returns:The default flag for new items in the list.
InExcludeData.SetDefaultFlag(defaultFlag)

New in version R18.020.

Sets the default flag for new items in the list.

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