Commit: 69c048d723eb5939d9cfef6b4ba52f39e2a72e04
Author: Campbell Barton
Date: Fri May 1 05:20:13 2015 +1000
Branches: depsgraph_refactor
https://developer.blender.org/rB69c048d723eb5939d9cfef6b4ba52f39e2a72e04
Cleanup: replace ad-hoc formatting /w doxygen
===================================================================
M source/blender/depsgraph/intern/depsgraph.h
M source/blender/depsgraph/intern/depsgraph_build_idusers.cpp
M source/blender/depsgraph/intern/depsgraph_build_nodes.cpp
M source/blender/depsgraph/intern/depsgraph_build_relations.cpp
M source/blender/depsgraph/intern/depsgraph_eval.cpp
M source/blender/depsgraph/intern/depsgraph_intern.h
M source/blender/depsgraph/intern/depsgraph_queue.cpp
M source/blender/depsgraph/intern/depsgraph_type_defines.cpp
M source/blender/depsgraph/intern/depsnode_component.h
===================================================================
diff --git a/source/blender/depsgraph/intern/depsgraph.h
b/source/blender/depsgraph/intern/depsgraph.h
index 200524e..8ce7362 100644
--- a/source/blender/depsgraph/intern/depsgraph.h
+++ b/source/blender/depsgraph/intern/depsgraph.h
@@ -98,27 +98,30 @@ struct Depsgraph {
Depsgraph();
~Depsgraph();
- /* Find node which matches the specified description.
+ /**
+ * Find node which matches the specified description.
*
- * < id: ID block that is associated with this
- * < (subdata): identifier used for sub-ID data (e.g. bone)
- * < type: type of node we're dealing with
- * < (name): custom identifier assigned to node
+ * \param id: ID block that is associated with this
+ * \param subdata: identifier used for sub-ID data (e.g. bone)
+ * \param type: type of node we're dealing with
+ * \param name: custom identifier assigned to node
*
- * > returns: A node matching the required characteristics if it exists
- * OR NULL if no such node exists in the graph
+ * \return A node matching the required characteristics if it exists
+ * or NULL if no such node exists in the graph.
*/
DepsNode *find_node(const ID *id,
eDepsNode_Type type,
const string &subdata,
const string &name);
- /* Convenience wrapper to find node given just pointer + property.
- * < ptr: pointer to the data that node will represent
- * < (prop): optional property affected - providing this effectively
results in inner nodes being returned
+ /**
+ * Convenience wrapper to find node given just pointer + property.
*
- * > returns: A node matching the required characteristics if it exists
- * OR NULL if no such node exists in the graph
+ * \param ptr: pointer to the data that node will represent
+ * \param prop: optional property affected - providing this effectively
results in inner nodes being returned
+ *
+ * \return A node matching the required characteristics if it exists
+ * or NULL if no such node exists in the graph
*/
DepsNode *find_node_from_pointer(const PointerRNA *ptr, const
PropertyRNA *prop) const;
@@ -191,26 +194,27 @@ struct Depsgraph {
// XXX: additional stuff like eval contexts, mempools for allocating
nodes from, etc.
};
-/* Helper macros for interating over set of relationship links
+/**
+ * Helper macros for interating over set of relationship links
* incident on each node.
*
- * NOTE: it is safe to perform removal operations here...
+ * \note it is safe to perform removal operations here...
*
- * < relations_set: (DepsNode::Relations) set of relationships (in/out links)
- * > relation: (DepsRelation *) identifier where DepsRelation that we're
+ * relations_set[in]: (DepsNode::Relations) set of relationships (in/out links)
+ * relation[out]: (DepsRelation *) identifier where DepsRelation that we're
* currently accessing comes up
*/
-#define DEPSNODE_RELATIONS_ITER_BEGIN(relations_set_, relation_)
\
- {
\
+#define DEPSNODE_RELATIONS_ITER_BEGIN(relations_set_, relation_) \
+ { \
OperationDepsNode::Relations::const_iterator __rel_iter =
relations_set_.begin(); \
- while (__rel_iter != relations_set_.end()) {
\
- DepsRelation *relation_ = *__rel_iter;
\
- ++__rel_iter;
+ while (__rel_iter != relations_set_.end()) { \
+ DepsRelation *relation_ = *__rel_iter; \
+ ++__rel_iter; \
/* ... code for iterator body can be written here ... */
-#define DEPSNODE_RELATIONS_ITER_END
\
- }
\
- }
+#define DEPSNODE_RELATIONS_ITER_END \
+ } \
+ } ((void)0)
#endif /* __DEPSGRAPH_H__ */
diff --git a/source/blender/depsgraph/intern/depsgraph_build_idusers.cpp
b/source/blender/depsgraph/intern/depsgraph_build_idusers.cpp
index 31c0ffd..b8f3c7e 100644
--- a/source/blender/depsgraph/intern/depsgraph_build_idusers.cpp
+++ b/source/blender/depsgraph/intern/depsgraph_build_idusers.cpp
@@ -97,14 +97,15 @@ extern "C" {
#include "depsgraph_intern.h"
/* ******************************************** */
-/* ID User Builder
+/**
+ * ID User Builder
*
* This builder creates links between ID datablocks to
* say that datablock B "uses" datablock A.
*
- * NOTE: This ordering is the *opposite* of the way
- * we typically think of hierarchical relationships.
- * For example, "ob.data" becomes "obdata -> object"
+ * \note This ordering is the *opposite* of the way
+ * we typically think of hierarchical relationships.
+ * For example, "ob.data" becomes "obdata -> object"
*/
DepsgraphIDUsersBuilder::DepsgraphIDUsersBuilder(Depsgraph *graph) :
diff --git a/source/blender/depsgraph/intern/depsgraph_build_nodes.cpp
b/source/blender/depsgraph/intern/depsgraph_build_nodes.cpp
index 0d21f01..8cf197b 100644
--- a/source/blender/depsgraph/intern/depsgraph_build_nodes.cpp
+++ b/source/blender/depsgraph/intern/depsgraph_build_nodes.cpp
@@ -26,6 +26,7 @@
* Methods for constructing depsgraph's nodes
*/
+
#include <stdio.h>
#include <stdlib.h>
#include <string.h>
@@ -490,7 +491,9 @@ void DepsgraphNodeBuilder::build_object_transform(Scene
*scene, Object *ob)
DEG_OPCODE_TRANSFORM_FINAL);
}
-/* == Constraints Graph Notes ==
+/**
+ * Constraints Graph Notes
+ *
* For constraints, we currently only add a operation node to the Transform
* or Bone components (depending on whichever type of owner we have).
* This represents the entire constraints stack, which is for now just
@@ -521,9 +524,10 @@ void DepsgraphNodeBuilder::build_pose_constraints(Object
*ob, bPoseChannel *pcha
DEG_OPCODE_BONE_CONSTRAINTS);
}
-/* Build graph nodes for AnimData block
- * < scene_node: Scene that ID-block this lives on belongs to
- * < id: ID-Block which hosts the AnimData
+/**
+ * Build graph nodes for AnimData block
+ * \param scene_node: Scene that ID-block this lives on belongs to
+ * \param id: ID-Block which hosts the AnimData
*/
void DepsgraphNodeBuilder::build_animdata(ID *id)
{
@@ -555,9 +559,10 @@ void DepsgraphNodeBuilder::build_animdata(ID *id)
}
}
-/* Build graph node(s) for Driver
- * < id: ID-Block that driver is attached to
- * < fcu: Driver-FCurve
+/**
+ * Build graph node(s) for Driver
+ * \param id: ID-Block that driver is attached to
+ * \param fcu: Driver-FCurve
*/
OperationDepsNode *DepsgraphNodeBuilder::build_driver(ID *id, FCurve *fcu)
{
@@ -617,7 +622,10 @@ void DepsgraphNodeBuilder::build_rigidbody(Scene *scene)
{
RigidBodyWorld *rbw = scene->rigidbody_world;
- /* == Rigidbody Simulation Nodes ==
+ /**
+ * Rigidbody Simulation Nodes
+ * ==========================
+ *
* There are 3 nodes related to Rigidbody Simulation:
* 1) "Initialize/Rebuild World" - this is called sparingly, only when
the simulation
* needs to be rebuilt (mainly after file reload, or moving back to
start frame)
@@ -669,7 +677,10 @@ void DepsgraphNodeBuilder::build_rigidbody(Scene *scene)
void DepsgraphNodeBuilder::build_particles(Object *ob)
{
- /* == Particle Systems Nodes ==
+ /**
+ * Particle Systems Nodes
+ * ======================
+ *
* There are two types of nodes associated with representing
* particle systems:
* 1) Component (EVAL_PARTICLES) - This is the particle-system
@@ -765,7 +776,10 @@ void DepsgraphNodeBuilder::build_rig(Scene *scene, Object
*ob)
}
}
- /* == Pose Rig Graph ==
+ /**
+ * Pose Rig Graph
+ * ==============
+ *
* Pose Component:
* - Mainly used for referencing Bone components.
* - This is where the evaluation operations for init/exec/cleanup
@@ -815,7 +829,9 @@ void DepsgraphNodeBuilder::build_rig(Scene *scene, Object
*ob)
build_pose_constraints(ob, pchan);
}
- /* IK Solvers...
+ /**
+ * IK Solvers...
+ *
* - These require separate processing steps are pose-level
* to be executed between chains of bones (i.e. once the
* base transforms of a bunch of bones is done)
diff --git a/source/blender/depsgraph/intern/depsgraph_build_relations.cpp
b/source/blender/depsgraph/intern/depsgraph_build_relations.cpp
index edbb346..cafb6c8 100644
--- a/source/blender/depsgraph/intern/depsgraph_build_relations.cpp
+++ b/source/blender/depsgraph/intern/depsgraph_build_relations.cpp
@@ -1471,8 +1471,10 @@ void DepsgraphRelationBuilder::build_shapekeys(ID
*obdata, Key *key)
//add_relation(key_key, obdata_key, DEPSREL_TYPE_GEOMETRY_EVAL,
"Shapekeys");
}
-/* ObData Geometry Evaluation
+/**
+ * ObData Geometry Evaluation
* ==========================
+ *
* The evaluation of geometry on objects is as follows:
* - The actual evaluated of the derived geometry (e.g. DerivedMesh, DispList,
etc.)
* occurs in the Geometry component of the object which references this.
This includes
diff --git a/source/blender/depsgraph/intern/depsgraph_eval.cpp
b/source/blender/depsgraph/intern/depsgraph_eval.cpp
index b8de71a..298a5f6 100644
--- a/source/blender/depsgraph/intern/depsgraph_eval.cpp
+++ b/source/blender/depsgraph/intern/depsgraph_eval.cpp
@@ -85,7 +85,8 @@ EvaluationContext *DEG_evaluation_context_new(int mode)
return eval_ctx;
}
-/* Initialize evaluation context.
+/**
+ * Initialize evaluation context.
* Used by the areas which currently overrides the context or doesn't have
* access to a proper one.
*/
@@ -278,11 +279,12 @@ static void schedule_children(TaskPool *pool,
}
}
-/* Evaluate all nodes tagged for updating,
- * ! This is usually done as part of main loop, but may also be
- * called from frame-change update.
+/**
+ * Evaluate all nodes tagged for updating,
+ * \warning This is usually done as part of main loop, but may also be
+ * called from frame-change update.
*
- * NOTE: Time sources should be all valid!
+ * \note Time sources should be all valid!
*/
void DEG_evaluate_on_refresh_ex(EvaluationContext *eval_ctx,
Depsgraph *graph,
diff --git a/source/blender/depsgraph/intern/depsgraph_intern.h
b/source/blender/depsgraph/intern/depsgraph_intern.h
index 55ea70b..bd
@@ Diff output truncated at 10240 characters. @@
_______________________________________________
Bf-blender-cvs mailing list
[email protected]
http://lists.blender.org/mailman/listinfo/bf-blender-cvs
