FloorCalibration
Extends
AbstractEntity
class FloorCalibration extends AbstractEntity
Static
create
static create(json = null): FloorCalibration
Parameters:
| Name | Type | Required | Default | Description |
|---|---|---|---|---|
| json | null | object | No | null | Used to constructor from a JSON representation. See fromJSON |
Returns:
Type: FloorCalibration
getName
static getName(): "FloorCalibration"
Returns:
Type: constant ("FloorCalibration": string)
Constructor
constructor
constructor(json = null): FloorCalibration
Parameters:
| Name | Type | Required | Default | Description |
|---|---|---|---|---|
| json | null | object | No | null | Used to constructor from a JSON representation. See fromJSON |
Properties
eye
| Type | Default | Description |
|---|---|---|
| Vector | new Vector() |
floor_id
| Type | Default | Description |
|---|---|---|
| int | null | null |
id
| Type | Default | Description |
|---|---|---|
| null | int | symbol | null | The entity identifier |
metadata
| Type | Default | Description |
|---|---|---|
| Map | new Map() |
site
| Type | Default | Description |
|---|---|---|
| Reference<Site> | new Reference('Site', null) |
site_calibration
| Type | Default | Description |
|---|---|---|
| Reference<SiteCalibration> | new Reference('SiteCalibration', null) |
target
| Type | Default | Description |
|---|---|---|
| Vector | new Vector() |
up
| Type | Default | Description |
|---|---|---|
| Vector | new Vector() |
zoom_max
| Type | Default | Description |
|---|---|---|
| number | null | null |
zoom_min
| Type | Default | Description |
|---|---|---|
| number | null | null |
Methods
toJSON
toJSON(): object
Returns:
Type: object (see properties bellow)
| Name | Type | Description |
|---|---|---|
| eye | {x: number, y: number, z: number} | |
| floor_id | int | null | |
| id | int | symbol | null | |
| metadata | object | |
| site | int | symbol | null | |
| site_calibration | int | symbol | null | |
| target | {x: number, y: number, z: number} | |
| up | {x: number, y: number, z: number} | |
| zoom_max | number | null | |
| zoom_min | number | null |
fromJSON
fromJSON(json: object): FloorCalibration
Parameters:
| Name | Type | Required | Default | Description |
|---|---|---|---|---|
| json | object | Yes | - | |
| json.eye | {x: number, y: number, z: number} | No | {x: 0, y: 0, z: 0} | |
| json.floor_id | int | null | No | null | |
| json.id | int | symbol | null | No | null | |
| json.metadata | object | No | {} | |
| json.site | int | symbol | null | No | null | |
| json.site_calibration | int | symbol | null | No | null | |
| json.target | {x: number, y: number, z: number} | No | {x: 0, y: 0, z: 0} | |
| json.up | {x: number, y: number, z: number} | No | {x: 0, y: 0, z: 0} | |
| json.zoom_max | number | null | No | null | |
| json.zoom_min | number | null | No | null |
Returns:
Returns this
clone
clone(): FloorCalibration
Returns:
A new deep copy
Type: FloorCalibration