Cesium for Unity 1.15.2
Loading...
Searching...
No Matches
CesiumForUnity.CesiumPropertyTable Class Reference

Represents a glTF property table in the EXT_structural_metadata extension. More...

Public Member Functions

Dictionary< String, CesiumMetadataValueGetMetadataValuesForFeature (Int64 featureId)
 Gets all of the property values for a given feature, mapped by property name.
 
void GetMetadataValuesForFeature (Dictionary< String, CesiumMetadataValue > values, Int64 featureId)
 Gets all of the property values for a given feature, mapped by property name.
 

Properties

CesiumPropertyTableStatus status [get, set]
 The status of the property table.
 
string name [get, set]
 The name of the property table.
 
Int64 count [get, set]
 The number of values each property in the table is expected to have.
 
Dictionary< String, CesiumPropertyTablePropertyproperties [get, set]
 The properties of the property table, mapped by property id.
 

Detailed Description

Represents a glTF property table in the EXT_structural_metadata extension.

A property table is a collection of properties for the features in a mesh. It knows how to look up the metadata values associated with a given feature ID.

Definition at line 34 of file CesiumPropertyTable.cs.

Member Function Documentation

◆ GetMetadataValuesForFeature() [1/2]

void CesiumForUnity.CesiumPropertyTable.GetMetadataValuesForFeature ( Dictionary< String, CesiumMetadataValue > values,
Int64 featureId )
inline

Gets all of the property values for a given feature, mapped by property name.

This will only include values from valid property table properties.

Call the overload with a Dictionary parameter if you wish to avoid allocation of a new Dictionary with every access.

If the feature ID is out-of-bounds, the returned dictionary will be empty.

Parameters
valuesThe dictionary of values that will be cleared and filled by this method.
featureIdThe ID of the feature.

Definition at line 108 of file CesiumPropertyTable.cs.

◆ GetMetadataValuesForFeature() [2/2]

Dictionary< String, CesiumMetadataValue > CesiumForUnity.CesiumPropertyTable.GetMetadataValuesForFeature ( Int64 featureId)
inline

Gets all of the property values for a given feature, mapped by property name.

This will only include values from valid property table properties.

If the feature ID is out-of-bounds, the returned dictionary will be empty.

Parameters
featureIdThe ID of the feature.
Returns
A dictionary of the property values mapped by property name.

Definition at line 86 of file CesiumPropertyTable.cs.

Property Documentation

◆ count

Int64 CesiumForUnity.CesiumPropertyTable.count
getset

The number of values each property in the table is expected to have.

If an error occurred while parsing the property table, this returns zero.

Definition at line 58 of file CesiumPropertyTable.cs.

◆ name

string CesiumForUnity.CesiumPropertyTable.name
getset

The name of the property table.

If no name was specified in the glTF extension, this is an empty string.

Definition at line 49 of file CesiumPropertyTable.cs.

◆ properties

Dictionary<String, CesiumPropertyTableProperty> CesiumForUnity.CesiumPropertyTable.properties
getset

The properties of the property table, mapped by property id.

Definition at line 66 of file CesiumPropertyTable.cs.

◆ status

CesiumPropertyTableStatus CesiumForUnity.CesiumPropertyTable.status
getset

The status of the property table.

If an error occurred while parsing the property table from the glTF extension, this briefly conveys why.

Definition at line 40 of file CesiumPropertyTable.cs.


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