c4d.InExcludeData¶
-
class
c4d.InExcludeData¶ InExclude data type (CUSTOMDATATYPE_INEXCLUDE_LIST) for use with the
InExcludeCustomGuiGUI.
Methods Signatures
|
Inserts an object into the list. |
|
Removes the object at index from the list. |
|
Gets the index of pObject in the list. |
|
Gets the object at index in the list. |
|
Gets the object count. |
|
Gets the flags for the object at index in the list. |
|
Sets the flags for the object at index in the list. |
|
Gets the number of flags for each object. |
|
Sets the number of flags for each object. |
|
Gets the default flag for new items in the list. |
|
Sets the default flag for new items in the list. |
|
Resets the list. |
|
Retrieves the data container for the object at index lIndex in the list. |
Inheritance
Parent Class:
Methods Documentation
-
InExcludeData.__init__(self, v=None)¶ - Parameters
v (Optional[c4d.InExcludeData]) – Copy constructor.
-
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
doc (c4d.documents.BaseDocument) – The document to evaluate the links in.
pObject (c4d.BaseList2D) – The object to search for.
- 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
doc (c4d.documents.BaseDocument) – The document to evaluate the links in.
index (int) – Object index. (0 <= index <
GetObjectCount())
- Return type
Optional[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.
-
InExcludeData.Reset(self)¶ Resets the list.
New in version 24.
-
InExcludeData.GetData(self, lIndex)¶ Retrieves the data container for the object at index lIndex in the list.
New in version 2023.1.0.
- Parameters
lIndex (int) – Object index. (0 <= index <
GetObjectCount())- Returns
The data container. Mostly used with the c4d.IN_EXCLUDE_DATA_SELECTION key to detect or define if an element is selected.
- Return type