c4d.modules.mograph.FieldObject

New in version R20.

Inheritance

Members

FieldObject.__init__(type)

Creates a FieldObject instance.

Parameters:type (int) – The field type.
Return type:c4d.modules.mograph.FieldObject
Returns:The created FieldObject instance.
FieldObject.InitSampling(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(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(input, output, info, flags)

Samples points within the field.

Warning

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

Parameters:
FieldObject.GetFieldFlags(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.
FIELDOBJECT_FLAG_SKIPWITHDEFAULTOUTPUTS The field sampling is skipped with no error, untouched field output will be blended with previous layer.