From fb5a1bc7edffe3b086e58fd77ecd4b5bbd0d7c07 Mon Sep 17 00:00:00 2001
From: Philip Trettner <Philip.Trettner@rwth-aachen.de>
Date: Fri, 2 Oct 2020 15:17:10 +0200
Subject: [PATCH] add a comment for views
---
src/polymesh/view.hh | 13 +++++++++++++
1 file changed, 13 insertions(+)
diff --git a/src/polymesh/view.hh b/src/polymesh/view.hh
index f0a7065..167a157 100644
--- a/src/polymesh/view.hh
+++ b/src/polymesh/view.hh
@@ -5,6 +5,19 @@
namespace polymesh
{
+/**
+ * Builds a non-owning view on an attribute
+ * Does preserve references where possible
+ *
+ * Usage:
+ *
+ * pm::Mesh m;
+ * auto pos = m.vertices().make_attribute<tg::pos3>();
+ *
+ * // does NOT allocate memory, is only a view on pos
+ * auto z_view = pos.view([](tg::pos3& p) -> float& { return p.z; });
+ * z_view[v] = 8; // writes through to pos
+ */
template <class CollectionT, class FuncT>
struct attribute_view
{
--
GitLab