#include <c4d_fielddata.h>

Detailed Description

Thread local information for this field sample invocation.

Public Member Functions
	FieldInfo ()=default

	FieldInfo (FieldInfo &&src)

	~FieldInfo ()=default

	MAXON_OPERATOR_MOVE_ASSIGNMENT (FieldInfo)

Bool	IsValid () const

Bool	IsPopulated () const

maxon::Result< void >	CopyFrom (const FieldInfo &src)

Static Public Member Functions
static maxon::Result< FieldInfo >	Create (const BaseList2D *caller, FIELDSAMPLE_FLAG callingFlags=FIELDSAMPLE_FLAG::VALUE)

static maxon::Result< FieldInfo >	Create (const BaseList2D *caller, const FieldInput &inputs, FIELDSAMPLE_FLAG callingFlags=FIELDSAMPLE_FLAG::VALUE, Int threadIndex=0, Int threadCount=0)

static maxon::Result< FieldInfo >	Create (const BaseList2D caller, const BaseDocument doc, FIELDSAMPLE_FLAG callingFlags, const FieldInput &inputs)

static maxon::Result< FieldInfo >	Create (const FieldCallerStack &caller, const BaseDocument *doc, FIELDSAMPLE_FLAG callingFlags, const FieldInput &inputs)

static FieldInfo	Create (FIELDSAMPLE_FLAG callingFlags, BaseThread thread, const BaseDocument document, Int currentThreadIndex, Int threadCount, const FieldInput &inputs=FieldInput())

static maxon::Result< FieldInfo >	Create (FIELDSAMPLE_FLAG callingFlags, BaseThread thread, const BaseDocument doc, Int currentThreadIndex, Int threadCount, const FieldInput &inputs, const FieldCallerStack &caller)

static maxon::Result< FieldInfo >	Create (FIELDSAMPLE_FLAG callingFlags, BaseThread thread, const BaseDocument doc, Int currentThreadIndex, Int threadCount, const FieldInput &inputs, const std::initializer_list< const BaseList2D * > &callers)

Public Attributes
FIELDSAMPLE_FLAG	_flags

Int	_threadIndex

Int	_totalThreadCount

BaseThread *	_callerThread

const BaseDocument *	_doc

FieldInput	_inputData

FieldCallerStack	_callerStack

Private Member Functions
	MAXON_DISALLOW_COPY_AND_ASSIGN (FieldInfo)

Constructor & Destructor Documentation

◆ FieldInfo() [1/2]

FieldInfo ( )

default

◆ FieldInfo() [2/2]

FieldInfo ( FieldInfo && src )

◆ ~FieldInfo()

~FieldInfo ( )

default

Member Function Documentation

◆ MAXON_OPERATOR_MOVE_ASSIGNMENT()

MAXON_OPERATOR_MOVE_ASSIGNMENT ( FieldInfo )

◆ IsValid()

Bool IsValid ( ) const

Checks if the FieldInfo data is valid. Default (empty) FieldInfo is considered valid.

◆ IsPopulated()

Bool IsPopulated ( ) const

Checks if the FieldInfo is valid and non-empty (all content should be set and ready for sampling)

◆ CopyFrom()

maxon::Result<void> CopyFrom ( const FieldInfo & src )

Copies content from the supplied FieldInfo.

Parameters

[in] src The source info.

Returns: A maxon::Result.

◆ Create() [1/7]

static maxon::Result<FieldInfo> Create	(	const BaseList2D *	caller,
		FIELDSAMPLE_FLAG	callingFlags = `FIELDSAMPLE_FLAG::VALUE`
	)

static

Creates a FieldInfo while relaying potential allocation errors. On error, the result will contain a default FieldInfo structure.

Parameters

[in]	caller	The caller object, should belong to the document being used.
[in]	callingFlags	(Optional) The channel sampling flags expected to be used for sampling.

Returns: A maxon::Result containing the resulting FieldInfo, _inputData will not be populated, if you use this with the "Direct" sampling methods of the FieldList without populating _inputData you will encounter problematic behavior that could lead to crashes.

◆ Create() [2/7]

static maxon::Result<FieldInfo> Create	(	const BaseList2D *	caller,
		const FieldInput &	inputs,
		FIELDSAMPLE_FLAG	callingFlags = `FIELDSAMPLE_FLAG::VALUE`,
		Int	threadIndex = `0`,
		Int	threadCount = `0`
	)

static

Creates a FieldInfo while relaying potential allocation errors. On error, the result will contain a default FieldInfo structure.

Parameters

[in]	caller	The caller object, should belong to the document being used.
[in]	inputs	The inputs that will be sampled.
[in]	callingFlags	(Optional) The channel sampling flags expected to be used for sampling.
[in]	threadIndex	(Optional) Zero-based index of the thread within the current MP loop alternatively just 0 for the initial thread.
[in]	threadCount	(Optional) Number of threads to be used, 0 or lower to automatically calculate for MP invocation.

Returns: A maxon::Result containing the resulting FieldInfo.

◆ Create() [3/7]

static maxon::Result<FieldInfo> Create	(	const BaseList2D *	caller,
		const BaseDocument *	doc,
		FIELDSAMPLE_FLAG	callingFlags,
		const FieldInput &	inputs
	)

static

