c4d.modules.mograph.FieldInfo

New in version R20.

Members

FieldInfo._flags

The channels that should be sampled.

Type: int

FieldInfo._threadIndex

The current thread index.

Type: int

FieldInfo._totalThreadCount

The number of threads active for the current execution.

Type: int

FieldInfo._callerThread

The calling thread. Required.

Type: c4d.threading.BaseThread

FieldInfo._doc

The calling document. Required.

Type: c4d.documents.BaseDocument

FieldInfo._callerStack

A list of objects for the calculation as well as an ID for the invocation chain. Required.

Note

The caller stack ID is especially useful to hash data to a specific caller.

Warning

The ID uses the memory addresses of the callers so the value can change on undo/redo and on document load.

Type: c4d.modules.mograph.FieldCallerStack

FieldInfo._inputData

The input data to be sampled.

Type: c4d.modules.mograph.FieldInput

FieldInfo.__init__()

Creates a FieldInfo instance.

Return type:c4d.modules.mograph.FieldInfo
Returns:The created FieldInfo instance.
FieldInfo.IsValid()

Checks if the FieldInfo data is valid.

Note

Default empty FieldInfo is considered valid.

Return type:bool
Returns:True if the FieldInfo is valid, otherwise False.
FieldInfo.IsPopulated()

Checks if the FieldInfo data is valid and non-empty.

Note

Required FieldInfo content should be set and ready for sampling.

Return type:bool
Returns:True if the FieldInfo is populated, otherwise False.