c4d.modules.mograph.FieldObject¶

Parent Class:

Overview¶

Field Sampling
`FieldObject.FreeSampling()`	Frees any data allocated in `InitSampling()`.
`FieldObject.GetFieldFlags()`	Returns the field flags.
`FieldObject.InitSampling()`	Initializes field sampling.
`FieldObject.Sample()`	Samples points within the field.
Magic Methods
`FieldObject.__init__()`	Creates a `FieldObject` instance.

FieldObject.FreeSampling(self, info)¶

Frees any data allocated in InitSampling().

Warning

Must be called after sampling is finished.

Warning

Due to core changes in 2024.0.0, this function is not working in Python 2024.0.0.

This is going to be fixed in an upcoming version.

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

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.

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.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.

Warning

Due to core changes in 2024.0.0, this function is not working in Python 2024.0.0.

This is going to be fixed in an upcoming version.

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.__init__(self, type)¶

Creates a FieldObject instance.

Category	Option	Description
Query	Words and phrases	Search is case-insensitive. Put a phrase in quotes for an exact match. Quoted phrases require every word and disable fuzzy matching.
Terms	OR / AND	Choose whether to match any term or require all terms.
Fuzzy	On / Off	Toggle approximate and prefix matches. Quoted phrases always use strict matching.
Results	Sparse / Dense	Sparse groups multiple hits for one entity and hides its owned API members when the class or module itself matches. Dense lists each match separately.
Sort by	Type / Relevance	Group results by entity type then rank within each group, or rank all results by relevance.
Content	All / API / Manuals / Examples / Resources	Search all documentation, API documentation, manuals, the examples index, or the resources index. Code examples embedded in other sections retain their own content area.
Entity	All / Page / Module / Class / Function / Attribute / Description / Node / Symbol / Icon	Page covers results without a specific entity type. Resource entity types are available with All or Resources; API entity types are available with All or API.
Location	All / Text / Code / Name / Signature	Text covers everything outside code, names, and signatures. Name and Signature are available with All or API.

FIELDOBJECTSAMPLE_FLAG_NONE	None.
FIELDOBJECTSAMPLE_FLAG_DISABLEDIRECTIONFALLOFF	Private.