Cesium for Unreal 2.24.1
Loading...
Searching...
No Matches
Public Member Functions | Protected Member Functions | List of all members
UCesiumMetadataComponent Class Reference

A base component interface for interacting with metadata in a Cesium3DTileset. More...

#include <CesiumMetadataComponent.h>

Inheritance diagram for UCesiumMetadataComponent:
UCesiumFeaturesMetadataComponent

Public Member Functions

void SyncStatistics ()
 Syncs this component's statistics description from its tileset owner, retrieving values for the corresponding semantics.
 
bool IsSyncing () const
 Whether a sync is already in progress.
 
void InterruptSync ()
 Interrupts any sync happening on this component.
 

Protected Member Functions

virtual void OnFetchMetadata (ACesium3DTileset *pActor, const Cesium3DTilesSelection::TilesetMetadata *pMetadata)
 Event that occurs once metadata is successfully synced from the tileset during SyncStatistics.
 
virtual void ClearStatistics ()
 Called during various parts of the sync process.
 
virtual void OnRegister () override
 

Detailed Description

A base component interface for interacting with metadata in a Cesium3DTileset.

Definition at line 20 of file CesiumMetadataComponent.h.

Member Function Documentation

◆ ClearStatistics()

virtual void UCesiumMetadataComponent::ClearStatistics ( )
protectedvirtual

Called during various parts of the sync process.

Derived classes must override this.

Reimplemented in UCesiumFeaturesMetadataComponent.

◆ InterruptSync()

void UCesiumMetadataComponent::InterruptSync ( )

Interrupts any sync happening on this component.

Usually called before destroying or refreshing a tileset.

◆ IsSyncing()

bool UCesiumMetadataComponent::IsSyncing ( ) const

Whether a sync is already in progress.

◆ OnFetchMetadata()

virtual void UCesiumMetadataComponent::OnFetchMetadata ( ACesium3DTileset * pActor,
const Cesium3DTilesSelection::TilesetMetadata * pMetadata )
protectedvirtual

Event that occurs once metadata is successfully synced from the tileset during SyncStatistics.

Derived classes must override this to make use of the results.

Reimplemented in UCesiumFeaturesMetadataComponent.

◆ OnRegister()

virtual void UCesiumMetadataComponent::OnRegister ( )
overrideprotectedvirtual

◆ SyncStatistics()

void UCesiumMetadataComponent::SyncStatistics ( )

Syncs this component's statistics description from its tileset owner, retrieving values for the corresponding semantics.

If there are described statistics that are not present on the tileset owner, they will be left as null values.

The documentation for this class was generated from the following file: