Options
All
  • Public
  • Public/Protected
  • All
Menu

A ModelDescriptor for HSPC data.

since

2020.0

Hierarchy

Overview

Properties

description

description: string

A human readable description for the model.

name

name: string

A human readable name for the model.

Optional properties

properties: {}

An optional set of properties.

For HSPC versions 8 and up, these properties can be used for expression based styling.

Entries for which the role is known will exhibit the "role" property. Currently exposed roles are :

  • "color" : Color [vec4]
  • "normal" : Normal (facing direction of points) [vec3]
  • "intensity" : Intensity [number]
  • "classification" : Classification [number]

When available, the data type will also be listed. Possible types are :

  • "float32" : A 32-bit float
  • "float64" : a 64-bit double
  • "int32" : a 32-bit signed int
  • "int16" : a 16-bit signed int
  • "int8" : a 8-bit signed char
  • "uint32" : a 32-bit unsigned int
  • "uint16" : a 16-bit unsigned int
  • "uint8" : a 8-bit unsigned char

These will give a hint about the possible range of values for a given attribute. For instance, uint8 data will only be in range 0-255, helping in designing an effective styling range.

Example of what a descriptor can look like:

"properties" : {
  "colorRGB" : {
    "role" : "color"
  },
  "I" : {
    "role" : "intensity",
    "type" : "float32"
  },
  "C" : {
    "role" : "classification",
    "type" : "uint8"
  }
}

Type declaration

  • [propertyName: string]: { role?: string; type?: string }
    • Optional role?: string
    • Optional type?: string

source

source: string

The source from which this model was created.

type

type: string

A String containing a type constant. This value provides an indication of what kind of data a model contains

Optional version

version: string

An optional property containing version information.

Legend

  • Module
  • Object literal
  • Variable
  • Function
  • Function with type parameter
  • Index signature
  • Type alias
  • Type alias with type parameter
  • Enumeration
  • Enumeration member
  • Property
  • Method
  • Interface
  • Interface with type parameter
  • Constructor
  • Property
  • Method
  • Index signature
  • Class
  • Class with type parameter
  • Constructor
  • Property
  • Method
  • Accessor
  • Index signature
  • Inherited constructor
  • Inherited property
  • Inherited method
  • Inherited accessor
  • Protected property
  • Protected method
  • Protected accessor
  • Private property
  • Private method
  • Private accessor
  • Static property
  • Static method