ConstructorOptions

sealed interface ConstructorOptions(source)

Properties

Link copied to clipboard
abstract var arrayLength: Int?

The number of array elements. Only defined for fixed length arrays.

Link copied to clipboard

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

Link copied to clipboard
abstract var default: Any?

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

Link copied to clipboard
abstract var description: String?

The description of the property.

Link copied to clipboard
abstract var enumType: MetadataEnum?

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

Link copied to clipboard
abstract var extensions: Any?

An object containing extensions.

Link copied to clipboard
abstract var extras: Any?

Extra user-defined properties.

Link copied to clipboard
abstract var id: String

The ID of the property.

Link copied to clipboard
abstract var isArray: Boolean?

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

Link copied to clipboard

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

Link copied to clipboard
abstract var 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.

Link copied to clipboard
abstract var 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.

Link copied to clipboard
abstract var name: String?

The name of the property.

Link copied to clipboard
abstract var noData: Any?

The no-data sentinel value that represents null values.

Link copied to clipboard
abstract var normalized: Boolean?

Whether the property is normalized. Default value - false

Link copied to clipboard
abstract var offset: Any?

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

Link copied to clipboard
abstract var required: Boolean?

Whether the property is required. Default value - false

Link copied to clipboard
abstract var scale: Any?

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

Link copied to clipboard
abstract var semantic: String?

An identifier that describes how this property should be interpreted.

Link copied to clipboard
abstract var type: MetadataType

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