From 96360aff25a8d5a69825978d4b4556e0a209e6d0 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Vladim=C3=ADr=20Vondru=C5=A1?= Date: Tue, 17 May 2022 15:38:06 +0200 Subject: [PATCH] SceneTools: mark everything here as experiental. To make people not rely too much on anything here -- I smell some API changes incoming. --- src/Magnum/SceneTools/FlattenMeshHierarchy.h | 10 ++++++++++ src/Magnum/SceneTools/OrderClusterParents.h | 6 ++++++ 2 files changed, 16 insertions(+) diff --git a/src/Magnum/SceneTools/FlattenMeshHierarchy.h b/src/Magnum/SceneTools/FlattenMeshHierarchy.h index 6d8c4028e..9b216a56e 100644 --- a/src/Magnum/SceneTools/FlattenMeshHierarchy.h +++ b/src/Magnum/SceneTools/FlattenMeshHierarchy.h @@ -55,6 +55,9 @@ The operation is done in an @f$ \mathcal{O}(m + n) @f$ execution time and memory complexity, with @f$ m @f$ being size of the @ref Trade::SceneField::Mesh field and @f$ n @f$ being @ref Trade::SceneData::mappingBound(). The function calls @ref orderClusterParents() internally. + +@experimental + @see @ref Trade::SceneData::hasField(), @ref Trade::SceneData::is2D(), @ref MeshTools::concatenate() */ @@ -64,6 +67,8 @@ MAGNUM_SCENETOOLS_EXPORT Containers::Array> flattenMeshHierarchy2D(const Trade::SceneData& scene); @@ -86,6 +91,9 @@ The operation is done in an @f$ \mathcal{O}(m + n) @f$ execution time and memory complexity, with @f$ m @f$ being size of the @ref Trade::SceneField::Mesh field and @f$ n @f$ being @ref Trade::SceneData::mappingBound(). The function calls @ref orderClusterParents() internally. + +@experimental + @see @ref Trade::SceneData::hasField(), @ref Trade::SceneData::is3D(), @ref MeshTools::concatenate() */ @@ -95,6 +103,8 @@ MAGNUM_SCENETOOLS_EXPORT Containers::Array> flattenMeshHierarchy3D(const Trade::SceneData& scene); diff --git a/src/Magnum/SceneTools/OrderClusterParents.h b/src/Magnum/SceneTools/OrderClusterParents.h index 41c76a6d9..8780f19b0 100644 --- a/src/Magnum/SceneTools/OrderClusterParents.h +++ b/src/Magnum/SceneTools/OrderClusterParents.h @@ -56,6 +56,9 @@ complexity, with @f$ n @f$ being @ref Trade::SceneData::mappingBound(). The @ref Trade::SceneField::Parent field is expected to be contained in the scene, having no cycles (i.e., every node listed just once) and not being sparse (i.e., every node listed in the field reachable from the root). + +@experimental + @see @ref Trade::SceneData::hasField() */ MAGNUM_SCENETOOLS_EXPORT Containers::Array> orderClusterParents(const Trade::SceneData& scene); @@ -68,6 +71,9 @@ Like @ref orderClusterParents(), but puts the result into @p mappingDestination and @p parentDestination instead of allocating a new array. Expect that both views have a size equal to size of the @ref Trade::SceneField::Parent view in @p scene. + +@experimental + @see @ref Trade::SceneData::fieldSize(SceneField) const */ MAGNUM_SCENETOOLS_EXPORT void orderClusterParentsInto(const Trade::SceneData& scene, const Containers::StridedArrayView1D& mappingDestination, const Containers::StridedArrayView1D& parentDestination);