Welcome to mirror list, hosted at ThFree Co, Russian Federation.

git.blender.org/blender.git - Unnamed repository; edit this file 'description' to name the repository.
summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorCampbell Barton <ideasman42@gmail.com>2019-01-07 14:19:13 +0300
committerCampbell Barton <ideasman42@gmail.com>2019-01-07 16:43:00 +0300
commit5a43406e1bad973a8cb32702b4fdb588068a6dcd (patch)
treeb47ac75f429b586950dab5300669c373023efab8 /source/blender/makesdna/DNA_modifier_types.h
parent0215caeac2ad013fa03e2799049f5358d951ebfa (diff)
Cleanup: move DNA comments before struct members
Needed for clang-format in some cases, see: T53211
Diffstat (limited to 'source/blender/makesdna/DNA_modifier_types.h')
-rw-r--r--source/blender/makesdna/DNA_modifier_types.h522
1 files changed, 347 insertions, 175 deletions
diff --git a/source/blender/makesdna/DNA_modifier_types.h b/source/blender/makesdna/DNA_modifier_types.h
index 37157248aa6..1cd4c4e2908 100644
--- a/source/blender/makesdna/DNA_modifier_types.h
+++ b/source/blender/makesdna/DNA_modifier_types.h
@@ -112,7 +112,8 @@ typedef struct ModifierData {
int stackindex;
short flag;
short pad;
- char name[64]; /* MAX_NAME */
+ /** MAX_NAME. */
+ char name[64];
char *error;
} ModifierData;
@@ -130,7 +131,8 @@ typedef struct MappingInfoModifierData {
struct Tex *texture;
struct Object *map_object;
- char uvlayer_name[64]; /* MAX_CUSTOMDATA_LAYER_NAME */
+ /** MAX_CUSTOMDATA_LAYER_NAME. */
+ char uvlayer_name[64];
int uvlayer_tmp;
int texmapping;
} MappingInfoModifierData;
@@ -172,7 +174,8 @@ typedef struct LatticeModifierData {
ModifierData modifier;
struct Object *object;
- char name[64]; /* optional vertexgroup name, MAX_VGROUP_NAME */
+ /** Optional vertexgroup name, MAX_VGROUP_NAME. */
+ char name[64];
float strength;
char pad[4];
} LatticeModifierData;
@@ -181,8 +184,10 @@ typedef struct CurveModifierData {
ModifierData modifier;
struct Object *object;
- char name[64]; /* optional vertexgroup name, MAX_VGROUP_NAME */
- short defaxis; /* axis along which curve deforms */
+ /** Optional vertexgroup name, MAX_VGROUP_NAME. */
+ char name[64];
+ /** Axis along which curve deforms. */
+ short defaxis;
char pad[6];
} CurveModifierData;
@@ -202,8 +207,10 @@ typedef struct BuildModifierData {
float start, length;
short flag;
- short randomize; /* (bool) whether order of vertices is randomized - legacy files (for readfile conversion) */
- int seed; /* (int) random seed */
+ /** (bool) whether order of vertices is randomized - legacy files (for readfile conversion). */
+ short randomize;
+ /** (int) random seed. */
+ int seed;
} BuildModifierData;
/* Build Modifier -> flag */
@@ -216,11 +223,15 @@ enum {
typedef struct MaskModifierData {
ModifierData modifier;
- struct Object *ob_arm; /* armature to use to in place of hardcoded vgroup */
- char vgroup[64]; /* name of vertex group to use to mask, MAX_VGROUP_NAME */
+ /** Armature to use to in place of hardcoded vgroup. */
+ struct Object *ob_arm;
+ /** Name of vertex group to use to mask, MAX_VGROUP_NAME. */
+ char vgroup[64];
- short mode; /* using armature or hardcoded vgroup */
- short flag; /* flags for various things */
+ /** Using armature or hardcoded vgroup. */
+ short mode;
+ /** Flags for various things. */
+ short flag;
float threshold;
} MaskModifierData;
@@ -303,7 +314,8 @@ enum {
typedef struct MirrorModifierData {
ModifierData modifier;
- short axis DNA_DEPRECATED; /* deprecated, use flag instead */
+ /** Deprecated, use flag instead. */
+ short axis DNA_DEPRECATED;
short flag;
float tolerance;
float uv_offset[2];
@@ -332,7 +344,8 @@ enum {
typedef struct EdgeSplitModifierData {
ModifierData modifier;
- float split_angle; /* angle above which edges should be split */
+ /** Angle above which edges should be split. */
+ float split_angle;
int flags;
} EdgeSplitModifierData;
@@ -349,17 +362,25 @@ typedef struct BevelModNorEditData {
typedef struct BevelModifierData {
ModifierData modifier;
- float value; /* the "raw" bevel value (distance/amount to bevel) */
- int res; /* the resolution (as originally coded, it is the number of recursive bevels) */
- short flags; /* general option flags */
- short val_flags; /* used to interpret the bevel value */
- short lim_flags; /* flags to tell the tool how to limit the bevel */
- short e_flags; /* flags to direct how edge weights are applied to verts */
- short mat; /* material index if >= 0, else material inherited from surrounding faces */
+ /** The "raw" bevel value (distance/amount to bevel). */
+ float value;
+ /** The resolution (as originally coded, it is the number of recursive bevels). */
+ int res;
+ /** General option flags. */
+ short flags;
+ /** Used to interpret the bevel value. */
+ short val_flags;
+ /** Flags to tell the tool how to limit the bevel. */
+ short lim_flags;
+ /** Flags to direct how edge weights are applied to verts. */
+ short e_flags;
+ /** Material index if >= 0, else material inherited from surrounding faces. */
+ short mat;
short edge_flags;
short face_str_mode;
short pad2;
- float profile; /* controls profile shape (0->1, .5 is round) */
+ /** Controls profile shape (0->1, .5 is round). */
+ float profile;
/* if the MOD_BEVEL_ANGLE is set, this will be how "sharp" an edge must be before it gets beveled */
float bevel_angle;
/* if the MOD_BEVEL_VWEIGHT option is set, this will be the name of the vert group, MAX_VGROUP_NAME */
@@ -414,10 +435,13 @@ typedef struct SmokeModifierData {
ModifierData modifier;
struct SmokeDomainSettings *domain;
- struct SmokeFlowSettings *flow; /* inflow, outflow, smoke objects */
- struct SmokeCollSettings *coll; /* collision objects */
+ /** Inflow, outflow, smoke objects. */
+ struct SmokeFlowSettings *flow;
+ /** Collision objects. */
+ struct SmokeCollSettings *coll;
float time;
- int type; /* domain, inflow, outflow, ... */
+ /** Domain, inflow, outflow, .... */
+ int type;
} SmokeModifierData;
/* Smoke modifier flags */
@@ -433,14 +457,16 @@ typedef struct DisplaceModifierData {
/* keep in sync with MappingInfoModifierData */
struct Tex *texture;
struct Object *map_object;
- char uvlayer_name[64]; /* MAX_CUSTOMDATA_LAYER_NAME */
+ /** MAX_CUSTOMDATA_LAYER_NAME. */
+ char uvlayer_name[64];
int uvlayer_tmp;
int texmapping;
/* end MappingInfoModifierData */
float strength;
int direction;
- char defgrp_name[64]; /* MAX_VGROUP_NAME */
+ /** MAX_VGROUP_NAME. */
+ char defgrp_name[64];
float midlevel;
int space;
} DisplaceModifierData;
@@ -473,12 +499,14 @@ typedef struct UVProjectModifierData {
ModifierData modifier;
/* the objects which do the projecting */
- struct Object *projectors[10]; /* MOD_UVPROJECT_MAXPROJECTORS */
+ /** MOD_UVPROJECT_MAXPROJECTORS. */
+ struct Object *projectors[10];
int pad2;
int num_projectors;
float aspectx, aspecty;
float scalex, scaley;
- char uvlayer_name[64]; /* MAX_CUSTOMDATA_LAYER_NAME */
+ /** MAX_CUSTOMDATA_LAYER_NAME. */
+ char uvlayer_name[64];
int uvlayer_tmp, pad;
} UVProjectModifierData;
@@ -492,13 +520,19 @@ enum {
typedef struct DecimateModifierData {
ModifierData modifier;
- float percent; /* (mode == MOD_DECIM_MODE_COLLAPSE) */
- short iter; /* (mode == MOD_DECIM_MODE_UNSUBDIV) */
- char delimit; /* (mode == MOD_DECIM_MODE_DISSOLVE) */
- char symmetry_axis; /* (mode == MOD_DECIM_MODE_COLLAPSE) */
- float angle; /* (mode == MOD_DECIM_MODE_DISSOLVE) */
+ /** (mode == MOD_DECIM_MODE_COLLAPSE). */
+ float percent;
+ /** (mode == MOD_DECIM_MODE_UNSUBDIV). */
+ short iter;
+ /** (mode == MOD_DECIM_MODE_DISSOLVE). */
+ char delimit;
+ /** (mode == MOD_DECIM_MODE_COLLAPSE). */
+ char symmetry_axis;
+ /** (mode == MOD_DECIM_MODE_DISSOLVE). */
+ float angle;
- char defgrp_name[64]; /* MAX_VGROUP_NAME */
+ /** MAX_VGROUP_NAME. */
+ char defgrp_name[64];
float defgrp_factor;
short flag, mode;
@@ -522,7 +556,8 @@ enum {
typedef struct SmoothModifierData {
ModifierData modifier;
float fac;
- char defgrp_name[64]; /* MAX_VGROUP_NAME */
+ /** MAX_VGROUP_NAME. */
+ char defgrp_name[64];
short flag, repeat;
} SmoothModifierData;
@@ -541,7 +576,8 @@ typedef struct CastModifierData {
float fac;
float radius;
float size;
- char defgrp_name[64]; /* MAX_VGROUP_NAME */
+ /** MAX_VGROUP_NAME. */
+ char defgrp_name[64];
short flag, type;
} CastModifierData;
@@ -568,13 +604,15 @@ typedef struct WaveModifierData {
/* keep in sync with MappingInfoModifierData */
struct Tex *texture;
struct Object *map_object;
- char uvlayer_name[64]; /* MAX_CUSTOMDATA_LAYER_NAME */
+ /** MAX_CUSTOMDATA_LAYER_NAME. */
+ char uvlayer_name[64];
int uvlayer_tmp;
int texmapping;
/* end MappingInfoModifierData */
struct Object *objectcenter;
- char defgrp_name[64]; /* MAX_VGROUP_NAME */
+ /** MAX_VGROUP_NAME. */
+ char defgrp_name[64];
short flag, pad;
@@ -600,11 +638,14 @@ enum {
typedef struct ArmatureModifierData {
ModifierData modifier;
- short deformflag, multi; /* deformflag replaces armature->deformflag */
+ /** Deformflag replaces armature->deformflag. */
+ short deformflag, multi;
int pad2;
struct Object *object;
- float *prevCos; /* stored input of previous modifier, for vertexgroup blending */
- char defgrp_name[64]; /* MAX_VGROUP_NAME */
+ /** Stored input of previous modifier, for vertexgroup blending. */
+ float *prevCos;
+ /** MAX_VGROUP_NAME. */
+ char defgrp_name[64];
} ArmatureModifierData;
enum {
@@ -629,21 +670,28 @@ typedef struct HookModifierData {
ModifierData modifier;
struct Object *object;
- char subtarget[64]; /* optional name of bone target, MAX_ID_NAME-2 */
+ /** Optional name of bone target, MAX_ID_NAME-2. */
+ char subtarget[64];
char flag;
- char falloff_type; /* use enums from WarpModifier (exact same functionality) */
+ /** Use enums from WarpModifier (exact same functionality). */
+ char falloff_type;
char pad[6];
- float parentinv[4][4]; /* matrix making current transform unmodified */
- float cent[3]; /* visualization of hook */
- float falloff; /* if not zero, falloff is distance where influence zero */
+ /** Matrix making current transform unmodified. */
+ float parentinv[4][4];
+ /** Visualization of hook. */
+ float cent[3];
+ /** If not zero, falloff is distance where influence zero. */
+ float falloff;
struct CurveMapping *curfalloff;
- int *indexar; /* if NULL, it's using vertexgroup */
+ /** If NULL, it's using vertexgroup. */
+ int *indexar;
int totindex;
float force;
- char name[64]; /* optional vertexgroup name, MAX_VGROUP_NAME */
+ /** Optional vertexgroup name, MAX_VGROUP_NAME. */
+ char name[64];
} HookModifierData;
typedef struct SoftbodyModifierData {
@@ -653,13 +701,17 @@ typedef struct SoftbodyModifierData {
typedef struct ClothModifierData {
ModifierData modifier;
- struct Cloth *clothObject; /* The internal data structure for cloth. */
- struct ClothSimSettings *sim_parms; /* definition is in DNA_cloth_types.h */
- struct ClothCollSettings *coll_parms; /* definition is in DNA_cloth_types.h */
+ /** The internal data structure for cloth. */
+ struct Cloth *clothObject;
+ /** Definition is in DNA_cloth_types.h. */
+ struct ClothSimSettings *sim_parms;
+ /** Definition is in DNA_cloth_types.h. */
+ struct ClothCollSettings *coll_parms;
/* PointCache can be shared with other instances of ClothModifierData.
* Inspect (modifier.flag & eModifierFlag_SharedCaches) to find out. */
- struct PointCache *point_cache; /* definition is in DNA_object_force_types.h */
+ /** Definition is in DNA_object_force_types.h. */
+ struct PointCache *point_cache;
struct ListBase ptcaches;
/* XXX nasty hack, remove once hair can be separated from cloth modifier data */
@@ -676,33 +728,45 @@ typedef struct ClothModifierData {
typedef struct CollisionModifierData {
ModifierData modifier;
- struct MVert *x; /* position at the beginning of the frame */
- struct MVert *xnew; /* position at the end of the frame */
- struct MVert *xold; /* unused atm, but was discussed during sprint */
- struct MVert *current_xnew; /* new position at the actual inter-frame step */
- struct MVert *current_x; /* position at the actual inter-frame step */
- struct MVert *current_v; /* (xnew - x) at the actual inter-frame step */
+ /** Position at the beginning of the frame. */
+ struct MVert *x;
+ /** Position at the end of the frame. */
+ struct MVert *xnew;
+ /** Unused atm, but was discussed during sprint. */
+ struct MVert *xold;
+ /** New position at the actual inter-frame step. */
+ struct MVert *current_xnew;
+ /** Position at the actual inter-frame step. */
+ struct MVert *current_x;
+ /** (xnew - x) at the actual inter-frame step. */
+ struct MVert *current_v;
struct MVertTri *tri;
unsigned int mvert_num;
unsigned int tri_num;
- float time_x, time_xnew; /* cfra time of modifier */
- char is_static; /* collider doesn't move this frame, i.e. x[].co==xnew[].co */
+ /** Cfra time of modifier. */
+ float time_x, time_xnew;
+ /** Collider doesn't move this frame, i.e. x[].co==xnew[].co. */
+ char is_static;
char pad[7];
- struct BVHTree *bvhtree; /* bounding volume hierarchy for this cloth object */
+ /** Bounding volume hierarchy for this cloth object. */
+ struct BVHTree *bvhtree;
} CollisionModifierData;
typedef struct SurfaceModifierData {
ModifierData modifier;
- struct MVert *x; /* old position */
- struct MVert *v; /* velocity */
+ /** Old position. */
+ struct MVert *x;
+ /** Velocity. */
+ struct MVert *v;
struct Mesh *mesh;
- struct BVHTreeFromMesh *bvhtree; /* bounding volume hierarchy of the mesh faces */
+ /** Bounding volume hierarchy of the mesh faces. */
+ struct BVHTreeFromMesh *bvhtree;
int cfra, numverts;
} SurfaceModifierData;
@@ -743,30 +807,46 @@ typedef struct MDefCell {
typedef struct MeshDeformModifierData {
ModifierData modifier;
- struct Object *object; /* mesh object */
- char defgrp_name[64]; /* optional vertexgroup name, MAX_VGROUP_NAME */
+ /** Mesh object. */
+ struct Object *object;
+ /** Optional vertexgroup name, MAX_VGROUP_NAME. */
+ char defgrp_name[64];
short gridsize, flag, pad[2];
/* result of static binding */
- MDefInfluence *bindinfluences; /* influences */
- int *bindoffsets; /* offsets into influences array */
- float *bindcagecos; /* coordinates that cage was bound with */
- int totvert, totcagevert; /* total vertices in mesh and cage */
+ /** Influences. */
+ MDefInfluence *bindinfluences;
+ /** Offsets into influences array. */
+ int *bindoffsets;
+ /** Coordinates that cage was bound with. */
+ float *bindcagecos;
+ /** Total vertices in mesh and cage. */
+ int totvert, totcagevert;
/* result of dynamic binding */
- MDefCell *dyngrid; /* grid with dynamic binding cell points */
- MDefInfluence *dyninfluences; /* dynamic binding vertex influences */
- int *dynverts; /* is this vertex bound or not? */
- int dyngridsize; /* size of the dynamic bind grid */
- int totinfluence; /* total number of vertex influences */
- float dyncellmin[3]; /* offset of the dynamic bind grid */
- float dyncellwidth; /* width of dynamic bind cell */
- float bindmat[4][4]; /* matrix of cage at binding time */
+ /** Grid with dynamic binding cell points. */
+ MDefCell *dyngrid;
+ /** Dynamic binding vertex influences. */
+ MDefInfluence *dyninfluences;
+ /** Is this vertex bound or not?. */
+ int *dynverts;
+ /** Size of the dynamic bind grid. */
+ int dyngridsize;
+ /** Total number of vertex influences. */
+ int totinfluence;
+ /** Offset of the dynamic bind grid. */
+ float dyncellmin[3];
+ /** Width of dynamic bind cell. */
+ float dyncellwidth;
+ /** Matrix of cage at binding time. */
+ float bindmat[4][4];
/* deprecated storage */
- float *bindweights; /* deprecated inefficient storage */
- float *bindcos; /* deprecated storage of cage coords */
+ /** Deprecated inefficient storage. */
+ float *bindweights;
+ /** Deprecated storage of cage coords. */
+ float *bindcos;
/* runtime */
void (*bindfunc)(struct MeshDeformModifierData *mmd, struct Mesh *cagemesh,
@@ -787,8 +867,10 @@ typedef struct ParticleSystemModifierData {
ModifierData modifier;
struct ParticleSystem *psys;
- struct Mesh *mesh_final; /* Final Mesh - its topology may differ from orig mesh. */
- struct Mesh *mesh_original; /* Original mesh that particles are attached to. */
+ /** Final Mesh - its topology may differ from orig mesh. */
+ struct Mesh *mesh_final;
+ /** Original mesh that particles are attached to. */
+ struct Mesh *mesh_original;
int totdmvert, totdmedge, totdmface;
short flag, pad;
} ParticleSystemModifierData;
@@ -823,8 +905,10 @@ typedef struct ParticleInstanceModifierData {
float position, random_position;
float rotation, random_rotation;
float particle_amount, particle_offset;
- char index_layer_name[64]; /* MAX_CUSTOMDATA_LAYER_NAME */
- char value_layer_name[64]; /* MAX_CUSTOMDATA_LAYER_NAME */
+ /** MAX_CUSTOMDATA_LAYER_NAME. */
+ char index_layer_name[64];
+ /** MAX_CUSTOMDATA_LAYER_NAME. */
+ char value_layer_name[64];
} ParticleInstanceModifierData;
typedef enum {
@@ -842,7 +926,8 @@ typedef struct ExplodeModifierData {
int *facepa;
short flag, vgroup;
float protect;
- char uvname[64]; /* MAX_CUSTOMDATA_LAYER_NAME */
+ /** MAX_CUSTOMDATA_LAYER_NAME. */
+ char uvname[64];
} ExplodeModifierData;
typedef struct MultiresModifierData {
@@ -864,21 +949,31 @@ typedef enum {
typedef struct FluidsimModifierData {
ModifierData modifier;
- struct FluidsimSettings *fss; /* definition is in DNA_object_fluidsim_types.h */
+ /** Definition is in DNA_object_fluidsim_types.h. */
+ struct FluidsimSettings *fss;
} FluidsimModifierData;
typedef struct ShrinkwrapModifierData {
ModifierData modifier;
- struct Object *target; /* shrink target */
- struct Object *auxTarget; /* additional shrink target */
- char vgroup_name[64]; /* optional vertexgroup name, MAX_VGROUP_NAME */
- float keepDist; /* distance offset to keep from mesh/projection point */
- short shrinkType; /* shrink type projection */
- char shrinkOpts; /* shrink options */
- char shrinkMode; /* shrink to surface mode */
- float projLimit; /* limit the projection ray cast */
- char projAxis; /* axis to project over */
+ /** Shrink target. */
+ struct Object *target;
+ /** Additional shrink target. */
+ struct Object *auxTarget;
+ /** Optional vertexgroup name, MAX_VGROUP_NAME. */
+ char vgroup_name[64];
+ /** Distance offset to keep from mesh/projection point. */
+ float keepDist;
+ /** Shrink type projection. */
+ short shrinkType;
+ /** Shrink options. */
+ char shrinkOpts;
+ /** Shrink to surface mode. */
+ char shrinkMode;
+ /** Limit the projection ray cast. */
+ float projLimit;
+ /** Axis to project over. */
+ char projAxis;
/* If using projection over vertex normal this controls the level of subsurface that must be done
* before getting the vertex coordinates and normal
@@ -944,14 +1039,21 @@ enum {
typedef struct SimpleDeformModifierData {
ModifierData modifier;
- struct Object *origin; /* object to control the origin of modifier space coordinates */
- char vgroup_name[64]; /* optional vertexgroup name, MAX_VGROUP_NAME */
- float factor; /* factors to control simple deforms */
- float limit[2]; /* lower and upper limit */
+ /** Object to control the origin of modifier space coordinates. */
+ struct Object *origin;
+ /** Optional vertexgroup name, MAX_VGROUP_NAME. */
+ char vgroup_name[64];
+ /** Factors to control simple deforms. */
+ float factor;
+ /** Lower and upper limit. */
+ float limit[2];
- char mode; /* deform function */
- char axis; /* lock axis (for taper and stretch) */
- char deform_axis; /* axis to perform the deform on (default is X, but can be overridden by origin */
+ /** Deform function. */
+ char mode;
+ /** Lock axis (for taper and stretch). */
+ char axis;
+ /** Axis to perform the deform on (default is X, but can be overridden by origin. */
+ char deform_axis;
char flag;
} SimpleDeformModifierData;
@@ -982,12 +1084,16 @@ typedef struct ShapeKeyModifierData {
typedef struct SolidifyModifierData {
ModifierData modifier;
- char defgrp_name[64]; /* name of vertex group to use, MAX_VGROUP_NAME */
- float offset; /* new surface offset level*/
- float offset_fac; /* midpoint of the offset */
+ /** Name of vertex group to use, MAX_VGROUP_NAME. */
+ char defgrp_name[64];
+ /** New surface offset leve.l*/
+ float offset;
+ /** Midpoint of the offset . */
+ float offset_fac;
/* factor for the minimum weight to use when vgroups are used, avoids 0.0 weights giving duplicate geometry */
float offset_fac_vg;
- float offset_clamp; /* clamp offset based on surrounding geometry */
+ /** Clamp offset based on surrounding geometry. */
+ float offset_clamp;
float pad;
float crease_inner;
float crease_outer;
@@ -1061,8 +1167,10 @@ typedef struct OceanModifierData {
int bakestart;
int bakeend;
- char cachepath[1024]; /* FILE_MAX */
- char foamlayername[64]; /* MAX_CUSTOMDATA_LAYER_NAME */
+ /** FILE_MAX. */
+ char cachepath[1024];
+ /** MAX_CUSTOMDATA_LAYER_NAME. */
+ char foamlayername[64];
char cached;
char geometry_mode;
@@ -1098,7 +1206,8 @@ typedef struct WarpModifierData {
/* keep in sync with MappingInfoModifierData */
struct Tex *texture;
struct Object *map_object;
- char uvlayer_name[64]; /* MAX_CUSTOMDATA_LAYER_NAME */
+ /** MAX_CUSTOMDATA_LAYER_NAME. */
+ char uvlayer_name[64];
int uvlayer_tmp;
int texmapping;
/* end MappingInfoModifierData */
@@ -1106,10 +1215,12 @@ typedef struct WarpModifierData {
struct Object *object_from;
struct Object *object_to;
struct CurveMapping *curfalloff;
- char defgrp_name[64]; /* optional vertexgroup name, MAX_VGROUP_NAME */
+ /** Optional vertexgroup name, MAX_VGROUP_NAME. */
+ char defgrp_name[64];
float strength;
float falloff_radius;
- char flag; /* not used yet */
+ /** Not used yet. */
+ char flag;
char falloff_type;
char pad[6];
} WarpModifierData;
@@ -1132,28 +1243,40 @@ typedef enum {
typedef struct WeightVGEditModifierData {
ModifierData modifier;
- char defgrp_name[64]; /* Name of vertex group to edit. MAX_VGROUP_NAME. */
+ /** Name of vertex group to edit. MAX_VGROUP_NAME. */
+ char defgrp_name[64];
- short edit_flags; /* Using MOD_WVG_EDIT_* flags. */
- short falloff_type; /* Using MOD_WVG_MAPPING_* defines. */
- float default_weight; /* Weight for vertices not in vgroup. */
+ /** Using MOD_WVG_EDIT_* flags. */
+ short edit_flags;
+ /** Using MOD_WVG_MAPPING_* defines. */
+ short falloff_type;
+ /** Weight for vertices not in vgroup. */
+ float default_weight;
/* Mapping stuff. */
- struct CurveMapping *cmap_curve; /* The custom mapping curve! */
+ /** The custom mapping curve!. */
+ struct CurveMapping *cmap_curve;
/* The add/remove vertices weight thresholds. */
float add_threshold, rem_threshold;
/* Masking options. */
- float mask_constant; /* The global "influence", if no vgroup nor tex is used as mask. */
- char mask_defgrp_name[64]; /* Name of mask vertex group from which to get weight factors. MAX_VGROUP_NAME */
+ /** The global "influence", if no vgroup nor tex is used as mask. */
+ float mask_constant;
+ /** Name of mask vertex group from which to get weight factors. MAX_VGROUP_NAME. */
+ char mask_defgrp_name[64];
/* Texture masking. */
- int mask_tex_use_channel; /* Which channel to use as weightf. */
- struct Tex *mask_texture; /* The texture. */
- struct Object *mask_tex_map_obj; /* Name of the map object. */
- int mask_tex_mapping; /* How to map the texture (using MOD_DISP_MAP_* enums). */
- char mask_tex_uvlayer_name[64]; /* Name of the UV map. MAX_CUSTOMDATA_LAYER_NAME */
+ /** Which channel to use as weightf. */
+ int mask_tex_use_channel;
+ /** The texture. */
+ struct Tex *mask_texture;
+ /** Name of the map object. */
+ struct Object *mask_tex_map_obj;
+ /** How to map the texture (using MOD_DISP_MAP_* enums). */
+ int mask_tex_mapping;
+ /** Name of the UV map. MAX_CUSTOMDATA_LAYER_NAME. */
+ char mask_tex_uvlayer_name[64];
/* Padding... */
int pad_i1;
@@ -1169,25 +1292,38 @@ enum {
typedef struct WeightVGMixModifierData {
ModifierData modifier;
- char defgrp_name_a[64]; /* Name of vertex group to modify/weight. MAX_VGROUP_NAME. */
- char defgrp_name_b[64]; /* Name of other vertex group to mix in. MAX_VGROUP_NAME. */
- float default_weight_a; /* Default weight value for first vgroup. */
- float default_weight_b; /* Default weight value to mix in. */
- char mix_mode; /* How second vgroups weights affect first ones */
- char mix_set; /* What vertices to affect. */
+ /** Name of vertex group to modify/weight. MAX_VGROUP_NAME. */
+ char defgrp_name_a[64];
+ /** Name of other vertex group to mix in. MAX_VGROUP_NAME. */
+ char defgrp_name_b[64];
+ /** Default weight value for first vgroup. */
+ float default_weight_a;
+ /** Default weight value to mix in. */
+ float default_weight_b;
+ /** How second vgroups weights affect first ones. */
+ char mix_mode;
+ /** What vertices to affect. */
+ char mix_set;
char pad_c1[6];
/* Masking options. */
- float mask_constant; /* The global "influence", if no vgroup nor tex is used as mask. */
- char mask_defgrp_name[64]; /* Name of mask vertex group from which to get weight factors. MAX_VGROUP_NAME */
+ /** The global "influence", if no vgroup nor tex is used as mask. */
+ float mask_constant;
+ /** Name of mask vertex group from which to get weight factors. MAX_VGROUP_NAME. */
+ char mask_defgrp_name[64];
/* Texture masking. */
- int mask_tex_use_channel; /* Which channel to use as weightf. */
- struct Tex *mask_texture; /* The texture. */
- struct Object *mask_tex_map_obj; /* Name of the map object. */
- int mask_tex_mapping; /* How to map the texture! */
- char mask_tex_uvlayer_name[64]; /* Name of the UV map. MAX_CUSTOMDATA_LAYER_NAME. */
+ /** Which channel to use as weightf. */
+ int mask_tex_use_channel;
+ /** The texture. */
+ struct Tex *mask_texture;
+ /** Name of the map object. */
+ struct Object *mask_tex_map_obj;
+ /** How to map the texture!. */
+ int mask_tex_mapping;
+ /** Name of the UV map. MAX_CUSTOMDATA_LAYER_NAME. */
+ char mask_tex_uvlayer_name[64];
/* Padding... */
int pad_i1;
@@ -1216,7 +1352,8 @@ enum {
typedef struct WeightVGProximityModifierData {
ModifierData modifier;
- char defgrp_name[64]; /* Name of vertex group to modify/weight. MAX_VGROUP_NAME. */
+ /** Name of vertex group to modify/weight. MAX_VGROUP_NAME. */
+ char defgrp_name[64];
/* Proximity modes. */
int proximity_mode;
@@ -1226,20 +1363,29 @@ typedef struct WeightVGProximityModifierData {
struct Object *proximity_ob_target;
/* Masking options. */
- float mask_constant; /* The global "influence", if no vgroup nor tex is used as mask. */
- char mask_defgrp_name[64]; /* Name of mask vertex group from which to get weight factors. MAX_VGROUP_NAME */
+ /** The global "influence", if no vgroup nor tex is used as mask. */
+ float mask_constant;
+ /** Name of mask vertex group from which to get weight factors. MAX_VGROUP_NAME. */
+ char mask_defgrp_name[64];
/* Texture masking. */
- int mask_tex_use_channel; /* Which channel to use as weightf. */
- struct Tex *mask_texture; /* The texture. */
- struct Object *mask_tex_map_obj; /* Name of the map object. */
- int mask_tex_mapping; /* How to map the texture! */
- char mask_tex_uvlayer_name[64]; /* Name of the UV Map. MAX_CUSTOMDATA_LAYER_NAME. */
-
- float min_dist, max_dist; /* Distances mapping to 0.0/1.0 weights. */
+ /** Which channel to use as weightf. */
+ int mask_tex_use_channel;
+ /** The texture. */
+ struct Tex *mask_texture;
+ /** Name of the map object. */
+ struct Object *mask_tex_map_obj;
+ /** How to map the texture!. */
+ int mask_tex_mapping;
+ /** Name of the UV Map. MAX_CUSTOMDATA_LAYER_NAME. */
+ char mask_tex_uvlayer_name[64];
+
+ /** Distances mapping to 0.0/1.0 weights. */
+ float min_dist, max_dist;
/* Put here to avoid breaking existing struct... */
- short falloff_type; /* Using MOD_WVG_MAPPING_* enums. */
+ /** Using MOD_WVG_MAPPING_* enums. */
+ short falloff_type;
/* Padding... */
short pad_s1;
@@ -1293,7 +1439,8 @@ typedef struct DynamicPaintModifierData {
struct DynamicPaintCanvasSettings *canvas;
struct DynamicPaintBrushSettings *brush;
- int type; /* ui display: canvas / brush */
+ /** Ui display: canvas / brush. */
+ int type;
int pad;
} DynamicPaintModifierData;
@@ -1396,7 +1543,8 @@ typedef struct LaplacianSmoothModifierData {
ModifierData modifier;
float lambda, lambda_border, pad1;
- char defgrp_name[64]; /* MAX_VGROUP_NAME */
+ /** MAX_VGROUP_NAME. */
+ char defgrp_name[64];
short flag, repeat;
} LaplacianSmoothModifierData;
@@ -1425,7 +1573,8 @@ typedef struct CorrectiveSmoothModifierData {
char smooth_type, rest_source;
char pad[2];
- char defgrp_name[64]; /* MAX_VGROUP_NAME */
+ /** MAX_VGROUP_NAME. */
+ char defgrp_name[64];
/* runtime-only cache (delta's between),
* delta's between the original positions and the smoothed positions */
@@ -1456,15 +1605,22 @@ typedef struct UVWarpModifierData {
char axis_u, axis_v;
char pad[6];
- float center[2]; /* used for rotate/scale */
-
- struct Object *object_src; /* source */
- char bone_src[64]; /* optional name of bone target, MAX_ID_NAME-2 */
- struct Object *object_dst; /* target */
- char bone_dst[64]; /* optional name of bone target, MAX_ID_NAME-2 */
-
- char vgroup_name[64]; /* optional vertexgroup name, MAX_VGROUP_NAME */
- char uvlayer_name[64]; /* MAX_CUSTOMDATA_LAYER_NAME */
+ /** Used for rotate/scale. */
+ float center[2];
+
+ /** Source. */
+ struct Object *object_src;
+ /** Optional name of bone target, MAX_ID_NAME-2. */
+ char bone_src[64];
+ /** Target. */
+ struct Object *object_dst;
+ /** Optional name of bone target, MAX_ID_NAME-2. */
+ char bone_dst[64];
+
+ /** Optional vertexgroup name, MAX_VGROUP_NAME. */
+ char vgroup_name[64];
+ /** MAX_CUSTOMDATA_LAYER_NAME. */
+ char uvlayer_name[64];
} UVWarpModifierData;
/* cache modifier */
@@ -1472,7 +1628,8 @@ typedef struct MeshCacheModifierData {
ModifierData modifier;
char flag;
- char type; /* file format */
+ /** File format. */
+ char type;
char time_mode;
char play_mode;
@@ -1497,7 +1654,8 @@ typedef struct MeshCacheModifierData {
float eval_time;
float eval_factor;
- char filepath[1024]; /* FILE_MAX */
+ /** FILE_MAX. */
+ char filepath[1024];
} MeshCacheModifierData;
enum {
@@ -1530,10 +1688,12 @@ enum {
typedef struct LaplacianDeformModifierData {
ModifierData modifier;
- char anchor_grp_name[64]; /* MAX_VGROUP_NAME */
+ /** MAX_VGROUP_NAME. */
+ char anchor_grp_name[64];
int total_verts, repeat;
float *vertexco;
- void *cache_system; /* runtime only */
+ /** Runtime only. */
+ void *cache_system;
short flag, pad[3];
} LaplacianDeformModifierData;
@@ -1546,7 +1706,8 @@ enum {
/* many of these options match 'solidify' */
typedef struct WireframeModifierData {
ModifierData modifier;
- char defgrp_name[64]; /* MAX_VGROUP_NAME */
+ /** MAX_VGROUP_NAME. */
+ char defgrp_name[64];
float offset;
float offset_fac;
float offset_fac_vg;
@@ -1570,7 +1731,8 @@ typedef struct DataTransferModifierData {
struct Object *ob_source;
- int data_types; /* See DT_TYPE_ enum in ED_object.h */
+ /** See DT_TYPE_ enum in ED_object.h. */
+ int data_types;
/* See MREMAP_MODE_ enum in BKE_mesh_mapping.h */
int vmap_mode;
@@ -1584,12 +1746,16 @@ typedef struct DataTransferModifierData {
int pad_i1;
- int layers_select_src[4]; /* DT_MULTILAYER_INDEX_MAX; See DT_FROMLAYERS_ enum in ED_object.h */
- int layers_select_dst[4]; /* DT_MULTILAYER_INDEX_MAX; See DT_TOLAYERS_ enum in ED_object.h */
+ /** DT_MULTILAYER_INDEX_MAX; See DT_FROMLAYERS_ enum in ED_object.h. */
+ int layers_select_src[4];
+ /** DT_MULTILAYER_INDEX_MAX; See DT_TOLAYERS_ enum in ED_object.h. */
+ int layers_select_dst[4];
- int mix_mode; /* See CDT_MIX_ enum in BKE_customdata.h */
+ /** See CDT_MIX_ enum in BKE_customdata.h. */
+ int mix_mode;
float mix_factor;
- char defgrp_name[64]; /* MAX_VGROUP_NAME */
+ /** MAX_VGROUP_NAME. */
+ char defgrp_name[64];
int flags;
} DataTransferModifierData;
@@ -1610,8 +1776,10 @@ enum {
/* Set Split Normals modifier */
typedef struct NormalEditModifierData {
ModifierData modifier;
- char defgrp_name[64]; /* MAX_VGROUP_NAME */
- struct Object *target; /* Source of normals, or center of ellipsoid. */
+ /** MAX_VGROUP_NAME. */
+ char defgrp_name[64];
+ /** Source of normals, or center of ellipsoid. */
+ struct Object *target;
short mode;
short flag;
short mix_mode;
@@ -1648,7 +1816,8 @@ typedef struct MeshSeqCacheModifierData {
struct CacheFile *cache_file;
struct CacheReader *reader;
- char object_path[1024]; /* 1024 = FILE_MAX */
+ /** 1024 = FILE_MAX. */
+ char object_path[1024];
char read_flag;
char pad[7];
@@ -1681,8 +1850,10 @@ typedef struct SurfaceDeformModifierData {
ModifierData modifier;
struct Depsgraph *depsgraph;
- struct Object *target; /* bind target object */
- SDefVert *verts; /* vertex bind data */
+ /** Bind target object. */
+ struct Object *target;
+ /** Vertex bind data. */
+ SDefVert *verts;
float falloff;
unsigned int numverts, numpoly;
int flags;
@@ -1708,7 +1879,8 @@ enum {
typedef struct WeightedNormalModifierData {
ModifierData modifier;
- char defgrp_name[64]; /* MAX_VGROUP_NAME */
+ /** MAX_VGROUP_NAME. */
+ char defgrp_name[64];
char mode, flag;
short weight;
float thresh;