Depsgraph: Added note that the filtering function should NOT be called on a filtered graph

This commit is contained in:
Joshua Leung 2018-08-23 16:55:07 +12:00
parent 3fa4e52657
commit 0e09bfa059
2 changed files with 8 additions and 2 deletions

View File

@ -233,7 +233,10 @@ typedef struct DEG_FilterQuery {
eDEG_FilterQuery_Granularity detail_level;
} DEG_FilterQuery;
/* Obtain a new graph instance that only contains the subset of desired nodes */
/* Obtain a new graph instance that only contains the subset of desired nodes
* WARNING: Do NOT pass an already filtered depsgraph through this function again,
* as we are currently unable to accurately recreate it.
*/
Depsgraph *DEG_graph_filter(const Depsgraph *depsgraph, struct Main *bmain, DEG_FilterQuery *query);

View File

@ -185,7 +185,10 @@ void deg_filter_remove_unwanted_ids(Depsgraph *graph, GSet *retained_ids)
/* *************************************************** */
/* Graph Filtering API */
/* Obtain a new graph instance that only contains the nodes needed */
/* Obtain a new graph instance that only contains the subset of desired nodes
* WARNING: Do NOT pass an already filtered depsgraph through this function again,
* as we are currently unable to accurately recreate it.
*/
Depsgraph *DEG_graph_filter(const Depsgraph *graph_src, Main *bmain, DEG_FilterQuery *query)
{
const DEG::Depsgraph *deg_graph_src = reinterpret_cast<const DEG::Depsgraph *>(graph_src);