c4d.GeListNode

The base class of many other classes. This class is also a linked list which enables you to link several objects with each other.

Definition

class c4d.GeListNode

• GeListNode.__getitem__()
• GeListNode.__setitem__()

Insert functions

• GeListNode.InsertBefore()
• GeListNode.InsertAfter()
• GeListNode.InsertUnder()
• GeListNode.InsertUnderLast()

List Handler

• GeListNode.GetNext()
• GeListNode.GetPred()
• GeListNode.GetUp()
• GeListNode.GetDown()
• GeListNode.GetDownLast()
• GeListNode.GetChildren()

N-Bit Handler

• GeListNode.GetNBit()
• GeListNode.ChangeNBit()

Miscellaneous Methods

• GeListNode.Remove()
• GeListNode.GetDocument()
• GeListNode.GetListHead()
• GeListNode.IsDocumentRelated()

Inheritance

• c4d.C4DAtom

  • c4d.GeListNode

    • c4d.CKey
    • c4d.BaseList2D

Members

GeListNode.__setitem__(self, key, value)

Uses a description ID as a key into the container, and stores the specified data.

Parameters:

• key (int, list or DescID) – The description ID.
• value (any) –

  The data to store:

  Types to get and set
  bool
  int
  float
  long
  str
  BaseContainer
  Matrix
  Vector
  BaseList2D
  BaseTime
  MatAssignData
  InExcludeData
  SplineData
  Gradient
  DateTimeData
  PriorityData
  LayerSet
  FontData
  UnitScaleData
  PLAData

GeListNode.__getitem__(self, key)

Uses a description ID as a key into the container, and retrieves the stored data.

Parameters:key (int, list or DescID) – The description ID. Return type:any Returns:See __setitem__()

GeListNode.InsertUnder(obj)

Insert self under obj.

Note

Please take care, obj is a correct type. For example you cannot insert a document under an BaseObject. You can check it by calling C4DAtom.GetClassification() and C4DAtom.GetType().

Parameters:obj (GeListNode) – The object to insert under.

GeListNode.InsertUnderLast(obj)

Insert this node as the last child of obj.

Note

You must make sure that the insertion is sane, for example you cannot insert a key into the object list. It is also necessary to call Remove() first if the object is already inserted into another list.

Parameters:obj (GeListNode) – The object to insert under.

GeListNode.InsertAfter(obj)

Insert self after obj.

Note

Please take care, obj is a correct type. For example you cannot insert a document under an BaseObject. You can check it by using C4DAtom.GetClassification() and C4DAtom.GetType().

Parameters:obj (GeListNode) – The object to insert after.

GeListNode.InsertBefore(obj)

Insert self before obj.

Note

Please take care, obj is a correct type. For example you cannot insert a document under an BaseObject. You can check it by using C4DAtom.GetClassification() and C4DAtom.GetType().

Parameters:obj (GeListNode) – The object to insert before.

GeListNode.GetUp()

Returns the parent object.

Return type:GeListNode or None Returns:The parent object.

GeListNode.GetDown()

Returns the first child of this object in the list.

Return type:GeListNode or None Returns:The first child object.

GeListNode.GetDownLast()

Returns the last child of this object in the list.

Return type:GeListNode or None Returns:The first child object.

GeListNode.GetNext()

Returns the next object in the list.

Return type:GeListNode or None Returns:The next object.

GeListNode.GetPred()

Returns the previous object in the list.

Return type:GeListNode or None Returns:The previous object.

GeListNode.GetChildren()

Returns children in a list (not grandchild).

Return type:list of type GeListNode Returns:All children in a list.

GeListNode.Remove()

Removes this node from a list.

GeListNode.GetDocument()

Get the document for this node.

Return type:BaseDocument Returns:The document.

GeListNode.GetListHead()

Returns the list head.

Return type:GeListNode Returns:The list head.

GeListNode.IsDocumentRelated()

Checks if the node is of a type that can be inserted into a BaseDocument

Return type:bool Returns:True if the node is document related, otherwise False.

GeListNode.GetNBit(bit)

Raw access to a 64-bit bitfield, containing information about the node state.

Parameters:bit (int) –

Bit index:

