GeListHead Class Reference

#include <c4d_baselist.h>

Inheritance diagram for GeListHead:

Detailed Description

Stores a list of GeListNode objects.

Note
Has to be created with Alloc() and destroyed with Free(). Use AutoAlloc to automate the allocation and destruction based on scope.

Private Member Functions

 GeListHead ()
 
 ~GeListHead ()
 

Navigation

void InsertBefore (GeListNode *bl)
 
void InsertAfter (GeListNode *bl)
 
void InsertUnder (GeListNode *bl)
 
void InsertUnderLast (GeListNode *bl)
 
void Remove (void)
 

Alloc/Free

static GeListHeadAlloc (void)
 
static void Free (GeListHead *&v)
 

Miscellaneous

void SetParent (GeListNode *parent)
 
GeListNodeGetParent (void)
 
GeListNodeGetFirst (void)
 
GeListNodeGetLast (void)
 
void FlushAll (void)
 

Insertion

void InsertFirst (GeListNode *bn)
 
void InsertLast (GeListNode *bn)
 
void Insert (GeListNode *bn, GeListNode *parent, GeListNode *prev)
 

Additional Inherited Members

- Public Member Functions inherited from GeListNode
GeListNodeGetNext (void)
 
GeListNodeGetPred (void)
 
GeListNodeGetDown (void)
 
GeListNodeGetUp (void)
 
GeListNodeGetDownLast (void)
 
void InsertBefore (GeListNode *bl)
 
void InsertAfter (GeListNode *bl)
 
void InsertUnder (GeListNode *bl)
 
void InsertUnderLast (GeListNode *bl)
 
void Remove (void)
 
GeListHeadGetListHead (void)
 
Int32 GetNodeID (Int32 index=0) const
 
template<typename CAST >
const CAST * GetNodeData (Int32 index=0) const
 
template<typename CAST >
CAST * GetNodeData (Int32 index=0)
 
void SetCustomData (GeListNode *node)
 
GeListNodeGetCustomData (void)
 
BaseDocumentGetDocument (void)
 
Int32 GetBranchInfo (BranchInfo *info, Int32 max, GETBRANCHINFO flags)
 
Bool IsDocumentRelated (void)
 
Int32 GetInfo (void)
 
Bool GetNBit (NBIT bit) const
 
Bool ChangeNBit (NBIT bit, NBITCONTROL bitmode)
 
- Public Member Functions inherited from C4DAtom
Int32 GetType (void) const
 
Int32 GetRealType (void) const
 
Int32 GetDiskType (void) const
 
Bool IsInstanceOf (Int32 id) const
 
Int32 GetClassification (void) const
 
Bool Message (Int32 type, void *data=nullptr)
 
Bool MultiMessage (MULTIMSG_ROUTE flags, Int32 type, void *data)
 
C4DAtomGetClone (COPYFLAGS flags, AliasTrans *trn)
 
Bool CopyTo (C4DAtom *dst, COPYFLAGS flags, AliasTrans *trn)
 
Bool Read (HyperFile *hf, Int32 id, Int32 level)
 
Bool Write (HyperFile *hf)
 
Bool ReadObject (HyperFile *hf, Bool readheader)
 
Bool WriteObject (HyperFile *hf)
 
Bool GetDescription (Description *description, DESCFLAGS_DESC flags)
 
Bool GetParameter (const DescID &id, GeData &t_data, DESCFLAGS_GET flags)
 
Bool SetParameter (const DescID &id, const GeData &t_data, DESCFLAGS_SET flags)
 
DynamicDescriptionGetDynamicDescription ()
 
Bool GetEnabling (const DescID &id, const GeData &t_data, DESCFLAGS_ENABLE flags, const BaseContainer *itemdesc)
 
Bool TranslateDescID (const DescID &id, DescID &res_id, C4DAtom *&res_at)
 
UInt32 GetDirty (DIRTYFLAGS flags) const
 
void SetDirty (DIRTYFLAGS flags)
 
UInt32 GetHDirty (HDIRTYFLAGS mask) const
 
void SetHDirty (HDIRTYFLAGS mask)
 

Constructor & Destructor Documentation

§ GeListHead()

GeListHead ( )
private

§ ~GeListHead()

~GeListHead ( )
private

Member Function Documentation

§ InsertBefore()

void InsertBefore ( GeListNode bl)
private

§ InsertAfter()

void InsertAfter ( GeListNode bl)
private

§ InsertUnder()

void InsertUnder ( GeListNode bl)
private

§ InsertUnderLast()

void InsertUnderLast ( GeListNode bl)
private

§ Remove()

void Remove ( void  )
private

§ Alloc()

static GeListHead* Alloc ( void  )
static

Allocates a list head. Destroy the allocated list head with Free(). Use AutoAlloc to automate the allocation and destruction based on scope.

Returns
The allocated list head, or nullptr if the allocation failed.

§ Free()

static void Free ( GeListHead *&  v)
static

Destructs list heads allocated with Alloc(). Use AutoAlloc to automate the allocation and destruction based on scope.

Parameters
[in,out]vThe list head to destruct. If the pointer is nullptr nothing happens. The pointer is assigned nullptr afterwards.

§ SetParent()

void SetParent ( GeListNode parent)

Sets the parent of the list head.
Usually called directly after the list head is allocated.

Parameters
[in]parentThe new parent. The caller owns the pointed parent.

§ GetParent()

GeListNode* GetParent ( void  )

Gets the parent of the list head.
For the tag list head this would be the object, for the object list head this would be the document etc.

Returns
The parent. Cinema 4D owns the pointed parent.

§ GetFirst()

GeListNode* GetFirst ( void  )

Gets the first node in the list.

Returns
The first node in the list. The list owns the pointed node.

§ GetLast()

GeListNode* GetLast ( void  )

Gets the last node in the list.

Returns
The last node in the list. The list owns the pointed node.

§ FlushAll()

void FlushAll ( void  )

Clears the list, removing all nodes.

§ InsertFirst()

void InsertFirst ( GeListNode bn)

Inserts bn as the first element in the list.

Parameters
[in]bnThe node to insert first. The caller owns the pointed node.

§ InsertLast()

void InsertLast ( GeListNode bn)

Inserts bn as the last element in the list.

Parameters
[in]bnThe node to insert last. The caller owns the pointed node.

§ Insert()

void Insert ( GeListNode bn,
GeListNode parent,
GeListNode prev 
)

Inserts bn as a child of parent or after prev.

Parameters
[in]bnThe node to insert. The caller owns the pointed node.
[in]parentThe node to insert bn as child. The caller owns the pointed node.
[in]prevThe node to insert bn after. The caller owns the pointed node.