c4d.modules.mograph.FieldCallerStack¶

Attributes

FieldCallerStack._value¶

Caller stack id.

Type: int

Methods Signatures

`FieldCallerStack.__init__(self)`	Creates a `c4d.modules.mograph.FieldCallerStack` instance.
`FieldCallerStack.__getitem__(self, key)`	Retrieves a caller from the stack by index.

`FieldCallerStack.CopyFrom(self, src)`	Copies from the supplied `FieldCallerStack` src.
`FieldCallerStack.RecalcValue(self)`	Calculates the ID of the caller stack from scratch. Does not update stored ID value.
`FieldCallerStack.UpdateValue(self)`	Recalculates the ID of the caller stack from scratch and updates the internal stack ID value.
`FieldCallerStack.Add(self, caller)`	Adds a caller to the stack and updates the stack ID.
`FieldCallerStack.GetCount(self)`	Returns the number of callers involved in the stack.
`FieldCallerStack.GetValue(self)`	Returns the caller stack ID.
`FieldCallerStack.IsValid(self)`	Checks if the caller stack is valid.

Methods Documentation

FieldCallerStack.__init__(self)¶

Creates a c4d.modules.mograph.FieldCallerStack instance.

Return type:	c4d.modules.mograph.FieldCallerStack
Returns:	The created `c4d.modules.mograph.FieldCallerStack` instance.

FieldCallerStack.__getitem__(self, key)¶

Retrieves a caller from the stack by index.

Parameters:	key (int) – The caller index.
Raises:	IndexError – If the index key is out of range : 0<=key<`GetCount()`.
Return type:	c4d.BaseList2D
Returns:	The caller.

FieldCallerStack.CopyFrom(self, src)¶

Copies from the supplied FieldCallerStack src.

Parameters:	src (c4d.modules.mograph.FieldCallerStack) – The source.
Return type:	bool
Returns:	True if successful, otherwise False.

FieldCallerStack.RecalcValue(self)¶

Calculates the ID of the caller stack from scratch. Does not update stored ID value.

Return type:	int
Returns:	The new caller stack ID.

FieldCallerStack.UpdateValue(self)¶: Recalculates the ID of the caller stack from scratch and updates the internal stack ID value.

FieldCallerStack.Add(self, caller)¶

Adds a caller to the stack and updates the stack ID.

Parameters:	caller (c4d.BaseList2D) – The caller object to add to the stack.
Return type:	bool
Returns:	True if successful, otherwise False.

FieldCallerStack.GetCount(self)¶

Returns the number of callers involved in the stack.

Return type:	int
Returns:	The number of callers.

FieldCallerStack.GetValue(self)¶

Returns the caller stack ID.

Return type:	int
Returns:	The caller stack ID.

FieldCallerStack.IsValid(self)¶

Checks if the caller stack is valid.

Note

An empty stack is valid.

A stack with broken links to callers is not valid.

Warning

A non empty stack with no stack ID value is not valid.

Return type:	bool
Returns:	True if the caller stack is valid, otherwise False.