Skip to content

Commit

Permalink
Doc tweaks from review.
Browse files Browse the repository at this point in the history
  • Loading branch information
kring committed Aug 22, 2024
1 parent 40ce73f commit 0b8f284
Showing 1 changed file with 13 additions and 14 deletions.
27 changes: 13 additions & 14 deletions Source/CesiumRuntime/Public/CesiumRasterOverlay.h
Original file line number Diff line number Diff line change
Expand Up @@ -138,14 +138,13 @@ class CESIUMRUNTIME_API UCesiumRasterOverlay : public UActorComponent {
void SetSubTileCacheBytes(int64 Value);

/**
* Activates this raster overlay, which will add it to (that is: display it
* on) the Cesium3DTileset to which the component is attached, if it hasn't
* already been added. The overlay will continue to be shown on the tileset
* until it is deactivated.
* Activates this raster overlay, which will display it on the Cesium3DTileset
* to which the component is attached, if it isn't already displayed. The
* overlay will continue to be shown on the tileset until it is deactivated.
*
* If the overlay is already displayed on the Cesium3DTileset, calling this
* function will not cause it to pick up any new values for properties that
* have been modified since it as added. To do that, call Refresh.
* have been modified since it was added. To do that, call Refresh.
*
* If you created this overlay component via Blueprints, consider setting the
* "Auto Activate" property to false on the "Add Component" node and call
Expand All @@ -158,9 +157,9 @@ class CESIUMRUNTIME_API UCesiumRasterOverlay : public UActorComponent {
virtual void Activate(bool bReset) override;

/**
* Deactivates this raster overlay. This will remove it from (that is: stop
* displaying it on) the Cesium3DTileset to which the component is attached.
* The overlay will not be shown again until the component is re-activated.
* Deactivates this raster overlay. This will stop displaying it on the
* Cesium3DTileset to which the component is attached. The overlay will not be
* shown again until the component is re-activated.
*/
virtual void Deactivate() override;

Expand Down Expand Up @@ -215,12 +214,12 @@ class CESIUMRUNTIME_API UCesiumRasterOverlay : public UActorComponent {
/**
* The maximum number of bytes to use to cache sub-tiles in memory.
*
* This is used by provider types, that have an underlying tiling
* scheme that may not align with the tiling scheme of the geometry tiles on
* which the raster overlay tiles are draped. Because a single sub-tile may
* overlap multiple geometry tiles, it is useful to cache loaded sub-tiles
* in memory in case they're needed again soon. This property controls the
* maximum size of that cache.
* This is used by provider types that have an underlying tiling scheme that
* may not align with the tiling scheme of the geometry tiles on which the
* raster overlay tiles are draped. Because a single sub-tile may overlap
* multiple geometry tiles, it is useful to cache loaded sub-tiles in memory
* in case they're needed again soon. This property controls the maximum size
* of that cache.
*/
UPROPERTY(
EditAnywhere,
Expand Down

0 comments on commit 0b8f284

Please sign in to comment.