Blender V5.3
blender::FModifierTypeInfo Struct Reference

#include <BKE_fcurve.hh>

Public Attributes

short type
short size
short acttype
short requires_flag
char name [64]
char struct_name [64]
uint storage_size
void(*) free_data (FModifier *fcm)
void(*) copy_data (FModifier *fcm, const FModifier *src)
void(*) new_data (void *mdata)
void(*) verify_data (FModifier *fcm)
float(*) evaluate_modifier_time (const FCurve *fcu, const FModifier *fcm, float cvalue, float evaltime, void *storage)
void(*) evaluate_modifier (const FCurve *fcu, const FModifier *fcm, float *cvalue, float evaltime, void *storage)

Detailed Description

F-Curve Modifier Type-Info (fmi): This struct provides function pointers for runtime, so that functions can be written more generally (with fewer/no special exceptions for various modifiers).

Callers of these functions must check that they actually point to something useful, as some constraints don't define some of these.

Warning
it is not too advisable to reorder order of members of this struct, as you'll have to edit quite a few (FMODIFIER_NUM_TYPES) of these structs.

Definition at line 66 of file BKE_fcurve.hh.

Member Data Documentation

◆ acttype

short blender::FModifierTypeInfo::acttype

eFMI_Action_Types.

Definition at line 73 of file BKE_fcurve.hh.

Referenced by blender::list_has_suitable_fmodifier().

◆ copy_data

void(*) blender::FModifierTypeInfo::copy_data(FModifier *fcm, const FModifier *src)

Copy any special data that is allocated separately (optional).

Definition at line 87 of file BKE_fcurve.hh.

Referenced by blender::copy_fmodifier(), and blender::copy_fmodifiers().

◆ evaluate_modifier

void(*) blender::FModifierTypeInfo::evaluate_modifier(const FCurve *fcu, const FModifier *fcm, float *cvalue, float evaltime, void *storage)

Evaluate the modifier for the given time and 'accumulated' value

Definition at line 101 of file BKE_fcurve.hh.

Referenced by blender::evaluate_value_fmodifiers().

◆ evaluate_modifier_time

float(*) blender::FModifierTypeInfo::evaluate_modifier_time(const FCurve *fcu, const FModifier *fcm, float cvalue, float evaltime, void *storage)

Evaluate time that the modifier requires the F-Curve to be evaluated at

Definition at line 98 of file BKE_fcurve.hh.

Referenced by blender::evaluate_time_fmodifiers().

◆ free_data

void(*) blender::FModifierTypeInfo::free_data(FModifier *fcm)

Free any data that is allocated separately (optional).

Definition at line 85 of file BKE_fcurve.hh.

Referenced by blender::remove_fmodifier().

◆ name

char blender::FModifierTypeInfo::name[64]

◆ new_data

void(*) blender::FModifierTypeInfo::new_data(void *mdata)

Set settings for data that will be used for FCuModifier.data (memory already allocated using MEM_new_zeroed).

Definition at line 92 of file BKE_fcurve.hh.

Referenced by blender::add_fmodifier().

◆ requires_flag

short blender::FModifierTypeInfo::requires_flag

eFMI_Requirement_Flags.

Definition at line 75 of file BKE_fcurve.hh.

Referenced by blender::BKE_fmodifier_ensure_flag().

◆ size

short blender::FModifierTypeInfo::size

size in bytes of the struct.

Definition at line 71 of file BKE_fcurve.hh.

Referenced by blender::add_fmodifier().

◆ storage_size

uint blender::FModifierTypeInfo::storage_size

Size of buffer that can be reused between time and value evaluation.

Definition at line 81 of file BKE_fcurve.hh.

Referenced by blender::evaluate_fmodifiers_storage_size_per_modifier().

◆ struct_name

char blender::FModifierTypeInfo::struct_name[64]

◆ type

short blender::FModifierTypeInfo::type

#FMODIFIER_TYPE_*

Definition at line 69 of file BKE_fcurve.hh.

Referenced by blender::graph_fmodifier_itemf(), and blender::nla_fmodifier_itemf().

◆ verify_data

void(*) blender::FModifierTypeInfo::verify_data(FModifier *fcm)

Verifies that the modifier settings are valid

Definition at line 94 of file BKE_fcurve.hh.


The documentation for this struct was generated from the following file: