Differential D4834 Diff 15376 doc/python_api/examples/bpy.types.Depsgraph.1.py

Changeset View

Standalone View

doc/python_api/examples/bpy.types.Depsgraph.1.py

This file was added.

				"""
				Dependency graph: Evaluated ID example
				++++++++++++++++++++++++++++++++++++++

				This example demonstrates access to the evaluated ID (such as object, material, etc.) state from
				an original ID.
				This is needed every time one needs to access state with animation, constraints, and modifiers
				brechtUnsubmitted Not Done Inline Actions from original one -> from an original ID brecht: from original one -> from an original ID
				taken into account.
				"""
				brechtUnsubmitted Not Done Inline Actions Such access -> This brecht: Such access -> This
				import bpy


				class OBJECT_OT_evaluated_example(bpy.types.Operator):
				"""Access evaluated object state and do something with it"""
				bl_label = "DEG Access Evaluated Object"
				bl_idname = "object.evaluated_example"

				def execute(self, context):
				# This is an original object. Its data does not have any modifiers applied.
				object = context.object
				if object is None or object.type != 'MESH':
				self.report({'INFO'}, "No active mesh object to get info from")
				return {'CANCELLED'}
				# Evaluated object exists within a specific dependency graph.
				# We will request evaluated object from the dependency graph which corresponds to the
				# current scene and view layer.
				brechtUnsubmitted Not Done Inline Actions for -> from brecht: for -> from
				#
				brechtUnsubmitted Not Done Inline Actions amd -> and brecht: amd -> and
				# NOTE: This call ensure the dependency graph is fully evaluated. This might be expensive
				# if changes were made made to the scene, but is needed to ensure no dangling or incorrect
				# pointers are exposed.
				depsgraph = context.evaluated_depsgraph_get()
				brechtUnsubmitted Not Done Inline Actions dependency graph -> the dependency graph there are changes made -> changes were made danling -> dangling brecht: dependency graph -> the dependency graph there are changes made -> changes were made danling ->…
				# Actually request evaluated object.
				#
				# This object has animation and drivers applied on it, together with constraints and
				# modifiers.
				#
				# For mesh objects the object.data will be a mesh with all modifiers applied.
				# This means that in access to vertices or faces after modifier stack happens via fields of
				# object_eval.object.
				#
				# For other types of objects the object_eval.data does not have modifiers applied on it,
				# but has animation applied.
				#
				# NOTE: All ID types have `evaluated_get()`, including materials, node trees, worlds.
				object_eval = object.evaluated_get(depsgraph)
				brechtUnsubmitted Not Done Inline Actions has -> have brecht: has -> have
				mesh_eval = object_eval.data
				self.report({'INFO'}, f"Number of evaluated vertices: {len(mesh_eval.vertices)}")
				return {'FINISHED'}


				def register():
				bpy.utils.register_class(OBJECT_OT_evaluated_example)


				def unregister():
				bpy.utils.unregister_class(OBJECT_OT_evaluated_example)


				if __name__ == "__main__":
				register()