From 2ea565b0ec94136d01fb3ff5bdc31cecfe1c2440 Mon Sep 17 00:00:00 2001
From: Brecht Van Lommel <brecht@blender.org>
Date: Mon, 12 Jul 2021 16:15:03 +0200
Subject: Cleanup: improve naming and comments of scene frame/ctime functions

Confusingly, BKE_scene_frame_get did not match the frame number as expected by
BKE_scene_frame_set. Instead it return the value after time remapping, which
is commonly named "ctime".

* Rename BKE_scene_frame_get to BKE_scene_ctime_get
* Add a new BKE_scene_frame_get that matches BKE_scene_frame_set
* Use int/float depending if fractional frame is expected
---
 source/blender/modifiers/intern/MOD_build.c          |  2 +-
 source/blender/modifiers/intern/MOD_explode.c        | 12 ++++++------
 source/blender/modifiers/intern/MOD_meshcache.c      |  8 ++++----
 source/blender/modifiers/intern/MOD_particlesystem.c |  1 -
 4 files changed, 11 insertions(+), 12 deletions(-)

(limited to 'source/blender/modifiers')

diff --git a/source/blender/modifiers/intern/MOD_build.c b/source/blender/modifiers/intern/MOD_build.c
index c38e5126f6b..52f21e3d3d0 100644
--- a/source/blender/modifiers/intern/MOD_build.c
+++ b/source/blender/modifiers/intern/MOD_build.c
@@ -101,7 +101,7 @@ static Mesh *modifyMesh(ModifierData *md, const ModifierEvalContext *ctx, struct
   range_vn_i(faceMap, numPoly_src, 0);
 
   struct Scene *scene = DEG_get_input_scene(ctx->depsgraph);
-  frac = (BKE_scene_frame_get(scene) - bmd->start) / bmd->length;
+  frac = (BKE_scene_ctime_get(scene) - bmd->start) / bmd->length;
   CLAMP(frac, 0.0f, 1.0f);
   if (bmd->flag & MOD_BUILD_FLAG_REVERSE) {
     frac = 1.0f - frac;
diff --git a/source/blender/modifiers/intern/MOD_explode.c b/source/blender/modifiers/intern/MOD_explode.c
index 545e23221ec..bf197dca7e5 100644
--- a/source/blender/modifiers/intern/MOD_explode.c
+++ b/source/blender/modifiers/intern/MOD_explode.c
@@ -919,7 +919,7 @@ static Mesh *explodeMesh(ExplodeModifierData *emd,
   EdgeHashIterator *ehi;
   float *vertco = NULL, imat[4][4];
   float rot[4];
-  float cfra;
+  float ctime;
   /* float timestep; */
   const int *facepa = emd->facepa;
   int totdup = 0, totvert = 0, totface = 0, totpart = 0, delface = 0;
@@ -940,7 +940,7 @@ static Mesh *explodeMesh(ExplodeModifierData *emd,
 
   /* timestep = psys_get_timestep(&sim); */
 
-  cfra = BKE_scene_frame_get(scene);
+  ctime = BKE_scene_ctime_get(scene);
 
   /* hash table for vertice <-> particle relations */
   vertpahash = BLI_edgehash_new(__func__);
@@ -962,7 +962,7 @@ static Mesh *explodeMesh(ExplodeModifierData *emd,
 
     /* do mindex + totvert to ensure the vertex index to be the first
      * with BLI_edgehashIterator_getKey */
-    if (pa == NULL || cfra < pa->time) {
+    if (pa == NULL || ctime < pa->time) {
       mindex = totvert + totpart;
     }
     else {
@@ -1022,7 +1022,7 @@ static Mesh *explodeMesh(ExplodeModifierData *emd,
 
       psys_get_birth_coords(&sim, pa, &birth, 0, 0);
 
-      state.time = cfra;
+      state.time = ctime;
       psys_get_particle_state(&sim, ed_v2, &state, 1);
 
       vertco = explode->mvert[v].co;
@@ -1076,7 +1076,7 @@ static Mesh *explodeMesh(ExplodeModifierData *emd,
     orig_v4 = source.v4;
 
     /* Same as above in the first loop over mesh's faces. */
-    if (pa == NULL || cfra < pa->time) {
+    if (pa == NULL || ctime < pa->time) {
       mindex = totvert + totpart;
     }
     else {
@@ -1096,7 +1096,7 @@ static Mesh *explodeMesh(ExplodeModifierData *emd,
 
     /* override uv channel for particle age */
     if (mtface) {
-      float age = (pa != NULL) ? (cfra - pa->time) / pa->lifetime : 0.0f;
+      float age = (pa != NULL) ? (ctime - pa->time) / pa->lifetime : 0.0f;
       /* Clamp to this range to avoid flipping to the other side of the coordinates. */
       CLAMP(age, 0.001f, 0.999f);
 
diff --git a/source/blender/modifiers/intern/MOD_meshcache.c b/source/blender/modifiers/intern/MOD_meshcache.c
index 6ec3277ee7a..e0507320628 100644
--- a/source/blender/modifiers/intern/MOD_meshcache.c
+++ b/source/blender/modifiers/intern/MOD_meshcache.c
@@ -104,20 +104,20 @@ static void meshcache_do(MeshCacheModifierData *mcmd,
   /* -------------------------------------------------------------------- */
   /* Interpret Time (the reading functions also do some of this ) */
   if (mcmd->play_mode == MOD_MESHCACHE_PLAY_CFEA) {
-    const float cfra = BKE_scene_frame_get(scene);
+    const float ctime = BKE_scene_ctime_get(scene);
 
     switch (mcmd->time_mode) {
       case MOD_MESHCACHE_TIME_FRAME: {
-        time = cfra;
+        time = ctime;
         break;
       }
       case MOD_MESHCACHE_TIME_SECONDS: {
-        time = cfra / fps;
+        time = ctime / fps;
         break;
       }
       case MOD_MESHCACHE_TIME_FACTOR:
       default: {
-        time = cfra / fps;
+        time = ctime / fps;
         break;
       }
     }
diff --git a/source/blender/modifiers/intern/MOD_particlesystem.c b/source/blender/modifiers/intern/MOD_particlesystem.c
index 38cce5e6a50..ef70f3fe6f4 100644
--- a/source/blender/modifiers/intern/MOD_particlesystem.c
+++ b/source/blender/modifiers/intern/MOD_particlesystem.c
@@ -120,7 +120,6 @@ static void deformVerts(ModifierData *md,
   Mesh *mesh_src = mesh;
   ParticleSystemModifierData *psmd = (ParticleSystemModifierData *)md;
   ParticleSystem *psys = NULL;
-  /* float cfra = BKE_scene_frame_get(md->scene); */ /* UNUSED */
 
   if (ctx->object->particlesystem.first) {
     psys = psmd->psys;
-- 
cgit v1.2.3