NBIT_0
NBIT_TL1_FOLD	Folding bit for Timeline 1.
NBIT_TL2_FOLD	Folding bit for Timeline 2.
NBIT_TL3_FOLD	Folding bit for Timeline 3.
NBIT_TL4_FOLD	Folding bit for Timeline 4.
NBIT_TL1_SELECT	Selection bit for Timeline 1.
NBIT_TL2_SELECT	Selection bit for Timeline 2.
NBIT_TL3_SELECT	Selection bit for Timeline 3.
NBIT_TL4_SELECT	Selection bit for Timeline 4.
NBIT_TL1_TDRAW
NBIT_TL2_TDRAW
NBIT_TL3_TDRAW
NBIT_TL4_TDRAW
NBIT_CKEY_ACTIVE	Active point of animation path in editor.
NBIT_OM1_FOLD	Folding bit for Object manager 1.
NBIT_OM2_FOLD	Folding bit for Object manager 2.
NBIT_OM3_FOLD	Folding bit for Object manager 3.
NBIT_OM4_FOLD	Folding bit for Object manager 4.
NBIT_TL1_FOLDTR	Track folding for Timeline 1.
NBIT_TL2_FOLDTR	Track folding for Timeline 2.
NBIT_TL3_FOLDTR	Track folding for Timeline 3.
NBIT_TL4_FOLDTR	Track folding for Timeline 4.
NBIT_TL1_FOLDFC	F-Curve folding for Timeline 1.
NBIT_TL2_FOLDFC	F-Curve folding for Timeline 2.
NBIT_TL3_FOLDFC	F-Curve folding for Timeline 3.
NBIT_TL4_FOLDFC	F-Curve folding for Timeline 4.
NBIT_SOURCEOPEN
NBIT_TL1_HIDE	Hide in Timeline 1.
NBIT_TL2_HIDE	Hide in Timeline 2.
NBIT_TL3_HIDE	Hide in Timeline 3.
NBIT_TL4_HIDE	Hide in Timeline 4.
NBIT_SOLO_ANIM	Solo animation.
NBIT_SOLO_LAYER	Solo layer.
NBIT_TL1_SELECT2
NBIT_TL2_SELECT2
NBIT_TL3_SELECT2
NBIT_TL4_SELECT2
NBIT_SOLO_MOTION	Solo motion.
NBIT_CKEY_LOCK_T	Lock key time.
NBIT_CKEY_LOCK_V	Lock key value.
NBIT_CKEY_MUTE	Mute key.
NBIT_CKEY_CLAMP	Clamp key tangents.
NBIT_CKEY_BREAK	Break key tangents.
NBIT_CKEY_KEEPVISUALANGLE	Keep visual angle.
NBIT_CKEY_LOCK_O	Lock key tangents angles.
NBIT_CKEY_LOCK_L	Lock key tangents length.
NBIT_CKEY_AUTO	Key auto tangents.
NBIT_CKEY_ZERO_O_OLD	Deprecated.
NBIT_CKEY_ZERO_L_OLD	Deprecated.
NBIT_TL1_FCSELECT	F-Curve selection bit for Timeline 1.
NBIT_TL2_FCSELECT	F-Curve selection bit for Timeline 2.
NBIT_TL3_FCSELECT	F-Curve selection bit for Timeline 3.
NBIT_TL4_FCSELECT	F-Curve selection bit for Timeline 4.
NBIT_CKEY_BREAKDOWN
NBIT_TL1_FOLDMOTION	Motion clip folding for Timeline 1.
NBIT_TL2_FOLDMOTION	Motion clip folding for Timeline 2.
NBIT_TL3_FOLDMOTION	Motion clip folding for Timeline 3.
NBIT_TL4_FOLDMOTION	Motion clip folding for Timeline 4.
NBIT_TL1_SELECTMOTION	Motion clip selection for Timeline 1.
NBIT_TL2_SELECTMOTION	Motion clip selection for Timeline 2.
NBIT_TL3_SELECTMOTION	Motion clip selection for Timeline 3.
NBIT_TL4_SELECTMOTION	Motion clip selection for Timeline 4.
NBIT_OHIDE
NBIT_TL_TBAKE
NBIT_TL1_FOLDSM
NBIT_TL2_FOLDSM
NBIT_TL3_FOLDSM
NBIT_TL4_FOLDSM
NBIT_SUBOBJECT
NBIT_LINK_ACTIVE
NBIT_THIDE
NBIT_SUBOBJECT_AM
NBIT_PROTECTION	PSR protection.
NBIT_NOANIM	No animation.
NBIT_NOSELECT	No selection.
NBIT_EHIDE	Hide in viewport.
NBIT_REF	XRef.
NBIT_NO_DD	No drag and drop.
NBIT_REF_OHIDE	XRef object hide.
NBIT_NO_DD	No drag and drop.
NBIT_MAX
NBIT_PRIVATE_MASK1
NBIT_PRIVATE_MASK2
NBIT_PRIVATE_MASK3
NBIT_PRIVATE_MASK4

Return type:bool Returns:Bit state.

GeListNode.ChangeNBit(bit, bitmode)

Sets bits in the 64-bit bitfield of the node.

Parameters:

