# Class: Gltf

## vcs.vcm.layer.cesium.Gltf

represents a gltf layer for cesium.

#### new vcs.vcm.layer.cesium.Gltf(options)

  Name | Type | Description
  --- | --- | ---
  `options` | vcs.vcm.layer.cesium.Gltf.Options |

### Extends

- vcs.vcm.layer.cesium.Entities

### Members

#### className{string}

  class Name of the Object

#### hiddenObjectIds{Array.<string>}

  array of object Ids which should be hidden global, if this layer is active

#### name{string}

  unique Name

### Methods

#### activate(active){Promise} inherited

  Activates or deactivates this layer object, i.e. changes its internal view state and updates the map by calling show

  Name | Type | Description
  --- | --- | ---
  `active` | boolean | false or true activates or deactivates this layer

  ##### Fires:

  - `LAYER_ACTIVATED` (vcs.vcm.layer.Layer) - vcs.vcm.event.EventType.LAYER_ACTIVATED is triggered when a layer is activated.
  - `LAYER_CHANGED` (vcs.vcm.layer.Layer) - vcs.vcm.event.EventType.LAYER_CHANGED is triggered when a layer is activated or deactivated.
  - `LAYER_DEACTIVATED` (vcs.vcm.layer.Layer) - vcs.vcm.event.EventType.LAYER_DEACTIVATED is triggered when a layer is deactivated.

#### addEntity(options, attributes, allowPicking){null|string} inherited

  adds an entity

  Name | Type | Description
  --- | --- | ---
  `options` | Object | Cesium.Entity | Cesium Entity options, or the entity
  `attributes` | Object | a set of properties, typically used for rendering a balloon
  `allowPicking` | boolean | whether to override the layers allowPicking setting for this entity

  ##### Returns:

  the entities id

#### addGenericFeatureProperties(properties) inherited

  Set properties, which are always added to the generic object, eg. for use in balloons

  Name | Type | Description
  --- | --- | ---
  `properties` | Object |

#### clearHiddenObjects() inherited

  clears all the hidden objects

#### clearHighlighting() inherited

  clears all highlighted objects

#### clearStyle() inherited

  Clears the style of this layer

#### dispose() inherited

  disposes of this layer, removes instances from the current maps and the framework

#### flyToEntity(id) inherited

  Zooms to an entity with the given id

  Name | Type | Description
  --- | --- | ---
  `id` | string |

#### getClassName(){string} inherited

  returns the class name of this object.

  Deprecated
    - Yes

  ##### Returns:

  className

#### getConfigObject(){Object} inherited

#### getDataSource(){Cesium.DataSource} inherited

  Returns the layers Cesium.DataSource

  Deprecated
    - v.3.6

#### getEntities(){Cesium.EntityCollection} inherited

  Returns the layer Cesium.EntityCollection

  Deprecated
    - v3.6

#### getExclusiveGroup(){string} inherited

  returns the exclusive group of this layer

  Deprecated
    - Yes

#### getExtent(){vcs.vcm.util.Extent} inherited

  returns the Extent of this layer

  Deprecated
    - Yes

#### getId(){string} inherited

  returns the id of this object

  Deprecated
    - Yes

#### getName(){string} inherited

  returns the name of the Object, the name is either given by the config Object or a uuid is generated

  Deprecated
    - Yes

#### getType(){number} inherited

  returns the type of this layer

  Deprecated
    - Yes

#### hideObjects(toHide) inherited

  hides a number of objects

  Name | Type | Description
  --- | --- | ---
  `toHide` | Array.<(string|number)> | A list of Object Ids which will be hidden

#### highlight(toHighlight) inherited

  highlights a number of building objects with the given color

  Name | Type | Description
  --- | --- | ---
  `toHighlight` | Object.<string, (vcs.vcm.util.style.VectorStyleItem|Cesium.Color|ol.style.Style)> |

#### isActive(){boolean} inherited

  checks if the layer is active

  Deprecated
    - Yes

#### isExclusive(){boolean} inherited

  returns whether this layer can only be used exclusive

  Deprecated
    - Yes

#### isIconManagerInUse(){boolean} inherited

  returns whether this layer is used by the iconmanager

  Deprecated
    - Yes

#### isInitialized(){boolean} inherited

  returns true if the layer is initialized

  Deprecated
    - Yes

#### isSupported(opt_map){boolean} inherited

  checks if the currently active map supports this layer

  Name | Type | Description
  --- | --- | ---
  `map` | vcs.vcm.maps.Map |

#### setStyle(style, silent) inherited

  Sets the style based on a styleName on a layer

  Name | Type | Description
  --- | --- | ---
  `style` | string | ol.style.Style | ol.StyleFunction | vcs.vcm.util.style.StyleItem |
  `silent` | boolean |

#### showObjects(toUnhide) inherited

  unHides a number of objects

  Name | Type | Description
  --- | --- | ---
  `toUnhide` | Array.<(string|number)> | A list of Object Ids which will be unHidden

#### unHighlight(toUnHighlight) inherited

  unhighlights a number of building objects

  Name | Type | Description
  --- | --- | ---
  `toUnHighlight` | Array.<string> | Array with IDS to unhighlight

### Type Definitions

#### vcs.vcm.layer.cesium.Gltf.Model{Object}

  ##### Properties:

  Name | Type | Description
  --- | --- | ---
  `url` | string |
  `id` | string | undefined |
  `longitude` | number |
  `latitude` | number |
  `height` | number |
  `heading` | number | undefined |
  `pitch` | number | undefined |
  `roll` | number | undefined |
  `scale` | number | undefined |

### Events

#### LAYER_ACTIVATED inherited

  vcs.vcm.event.EventType.LAYER_ACTIVATED is triggered when a layer is activated.

  ##### Type:

  - vcs.vcm.layer.Layer

#### LAYER_CHANGED inherited

  vcs.vcm.event.EventType.LAYER_CHANGED is triggered when a layer is activated or deactivated.

  ##### Type:

  - vcs.vcm.layer.Layer

#### LAYER_DEACTIVATED inherited

  vcs.vcm.event.EventType.LAYER_DEACTIVATED is triggered when a layer is deactivated.

  ##### Type:

  - vcs.vcm.layer.Layer