From abe1a061f8aab5c9357ff92fd6b579a8a9553f0d Mon Sep 17 00:00:00 2001 From: Campbell Barton Date: Sat, 13 Mar 2021 03:12:24 +1100 Subject: Docs: add doc-string for TransDataContainer --- source/blender/editors/transform/transform.h | 14 ++++++++++++++ 1 file changed, 14 insertions(+) diff --git a/source/blender/editors/transform/transform.h b/source/blender/editors/transform/transform.h index 24335b6b6b7..4b43592165b 100644 --- a/source/blender/editors/transform/transform.h +++ b/source/blender/editors/transform/transform.h @@ -429,6 +429,20 @@ typedef struct TransCustomDataContainer { } TransCustomDataContainer; #define TRANS_CUSTOM_DATA_ELEM_MAX (sizeof(TransCustomDataContainer) / sizeof(TransCustomData)) +/** + * Container for Transform Data + * + * Used to implement multi-object modes, so each object can have it's + * own data array as well as object matrix, local center etc. + * + * Anything that can't be shared between all objects + * and doesn't make sense to store for every vertex (in the #TransDataContainer.data). + * + * \note at some point this could be used to store non object containers + * although this only makes sense if each container has it's own matrices, + * otherwise all elements may as well be stored in one array (#TransDataContainer.data), + * as is already done for curve-objects, f-curves. etc. + */ typedef struct TransDataContainer { /** Transformed data (array). */ TransData *data; -- cgit v1.2.3