#include <c4d_fielddata.h>

Inheritance diagram for FieldObject:

[legend]

Public Member Functions
maxon::Result< maxon::GenericData >	InitSampling (const FieldInfo &info) const

void	FreeSampling (const FieldInfo &info, maxon::GenericData &extraData) const

maxon::Result< void >	Sample (const FieldInput &inputs, FieldOutputBlock &outputs, const FieldInfo &info, const maxon::GenericData &extraData, const FIELDOBJECTSAMPLE_FLAG &objectSampleFlags=FIELDOBJECTSAMPLE_FLAG::NONE) const

FIELDOBJECT_FLAG	GetFieldFlags (const BaseDocument *doc) const

void	CheckDirty (const BaseDocument *doc)

Public Member Functions inherited from BaseObject
const Matrix &	GetDeformMatrix () const

void	SetDeformMatrix (const Matrix &dm)

void	ClearDeformMatrix ()

const Matrix &	GetUndeformedMl () const

const Matrix &	GetUndeformedMlInverse () const

Matrix	GetUndeformedMg () const

Bool	HasDeformMatrix () const

BaseObject *	GetNext ()

const BaseObject *	GetNext () const

BaseObject *	GetPred ()

const BaseObject *	GetPred () const

BaseObject *	GetUp ()

const BaseObject *	GetUp () const

BaseObject *	GetDown ()

const BaseObject *	GetDown () const

BaseObject *	GetDownLast ()

const BaseObject *	GetDownLast () const

Vector	GetAbsPos () const

void	SetAbsPos (const Vector &v)

Vector	GetAbsScale () const

void	SetAbsScale (const Vector &v)

Vector	GetAbsRot () const

void	SetAbsRot (const Vector &v)

Vector	GetFrozenPos () const

void	SetFrozenPos (const Vector &v)

Vector	GetFrozenScale () const

void	SetFrozenScale (const Vector &v)

Vector	GetFrozenRot () const

void	SetFrozenRot (const Vector &v)

Vector	GetRelPos () const

void	SetRelPos (const Vector &v)

Vector	GetRelScale () const

void	SetRelScale (const Vector &v)

Vector	GetRelRot () const

void	SetRelRot (const Vector &v)

const Matrix &	GetMl () const

void	SetMl (const Matrix &m)

Matrix	GetFrozenMln () const

Matrix	GetRelMln () const

Matrix	GetRelMl () const

void	SetRelMl (const Matrix &m)

Matrix	GetMg () const

void	SetMg (const Matrix &m)

Matrix	GetMln () const

Matrix	GetMgn () const

Matrix	GetUpMg () const

void	CopyMatrixTo (BaseObject *dst) const

Vector	GetMp () const

Vector	GetRad () const

void	GetDimension (Vector &mp, Vector &rad) const

Int32	GetEditorMode () const

Int32	GetEditorModeH () const

void	SetEditorMode (Int32 mode)

Int32	GetRenderMode () const

Int32	GetRenderModeH () const

void	SetRenderMode (Int32 mode)

Bool	GetDeformMode () const

void	SetDeformMode (Bool mode)

Int32	GetRealDeformMode () const

void	SetRealDeformMode (Int32 mode)

Int32	GetUniqueIP () const

void	SetUniqueIP (Int32 ip)

BaseTag *	GetFirstTag ()

const BaseTag *	GetFirstTag () const

BaseTag *	GetLastTag ()

const BaseTag *	GetLastTag () const

BaseTag *	GetTag (Int32 type, Int32 nr=0)

const BaseTag *	GetTag (Int32 type, Int32 nr=0) const

maxon::Block< const BaseTag *const >	GetTagsOfType (Int32 type) const

maxon::Block< BaseTag *const >	GetTagsOfType (Int32 type)

const void *	GetTagDataR (Int32 type, Int32 nr=0) const

void *	GetTagDataW (Int32 type, Int32 nr=0)

Int32	GetTagDataCount (Int32 type) const

const VariableTagDataRef &	GetVariableTagData (Int32 type, Int32 nr=0) const

BaseTag *	MakeTag (Int32 type, BaseTag *pred=nullptr)

VariableTag *	MakeVariableTag (Int32 type, Int32 count, BaseTag *pred=nullptr)

void	InsertTag (BaseTag tp, BaseTag pred=nullptr)

void	KillTag (Int32 type, Int32 nr=0)

