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

Represents a feature ID attribute from a glTF primitive. More...

Inheritance diagram for CesiumForUnity.CesiumFeatureIdAttribute:
CesiumForUnity.CesiumFeatureIdSet

Public Member Functions

override partial Int64 GetFeatureIdForVertex (Int64 vertexIndex)
 Gets the feature ID associated with a given vertex.The feature ID can be used with a CesiumPropertyTable to retrieve the corresponding metadata.This returns -1 if the given vertex is out-of-bounds, or if the feature ID set is invalid.
 
override Int64 GetFeatureIdFromRaycastHit (RaycastHit hitInfo)
 Gets the feature ID from the feature ID set using the given raycast hit.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 CesiumPropertyTable 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.
 
- Public Member Functions inherited from CesiumForUnity.CesiumFeatureIdSet
virtual void Dispose ()
 

Properties

CesiumFeatureIdAttributeStatus status [get, set]
 The status of this feature ID attribute.
 
- Properties inherited from CesiumForUnity.CesiumFeatureIdSet
CesiumFeatureIdSetType type [get, protected set]
 The type of this feature ID set.
 
String label [get, set]
 The label assigned to this feature ID set.
 
Int64 featureCount [get, set]
 The number of features this primitive has.
 
Int64 nullFeatureId [get, set]
 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.
 
Int64 propertyTableIndex [get, set]
 The index of the property table corresponding to this feature ID set.
 

Detailed Description

Represents a feature ID attribute from a glTF primitive.

Provides access to per-vertex feature IDs which can be used with the corresponding CesiumPropertyTable to access per-vertex metadata.

Definition at line 34 of file CesiumFeatureIdAttribute.cs.

Member Function Documentation

◆ GetFeatureIdForVertex()

override partial Int64 CesiumForUnity.CesiumFeatureIdAttribute.GetFeatureIdForVertex ( Int64 vertexIndex)
virtual

Gets the feature ID associated with a given vertex.The feature ID can be used with a CesiumPropertyTable to retrieve the corresponding metadata.This returns -1 if the given vertex is out-of-bounds, or if the feature ID set is invalid.

Reimplemented from CesiumForUnity.CesiumFeatureIdSet.

◆ GetFeatureIdFromRaycastHit()

override Int64 CesiumForUnity.CesiumFeatureIdAttribute.GetFeatureIdFromRaycastHit ( RaycastHit hitInfo)
inlinevirtual

Gets the feature ID from the feature ID set using the given raycast hit.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 CesiumPropertyTable 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.

Reimplemented from CesiumForUnity.CesiumFeatureIdSet.

Definition at line 55 of file CesiumFeatureIdAttribute.cs.

Property Documentation

◆ status

CesiumFeatureIdAttributeStatus CesiumForUnity.CesiumFeatureIdAttribute.status
getset

The status of this feature ID attribute.

Definition at line 39 of file CesiumFeatureIdAttribute.cs.


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