Cesium for Unreal 2.24.1
Loading...
Searching...
No Matches
UCesiumFeaturesMetadataComponent Class Reference

A component that can be added to Cesium3DTileset actors to dictate what feature ID sets or metadata to encode for access on the GPU. More...

#include <CesiumFeaturesMetadataComponent.h>

Inheritance diagram for UCesiumFeaturesMetadataComponent:

Public Member Functions

PRAGMA_ENABLE_DEPRECATION_WARNINGS 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.
 
virtual void PostLoad () override
 

Public Attributes

FCesiumFeaturesMetadataDescription Description
 Description of both feature IDs and metadata from a glTF via the EXT_mesh_features, EXT_instance_features, and EXT_structural_metadata extensions.
 
PRAGMA_DISABLE_DEPRECATION_WARNINGS TArray< FCesiumFeatureIdSetDescriptionFeatureIdSets
 Description of the feature ID sets in the visible glTF primitives across the tileset.
 
TSet< FString > PropertyTextureNames
 Names of the property textures used by the glTF primitives across the tileset.
 
TArray< FCesiumPropertyTableDescriptionPropertyTables
 Descriptions of the property tables in the visible glTF models across the tileset.
 
TArray< FCesiumPropertyTextureDescriptionPropertyTextures
 Descriptions of property textures in the visible glTF models across the tileset.
 

Protected Member Functions

virtual void OnRegister () override
 

Detailed Description

A component that can be added to Cesium3DTileset actors to dictate what feature ID sets or metadata to encode for access on the GPU.

"Add Properties" allows users to find and select desired feature ID sets and metadata properties. Once a selection is made, "Generate Material" can be used to auto-generated the boiler-plate code to access the selected properties in the Unreal material.

Definition at line 23 of file CesiumFeaturesMetadataComponent.h.

Member Function Documentation

◆ InterruptSync()

void UCesiumFeaturesMetadataComponent::InterruptSync ( )

Interrupts any sync happening on this component.

Usually called before destroying or refreshing a tileset.

◆ IsSyncing()

bool UCesiumFeaturesMetadataComponent::IsSyncing ( ) const

Whether a sync is already in progress.

◆ OnRegister()

virtual void UCesiumFeaturesMetadataComponent::OnRegister ( )
overrideprotectedvirtual

◆ PostLoad()

virtual void UCesiumFeaturesMetadataComponent::PostLoad ( )
overridevirtual

◆ SyncStatistics()

PRAGMA_ENABLE_DEPRECATION_WARNINGS void UCesiumFeaturesMetadataComponent::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.

Member Data Documentation

◆ Description

FCesiumFeaturesMetadataDescription UCesiumFeaturesMetadataComponent::Description

Description of both feature IDs and metadata from a glTF via the EXT_mesh_features, EXT_instance_features, and EXT_structural_metadata extensions.

Indicates what parts of the extension should be uploaded to the GPU for access in Unreal materials.

Definition at line 78 of file CesiumFeaturesMetadataComponent.h.

◆ FeatureIdSets

PRAGMA_DISABLE_DEPRECATION_WARNINGS TArray<FCesiumFeatureIdSetDescription> UCesiumFeaturesMetadataComponent::FeatureIdSets

Description of the feature ID sets in the visible glTF primitives across the tileset.

Definition at line 95 of file CesiumFeaturesMetadataComponent.h.

◆ PropertyTables

TArray<FCesiumPropertyTableDescription> UCesiumFeaturesMetadataComponent::PropertyTables

Descriptions of the property tables in the visible glTF models across the tileset.

Definition at line 122 of file CesiumFeaturesMetadataComponent.h.

◆ PropertyTextureNames

TSet<FString> UCesiumFeaturesMetadataComponent::PropertyTextureNames

Names of the property textures used by the glTF primitives across the tileset.

This should be a subset of the property textures listed in the model metadata. Property textures can be passed to the material even if they are not explicitly used by a glTF primitive, but the primitive may lack the corresponding sets of texture coordinates intended to sample them.

Definition at line 111 of file CesiumFeaturesMetadataComponent.h.

◆ PropertyTextures

TArray<FCesiumPropertyTextureDescription> UCesiumFeaturesMetadataComponent::PropertyTextures

Descriptions of property textures in the visible glTF models across the tileset.

Definition at line 133 of file CesiumFeaturesMetadataComponent.h.


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