Files
test/source/blender/depsgraph/intern/node/deg_node_id.h
Sergey Sharybin 0dcee6a386 Fix T99733: Objects with driven visibility are evaluated when not needed
The issue was caused by the fact that objects with driven or animated
visibility were considered visible by the dependency graph evaluation.

This change makes it so the dependency graph evaluation is aware of
visibility which might be changing. This is achieved by evaluating the
path of the graph which affects objects visibility and adjusts to it
before evaluating the rest of the graph.

There is some time penalty to this, but there does not seem to be a
way to fully avoid this penalty.

With the production shot from the heist project the FPS drops by a
tenth of a frame (~9.4 vs ~9.3 fps) when adding a driver to an object
which keeps it visible. Note that this is a bit hard to measure since
the FPS fluctuates quite a bit throughout the playback. On the other
hand, having a driver on a visibility of a heavy object from character
and setting visibility to false gives big speedup.

Also worth noting that there is no penalty at all when there are no
animated visibilities in the scene.

Differential Revision: https://developer.blender.org/D15498
2022-07-21 09:49:16 +02:00

133 lines
4.3 KiB
C++

/* SPDX-License-Identifier: GPL-2.0-or-later
* Copyright 2013 Blender Foundation. All rights reserved. */
/** \file
* \ingroup depsgraph
*/
#pragma once
#include "BLI_ghash.h"
#include "BLI_sys_types.h"
#include "DNA_ID.h"
#include "intern/node/deg_node.h"
namespace blender::deg {
struct ComponentNode;
typedef uint64_t IDComponentsMask;
/* NOTE: We use max comparison to mark an id node that is linked more than once
* So keep this enum ordered accordingly. */
enum eDepsNode_LinkedState_Type {
/* Generic indirectly linked id node. */
DEG_ID_LINKED_INDIRECTLY = 0,
/* Id node present in the set (background) only. */
DEG_ID_LINKED_VIA_SET = 1,
/* Id node directly linked via the SceneLayer. */
DEG_ID_LINKED_DIRECTLY = 2,
};
const char *linkedStateAsString(eDepsNode_LinkedState_Type linked_state);
/* ID-Block Reference */
struct IDNode : public Node {
struct ComponentIDKey {
ComponentIDKey(NodeType type, const char *name = "");
uint64_t hash() const;
bool operator==(const ComponentIDKey &other) const;
NodeType type;
const char *name;
};
/** Initialize 'id' node - from pointer data given. */
virtual void init(const ID *id, const char *subdata) override;
void init_copy_on_write(ID *id_cow_hint = nullptr);
~IDNode();
void destroy();
virtual string identifier() const override;
ComponentNode *find_component(NodeType type, const char *name = "") const;
ComponentNode *add_component(NodeType type, const char *name = "");
virtual void tag_update(Depsgraph *graph, eUpdateSource source) override;
void finalize_build(Depsgraph *graph);
IDComponentsMask get_visible_components_mask() const;
/* Type of the ID stored separately, so it's possible to perform check whether CoW is needed
* without de-referencing the id_cow (which is not safe when ID is NOT covered by CoW and has
* been deleted from the main database.) */
ID_Type id_type;
/* ID Block referenced. */
ID *id_orig;
/* Session-wide UUID of the id_orig.
* Is used on relations update to map evaluated state from old nodes to the new ones, without
* relying on pointers (which are not guaranteed to be unique) and without dereferencing id_orig
* which could be "stale" pointer. */
uint id_orig_session_uuid;
/* Evaluated data-block.
* Will be covered by the copy-on-write system if the ID Type needs it. */
ID *id_cow;
/* Hash to make it faster to look up components. */
Map<ComponentIDKey, ComponentNode *> components;
/* Additional flags needed for scene evaluation.
* TODO(sergey): Only needed for until really granular updates
* of all the entities. */
uint32_t eval_flags;
uint32_t previous_eval_flags;
/* Extra customdata mask which needs to be evaluated for the mesh object. */
DEGCustomDataMeshMasks customdata_masks;
DEGCustomDataMeshMasks previous_customdata_masks;
eDepsNode_LinkedState_Type linked_state;
/* Indicates the data-block is to be considered visible in the evaluated scene.
*
* This flag is set during dependency graph build where check for an actual visibility might not
* be available yet due to driven or animated restriction flags. So it is more of an intent or,
* in other words, plausibility of the data-block to be visible. */
bool is_visible_on_build;
/* Evaluated state of whether evaluation considered this data-block "enabled".
*
* For objects this is derived from the base restriction flags, which might be animated or
* driven. It is set to `BASE_ENABLED_<VIEWPORT, RENDER>` (depending on the graph mode) after
* the object's flags from layer were evaluated.
*
* For other data-types is currently always true. */
bool is_enabled_on_eval;
/* For the collection type of ID, denotes whether collection was fully
* recursed into. */
bool is_collection_fully_expanded;
/* Is used to figure out whether object came to the dependency graph via a base. */
bool has_base;
/* Accumulated flag from operation. Is initialized and used during updates flush. */
bool is_user_modified;
/* Copy-on-Write component has been explicitly tagged for update. */
bool is_cow_explicitly_tagged;
/* Accumulate recalc flags from multiple update passes. */
int id_cow_recalc_backup;
IDComponentsMask visible_components_mask;
IDComponentsMask previously_visible_components_mask;
DEG_DEPSNODE_DECLARE;
};
} // namespace blender::deg