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

UObject *	GetStyleInstance () const
	Gets the instance of BlueprintStyleClass that has been created to style features in this tileset.

Public Member Functions inherited from UCesiumMetadataComponent
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.

Public Attributes
TSubclassOf< UObject >	BlueprintStyleClass
	The Blueprint class to instantiate for feature styling.

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< FCesiumFeatureIdSetDescription >	FeatureIdSets
	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< FCesiumPropertyTableDescription >	PropertyTables
	Descriptions of the property tables in the visible glTF models across the tileset.

TArray< FCesiumPropertyTextureDescription >	PropertyTextures
	Descriptions of property textures in the visible glTF models across the tileset.

Protected Member Functions
virtual void	OnFetchMetadata (ACesium3DTileset pActor, const Cesium3DTilesSelection::TilesetMetadata pMetadata) override
	Event that occurs once metadata is successfully synced from the tileset during SyncStatistics.

virtual void	ClearStatistics () override
	Called during various parts of the sync process.

Protected Member Functions inherited from UCesiumMetadataComponent
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 24 of file CesiumFeaturesMetadataComponent.h.

Member Function Documentation

◆ ClearStatistics()

virtual void UCesiumFeaturesMetadataComponent::ClearStatistics ( )

overrideprotectedvirtual

Called during various parts of the sync process.

Derived classes must override this.

Reimplemented from UCesiumMetadataComponent.

◆ GetStyleInstance()

UObject * UCesiumFeaturesMetadataComponent::GetStyleInstance ( ) const

inline

Gets the instance of BlueprintStyleClass that has been created to style features in this tileset.

If no BlueprintStyleClass was specified, this will be null.

This function may be used to modify variables on the instance of the style at runtime.

Definition at line 168 of file CesiumFeaturesMetadataComponent.h.

◆ OnFetchMetadata()

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

overrideprotectedvirtual

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 from UCesiumMetadataComponent.

◆ PostLoad()

virtual PRAGMA_ENABLE_DEPRECATION_WARNINGS void UCesiumFeaturesMetadataComponent::PostLoad ( )

overridevirtual

Member Data Documentation

◆ BlueprintStyleClass

TSubclassOf<UObject> UCesiumFeaturesMetadataComponent::BlueprintStyleClass

The Blueprint class to instantiate for feature styling.

This is used for any feature ID sets with StylingMode set to Blueprint.

Definition at line 77 of file CesiumFeaturesMetadataComponent.h.

◆ 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 92 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 109 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 136 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 125 of file CesiumFeaturesMetadataComponent.h.

◆ PropertyTextures

TArray<FCesiumPropertyTextureDescription> UCesiumFeaturesMetadataComponent::PropertyTextures

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

Definition at line 147 of file CesiumFeaturesMetadataComponent.h.

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

Source/CesiumRuntime/Public/CesiumFeaturesMetadataComponent.h

Public Member Functions

Public Attributes

Protected Member Functions