Browse Source

SceneTools: mark everything here as experiental.

To make people not rely too much on anything here -- I smell some API
changes incoming.
sceneconverter
Vladimír Vondruš 4 years ago
parent
commit
96360aff25
  1. 10
      src/Magnum/SceneTools/FlattenMeshHierarchy.h
  2. 6
      src/Magnum/SceneTools/OrderClusterParents.h

10
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 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 field and @f$ n @f$ being @ref Trade::SceneData::mappingBound(). The function
calls @ref orderClusterParents() internally. calls @ref orderClusterParents() internally.
@experimental
@see @ref Trade::SceneData::hasField(), @ref Trade::SceneData::is2D(), @see @ref Trade::SceneData::hasField(), @ref Trade::SceneData::is2D(),
@ref MeshTools::concatenate() @ref MeshTools::concatenate()
*/ */
@ -64,6 +67,8 @@ MAGNUM_SCENETOOLS_EXPORT Containers::Array<Containers::Triple<UnsignedInt, Int,
@m_since_latest @m_since_latest
Same as above with @p globalTransformation set to an identity matrix. Same as above with @p globalTransformation set to an identity matrix.
@experimental
*/ */
MAGNUM_SCENETOOLS_EXPORT Containers::Array<Containers::Triple<UnsignedInt, Int, Matrix3>> flattenMeshHierarchy2D(const Trade::SceneData& scene); MAGNUM_SCENETOOLS_EXPORT Containers::Array<Containers::Triple<UnsignedInt, Int, Matrix3>> 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 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 field and @f$ n @f$ being @ref Trade::SceneData::mappingBound(). The function
calls @ref orderClusterParents() internally. calls @ref orderClusterParents() internally.
@experimental
@see @ref Trade::SceneData::hasField(), @ref Trade::SceneData::is3D(), @see @ref Trade::SceneData::hasField(), @ref Trade::SceneData::is3D(),
@ref MeshTools::concatenate() @ref MeshTools::concatenate()
*/ */
@ -95,6 +103,8 @@ MAGNUM_SCENETOOLS_EXPORT Containers::Array<Containers::Triple<UnsignedInt, Int,
@m_since_latest @m_since_latest
Same as above with @p globalTransformation set to an identity matrix. Same as above with @p globalTransformation set to an identity matrix.
@experimental
*/ */
MAGNUM_SCENETOOLS_EXPORT Containers::Array<Containers::Triple<UnsignedInt, Int, Matrix4>> flattenMeshHierarchy3D(const Trade::SceneData& scene); MAGNUM_SCENETOOLS_EXPORT Containers::Array<Containers::Triple<UnsignedInt, Int, Matrix4>> flattenMeshHierarchy3D(const Trade::SceneData& scene);

6
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, @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 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). (i.e., every node listed in the field reachable from the root).
@experimental
@see @ref Trade::SceneData::hasField() @see @ref Trade::SceneData::hasField()
*/ */
MAGNUM_SCENETOOLS_EXPORT Containers::Array<Containers::Pair<UnsignedInt, Int>> orderClusterParents(const Trade::SceneData& scene); MAGNUM_SCENETOOLS_EXPORT Containers::Array<Containers::Pair<UnsignedInt, Int>> 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 @p mappingDestination and @p parentDestination instead of allocating a new
array. Expect that both views have a size equal to size of the array. Expect that both views have a size equal to size of the
@ref Trade::SceneField::Parent view in @p scene. @ref Trade::SceneField::Parent view in @p scene.
@experimental
@see @ref Trade::SceneData::fieldSize(SceneField) const @see @ref Trade::SceneData::fieldSize(SceneField) const
*/ */
MAGNUM_SCENETOOLS_EXPORT void orderClusterParentsInto(const Trade::SceneData& scene, const Containers::StridedArrayView1D<UnsignedInt>& mappingDestination, const Containers::StridedArrayView1D<Int>& parentDestination); MAGNUM_SCENETOOLS_EXPORT void orderClusterParentsInto(const Trade::SceneData& scene, const Containers::StridedArrayView1D<UnsignedInt>& mappingDestination, const Containers::StridedArrayView1D<Int>& parentDestination);

Loading…
Cancel
Save