c4d.modules.mograph.FieldCallerStack

New in version R20.

Members

FieldCallerStack._value

[Read-only]

The caller stack ID.

Type: int

FieldCallerStack.__init__()

Creates a c4d.modules.mograph.FieldCallerStack instance.

Return type:c4d.modules.mograph.FieldCallerStack
Returns:The created c4d.modules.mograph.FieldCallerStack instance.
FieldCallerStack.__getitem__(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(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()

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()

Recalculates the ID of the caller stack from scratch and updates the internal stack ID value.

FieldCallerStack.Add(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()

Returns the number of callers involved in the stack.

Return type:int
Returns:The number of callers.
FieldCallerStack.GetValue()

Returns the caller stack ID.

Return type:int
Returns:The caller stack ID.
FieldCallerStack.IsValid()

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.