kotlin-cesium-engine/cesium.engine/MetadataClassProperty

MetadataClassProperty

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

A metadata property, as part of a MetadataClass.

See the 3D Metadata Specification for 3D Tiles

Constructors

constructor(options: MetadataClassProperty.ConstructorOptions)

Types

ConstructorOptions

sealed interface ConstructorOptions

Properties

arrayLength

val arrayLength: Int

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

componentType

val componentType: MetadataComponentType

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

default

val default: Any

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

description

val description: String

The description of the property.

enumType

val enumType: MetadataEnum

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

extensions

val extensions: Any

An object containing extensions.

extras

val extras: Any

Extra user-defined properties.

val id: String

The ID of the property.

isArray

val isArray: Boolean

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

isVariableLengthArray

val isVariableLengthArray: Boolean

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

max

val max: Any

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

min

val min: Any

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

name

val name: String

The name of the property.

noData

val noData: Any

The no-data sentinel value that represents null values

normalized

val normalized: Boolean

Whether the property is normalized.

offset

val offset: Any

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

required

val required: Boolean

Whether the property is required.

scale

val scale: Any

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

semantic

val semantic: String

An identifier that describes how this property should be interpreted.

type

val type: MetadataType

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

MetadataClassProperty

See also

Constructors

Types

Properties