• bit (int) –

  Bit index:

  NBIT_0
  NBIT_TL1_FOLD	Folding bit for Timeline 1.
  NBIT_TL2_FOLD	Folding bit for Timeline 2.
  NBIT_TL3_FOLD	Folding bit for Timeline 3.
  NBIT_TL4_FOLD	Folding bit for Timeline 4.
  NBIT_TL1_SELECT	Selection bit for Timeline 1.
  NBIT_TL2_SELECT	Selection bit for Timeline 2.
  NBIT_TL3_SELECT	Selection bit for Timeline 3.
  NBIT_TL4_SELECT	Selection bit for Timeline 4.
  NBIT_TL1_TDRAW
  NBIT_TL2_TDRAW
  NBIT_TL3_TDRAW
  NBIT_TL4_TDRAW
  NBIT_CKEY_ACTIVE	Active point of animation path in editor.
  NBIT_OM1_FOLD	Folding bit for Object manager 1.
  NBIT_OM2_FOLD	Folding bit for Object manager 2.
  NBIT_OM3_FOLD	Folding bit for Object manager 3.
  NBIT_OM4_FOLD	Folding bit for Object manager 4.
  NBIT_TL1_FOLDTR	Track folding for Timeline 1.
  NBIT_TL2_FOLDTR	Track folding for Timeline 2.
  NBIT_TL3_FOLDTR	Track folding for Timeline 3.
  NBIT_TL4_FOLDTR	Track folding for Timeline 4.
  NBIT_TL1_FOLDFC	F-Curve folding for Timeline 1.
  NBIT_TL2_FOLDFC	F-Curve folding for Timeline 2.
  NBIT_TL3_FOLDFC	F-Curve folding for Timeline 3.
  NBIT_TL4_FOLDFC	F-Curve folding for Timeline 4.
  NBIT_SOURCEOPEN
  NBIT_TL1_HIDE	Hide in Timeline 1.
  NBIT_TL2_HIDE	Hide in Timeline 2.
  NBIT_TL3_HIDE	Hide in Timeline 3.
  NBIT_TL4_HIDE	Hide in Timeline 4.
  NBIT_SOLO_ANIM	Solo animation.
  NBIT_SOLO_LAYER	Solo layer.
  NBIT_TL1_SELECT2
  NBIT_TL2_SELECT2
  NBIT_TL3_SELECT2
  NBIT_TL4_SELECT2
  NBIT_SOLO_MOTION	Solo motion.
  NBIT_CKEY_LOCK_T	Lock key time.
  NBIT_CKEY_LOCK_V	Lock key value.
  NBIT_CKEY_MUTE	Mute key.
  NBIT_CKEY_CLAMP	Clamp key tangents.
  NBIT_CKEY_BREAK	Break key tangents.
  NBIT_CKEY_KEEPVISUALANGLE	Keep visual angle.
  NBIT_CKEY_LOCK_O	Lock key tangents angles.
  NBIT_CKEY_LOCK_L	Lock key tangents length.
  NBIT_CKEY_AUTO	Key auto tangents.
  NBIT_CKEY_ZERO_O_OLD	Deprecated.
  NBIT_CKEY_ZERO_L_OLD	Deprecated.
  NBIT_TL1_FCSELECT	F-Curve selection bit for Timeline 1.
  NBIT_TL2_FCSELECT	F-Curve selection bit for Timeline 2.
  NBIT_TL3_FCSELECT	F-Curve selection bit for Timeline 3.
  NBIT_TL4_FCSELECT	F-Curve selection bit for Timeline 4.
  NBIT_CKEY_BREAKDOWN
  NBIT_TL1_FOLDMOTION	Motion clip folding for Timeline 1.
  NBIT_TL2_FOLDMOTION	Motion clip folding for Timeline 2.
  NBIT_TL3_FOLDMOTION	Motion clip folding for Timeline 3.
  NBIT_TL4_FOLDMOTION	Motion clip folding for Timeline 4.
  NBIT_TL1_SELECTMOTION	Motion clip selection for Timeline 1.
  NBIT_TL2_SELECTMOTION	Motion clip selection for Timeline 2.
  NBIT_TL3_SELECTMOTION	Motion clip selection for Timeline 3.
  NBIT_TL4_SELECTMOTION	Motion clip selection for Timeline 4.
  NBIT_OHIDE
  NBIT_TL_TBAKE
  NBIT_TL1_FOLDSM
  NBIT_TL2_FOLDSM
  NBIT_TL3_FOLDSM
  NBIT_TL4_FOLDSM
  NBIT_SUBOBJECT
  NBIT_LINK_ACTIVE
  NBIT_THIDE
  NBIT_SUBOBJECT_AM
  NBIT_PROTECTION	PSR protection.
  NBIT_NOANIM	No animation.
  NBIT_NOSELECT	No selection.
  NBIT_EHIDE	Hide in viewport.
  NBIT_REF	XRef.
  NBIT_NO_DD	No drag and drop.
  NBIT_REF_OHIDE	XRef object hide.
  NBIT_NO_DD	No drag and drop.
  NBIT_MAX
  NBIT_PRIVATE_MASK1
  NBIT_PRIVATE_MASK2
  NBIT_PRIVATE_MASK3
  NBIT_PRIVATE_MASK4

• bitmode (int) –

  Bit mode:

  NBITCONTROL_SET	Set bit.
  NBITCONTROL_CLEAR	Clear bit.
  NBITCONTROL_TOGGLE	Toggle bit.
  NBITCONTROL_PRIVATE_NODIRTY	Private.

Return type:

bool

Returns:

Bit state.