[Bf-blender-cvs] [395a0acdb88] master: Cleanup: style, use doxygen for comments
Campbell Barton
noreply at git.blender.org
Thu Mar 14 23:55:54 CET 2019
Commit: 395a0acdb88338b9790ecefd142f4010df6b955d
Author: Campbell Barton
Date: Fri Mar 15 09:41:13 2019 +1100
Branches: master
https://developer.blender.org/rB395a0acdb88338b9790ecefd142f4010df6b955d
Cleanup: style, use doxygen for comments
===================================================================
M source/blender/makesdna/DNA_anim_types.h
M source/blender/makesdna/DNA_constraint_types.h
M source/blender/makesdna/DNA_object_force_types.h
M source/blender/makesdna/DNA_rigidbody_types.h
M source/blender/makesdna/DNA_tracking_types.h
===================================================================
diff --git a/source/blender/makesdna/DNA_anim_types.h b/source/blender/makesdna/DNA_anim_types.h
index 14708632eb6..337856b4bd2 100644
--- a/source/blender/makesdna/DNA_anim_types.h
+++ b/source/blender/makesdna/DNA_anim_types.h
@@ -83,7 +83,7 @@ typedef enum eFModifier_Types {
FMODIFIER_TYPE_ENVELOPE = 3,
FMODIFIER_TYPE_CYCLES = 4,
FMODIFIER_TYPE_NOISE = 5,
- /** unimplemented - for applying: fft, high/low pass filters, etc. */
+ /** Unimplemented - for applying: fft, high/low pass filters, etc. */
FMODIFIER_TYPE_FILTER = 6,
FMODIFIER_TYPE_PYTHON = 7,
FMODIFIER_TYPE_LIMITS = 8,
@@ -93,27 +93,27 @@ typedef enum eFModifier_Types {
FMODIFIER_NUM_TYPES
} eFModifier_Types;
-/* F-Curve Modifier Settings */
+/** F-Curve Modifier Settings. */
typedef enum eFModifier_Flags {
- /* modifier is not able to be evaluated for some reason, and should be skipped (internal) */
- FMODIFIER_FLAG_DISABLED = (1<<0),
- /* modifier's data is expanded (in UI) */
- FMODIFIER_FLAG_EXPANDED = (1<<1),
- /* modifier is active one (in UI) for editing purposes */
- FMODIFIER_FLAG_ACTIVE = (1<<2),
- /* user wants modifier to be skipped */
- FMODIFIER_FLAG_MUTED = (1<<3),
- /* restrict range that F-Modifier can be considered over */
- FMODIFIER_FLAG_RANGERESTRICT = (1<<4),
- /* use influence control */
- FMODIFIER_FLAG_USEINFLUENCE = (1<<5),
+ /** Modifier is not able to be evaluated for some reason, and should be skipped (internal). */
+ FMODIFIER_FLAG_DISABLED = (1 << 0),
+ /** Modifier's data is expanded (in UI). */
+ FMODIFIER_FLAG_EXPANDED = (1 << 1),
+ /** Modifier is active one (in UI) for editing purposes. */
+ FMODIFIER_FLAG_ACTIVE = (1 << 2),
+ /** User wants modifier to be skipped. */
+ FMODIFIER_FLAG_MUTED = (1 << 3),
+ /** Restrict range that F-Modifier can be considered over. */
+ FMODIFIER_FLAG_RANGERESTRICT = (1 << 4),
+ /** Use influence control. */
+ FMODIFIER_FLAG_USEINFLUENCE = (1 << 5),
} eFModifier_Flags;
/* --- */
/* Generator modifier data */
typedef struct FMod_Generator {
- /* general generator information */
+ /* general generator information */
/** Coefficients array. */
float *coefficients;
/** Size of the coefficients array. */
@@ -124,7 +124,6 @@ typedef struct FMod_Generator {
/** Which 'generator' to use eFMod_Generator_Modes. */
int mode;
- /* settings */
/** Settings. */
int flag;
} FMod_Generator;
@@ -252,10 +251,10 @@ typedef struct FMod_Limits {
/* limiting flags */
typedef enum eFMod_Limit_Flags {
- FCM_LIMIT_XMIN = (1<<0),
- FCM_LIMIT_XMAX = (1<<1),
- FCM_LIMIT_YMIN = (1<<2),
- FCM_LIMIT_YMAX = (1<<3),
+ FCM_LIMIT_XMIN = (1 << 0),
+ FCM_LIMIT_XMAX = (1 << 1),
+ FCM_LIMIT_YMIN = (1 << 2),
+ FCM_LIMIT_YMAX = (1 << 3),
} eFMod_Limit_Flags;
@@ -272,10 +271,14 @@ typedef struct FMod_Noise {
/* modification modes */
typedef enum eFMod_Noise_Modifications {
- FCM_NOISE_MODIF_REPLACE = 0, /* Modify existing curve, matching it's shape */
- FCM_NOISE_MODIF_ADD, /* Add noise to the curve */
- FCM_NOISE_MODIF_SUBTRACT, /* Subtract noise from the curve */
- FCM_NOISE_MODIF_MULTIPLY /* Multiply the curve by noise */
+ /** Modify existing curve, matching it's shape. */
+ FCM_NOISE_MODIF_REPLACE = 0,
+ /** Add noise to the curve. */
+ FCM_NOISE_MODIF_ADD,
+ /** Subtract noise from the curve. */
+ FCM_NOISE_MODIF_SUBTRACT,
+ /** Multiply the curve by noise. */
+ FCM_NOISE_MODIF_MULTIPLY
} eFMod_Noise_Modifications;
@@ -297,8 +300,10 @@ typedef struct FMod_Stepped {
/* stepped modifier range flags */
typedef enum eFMod_Stepped_Flags {
- FCM_STEPPED_NO_BEFORE = (1<<0), /* don't affect frames before the start frame */
- FCM_STEPPED_NO_AFTER = (1<<1), /* don't affect frames after the end frame */
+ /** Don't affect frames before the start frame. */
+ FCM_STEPPED_NO_BEFORE = (1<<0),
+ /** Don't affect frames after the end frame. */
+ FCM_STEPPED_NO_AFTER = (1<<1),
} eFMod_Stepped_Flags;
/* Drivers -------------------------------------- */
@@ -331,22 +336,21 @@ typedef struct DriverTarget {
int idtype;
} DriverTarget;
-/* Driver Target flags */
+/** Driver Target flags. */
typedef enum eDriverTarget_Flag {
- /* used for targets that use the pchan_name instead of RNA path
- * (i.e. rotation difference)
- */
+ /** used for targets that use the pchan_name instead of RNA path
+ * (i.e. rotation difference) */
DTAR_FLAG_STRUCT_REF = (1 << 0),
- /* idtype can only be 'Object' */
+ /** idtype can only be 'Object' */
DTAR_FLAG_ID_OB_ONLY = (1 << 1),
/* "localspace" flags */
- /* base flag - basically "pre parent+constraints" */
+ /** base flag - basically "pre parent+constraints" */
DTAR_FLAG_LOCALSPACE = (1 << 2),
- /* include constraints transformed to space including parents */
+ /** include constraints transformed to space including parents */
DTAR_FLAG_LOCAL_CONSTS = (1 << 3),
- /* error flags */
+ /** error flags */
DTAR_FLAG_INVALID = (1 << 4),
} eDriverTarget_Flag;
@@ -371,7 +375,8 @@ typedef enum eDriverTarget_TransformChannels {
#define MAX_DRIVER_TARGETS 8
-/* Driver Variable (dvar)
+/**
+ * Driver Variable (dvar)
*
* A 'variable' for use as an input for the driver evaluation.
* Defines a way of accessing some channel to use, that can be
@@ -401,20 +406,21 @@ typedef struct DriverVar {
float curval;
} DriverVar;
-/* Driver Variable Types */
+/** Driver Variable Types.* */
typedef enum eDriverVar_Types {
- /* single RNA property */
+ /** single RNA property */
DVAR_TYPE_SINGLE_PROP = 0,
- /* rotation difference (between 2 bones) */
+ /** rotation difference (between 2 bones) */
DVAR_TYPE_ROT_DIFF,
- /* distance between objects/bones */
+ /** distance between objects/bones */
DVAR_TYPE_LOC_DIFF,
- /* 'final' transform for object/bones */
+ /** 'final' transform for object/bones */
DVAR_TYPE_TRANSFORM_CHAN,
- /* maximum number of variable types
- * NOTE: this must always be th last item in this list,
- * so add new types above this line.
+ /** Maximum number of variable types.
+ *
+ * \note This must always be th last item in this list,
+ * so add new types above this line.
*/
MAX_DVAR_TYPES
} eDriverVar_Types;
@@ -456,7 +462,8 @@ typedef enum eDriverVar_Flags {
/* --- */
-/* Channel Driver (i.e. Drivers / Expressions) (driver)
+/**
+ * Channel Driver (i.e. Drivers / Expressions) (driver)
*
* Channel Drivers are part of the dependency system, and are executed in addition to
* normal user-defined animation. They take the animation result of some channel(s), and
@@ -495,40 +502,41 @@ typedef struct ChannelDriver {
int flag;
} ChannelDriver;
-/* driver type */
+/** Driver type. */
typedef enum eDriver_Types {
- /* target values are averaged together */
+ /** target values are averaged together. */
DRIVER_TYPE_AVERAGE = 0,
- /* python expression/function relates targets */
+ /** python expression/function relates targets. */
DRIVER_TYPE_PYTHON,
- /* sum of all values */
+ /** sum of all values. */
DRIVER_TYPE_SUM,
- /* smallest value */
+ /** smallest value. */
DRIVER_TYPE_MIN,
- /* largest value */
+ /** largest value. */
DRIVER_TYPE_MAX
} eDriver_Types;
-/* driver flags */
-/* note: (1<<5) is deprecated; was "DRIVER_FLAG_SHOWDEBUG" */
+/** Driver flags. */
typedef enum eDriver_Flags {
- /* driver has invalid settings (internal flag) */
- DRIVER_FLAG_INVALID = (1<<0),
- DRIVER_FLAG_DEPRECATED = (1<<1),
- /* driver does replace value, but overrides (for layering of animation over driver) */
- // TODO: this needs to be implemented at some stage or left out...
- //DRIVER_FLAG_LAYERING = (1<<2),
- /* use when the expression needs to be recompiled */
- DRIVER_FLAG_RECOMPILE = (1<<3),
- /* the names are cached so they don't need have python unicode versions created each time */
- DRIVER_FLAG_RENAMEVAR = (1<<4),
- /* include 'self' in the drivers namespace. */
- DRIVER_FLAG_USE_SELF = (1<<6),
+ /** Driver has invalid settings (internal flag) */
+ DRIVER_FLAG_INVALID = (1 << 0),
+ DRIVER_FLAG_DEPRECATED = (1 << 1),
+ /** Driver does replace value, but overrides (for layering of animation over driver) */
+ // TODO: this needs to be implemented at some stage or left out...
+ //DRIVER_FLAG_LAYERING = (1 << 2),
+ /** Use when the expression needs to be recompiled. */
+ DRIVER_FLAG_RECOMPILE = (1 << 3),
+ /** The names are cached so they don't need have python unicode versions created each time */
+ DRIVER_FLAG_RENAMEVAR = (1 << 4),
+ // DRIVER_FLAG_DEPRECATED_5 = (1 << 5),
+ /** Include 'self' in the drivers namespace. */
+ DRIVER_FLAG_USE_SELF = (1 << 6),
} eDriver_Flags;
/* F-Curves -------------------------------------- */
-/* FPoint (fpt)
+/**
+ * FPoint (fpt)
*
* This is the bare-minimum data required storing motion samples. Should be more efficient
* than using BPoints, which contain a lot of other unnecessary data...
@@ -664,7 +672,8 @@ typedef enum eFCurve_Smoothing {
/* NLA Strips ------------------------------------- */
-/* NLA Strip (strip)
+/**
+ * NLA Strip (strip)
*
* A NLA Strip is a container for the reuse of Action data, defining parameters
* to control the remapping of the Action data to some destination.
@@ -729,7 +738,7 @@ typedef enum eNlaStrip_Blend_Mode {
NLASTRIP_MODE_COMBINE,
} eNlaStrip_Blend_Mode;
-/* NLA Strip Extrpolation Mode */
+/** NLA Strip Extrpolation Mode. */
typedef enum eNlaStrip_Extrapolate_Mode {
/* extend before first frame if no previous strips in track,
* and always hold+extend last frame */
@@ -740,63 +749,64 @@ typedef enum eNlaStrip_Extrapolate_Mode {
NLASTRIP_EXTEND_NOTHING = 2,
} eNlaStrip_Extrapolate_Mode;
-/* NLA Strip Settings */
+/** NLA Strip Settings. */
typedef enum eNlaStrip_Flag {
/* UI selection flags */
- /* NLA strip is the active one in the track (also indicates if strip is being tweaked) */
+ /** NLA strip is the active one in the track (also indicates if strip is being tweaked) */
NLASTRIP_FLAG_ACTIVE = (1<<0),
- /* NLA strip is selected for editing */
+ /* NLA strip is selected for editing */
NLASTRIP_FLAG_SELECT = (1<<1),
-// NLASTRIP_FLAG_SELECT_L = (1<<2), // left handle selected
-// NLASTRIP_FLAG_SELEC
@@ Diff output truncated at 10240 characters. @@
More information about the Bf-blender-cvs
mailing list