c4d.modules.mograph.FieldObject¶

Methods Signatures

FieldObject.__init__(self, type) Creates a FieldObject instance.

`FieldObject.InitSampling(self, info)`	Initializes field sampling.
`FieldObject.FreeSampling(self, info)`	Frees any data allocated in `InitSampling()`.
`FieldObject.Sample(self, input, output, ...)`	Samples points within the field.
`FieldObject.GetFieldFlags(self, doc)`	Returns the field flags.

Inheritance

Parent Class:

Methods Documentation

FieldObject.__init__(self, type)¶

Creates a FieldObject instance.

Parameters:	type (int) – The field type.
Return type:	c4d.modules.mograph.FieldObject
Returns:	The created `FieldObject` instance.

FieldObject.InitSampling(self, info)¶

Initializes field sampling.

Warning

Must be called before Sample() is invoked.

Parameters:	info (c4d.modules.mograph.FieldInfo) – The `FieldInfo` to initialize sampling with.

FieldObject.FreeSampling(self, info)¶

Frees any data allocated in InitSampling().

Warning

Must be called after sampling is finished.

Parameters:	info (c4d.modules.mograph.FieldInfo) – The `FieldInfo` used for sampling.

FieldObject.Sample(self, input, output, info, flags)¶

Samples points within the field.

Warning

InitSampling() must be called before. FreeSampling() must be called once sampling is complete.

Parameters:

input (c4d.modules.mograph.FieldInput) – The points to sample in global space.
output (c4d.modules.mograph.FieldOutputBlock) – The output result values, should be allocated prior to usage.
info (c4d.modules.mograph.FieldInfo) – The FieldInfo to sample with. It should match the info used with InitSampling().
flags (int) –
The field object sample flags:

FIELDOBJECTSAMPLE_FLAG_NONE None.

FIELDOBJECTSAMPLE_FLAG_DISABLEDIRECTIONFALLOFF Private.

FieldObject.GetFieldFlags(self, doc)¶

Returns the field flags.

Parameters: doc (c4d.documents.BaseDocument) – The document.

Return type: int

Returns:

The field flags:

FIELDOBJECT_FLAG_NONE	None.
FIELDOBJECT_FLAG_INLINE	The field calculates with the current values of the field stack.
FIELDOBJECT_FLAG_GENERATINGCOLOR	The field is currently outputting color.
FIELDOBJECT_FLAG_PRESERVEALPHA	The field does not modify alpha, any color it produces is directly applied to the existing color ignoring the alpha blending.
FIELDOBJECT_FLAG_SKIP	The field should be skipped.
FIELDOBJECT_FLAG_ERRORSKIP	The field is currently experiencing an error.