Bool	CopyTagsTo (BaseObject dest, Int32 visible, Int32 variable, Int32 hierarchical, AliasTrans trans) const

BaseObject *	GetCache ()

const BaseObject *	GetCache () const

BaseObject *	GetDeformCache ()

const BaseObject *	GetDeformCache () const

LineObject *	GetIsoparm ()

void	SetIsoparm (LineObject *l)

BaseObject *	GetCacheParent () const

BaseObject *	GetCacheTopParent () const

Bool	SetPhong (Bool on, Bool anglelimit, Float angle)

Bool	IsDirty (DIRTYFLAGS flags) const

void	SetDirty (DIRTYFLAGS flags)

Bool	CheckCache (const HierarchyHelp *hh) const

void	Touch ()

void	GetColorProperties (ObjectColorProperties *prop) const

void	SetColorProperties (ObjectColorProperties *prop)

maxon::Opt< maxon::Color >	GetDisplayColor () const

const Matrix &	GetModelingAxis (BaseDocument *doc)

void	SetModelingAxis (const Matrix &m)

BaseObject *	GetAndCheckHierarchyClone (const HierarchyHelp hh, BaseObject op, HIERARCHYCLONEFLAGS flags, Bool dirty, AliasTrans trans, Int childCount, maxon::BaseArray< BaseObject * > *children, Bool addChildOrClone=false)

BaseObject *	GetAndCheckHierarchyClone (const HierarchyHelp hh, BaseObject op, HIERARCHYCLONEFLAGS flags, Bool dirty, AliasTrans trans, Bool allchildren)

BaseObject *	GetHierarchyClone (const HierarchyHelp hh, BaseObject op, HIERARCHYCLONEFLAGS flags, Bool dirty, AliasTrans trans)

BaseObject *	GetHierarchyClone (const HierarchyHelp hh, BaseObject op, HIERARCHYCLONEFLAGS flags, Bool dirty, AliasTrans trans, DIRTYFLAGS dirtyflags)

void	NewDependenceList ()

Bool	CompareDependenceList ()

void	AddDependence (const BaseObject *op)

void	AddDependence (const BaseObject *op, DIRTYFLAGS dirtyflags)

void	TouchDependenceList ()

void	SetRotationOrder (ROTATIONORDER order)

ROTATIONORDER	GetRotationOrder () const

void	SetQuaternionRotationMode (Bool active, Bool bUndo)

Bool	IsQuaternionRotationMode () const

Bool	SynchronizeVectorTrackKeys (Int32 vectorTrackID, Bool bUndo, BaseTime startRange=BaseTime(-108000, 1), BaseTime endRange=BaseTime(108000, 1))

Bool	FindBestEulerAngle (Int32 rotationTrackID, Bool bAdjustTangent, Bool bUndo, BaseTime startRange=BaseTime(-108000, 1), BaseTime endRange=BaseTime(108000, 1))

Bool	EvaluateSynchronizedRotation (const BaseTime &time, ANIMATEFLAGS flags, Vector *resultRotation=nullptr)

Bool	GetVectorTracks (const DescID &id, CTrack &xfound, CTrack &yfound, CTrack *&zfound)

Bool	GetVectorCurves (CCurve curveToSearch, CCurve &xfound, CCurve &yfound, CCurve &zfound)

UInt64	GetGUID () const

Int32	GetHighlightHandle (BaseDraw *bd)

SplineObject *	GetRealSpline ()

const SplineObject *	GetRealSpline () const

Float	GetVisibility (Float parent) const

Bool	SearchHierarchy (const BaseObject *op) const

BaseObject *	GetOrigin (Bool safe)

const BaseObject *	GetOrigin (Bool safe) const

void	SetOrigin (BaseObject *origin)

BaseObject *	GetTopOrigin (Bool parent, Bool safe) const

BaseObject *	GetEditObject (BaseObject **psds, DISPLAYEDITSTATE state, Bool safetey=true) const

void	RemoveFromCache (Bool clearParentObject=true)

DRAWRESULT	ObjDraw (DRAWPASS drawpass, BaseDraw bd, BaseDrawHelp bh)

maxon::Tuple< Bool, maxon::HashInt >	GetObjectDrawHash (Int32 type) const

void	GetDrawStateData (DrawStateData &state) const

Public Member Functions inherited from BaseList2D
void	SetBit (Int32 mask)

Bool	GetBit (Int32 mask) const

void	DelBit (Int32 mask)

void	ToggleBit (Int32 mask)

