deg_builder_cache.cc

Go to the documentation of this file.

/* SPDX-FileCopyrightText: 2018 Blender Authors
 *
 * SPDX-License-Identifier: GPL-2.0-or-later */
 
#include "intern/builder/deg_builder_cache.h"
 
#include "MEM_guardedalloc.h"
 
#include "DNA_anim_types.h"
 
#include "BLI_utildefines.h"
 
#include "BKE_anim_data.hh"
 
#include "RNA_path.hh"
 
namespace blender::deg {
 
/* Animated property storage. */
 
AnimatedPropertyID::AnimatedPropertyID() : data(nullptr), property_rna(nullptr) {}
 
AnimatedPropertyID::AnimatedPropertyID(const PointerRNA *pointer_rna,
                                       const PropertyRNA *property_rna)
    : AnimatedPropertyID(*pointer_rna, property_rna)
{
}
 
AnimatedPropertyID::AnimatedPropertyID(const PointerRNA &pointer_rna,
                                       const PropertyRNA *property_rna)
    : data(pointer_rna.data), property_rna(property_rna)
{
}
 
AnimatedPropertyID::AnimatedPropertyID(const ID *id, StructRNA *type, const char *property_name)
    : data(id)
{
  property_rna = RNA_struct_type_find_property(type, property_name);
}
 
AnimatedPropertyID::AnimatedPropertyID(const ID * /*id*/,
                                       StructRNA *type,
                                       void *data,
                                       const char *property_name)
    : data(data)
{
  property_rna = RNA_struct_type_find_property(type, property_name);
}
 
bool operator==(const AnimatedPropertyID &a, const AnimatedPropertyID &b)
{
  return a.data == b.data && a.property_rna == b.property_rna;
}
 
uint64_t AnimatedPropertyID::hash() const
{
  uintptr_t ptr1 = uintptr_t(data);
  uintptr_t ptr2 = uintptr_t(property_rna);
  return uint64_t(((ptr1 >> 4) * 33) ^ (ptr2 >> 4));
}
 
AnimatedPropertyStorage::AnimatedPropertyStorage() : is_fully_initialized(false) {}
 
void AnimatedPropertyStorage::initializeFromID(DepsgraphBuilderCache *builder_cache, const ID *id)
{
  PointerRNA own_pointer_rna = RNA_id_pointer_create(const_cast<ID *>(id));
  BKE_fcurves_id_cb(const_cast<ID *>(id), [&](ID * /*id*/, FCurve *fcurve) {
    if (fcurve->rna_path == nullptr || fcurve->rna_path[0] == '\0') {
      return;
    }
    /* Resolve property. */
    PointerRNA pointer_rna;
    PropertyRNA *property_rna = nullptr;
    if (!RNA_path_resolve_property(
            &own_pointer_rna, fcurve->rna_path, &pointer_rna, &property_rna))
    {
      return;
    }
    /* Get storage for the ID.
     * This is needed to deal with cases when nested datablock is animated by its parent. */
    AnimatedPropertyStorage *animated_property_storage = this;
    if (pointer_rna.owner_id != own_pointer_rna.owner_id) {
      animated_property_storage = builder_cache->ensureAnimatedPropertyStorage(
          pointer_rna.owner_id);
    }
    /* Set the property as animated. */
    animated_property_storage->tagPropertyAsAnimated(&pointer_rna, property_rna);
  });
}
 
void AnimatedPropertyStorage::tagPropertyAsAnimated(const AnimatedPropertyID &property_id)
{
  animated_objects_set.add(property_id.data);
  animated_properties_set.add(property_id);
}
 
void AnimatedPropertyStorage::tagPropertyAsAnimated(const PointerRNA *pointer_rna,
                                                    const PropertyRNA *property_rna)
{
  tagPropertyAsAnimated(AnimatedPropertyID(pointer_rna, property_rna));
}
 
bool AnimatedPropertyStorage::isPropertyAnimated(const AnimatedPropertyID &property_id)
{
  return animated_properties_set.contains(property_id);
}
 
bool AnimatedPropertyStorage::isPropertyAnimated(const PointerRNA *pointer_rna,
                                                 const PropertyRNA *property_rna)
{
  return isPropertyAnimated(AnimatedPropertyID(pointer_rna, property_rna));
}
 
bool AnimatedPropertyStorage::isAnyPropertyAnimated(const PointerRNA *pointer_rna)
{
  return animated_objects_set.contains(pointer_rna->data);
}
 
/* Builder cache itself. */
 
DepsgraphBuilderCache::~DepsgraphBuilderCache()
{
  for (AnimatedPropertyStorage *animated_property_storage :
       animated_property_storage_map_.values())
  {
    delete animated_property_storage;
  }
}
 
AnimatedPropertyStorage *DepsgraphBuilderCache::ensureAnimatedPropertyStorage(const ID *id)
{
  return animated_property_storage_map_.lookup_or_add_cb(
      id, []() { return new AnimatedPropertyStorage(); });
}
 
AnimatedPropertyStorage *DepsgraphBuilderCache::ensureInitializedAnimatedPropertyStorage(
    const ID *id)
{
  AnimatedPropertyStorage *animated_property_storage = ensureAnimatedPropertyStorage(id);
  if (!animated_property_storage->is_fully_initialized) {
    animated_property_storage->initializeFromID(this, id);
    animated_property_storage->is_fully_initialized = true;
  }
  return animated_property_storage;
}
 
}  // namespace blender::deg