From 0fcc44bff83b78c1af80d5c70b26bf8f44054e1c Mon Sep 17 00:00:00 2001 From: Nick Fisher Date: Wed, 23 Oct 2024 15:48:34 +0800 Subject: [PATCH] doc: update docstrings for setLayerVisibilty and setVisibilityLayer --- .../src/viewer/src/thermion_viewer_base.dart | 17 +++++++++++++---- 1 file changed, 13 insertions(+), 4 deletions(-) diff --git a/thermion_dart/lib/src/viewer/src/thermion_viewer_base.dart b/thermion_dart/lib/src/viewer/src/thermion_viewer_base.dart index 47c70c3f..931edec2 100644 --- a/thermion_dart/lib/src/viewer/src/thermion_viewer_base.dart +++ b/thermion_dart/lib/src/viewer/src/thermion_viewer_base.dart @@ -796,14 +796,23 @@ abstract class ThermionViewer { Future getViewportBoundingBox(ThermionEntity entity); /// - /// Filament assigns renderables to a numeric layer. - /// We place all scene assets in layer 0 (enabled by default), gizmos in layer 1 (enabled by default), world grid in layer 2 (disabled by default). - /// Use this method to toggle visibility of the respective layer. + /// Toggles the visibility of the respective layer. /// Future setLayerVisibility(int layer, bool visible); /// - /// Assigns [entity] to visibility layer [layer]. + /// All renderable entities are assigned a layer mask. + /// + /// By calling [setLayerVisibility], all renderable entities allocated to + /// the given layer can be efficiently hidden/revealed. + /// + /// By default, all renderable entities are assigned to layer 0 (and this + /// layer is enabled by default). Call [setVisibilityLayer] to change the + /// layer for the specified entity. + /// + /// Note that we currently also assign gizmos to layer 1 (enabled by default) + /// and the world grid to layer 2 (disabled by default). We suggest you avoid + /// using these layers. /// Future setVisibilityLayer(ThermionEntity entity, int layer);