Int32	GetAllBits () const

void	SetAllBits (Int32 bits)

void	SetBitEx (Int32 mask, Int32 flags)

const Char *	GetViewportRenderId (VIEWPORT_RENDER_ID typeId) const

BaseList2D *	GetNext ()

const BaseList2D *	GetNext () const

BaseList2D *	GetPred ()

const BaseList2D *	GetPred () const

BaseContainer	GetData () const

void	SetData (const BaseContainer &bc, Bool add=true)

const BaseContainer &	GetDataInstanceRef () const

BaseContainer &	GetDataInstanceRef ()

const BaseContainer *	GetDataInstance () const

BaseContainer *	GetDataInstance ()

String	GetName () const

void	SetName (const maxon::String &name, Bool setDirty=true)

String	GetBubbleHelp ()

Bool	TransferGoal (BaseList2D *dst, Bool undolink)

Bool	TransferMarker (BaseList2D *dst) const

Bool	CopyDynamicDescriptionFrom (const BaseList2D *src)

Bool	Scale (Float scale)

Bool	Edit ()

void	GetIcon (IconData *dat)

GeListHead *	GetNLARoot (Bool create)

BaseList2D *	AnimationLayerRemap (BaseObject **layer=nullptr)

String	GetTypeName () const

const BaseList2D *	GetMain () const

BaseList2D *	GetMain ()

void	InsertTrackSorted (CTrack *track)

Bool	AddEventNotification (BaseList2D bl, NOTIFY_EVENT eventid, NOTIFY_EVENT_FLAG flags, const BaseContainer data)

Bool	RemoveEventNotification (const BaseDocument doc, BaseList2D bl, NOTIFY_EVENT eventid)

Bool	FindEventNotification (const BaseDocument doc, BaseList2D bl, NOTIFY_EVENT eventid)

Bool	SetDescIDState (const DescID &id, DESCIDSTATE descidstate)

DESCIDSTATE	GetDescIDState (const DescID &id, Bool tolerant) const

GeListHead *	GetOverrideRoot (Bool create)

BaseOverride *	GetFirstOverride ()

GeListHead *	GetShaderRepositoryRoot (Bool create)

GeListHead *	GetHiddenShaderRoot (Bool create)

maxon::NimbusForwardRef	GetNimbusRef (const maxon::Id &spaceId) const

maxon::Result< maxon::NimbusForwardRef >	PrivateGetOrCreateNimbusRef (const maxon::Id &spaceId)

void	RemoveNimbusRef (const maxon::Id &spaceId)

maxon::Result< maxon::HashMap< maxon::Id, maxon::NimbusForwardRef > >	GetAllNimbusRefs () const

Bool	IsNodeBased () const

maxon::Result< Bool >	GetAccessedObjects (METHOD_ID method, AccessedObjectsCallback &access) const

maxon::Result< Bool >	GetAccessedObjectsRec (ACCESSED_OBJECTS_MASK read, ACCESSED_OBJECTS_MASK write, METHOD_ID method, Bool withSiblings, Bool withChildren, AccessedObjectsCallback &access) const

maxon::Result< Bool >	GetAccessedObjectsOfHierarchy (ACCESSED_OBJECTS_MASK read, ACCESSED_OBJECTS_MASK write, METHOD_ID method, AccessedObjectsCallback &access) const

maxon::Result< Bool >	GetAccessedObjectsOfChildren (ACCESSED_OBJECTS_MASK read, ACCESSED_OBJECTS_MASK write, METHOD_ID method, AccessedObjectsCallback &access) const

maxon::Result< Bool >	GetAccessedObjectsOfFirstChildHierarchy (ACCESSED_OBJECTS_MASK read, ACCESSED_OBJECTS_MASK write, METHOD_ID method, AccessedObjectsCallback &access) const

maxon::Result< maxon::GenericData >	GroupChanges ()

void	GetMarkerStampEx (UInt32 l1, UInt32 l2)

const GeMarker &	GetMarker () const

void	SetMarker (const GeMarker &m)

Bool	AddUniqueID (Int32 appid, const Char *const mem, Int bytes)

Bool	FindUniqueID (Int32 appid, const Char *&mem, Int &bytes) const

Int32	GetUniqueIDCount () const

Bool	GetUniqueIDIndex (Int32 idx, Int32 &id, const Char *&mem, Int &bytes) const