Creates a FieldInfo while relaying potential allocation errors. On error, the result will contain a default FieldInfo structure.

Parameters

[in]	caller	The caller object, should belong to the document being used.
[in]	doc	The document to sample.
[in]	callingFlags	The channel sampling flags expected to be used for sampling.
[in]	inputs	The inputs that will be sampled.

Returns: A maxon::Result containing the resulting FieldInfo.

◆ Create() [4/7]

static maxon::Result<FieldInfo> Create	(	const FieldCallerStack &	caller,
		const BaseDocument *	doc,
		FIELDSAMPLE_FLAG	callingFlags,
		const FieldInput &	inputs
	)

static

Creates a FieldInfo while relaying potential allocation errors. On error, the result will contain a default FieldInfo structure.

Parameters

[in]	caller	The caller stack object.
[in]	doc	The document to sample.
[in]	callingFlags	The channel sampling flags expected to be used for sampling.
[in]	inputs	The inputs that will be sampled.

Returns: A maxon::Result containing the resulting FieldInfo.

◆ Create() [5/7]

static FieldInfo Create	(	FIELDSAMPLE_FLAG	callingFlags,
		BaseThread *	thread,
		const BaseDocument *	document,
		Int	currentThreadIndex,
		Int	threadCount,
		const FieldInput &	inputs = `FieldInput()`
	)

static

Creates an incomplete FieldInfo that the user has to fill in with a FieldCallerStack. This overload cannot fail.

Parameters

[in]	callingFlags	The channels to sample.
[in]	thread	The caller thread.
[in]	document	The document to sample.
[in]	currentThreadIndex	The thread index that will sample those points.
[in]	threadCount	The total thread count.
[in]	inputs	The full point list.

Returns: The created FieldInfo.

◆ Create() [6/7]

static maxon::Result<FieldInfo> Create	(	FIELDSAMPLE_FLAG	callingFlags,
		BaseThread *	thread,
		const BaseDocument *	doc,
		Int	currentThreadIndex,
		Int	threadCount,
		const FieldInput &	inputs,
		const FieldCallerStack &	caller
	)

static

Creates a FieldInfo while relaying potential allocation errors. On error, the result will contain a default FieldInfo structure.

Parameters

[in]	callingFlags	The channels to sample.
[in]	thread	The caller thread.
[in]	doc	The document to sample.
[in]	currentThreadIndex	The thread index that will sample those points.
[in]	threadCount	The total thread count.
[in]	inputs	The full point list.
[in]	caller	The caller stack.

Returns: A maxon::Result containing the resulting FieldInfo.

◆ Create() [7/7]

static maxon::Result<FieldInfo> Create	(	FIELDSAMPLE_FLAG	callingFlags,
		BaseThread *	thread,
		const BaseDocument *	doc,
		Int	currentThreadIndex,
		Int	threadCount,
		const FieldInput &	inputs,
		const std::initializer_list< const BaseList2D * > &	callers
	)

static

Creates a FieldInfo while relaying potential allocation errors. On error, the result will contain a default FieldInfo structure.

Parameters

[in]	callingFlags	The channels to sample.
[in]	thread	The caller thread.
[in]	doc	The document to sample.
[in]	currentThreadIndex	The thread index that will sample those points.
[in]	threadCount	The total thread count.
[in]	inputs	The full point list.
[in]	callers	An initializer list to build the stack, first item is base of stack.

Returns: A maxon::Result containing the resulting FieldInfo.

◆ MAXON_DISALLOW_COPY_AND_ASSIGN()

MAXON_DISALLOW_COPY_AND_ASSIGN ( FieldInfo )

private

Member Data Documentation

◆ _flags

FIELDSAMPLE_FLAG _flags

The current flags represent which channels are available and should be sampled.

◆ _threadIndex

Int _threadIndex

The current thread index.

◆ _totalThreadCount

Int _totalThreadCount

The number of threads active for this execution.

◆ _callerThread

BaseThread* _callerThread

The calling thread @required.

◆ _doc

const BaseDocument* _doc

The calling document @required.

◆ _inputData

FieldInput _inputData

The input data to be sampled, caller owns this object @required.

◆ _callerStack

FieldCallerStack _callerStack

A list of objects that called this calculation as well as an ID for the invocation chain, useful if you need to hash data to a specific caller, this uses the memory addresses of the callers so the value could change on undo/redo and will change on document load @required.

Detailed Description

Public Member Functions

Static Public Member Functions

Public Attributes

Private Member Functions

Constructor & Destructor Documentation

◆ FieldInfo() [1/2]

◆ FieldInfo() [2/2]

◆ ~FieldInfo()

Member Function Documentation

◆ MAXON_OPERATOR_MOVE_ASSIGNMENT()

◆ IsValid()

◆ IsPopulated()

◆ CopyFrom()

◆ Create() [1/7]

◆ Create() [2/7]

◆ Create() [3/7]

◆ Create() [4/7]

◆ Create() [5/7]

◆ Create() [6/7]

◆ Create() [7/7]

◆ MAXON_DISALLOW_COPY_AND_ASSIGN()

Member Data Documentation

◆ _flags

◆ _threadIndex

◆ _totalThreadCount

◆ _callerThread

◆ _doc

◆ _inputData

◆ _callerStack