kotlin-cesium-engine/cesium.engine/MetadataClassProperty

MetadataClassProperty

open external class MetadataClassProperty(options: MetadataClassProperty.ConstructorOptions)(source)

A metadata property, as part of a MetadataClass.

See the 3D Metadata Specification for 3D Tiles

See also

Online Documentation

Constructors

MetadataClassProperty

constructor(options: MetadataClassProperty.ConstructorOptions)

Types

ConstructorOptions

external interface ConstructorOptions

Properties

external val arrayLength: Int

The number of array elements. Only defined for fixed-size arrays.

external val componentType: MetadataComponentType

The component type of the property. This includes integer (e.g. INT8 or UINT16), and floating point (FLOAT32 and FLOAT64) values

external val default: JsAny

A default value to use when an entity's property value is not defined.

external val description: String

The description of the property.

external val enumType: MetadataEnum

The enum type of the property. Only defined when type is ENUM.

external val extensions: JsAny

An object containing extensions.

external val extras: JsAny

Extra user-defined properties.

external val id: String

The ID of the property.

external val isArray: Boolean

True if a property is an array (either fixed length or variable length), false otherwise.

isVariableLengthArray

external val isVariableLengthArray: Boolean

True if a property is a variable length array, false otherwise.

external val max: JsAny

A number or an array of numbers storing the maximum allowable value of this property. Only defined when type is a numeric type.

external val min: JsAny

A number or an array of numbers storing the minimum allowable value of this property. Only defined when type is a numeric type.

external val name: String

The name of the property.

external val noData: JsAny

The no-data sentinel value that represents null values

external val normalized: Boolean

Whether the property is normalized.

external val offset: JsAny

The offset to be added to property values as part of the value transform.

external val required: Boolean

Whether the property is required.

external val scale: JsAny

The scale to be multiplied to property values as part of the value transform.

external val semantic: String

An identifier that describes how this property should be interpreted.

external val type: MetadataType

The type of the property such as SCALAR, VEC2, VEC3

Functions

gpuBytesPerElement

external fun gpuBytesPerElement(): Double

Determines the byte size of a single property element, stored on the GPU. This differs from the CPU byte size if the element type is a 64-bit type that can be downcast to a 32-bit type for texture packing (only relevant for textures created from property tables).