Bool	SetAnimatedParameter (const CTrack *track, const DescID &id, const GeData &t_data1, const GeData &t_data2, Float mix, DESCFLAGS_SET flags)

Bool	GetAnimatedParameter (const DescID &id, GeData &t_data1, GeData &t_data2, Float &mix, DESCFLAGS_GET flags) const

BaseShader *	GetFirstShader () const

void	InsertShader (BaseShader shader, BaseShader pred=nullptr)

void	ClearKeyframeSelection ()

Bool	FindKeyframeSelection (const DescID &id)

Bool	SetKeyframeSelection (const DescID &id, Bool selection)

Bool	KeyframeSelectionContent ()

LayerObject *	GetLayerObject (const BaseDocument *doc)

const LayerObject *	GetLayerObject (const BaseDocument *doc) const

Bool	SetLayerObject (const LayerObject *layer)

const LayerData *	GetLayerData (const BaseDocument *doc, Bool rawdata=false) const

Bool	SetLayerData (BaseDocument *doc, const LayerData &data)

GeListHead *	GetCTrackRoot (Bool create)

const GeListHead *	GetCTrackRoot () const

const CTrack *	GetFirstCTrack () const

CTrack *	GetFirstCTrack ()

const CTrack *	FindCTrack (const DescID &id) const

CTrack *	FindCTrack (const DescID &id)

Public Member Functions inherited from GeListNode
GeListNode *	GetNext ()

const GeListNode *	GetNext () const

GeListNode *	GetPred ()

const GeListNode *	GetPred () const

GeListNode *	GetDown ()

const GeListNode *	GetDown () const

GeListNode *	GetUp ()

const GeListNode *	GetUp () const

GeListNode *	GetDownLast ()

const GeListNode *	GetDownLast () const

void	InsertBefore (GeListNode *bl)

void	InsertAfter (GeListNode *bl)

void	InsertUnder (GeListNode *bl)

void	InsertUnderLast (GeListNode *bl)

void	Remove ()

void	FlushChilds ()

void	MoveChildrenTo (GeListNode *dest)

GeListHead *	GetListHead ()

const GeListHead *	GetListHead () const

Int32	GetNodeID (Int32 index=0) const

template<typename CAST >
const CAST *	GetNodeData (Int32 index=0) const

template<typename CAST >
CAST *	GetNodeData (Int32 index=0)

void	SetCustomData (GeListNode *node)

GeListNode *	GetCustomData ()

const GeListNode *	GetCustomData () const

const BaseDocument *	GetDocument () const

BaseDocument *	GetDocument ()

maxon::Result< Bool >	GetBranchInfo (const maxon::ValueReceiver< const BranchInfo & > &info, GETBRANCHINFO flags) const

Bool	IsDocumentRelated () const

Int32	GetInfo () const

Bool	GetNBit (NBIT bit) const

UInt32	GetNBitMask (Int32 index) const

Bool	ChangeNBit (NBIT bit, NBITCONTROL bitmode)

Public Member Functions inherited from C4DAtomGoal
Bool	HasLinks () const

Public Member Functions inherited from C4DAtom
Int32	GetType () const

Int32	GetRealType () const

Int32	GetDiskType () const

Bool	IsInstanceOf (Int32 id) const

Int32	GetClassification () const

Bool	Message (Int32 type, void *data=nullptr)

Bool	MultiMessage (MULTIMSG_ROUTE flags, Int32 type, void *data)

C4DAtom *	GetClone (COPYFLAGS flags, AliasTrans *trn) const

Bool	CopyTo (C4DAtom dst, COPYFLAGS flags, AliasTrans trn) const

Bool	Read (HyperFile *hf, Int32 id, Int32 level)

Bool	Write (HyperFile *hf) const

Bool	ReadObject (HyperFile *hf, Bool readheader)

Bool	WriteObject (HyperFile *hf) const

Bool	GetDescription (Description *description, DESCFLAGS_DESC flags) const

Bool	GetParameter (const DescID &id, GeData &t_data, DESCFLAGS_GET flags) const

Bool	SetParameter (const DescID &id, const GeData &t_data, DESCFLAGS_SET flags)

DynamicDescription *	GetDynamicDescriptionWritable ()

const DynamicDescription *	GetDynamicDescription () const

Bool	CopyDynamicDescriptionFrom (const BaseList2D *src)

Bool	GetEnabling (const DescID &id, const GeData &t_data, DESCFLAGS_ENABLE flags, const BaseContainer *itemdesc) const

