UCesiumFeatureIdSetBlueprintLibrary Class Reference

#include <CesiumFeatureIdSet.h>

Inheritance diagram for UCesiumFeatureIdSetBlueprintLibrary:

Static Public Member Functions
static const ECesiumFeatureIdSetType	GetFeatureIDSetType (UPARAM(ref) const FCesiumFeatureIdSet &FeatureIDSet)
	Gets the type of this feature ID set.
static const FCesiumFeatureIdAttribute &	GetAsFeatureIDAttribute (UPARAM(ref) const FCesiumFeatureIdSet &FeatureIDSet)
	Gets this feature ID set as a feature ID attribute.
static const FCesiumFeatureIdTexture &	GetAsFeatureIDTexture (UPARAM(ref) const FCesiumFeatureIdSet &FeatureIDSet)
	Gets this feature ID set as a feature ID texture.
static const int64	GetPropertyTableIndex (UPARAM(ref) const FCesiumFeatureIdSet &FeatureIDSet)
	Get the index of the property table corresponding to this feature ID set.
static int64	GetFeatureCount (UPARAM(ref) const FCesiumFeatureIdSet &FeatureIDSet)
	Get the number of features this primitive has.
static const int64	GetNullFeatureID (UPARAM(ref) const FCesiumFeatureIdSet &FeatureIDSet)
	Gets the null feature ID, i.e., the value that indicates no feature is associated with the owner.
static const FString	GetLabel (UPARAM(ref) const FCesiumFeatureIdSet &FeatureIDSet)
	Gets the label assigned to this feature ID set.
static int64	GetFeatureIDForVertex (UPARAM(ref) const FCesiumFeatureIdSet &FeatureIDSet, int64 VertexIndex)
	Gets the feature ID associated with a given vertex.
static int64	GetFeatureIDForInstance (UPARAM(ref) const FCesiumFeatureIdSet &FeatureIDSet, int64 InstanceIndex)
	Gets the feature ID associated with a given instance in glTF models using the EXT_mesh_gpu_instancing and EXT_instance_features extensions.
static int64	GetFeatureIDFromHit (UPARAM(ref) const FCesiumFeatureIdSet &FeatureIDSet, const FHitResult &Hit)
	Given a trace hit result, gets the feature ID from the feature ID set on the hit component.

Detailed Description

Definition at line 75 of file CesiumFeatureIdSet.h.

Member Function Documentation

GetAsFeatureIDAttribute()

static const FCesiumFeatureIdAttribute & UCesiumFeatureIdSetBlueprintLibrary::GetAsFeatureIDAttribute ( UPARAM(ref) const FCesiumFeatureIdSet & FeatureIDSet )

static

Gets this feature ID set as a feature ID attribute.

This can be used for more fine-grained interaction with the attribute itself. If this feature ID is not defined as an attribute, then the returned attribute will be invalid.

GetAsFeatureIDTexture()

static const FCesiumFeatureIdTexture & UCesiumFeatureIdSetBlueprintLibrary::GetAsFeatureIDTexture ( UPARAM(ref) const FCesiumFeatureIdSet & FeatureIDSet )

static

Gets this feature ID set as a feature ID texture.

This can be used for more fine-grained interaction with the texture itself. If this feature ID is not defined as a texture, then the returned texture will be invalid.

GetFeatureCount()

static int64 UCesiumFeatureIdSetBlueprintLibrary::GetFeatureCount ( UPARAM(ref) const FCesiumFeatureIdSet & FeatureIDSet )

static

Get the number of features this primitive has.

GetFeatureIDForInstance()

static int64 UCesiumFeatureIdSetBlueprintLibrary::GetFeatureIDForInstance ( UPARAM(ref) const FCesiumFeatureIdSet & FeatureIDSet, int64 InstanceIndex )

static

Gets the feature ID associated with a given instance in glTF models using the EXT_mesh_gpu_instancing and EXT_instance_features extensions.

The feature ID can be used with a FCesiumPropertyTable to retrieve the corresponding metadata.

This returns -1 if the given instance is out-of-bounds, if the feature ID set is not for instances, or if the feature ID set is invalid (e.g., it contains an invalid feature ID attribute).

GetFeatureIDForVertex()

static int64 UCesiumFeatureIdSetBlueprintLibrary::GetFeatureIDForVertex ( UPARAM(ref) const FCesiumFeatureIdSet & FeatureIDSet, int64 VertexIndex )

static

Gets the feature ID associated with a given vertex.

The feature ID can be used with a FCesiumPropertyTable to retrieve the corresponding metadata.

This returns -1 if the given vertex is out-of-bounds, or if the feature ID set is invalid (e.g., it contains an invalid feature ID texture).

GetFeatureIDFromHit()

static int64 UCesiumFeatureIdSetBlueprintLibrary::GetFeatureIDFromHit ( UPARAM(ref) const FCesiumFeatureIdSet & FeatureIDSet, const FHitResult & Hit )

static

Given a trace hit result, gets the feature ID from the feature ID set on the hit component.

This returns a more accurate value for feature ID textures, since they define feature IDs per-texel instead of per-vertex. The feature ID can be used with a FCesiumPropertyTable to retrieve the corresponding metadata.

This can still retrieve the feature IDs for non-texture feature ID sets. For attribute or implicit feature IDs, the first feature ID associated with the first vertex of the intersected face is returned.

This returns -1 if the feature ID set is invalid (e.g., it contains an invalid feature ID texture).

GetFeatureIDSetType()

static const ECesiumFeatureIdSetType UCesiumFeatureIdSetBlueprintLibrary::GetFeatureIDSetType ( UPARAM(ref) const FCesiumFeatureIdSet & FeatureIDSet )

static

Gets the type of this feature ID set.

GetLabel()

static const FString UCesiumFeatureIdSetBlueprintLibrary::GetLabel ( UPARAM(ref) const FCesiumFeatureIdSet & FeatureIDSet )

static

Gets the label assigned to this feature ID set.

If no label was present in the glTF feature ID set, this returns an empty string.

GetNullFeatureID()

static const int64 UCesiumFeatureIdSetBlueprintLibrary::GetNullFeatureID ( UPARAM(ref) const FCesiumFeatureIdSet & FeatureIDSet )

static

Gets the null feature ID, i.e., the value that indicates no feature is associated with the owner.

In other words, if a vertex or texel returns this value, then it is not associated with any feature.

If this value was not defined in the glTF feature ID set, this defaults to -1.

GetPropertyTableIndex()

static const int64 UCesiumFeatureIdSetBlueprintLibrary::GetPropertyTableIndex ( UPARAM(ref) const FCesiumFeatureIdSet & FeatureIDSet )

static

Get the index of the property table corresponding to this feature ID set.

The index can be used to fetch the appropriate FCesiumPropertyTable from the FCesiumModelMetadata. If the feature ID set does not specify a property table, this returns -1.

---

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

• Source/CesiumRuntime/Public/CesiumFeatureIdSet.h