Bool	TranslateDescID (const DescID &id, DescID &res_id, C4DAtom *&res_at)

UInt32	GetDirty (DIRTYFLAGS flags) const

void	SetDirty (DIRTYFLAGS flags)

UInt32	GetHDirty (HDIRTYFLAGS mask) const

void	SetHDirty (HDIRTYFLAGS mask)

Static Public Member Functions
static FieldObject *	Alloc (Int32 type)

static void	Free (FieldObject *&field)

Static Public Member Functions inherited from BaseObject
static BaseObject *	Alloc (Int32 type)

static void	Free (BaseObject *&bl)

Static Public Member Functions inherited from BaseList2D
static BaseList2D *	Alloc (Int32 type)

static void	Free (BaseList2D *&bl)

Private Member Functions
	MAXON_DISALLOW_COPY_AND_ASSIGN (FieldObject)

	FieldObject ()

	~FieldObject ()

Additional Inherited Members
Static Public Attributes inherited from BaseList2D
static const Int32	SETBIT_FLAG_NODIRTY

static const Int32	SETBIT_FLAG_REMOVE

Constructor & Destructor Documentation

◆ FieldObject()

FieldObject ( )

private

◆ ~FieldObject()

~FieldObject ( )

private

Member Function Documentation

◆ MAXON_DISALLOW_COPY_AND_ASSIGN()

MAXON_DISALLOW_COPY_AND_ASSIGN ( FieldObject )

private

◆ Alloc()

static FieldObject* Alloc ( Int32 type )

static

Allocates a Field object. Destroy the allocated Field object with Free(). Use AutoAlloc to automate the allocation and destruction based on scope.

Parameters

[in] type The field type.

Returns: The allocated Field object, or nullptr if the allocation failed.

◆ Free()

static void Free ( FieldObject *& field )

static

Destructs Field object allocated with Alloc(). Use AutoAlloc to automate the allocation and destruction based on scope.

Parameters

[in,out] field The Field object to destruct. If the pointer is nullptr nothing happens. The pointer is assigned nullptr afterwards.

◆ InitSampling()

maxon::Result<maxon::GenericData> InitSampling ( const FieldInfo & info ) const

Initializes Field Sampling, this must be called before Sample is invoked on any field object. FreeSampling must be called afterwards.

Parameters

[in] info The FieldInfo structure to initialize with.

Returns: OK on success.

◆ FreeSampling()

void FreeSampling	(	const FieldInfo &	info,
		maxon::GenericData &	extraData
	)		const

Frees any memory allocated in InitSampling. This must be called after InitSampling has been invoked.

Parameters

[in] info The FieldInfo structure used for initialization and sampling.

◆ Sample()

maxon::Result<void> Sample	(	const FieldInput &	inputs,
		FieldOutputBlock &	outputs,
		const FieldInfo &	info,
		const maxon::GenericData &	extraData,
		const FIELDOBJECTSAMPLE_FLAG &	objectSampleFlags = `FIELDOBJECTSAMPLE_FLAG::NONE`
	)		const

Samples an array of points within the field. InitSampling must be called before invocation, and FreeSampling must can called once all sampling is complete. NOTE: Sample does not receive the SharedData. If a field needs access to it, it can keep a reference on it or copy parts of it in InitSampling.

Parameters

[in]	inputs	The points to sample in global space.
[out]	outputs	The output result values, should be allocated prior to usage.
[in]	info	The FieldInfo structure, containing useful information for sampling, this should match the structure used in InitSampling.
[in]	objectSampleFlags	The object sample flags.

Returns: OK on success.

◆ GetFieldFlags()

FIELDOBJECT_FLAG GetFieldFlags ( const BaseDocument * doc ) const

Gets the FIELDOBJECT_FLAG flags for this object.

Parameters

[in] doc If non-null, the document.

Returns: The field flags.

◆ CheckDirty()

void CheckDirty ( const BaseDocument * doc )

Calls the dirtycheck function of this field object.

Parameters

[in] doc If non-null, the document.

Public Member Functions

Static Public Member Functions

Private Member Functions

Additional Inherited Members

Constructor & Destructor Documentation

◆ FieldObject()

◆ ~FieldObject()

Member Function Documentation

◆ MAXON_DISALLOW_COPY_AND_ASSIGN()

◆ Alloc()

◆ Free()

◆ InitSampling()

◆ FreeSampling()

◆ Sample()

◆ GetFieldFlags()

◆ CheckDirty()