Freedo

https://forweb.gbim360.com/latest/freedo/Documentation/
Admin
Freedo is a 3D geospatial visualization platform providing components for rendering models, terrain,...
Tokens:795,213
Snippets:4,158
Trust Score:4
Update:1 year ago
Show doc for...
Tokens:
Raw
### Instantiate Freedo.DebugAppearance

Source: https://forweb.gbim360.com/latest/freedo/Documentation/DebugAppearance

This example demonstrates how to create a new instance of Freedo.DebugAppearance, configuring it to visualize the 'normal' attribute.

```javascript
const primitive = new Freedo.Primitive({
  geometryInstances : // ...
  appearance : new Freedo.DebugAppearance({
    attributeName : 'normal'
  })
});
```

--------------------------------

### Create and Configure a Freedo Model with Properties

Source: https://forweb.gbim360.com/latest/freedo/Documentation/Model

Shows how to create a Freedo Model with various configuration options and handle its ready promise to play animations.

```javascript
const origin = Freedo.Cartesian3.fromDegrees(-95.0, 40.0, 200000.0);
const modelMatrix = Freedo.Transforms.eastNorthUpToFixedFrame(origin);

const model = scene.primitives.add(Freedo.Model.fromGltf({
  url : './duck/duck.gltf',
  show : true,                     // default
  modelMatrix : modelMatrix,
  scale : 2.0,                     // double size
  minimumPixelSize : 128,          // never smaller than 128 pixels
  maximumScale: 20000,             // never larger than 20000 * model size (overrides minimumPixelSize)
  allowPicking : false,            // not pickable
  debugShowBoundingVolume : false, // default
  debugWireframe : false
}));

model.readyPromise.then(function(model) {
  // Play all animations when the model is ready to render
  model.activeAnimations.addAll();
});
```

--------------------------------

### ClockViewModel.startTime Property

Source: https://forweb.gbim360.com/latest/freedo/Documentation/ClockViewModel

Gets or sets the start time of the clock, represented as a JulianDate. This property is observable and corresponds to the Clock#startTime property.

```javascript
Gets or sets the start time of the clock. See `Clock#startTime`. This property is observable.
```

--------------------------------

### Get EllipsoidGeodesic Properties

Source: https://forweb.gbim360.com/latest/freedo/Documentation/EllipsoidGeodesic

Retrieves properties of the EllipsoidGeodesic, including the ellipsoid used, start and end planetodetic points, the heading at these points, and the surface distance between them.

```javascript
// Get the ellipsoid
const ellipsoid = geodesic.ellipsoid;

// Get the start planetodetic point
const startPoint = geodesic.start;

// Get the end planetodetic point
const endPoint = geodesic.end;

// Get the heading at the start point
const startHeading = geodesic.startHeading;

// Get the heading at the end point
const endHeading = geodesic.endHeading;

// Get the surface distance between the start and end points
const surfaceDistance = geodesic.surfaceDistance;
```

--------------------------------

### VRTheWorldTerrainProvider Constructor

Source: https://forweb.gbim360.com/latest/freedo/Documentation/VRTheWorldTerrainProvider

Initializes a new instance of the VRTheWorldTerrainProvider.

```APIDOC
## new VRTheWorldTerrainProvider(options)

### Description
A `TerrainProvider` that produces terrain geometry by tessellating height maps retrieved from a VT MÄK VR-TheWorld server.

### Parameters
#### Path Parameters
None

#### Query Parameters
None

#### Request Body
- **options** (Object) - Required - Object with the following properties:
  - **url** (String) - Required - The URL of the VR-TheWorld TileMap.
  - **ellipsoid** (Ellipsoid) - Optional - The ellipsoid. If not specified, `Ellipsoid.WGS84` is used.
  - **credit** (String) - Optional - A credit for the data source, which is displayed on the canvas.

### Request Example
```javascript
const terrainProvider = new Freedo.VRTheWorldTerrainProvider({
  url : 'https://www.vr-theworld.com/vr-theworld/tiles1.0.0/73/'
});
viewer.terrainProvider = terrainProvider;
```

### Response
#### Success Response (200)
N/A (Constructor does not return a response)

#### Response Example
N/A
```

--------------------------------

### Add Animation Event Listener

Source: https://forweb.gbim360.com/latest/freedo/Documentation/ModelAnimation

Adds an event listener to the 'start' event of a ModelAnimation. This example logs a message to the console when the animation begins playing.

```javascript
animation.start.addEventListener(function(model, animation) {
  console.log('Animation started: ' + animation.name);
});
```

--------------------------------

### Instantiate Freedo ParticleSystem

Source: https://forweb.gbim360.com/latest/freedo/Documentation/ParticleSystem

Demonstrates how to create a new ParticleSystem instance with various customizable options. This includes setting emission rate, particle lifetime, color, scale, and image sources.

```javascript
const options = {
  show: true,
  emissionRate: 10,
  particleLife: 3.0,
  minimumParticleLife: 2.0,
  maximumParticleLife: 4.0,
  scale: 1.5,
  startScale: 0.5,
  endScale: 2.0,
  color: new Color(1.0, 1.0, 0.0),
  startColor: new Color(1.0, 0.0, 0.0),
  endColor: new Color(0.0, 0.0, 1.0),
  image: 'path/to/particle.png',
  minimumImageSize: new Cartesian2(10, 10),
  maximumImageSize: new Cartesian2(30, 30),
  sizeInMeters: true,
  minimumSpeed: 5.0,
  maximumSpeed: 15.0,
  mass: 1.0,
  minimumMass: 0.5,
  maximumMass: 1.5,
  loop: false
};

const particleSystem = new Freedo.ParticleSystem(options);
```

--------------------------------

### Get Starting Mouse Position

Source: https://forweb.gbim360.com/latest/freedo/Documentation/CameraEventAggregator

Retrieves the screen coordinates where the aggregation for a specific event type began. This is useful for tracking the initiation point of gestures like drags.

```javascript
var startPosition = handler.getStartMousePosition(Freedo.CameraEventType.LEFT_DOWN);
```

--------------------------------

### Initialize UrlTemplateImageryProvider with Options

Source: https://forweb.gbim360.com/latest/freedo/Documentation/UrlTemplateImageryProvider

Demonstrates initializing UrlTemplateImageryProvider with various options, including different tiling schemes, credits, and custom tags. This covers accessing Natural Earth II imagery, CartoDB Positron basemap, a Web Map Service (WMS) server, and using custom tags in the URL template.

```javascript
// Access Natural Earth II imagery, which uses a TMS tiling scheme and Geographic (EPSG:4326) project
const tms = new Freedo.UrlTemplateImageryProvider({
    url : Freedo.buildModuleUrl('Assets/Textures/NaturalEarthII') + '/{z}/{x}/{reverseY}.jpg',
    credit : '© Analytical Graphics, Inc.',
    tilingScheme : new Freedo.GeographicTilingScheme(),
    maximumLevel : 5
});
// Access the CartoDB Positron basemap, which uses an OpenStreetMap-like tiling scheme.
const positron = new Freedo.UrlTemplateImageryProvider({
    url : 'http://{s}.basemaps.cartocdn.com/light_all/{z}/{x}/{y}.png',
    credit : 'Map tiles by CartoDB, under CC BY 3.0. Data by OpenStreetMap, under ODbL.'
});
// Access a Web Map Service (WMS) server.
const wms = new Freedo.UrlTemplateImageryProvider({
   url : 'https://programs.communications.gov.au/geoserver/ows?tiled=true&'
         + 'transparent=true&format=image%2Fpng&exceptions=application%2Fvnd.ogc.se_xml&'
         + 'styles=&service=WMS&version=1.1.1&request=GetMap&'
         + 'layers=public%3AMyBroadband_Availability&srs=EPSG%3A3857&'
         + 'bbox={westProjected}%2C{southProjected}%2C{eastProjected}%2C{northProjected}&'
         + 'width=256&height=256',
   rectangle : Freedo.Rectangle.fromDegrees(96.799393, -43.598214999057824, 153.63925700000001, -9.2159219997013)
});
// Using custom tags in your template url.
const custom = new Freedo.UrlTemplateImageryProvider({
   url : 'https://yoururl/{Time}/{z}/{y}/{x}.png',
   customTags : {
       Time: function(imageryProvider, x, y, level) {
           return '20171231'
       }
   }
});
```

--------------------------------

### IonImageryProvider Methods

Source: https://forweb.gbim360.com/latest/freedo/Documentation/IonImageryProvider

Documentation for the methods available on the IonImageryProvider, including getting tile credits, picking features, and requesting images.

```APIDOC
## IonImageryProvider Methods

### getTileCredits(x, y, level) → Array.<Credit>

**Description**: Gets the credits to be displayed when a given tile is displayed.

**Parameters**:
- **x** (Number) - The tile X coordinate.
- **y** (Number) - The tile Y coordinate.
- **level** (Number) - The tile level.

**Returns**: The credits to be displayed when the tile is displayed.

**Throws**: DeveloperError : `getTileCredits` must not be called before the imagery provider is ready.

### pickFeatures(x, y, level, longitude, latitude) → Promise.<Array.<ImageryLayerFeatureInfo>>|undefined

**Description**: Asynchronously determines what features, if any, are located at a given longitude and latitude within a tile. This function should not be called before `IonImageryProvider#ready` returns true. This function is optional, so it may not exist on all ImageryProviders.

**Parameters**:
- **x** (Number) - The tile X coordinate.
- **y** (Number) - The tile Y coordinate.
- **level** (Number) - The tile level.
- **longitude** (Number) - The longitude at which to pick features.
- **latitude** (Number) - The latitude at which to pick features.

**Returns**: A promise for the picked features that will resolve when the asynchronous picking completes. The resolved value is an array of `ImageryLayerFeatureInfo` instances. The array may be empty if no features are found at the given location. It may also be undefined if picking is not supported.

**Throws**: DeveloperError : `pickFeatures` must not be called before the imagery provider is ready.

### requestImage(x, y, level, request) → Promise.<(HTMLImageElement|HTMLCanvasElement)>|undefined

**Description**: Requests the image for a given tile. This function should not be called before `IonImageryProvider#ready` returns true.

**Parameters**:
- **x** (Number) - The tile X coordinate.
- **y** (Number) - The tile Y coordinate.
- **level** (Number) - The tile level.
- **request** (Request) - optional The request object. Intended for internal use only.

**Returns**: A promise for the image that will resolve when the image is available, or undefined if there are too many active requests to the server, and the request should be retried later. The resolved image may be either an Image or a Canvas DOM object.

**Throws**: DeveloperError : `requestImage` must not be called before the imagery provider is ready.
```

--------------------------------

### Get Aggregated Mouse Movement

Source: https://forweb.gbim360.com/latest/freedo/Documentation/CameraEventAggregator

Retrieves the aggregated start and end positions for the current continuous mouse movement event. This method requires the event type and an optional keyboard modifier.

```javascript
var aggregatedMovement = handler.getMovement(Freedo.CameraEventType.MOUSE_MOVE);
```

--------------------------------

### Get Last Mouse Movement

Source: https://forweb.gbim360.com/latest/freedo/Documentation/CameraEventAggregator

Retrieves the start and end positions of the most recent mouse movement event. This is distinct from aggregated movement events and requires the event type and an optional modifier.

```javascript
var lastMovement = handler.getLastMovement(Freedo.CameraEventType.MOUSE_MOVE);
```

--------------------------------

### KmlTourFlyTo Constructor

Source: https://forweb.gbim360.com/latest/freedo/Documentation/KmlTourFlyTo

Initializes a new KmlTourFlyTo instance to transition the KmlTour to the next destination.

```APIDOC
## new Freedo.KmlTourFlyTo(duration, flyToMode, view)

### Description
Transitions the KmlTour to the next destination. This transition is facilitated using a specified flyToMode over a given number of seconds.

### Parameters
#### Constructor Parameters
- **duration** (Number) - Required - The duration of the entry in seconds.
- **flyToMode** (String) - Required - The KML fly to mode (e.g., 'bounce', 'smooth').
- **view** (KmlCamera | KmlLookAt) - Required - The camera view or lookAt object for the transition.
```

--------------------------------

### Initialize HomeButtonViewModel

Source: https://forweb.gbim360.com/latest/freedo/Documentation/HomeButtonViewModel

Constructor for the HomeButtonViewModel. It requires a Scene instance and an optional duration for camera flight.

```javascript
new Freedo.HomeButtonViewModel(scene, duration)
```

--------------------------------

### Create Cartesian3 from Array (JavaScript)

Source: https://forweb.gbim360.com/latest/freedo/Documentation/Cartesian3

Creates a Cartesian3 object from three consecutive elements in a JavaScript array. Supports specifying a starting index and an optional result object. Examples show usage with and without an offset.

```javascript
static Freedo.Cartesian3.fromArray(array, startingIndex, result) → Cartesian3
// Create a Cartesian3 with (1.0, 2.0, 3.0)
const v = [1.0, 2.0, 3.0];
const p = Freedo.Cartesian3.fromArray(v);

// Create a Cartesian3 with (1.0, 2.0, 3.0) using an offset into an array
const v2 = [0.0, 0.0, 1.0, 2.0, 3.0];
const p2 = Freedo.Cartesian3.fromArray(v2, 2);
```

--------------------------------

### Instantiate EllipsoidTerrainProvider

Source: https://forweb.gbim360.com/latest/freedo/Documentation/EllipsoidTerrainProvider

Creates a new EllipsoidTerrainProvider. It accepts an optional 'options' object to configure tilingScheme and ellipsoid. If not provided, default values are used.

```javascript
new Freedo.EllipsoidTerrainProvider(options)
```

--------------------------------

### Get and Log Feature Properties

Source: https://forweb.gbim360.com/latest/freedo/Documentation/FreedoPModelPointFeature

This example demonstrates how to retrieve all property names for a feature and then log the name and value of each property to the console. It utilizes the getPropertyNames and getProperty methods, which are essential for inspecting feature data, especially when working with batch table hierarchies.

```javascript
const propertyNames = feature.getPropertyNames();
const length = propertyNames.length;
for (let i = 0; i < length; ++i) {
    const propertyName = propertyNames[i];
    console.log(propertyName + ': ' + feature.getProperty(propertyName));
}
```

--------------------------------

### EllipsoidTerrainProvider Constructor

Source: https://forweb.gbim360.com/latest/freedo/Documentation/EllipsoidTerrainProvider

Initializes a new instance of the EllipsoidTerrainProvider.

```APIDOC
## new Freedo.EllipsoidTerrainProvider(options)

### Description
A very simple `TerrainProvider` that produces geometry by tessellating an ellipsoidal surface.

### Method
CONSTRUCTOR

### Parameters
#### Path Parameters
None

#### Query Parameters
None

#### Request Body
- **options** (Object) - optional Object with the following properties:
  - **tilingScheme** (TilingScheme) - optional The tiling scheme specifying how the ellipsoidal surface is broken into tiles. If this parameter is not provided, a `GeographicTilingScheme` is used.
  - **ellipsoid** (Ellipsoid) - optional The ellipsoid. If the tilingScheme is specified, this parameter is ignored and the tiling scheme's ellipsoid is used instead. If neither parameter is specified, the WGS84 ellipsoid is used.

### Request Example
```json
{
  "options": {
    "tilingScheme": "GeographicTilingScheme",
    "ellipsoid": "WGS84"
  }
}
```

### Response
#### Success Response (200)
This is a constructor, no direct response.

#### Response Example
N/A
```

--------------------------------

### Get Row from Matrix4 as Cartesian4

Source: https://forweb.gbim360.com/latest/freedo/Documentation/Matrix4

Retrieves a specific row of a Matrix4 as a Cartesian4 object. It takes the matrix, the zero-based row index (0-3), and a Cartesian4 object to store the result. An error is thrown if the index is out of bounds. Examples demonstrate retrieving a row into a new or existing Cartesian4 instance.

```javascript
static Freedo.Matrix4.getRow(matrix, index, result) → Cartesian4
```

```javascript
//Example 1: Returns an instance of Cartesian
const a = Freedo.Matrix4.getRow(m, 2, new Freedo.Cartesian4());
```

```javascript
//Example 2: Sets values for a Cartesian instance
const a = new Freedo.Cartesian4();
Freedo.Matrix4.getRow(m, 2, a);

// a.x = 18.0; a.y = 19.0; a.z = 20.0; a.w = 21.0;
```

--------------------------------

### Get Interval by Index

Source: https://forweb.gbim360.com/latest/freedo/Documentation/TimeIntervalCollection

Gets the interval at the specified index.

```APIDOC
## GET /websites/forweb_gbim360_freedo/get

### Description
Gets the interval at the specified index.

### Method
GET

### Endpoint
/websites/forweb_gbim360_freedo/get

### Parameters
#### Query Parameters
- **index** (Number) - Required - The index of the interval to retrieve.

### Response
#### Success Response (200)
- **TimeInterval** - The interval at the specified index, or `undefined` if no interval exists at that index.

#### Response Example
```json
{
  "start": "2023-10-27T10:00:00Z",
  "stop": "2023-10-27T12:00:00Z",
  "isStartIncluded": true,
  "isStopIncluded": false,
  "data": "example data"
}
```
```

--------------------------------

### FreedoWidget Initialization and Configuration

Source: https://forweb.gbim360.com/latest/freedo/Documentation/FreedoWidget

Demonstrates how to initialize and configure the FreedoWidget with various options, including custom imagery, terrain, and scene modes.

```APIDOC
## FreedoWidget Initialization

### Description
Initializes the FreedoWidget, optionally configuring imagery, terrain, and scene properties.

### Method
`new Freedo.FreedoWidget(containerId, options)`

### Parameters
#### Path Parameters
None

#### Query Parameters
None

#### Request Body
None

### Request Example
```javascript
// Widget with no terrain and default Bing Maps imagery provider.
const widget = new Freedo.FreedoWidget('cesiumContainer');

//Widget with ion imagery and Freedo World Terrain.
const widget2 = new Freedo.FreedoWidget('cesiumContainer', {
    imageryProvider : Freedo.createWorldImagery(),
    terrainProvider : Freedo.createWorldTerrain(),
    skyBox : new Freedo.SkyBox({
        sources : {
          positiveX : 'stars/TychoSkymapII.t3_08192x04096_80_px.jpg',
          negativeX : 'stars/TychoSkymapII.t3_08192x04096_80_mx.jpg',
          positiveY : 'stars/TychoSkymapII.t3_08192x04096_80_py.jpg',
          negativeY : 'stars/TychoSkymapII.t3_08192x04096_80_my.jpg',
          positiveZ : 'stars/TychoSkymapII.t3_08192x04096_80_pz.jpg',
          negativeZ : 'stars/TychoSkymapII.t3_08192x04096_80_mz.jpg'
        }
    }),
    // Show Columbus View map with Web Mercator projection
    sceneMode : Freedo.SceneMode.COLUMBUS_VIEW,
    mapProjection : new Freedo.WebMercatorProjection()
});
```

### Response
#### Success Response (200)
FreedoWidget instance

#### Response Example
```json
{
  "message": "FreedoWidget initialized successfully"
}
```
```

--------------------------------

### Get Material Type of ColorMaterialProperty

Source: https://forweb.gbim360.com/latest/freedo/Documentation/ColorMaterialProperty

Gets the Material type of the ColorMaterialProperty at a provided time.

```javascript
getType(time) → String
```

--------------------------------

### Initialize Viewer with Default Settings

Source: https://forweb.gbim360.com/latest/freedo/Documentation/Viewer

Demonstrates initializing the FreedO Viewer with the most basic settings, utilizing default values for scene mode and map projection.

```javascript
const viewer = new Freedo.Viewer('cesiumContainer');
```

--------------------------------

### Set Start Time

Source: https://forweb.gbim360.com/latest/freedo/Documentation/DataSourceClock

Sets the desired start time for the clock. This corresponds to the startTime property of a Clock object.

```javascript
dataSourceClock.startTime = /* JulianDate value */;
```

--------------------------------

### Instantiate Freedo.InfoBoxViewModel

Source: https://forweb.gbim360.com/latest/freedo/Documentation/InfoBoxViewModel

Demonstrates how to create a new instance of the InfoBoxViewModel from the Freedo library. This is the primary way to begin using the InfoBox functionality.

```javascript
new Freedo.InfoBoxViewModel()
```

--------------------------------

### MapboxStyleImageryProvider Constructor

Source: https://forweb.gbim360.com/latest/freedo/Documentation/MapboxStyleImageryProvider

Initializes a new instance of MapboxStyleImageryProvider with specified options.

```APIDOC
## new Freedo.MapboxStyleImageryProvider(options)

### Description
Provides tiled imagery hosted by Mapbox.

### Method
Constructor

### Endpoint
N/A (Class Constructor)

### Parameters
#### Path Parameters
None

#### Query Parameters
None

#### Request Body
- **options** (MapboxStyleImageryProvider.ConstructorOptions) - Required - Object describing initialization options.
  - **styleId** (String) - Required - The Mapbox style ID.
  - **accessToken** (String) - Required - The Mapbox access token.

### Request Example
```json
{
  "styleId": "streets-v11",
  "accessToken": "thisIsMyAccessToken"
}
```

### Response
N/A (Constructor)

### Error Handling
N/A (Constructor)
```

--------------------------------

### get(index)

Source: https://forweb.gbim360.com/latest/freedo/Documentation/PostProcessStageComposite

Gets the post-process stage or composite at the specified index. This method is used to access individual stages within the composite.

```APIDOC
## get(index)

### Description
Gets the post-process stage at `index`.

### Method
GET

### Endpoint
/websites/forweb_gbim360_freedo

### Parameters
#### Path Parameters

#### Query Parameters
- **index** (Number) - Required - The index of the post-process stage or composite.

#### Request Body

### Request Example
```bash
GET /websites/forweb_gbim360_freedo?index=0
```

### Response
#### Success Response (200)
- **PostProcessStage|PostProcessStageComposite**: The post-process stage or composite at index.

#### Response Example
```json
{
  "stage": {
    "name": "Bloom"
  }
}
```

### Errors
- **DeveloperError**: index must be greater than or equal to 0.
- **DeveloperError**: index must be less than `PostProcessStageComposite#length`.
```

--------------------------------

### Get Value of ColorMaterialProperty

Source: https://forweb.gbim360.com/latest/freedo/Documentation/ColorMaterialProperty

Gets the value of the ColorMaterialProperty at a provided time. An optional result object can be provided to store the value.

```javascript
getValue(time, result) → Object
```

--------------------------------

### IonImageryProvider Constructor Options

Source: https://forweb.gbim360.com/latest/freedo/Documentation/IonImageryProvider

Defines the initialization options for the IonImageryProvider constructor.

```APIDOC
## IonImageryProvider Constructor Options

### Freedo.IonImageryProvider.ConstructorOptions

**Description**: Initialization options for the TileMapServiceImageryProvider constructor

**Properties**:
- **assetId** (Number) - An ion imagery asset ID
- **accessToken** (String) - optional - The access token to use. Defaults to `Ion.defaultAccessToken`.
- **server** (String) - optional - The resource to the Freedo ion API server. Defaults to `Ion.defaultServer`.
```

--------------------------------

### GET /websites/forweb_gbim360_freedo/options

Source: https://forweb.gbim360.com/latest/freedo/Documentation/IonResource

Asynchronously gets options for the given resource. Returns a promise that will resolve to the result once loaded, or reject if the resource failed to load.

```APIDOC
## GET /websites/forweb_gbim360_freedo/options

### Description
Asynchronously retrieves the options for a specific resource. This operation uses XMLHttpRequest and requires CORS headers to be enabled on the server for cross-origin requests.

### Method
GET

### Endpoint
/websites/forweb_gbim360_freedo/options

### Parameters
#### Query Parameters
- **options** (Object) - Optional - An object containing optional properties such as `responseType`, `headers`, and `overrideMimeType`.
  - **responseType** (String) - Optional - Specifies the type of response expected.
  - **headers** (Object) - Optional - Additional HTTP headers to include in the request.
  - **overrideMimeType** (String) - Optional - Overrides the MIME type returned by the server.

### Response
#### Success Response (200)
- **Promise** - A promise that resolves with the requested data upon successful loading.

#### Response Example
```javascript
resource.options()
  .then(function(headers) {
      // Process the received headers or data
  }).catch(function(error) {
      // Handle any errors during the request
  });
```
```

--------------------------------

### FreedoWidget Constructor

Source: https://forweb.gbim360.com/latest/freedo/Documentation/FreedoWidget

Initializes a new FreedoWidget instance.

```APIDOC
## new Freedo.FreedoWidget(container, options)

### Description
A widget containing a Freedo scene.

### Method
CONSTRUCTOR

### Endpoint
N/A (Constructor)

### Parameters
#### Path Parameters
None

#### Query Parameters
None

#### Request Body
None

### Parameters for Constructor

| Name | Type | Description |
|---|---|---|
| `container` | Element | String | The DOM element or ID that will contain the widget. |
| `options` | Object (optional) | An optional object with the following properties: |

**Options Properties:**

| Name | Type | Default | Description |
|---|---|---|---|
| `clock` | Clock | `new Clock()` | The clock to use to control current time. |
| `imageryProvider` | ImageryProvider | `createWorldImagery()` | The imagery provider to serve as the base layer. If set to `false`, no imagery provider will be added. |
| `terrainProvider` | TerrainProvider | `new EllipsoidTerrainProvider` | The terrain provider. |
| `skyBox` | SkyBox | false | false | The skybox used to render the stars. When `undefined`, the default stars are used. If set to `false`, no skyBox, Sun, or Moon will be added. |
| `skyAtmosphere` | SkyAtmosphere | false | false | Blue sky, and the glow around the Earth's limb. Set to `false` to turn it off. |
| `sceneMode` | SceneMode | `SceneMode.SCENE3D` | The initial scene mode. |
| `scene3DOnly` | Boolean | `false` | When `true`, each geometry instance will only be rendered in 3D to save GPU memory. |
| `orderIndependentTranslucency` | Boolean | `true` | If true and the configuration supports it, use order independent translucency. |
| `mapProjection` | MapProjection | `new GeographicProjection()` | The map projection to use in 2D and Columbus View modes. |
| `globe` | Globe | false | `new Globe(mapProjection.ellipsoid)` | The globe to use in the scene. If set to `false`, no globe will be added. |
| `useDefaultRenderLoop` | Boolean | `true` | True if this widget should control the render loop, false otherwise. |
| `useBrowserRecommendedResolution` | Boolean | `true` | If true, render at the browser's recommended resolution and ignore `window.devicePixelRatio`. |
| `targetFrameRate` | Number |  | The target frame rate when using the default render loop. |
| `showRenderLoopErrors` | Boolean | `true` | If true, this widget will automatically display an HTML panel to the user containing the error, if a render loop error occurs. |
| `contextOptions` | Object |  | Context and WebGL creation properties corresponding to `options` passed to `Scene`. |
| `creditContainer` | Element | String |  | The DOM element or ID that will contain the `CreditDisplay`. If not specified, the credits are added to the bottom of the widget itself. |
| `creditViewport` | Element | String |  | The DOM element or ID that will contain the credit pop up created by the `CreditDisplay`. If not specified, it will appear over the widget itself. |
| `shadows` | Boolean | `false` | Determines if shadows are cast by light sources. |
| `terrainShadows` | ShadowMode | `ShadowMode.RECEIVE_ONLY` | Determines if the terrain casts or receives shadows from light sources. |
| `mapMode2D` | MapMode2D | `MapMode2D.INFINITE_SCROLL` | Determines if the 2D map is rotatable or can be scrolled infinitely in the horizontal direction. |
| `requestRenderMode` | Boolean | `false` | If true, rendering a frame will only occur when needed as determined by changes within the scene. Enabling improves performance of the application, but requires using `Scene#requestRender` to render a new frame explicitly in this mode. This will be necessary in many cases after making changes to the scene in other parts of the API. See Improving Performance with Explicit Rendering. |
| `maximumRenderTimeChange` | Number | `0.0` | If requestRenderMode is true, this value defines the maximum change in simulation time allowed before a render is requested. See Improving Performance with Explicit Rendering. |
| `msaaSamples` | Number | `1` | If provided, this value controls the rate of multisample antialiasing. Typical multisampling rates are 2, 4, and sometimes 8 samples per pixel. Higher sampling rates of MSAA may impact performance in exchange for improved visual quality. This value only applies to WebGL2 contexts that support multisample render targets. |

### Request Example
```javascript
const widget = new Freedo.FreedoWidget("containerId", {
  clock: new Clock(),
  imageryProvider: Cesium.createWorldImagery(),
  sceneMode: Cesium.SceneMode.SCENE2D
});
```

### Response
#### Success Response (200)
N/A (Constructor)

#### Response Example
N/A (Constructor)

### Throws
* DeveloperError : Element with id "container" does not exist in the document.
```

--------------------------------

### Get ConstantPositionProperty Reference Frame - JavaScript

Source: https://forweb.gbim360.com/latest/freedo/Documentation/ConstantPositionProperty

Gets the reference frame in which the position of the ConstantPositionProperty is defined. The default value for this property is `ReferenceFrame.FIXED`.

```javascript
referenceFrame : ReferenceFrame
```

--------------------------------

### Get Post-Process Stage - Scene/PostProcessStageComposite.js

Source: https://forweb.gbim360.com/latest/freedo/Documentation/PostProcessStageComposite

Gets the post-process stage at the specified index. This method allows retrieval of individual stages or composite stages within the collection.

```javascript
Scene/PostProcessStageComposite.js

/**
 * Gets the post-process stage at the specified index.
 * @memberof Scene
 *
 * @param {Number} index The index of the post-process stage or composite.
 * @returns {PostProcessStage|PostProcessStageComposite} The post-process stage or composite at index.
 *
 * @exception {DeveloperError} index must be greater than or equal to 0.
 * @exception {DeveloperError} index must be less than PostProcessStageComposite#length.
 */
function get(index) {
    // Implementation details...
}
```

--------------------------------

### PolygonGraphics Constructor

Source: https://forweb.gbim360.com/latest/freedo/Documentation/PolygonGraphics

Initializes a new instance of PolygonGraphics with optional configuration options.

```APIDOC
## PolygonGraphics Constructor

### Description
Initializes a new instance of PolygonGraphics. This class describes a polygon defined by an hierarchy of linear rings which make up the outer shape and any nested holes. The polygon conforms to the curvature of the globe and can be placed on the surface or at altitude and can optionally be extruded into a volume.

### Method
`new Freedo.PolygonGraphics(options)`

### Parameters
#### Path Parameters
None

#### Query Parameters
None

#### Request Body
- **options** (PolygonGraphics.ConstructorOptions) - Optional object describing initialization options.

### Request Example
```json
{
  "options": {
    "hierarchy": "...",
    "material": "..."
  }
}
```

### Response
#### Success Response (200)
Represents the newly created PolygonGraphics instance.

#### Response Example
```json
{
  "instance": "PolygonGraphics instance details"
}
```
```

--------------------------------

### Set EllipsoidGeodesic End Points

Source: https://forweb.gbim360.com/latest/freedo/Documentation/EllipsoidGeodesic

Sets or updates the start and end planetodetic points for the geodesic calculation. This method takes the start and end points as arguments.

```javascript
geodesic.setEndPoints(start, end);
```

--------------------------------

### Freedo Viewer Constructor

Source: https://forweb.gbim360.com/latest/freedo/Documentation/Viewer

Initializes the Freedo Viewer widget with a container and options.

```APIDOC
## new Freedo.Viewer(container, options)

### Description
A base widget for building applications. It composites all of the standard Freedo widgets into one reusable package. The widget can always be extended by using mixins, which add functionality useful for a variety of applications.

### Parameters
#### Path Parameters
None

#### Query Parameters
None

#### Request Body
None

### Parameters Table
| Name | Type | Description |
|---|---|---|
| `container` | Element | String | The DOM element or ID that will contain the widget. |
| `options` | Viewer.ConstructorOptions | Object | Optional object describing initialization options. |

### Throws
* DeveloperError : Element with id "container" does not exist in the document.
* DeveloperError : options.selectedImageryProviderViewModel is not available when not using the BaseLayerPicker widget, specify options.imageryProvider instead.
* DeveloperError : options.selectedTerrainProviderViewModel is not available when not using the BaseLayerPicker widget, specify options.terrainProvider instead.

### Request Example
```javascript
//Initialize the viewer widget with several custom options and mixins.
const viewer = new Freedo.Viewer('cesiumContainer', {
    //Start in Columbus Viewer
    sceneMode : Freedo.SceneMode.COLUMBUS_VIEW,
    //Use Freedo World Terrain
    terrainProvider : Freedo.createWorldTerrain(),
    //Hide the base layer picker
    baseLayerPicker : false,
    //Use OpenStreetMaps
    imageryProvider : new Freedo.OpenStreetMapImageryProvider({
        url : 'https://a.tile.openstreetmap.org/'
    }),
    skyBox : new Freedo.SkyBox({
        sources : {
          positiveX : 'stars/TychoSkymapII.t3_08192x04096_80_px.jpg',
          negativeX : 'stars/TychoSkymapII.t3_08192x04096_80_mx.jpg',
          positiveY : 'stars/TychoSkymapII.t3_08192x04096_80_py.jpg',
          negativeY : 'stars/TychoSkymapII.t3_08192x04096_80_my.jpg',
          positiveZ : 'stars/TychoSkymapII.t3_08192x04096_80_pz.jpg',
          negativeZ : 'stars/TychoSkymapII.t3_08192x04096_80_mz.jpg'
        }
    }),
    // Show Columbus View map with Web Mercator projection
    mapProjection : new Freedo.WebMercatorProjection()
});

//Add basic drag and drop functionality
viewer.extend(Freedo.viewerDragDropMixin);

//Show a pop-up alert if we encounter an error when processing a dropped file
viewer.dropError.addEventListener(function(dropHandler, name, error) {
    console.log(error);
    window.alert(error);
});
```

### Response
#### Success Response (200)
N/A (Constructor)

#### Response Example
N/A (Constructor)
```

--------------------------------

### Freedo Resource Initialization

Source: https://forweb.gbim360.com/latest/freedo/Documentation/Resource

Initializes a new Freedo Resource object with specified options, including URL, query parameters, headers, and retry configurations.

```APIDOC
## new Freedo.Resource(options)

### Description
A resource that includes the location and any other parameters needed to retrieve it or create derived resources. It also provides the ability to retry requests.

### Method
Constructor

### Parameters
#### Path Parameters
None

#### Query Parameters
None

#### Request Body
None

**options** (Object) - Required - The options object for the resource.
  - **url** (String) - Required - The URL of the resource.
  - **queryParameters** (Object) - Optional - An object containing query parameters to be sent with the request.
  - **templateValues** (Object) - Optional - Key/Value pairs to replace template values in the URL.
  - **headers** (Object) - Optional - Additional HTTP headers to be sent with the request. Defaults to `{}`.
  - **proxy** (Proxy) - Optional - A proxy object to be used when loading the resource.
  - **retryCallback** (Resource.RetryCallback) - Optional - A function to call when a request fails. If it returns true, the request will be retried.
  - **retryAttempts** (Number) - Optional - The number of times the retryCallback should be called before giving up. Defaults to `0`.
  - **request** (Request) - Optional - A Request object to be used. Intended for internal use only.

### Request Example
```javascript
function refreshTokenRetryCallback(resource, error) {
  if (error.statusCode === 403) {
    // 403 status code means a new token should be generated
    return getNewAccessToken()
      .then(function(token) {
        resource.queryParameters.access_token = token;
        return true;
      })
      .otherwise(function() {
        return false;
      });
  }

  return false;
}

const resource = new Resource({
   url: 'http://server.com/path/to/resource.json',
   proxy: new DefaultProxy('/proxy/'),
   headers: {
     'X-My-Header': 'valueOfHeader'
   },
   queryParameters: {
     'access_token': '123-435-456-000'
   },
   retryCallback: refreshTokenRetryCallback,
   retryAttempts: 1
});
```

### Response
#### Success Response (200)
N/A (Constructor does not return a value directly)

#### Response Example
N/A
```

--------------------------------

### Freedo Interval Constructor

Source: https://forweb.gbim360.com/latest/freedo/Documentation/Interval

Initializes a new Freedo Interval representing the closed interval [start, stop]. Both start and stop are optional numbers, defaulting to 0.0.

```javascript
new Freedo.Interval(start, stop)
```

--------------------------------

### Get Material type at a specific time

Source: https://forweb.gbim360.com/latest/freedo/Documentation/MaterialProperty

Gets the `Material` type at the provided time. This method is useful for determining the specific type of material rendering at a given point in time.

```javascript
getType(time) → String
Gets the `Material` type at the provided time.
Name | Type | Description  
---|---|---  
`time` |  JulianDate |  The time for which to retrieve the type.  
##### Returns:
The type of material.
```

--------------------------------

### OpenCageGeocoderService Constructor

Source: https://forweb.gbim360.com/latest/freedo/Documentation/OpenCageGeocoderService

Initializes the OpenCageGeocoderService with the server URL, API key, and optional parameters.

```APIDOC
## new Freedo.OpenCageGeocoderService(url, apiKey, params)

### Description
Initializes the OpenCageGeocoderService with the server URL, API key, and optional parameters.

### Parameters
#### Path Parameters
* None

#### Query Parameters
* None

#### Request Body
* **url** (String) - Required - The endpoint to the OpenCage server.
* **apiKey** (String) - Required - The OpenCage API Key.
* **params** (Object) - Optional - An object with the following properties to customize geocoding:
  * **abbrv** (Number) - Optional - When set to 1, attempts to abbreviate and shorten the formatted string.
  * **options.add_request** (Number) - Optional - When set to 1, includes various request parameters in the response for debugging.
  * **options.bounds** (String) - Optional - Provides a hint to the geocoder about the region of the query.
  * **options.countrycode** (String) - Optional - Restricts results to specified country or countries (ISO 3166-1 Alpha 2).
  * **options.jsonp** (String) - Optional - Wraps the returned JSON with a function name.
  * **options.language** (String) - Optional - An IETF format language code.
  * **options.limit** (Number) - Optional - The maximum number of results to return.
  * **options.min_confidence** (Number) - Optional - Minimum confidence level (1-10) for results.
  * **options.no_annotations** (Number) - Optional - When set to 1, results will not contain annotations.
  * **options.no_dedupe** (Number) - Optional - When set to 1, results will not be deduplicated.
  * **options.no_record** (Number) - Optional - When set to 1, the query contents are not logged.
  * **options.pretty** (Number) - Optional - When set to 1, results are 'pretty' printed for easier reading.
  * **options.proximity** (String) - Optional - Provides a hint to bias results towards locations closer to the specified coordinates (e.g., '41.40139,2.12870').

### Request Example
```json
{
  "url": "https://api.opencagedata.com/geocode/v1/",
  "apiKey": "<API key>"
}
```

### Response
#### Success Response (200)
* Not applicable for constructor.

#### Response Example
```json
// No response for constructor, but shows usage:
// const viewer = new Freedo.Viewer('cesiumContainer', {
//   geocoder: new Freedo.OpenCageGeocoderService('https://api.opencagedata.com/geocode/v1/', '<API key>')
// });
```
```

--------------------------------

### Initialize IonGeocoderService

Source: https://forweb.gbim360.com/latest/freedo/Documentation/IonGeocoderService

Constructs a new instance of the IonGeocoderService. Requires an options object which can include a scene, access token, and server URL for the Freedo ion API.

```javascript
new Freedo.IonGeocoderService(options)
```

--------------------------------

### Get Material value at a specific time

Source: https://forweb.gbim360.com/latest/freedo/Documentation/MaterialProperty

Gets the value of the property at the provided time. An optional `result` object can be supplied to store the value, otherwise a new instance is created and returned.

```javascript
getValue(time, result) → Object
Gets the value of the property at the provided time.
Name | Type | Description  
---|---|---  
`time` |  JulianDate |  The time for which to retrieve the value.  
`result` |  Object |  optional The object to store the value into, if omitted, a new instance is created and returned.  
##### Returns:
The modified result parameter or a new instance if the result parameter was not supplied.
```

--------------------------------

### KmlTour Constructor

Source: https://forweb.gbim360.com/latest/freedo/Documentation/KmlTour

Initializes a new KmlTour instance. It takes a name, id, and a playlist of tour entries.

```javascript
new Freedo.KmlTour(name, id, playlist)
```

--------------------------------

### Create GUID

Source: https://forweb.gbim360.com/latest/freedo/Documentation/global

Generates a Globally Unique Identifier (GUID) string, also known as a UUID. This 128-bit identifier ensures a very high probability of uniqueness across different systems and time.

```javascript
Core/createGuid.js
```

```javascript
this.guid = Freedo.createGuid();
```

--------------------------------

### Create a Freedo Model from glTF

Source: https://forweb.gbim360.com/latest/freedo/Documentation/Model

Demonstrates creating a Freedo Model instance from a glTF file. This is the most basic way to load a model.

```javascript
const model = scene.primitives.add(Freedo.Model.fromGltf({
  url : './duck/duck.gltf'
}));
```

--------------------------------

### Freedo.ReferenceProperty Constructor and Usage Example

Source: https://forweb.gbim360.com/latest/freedo/Documentation/ReferenceProperty

Demonstrates creating and using Freedo.ReferenceProperty to link entity properties. Includes examples of direct property referencing and using the fromString helper, along with escaping special characters.

```javascript
const collection = new Freedo.EntityCollection();

//Create a new entity and assign a billboard scale.
const object1 = new Freedo.Entity({id:'object1'});
object1.billboard = new Freedo.BillboardGraphics();
object1.billboard.scale = new Freedo.ConstantProperty(2.0);
collection.add(object1);

//Create a second entity and reference the scale from the first one.
const object2 = new Freedo.Entity({id:'object2'});
object2.model = new Freedo.ModelGraphics();
object2.model.scale = new Freedo.ReferenceProperty(collection, 'object1', ['billboard', 'scale']);
collection.add(object2);

//Create a third object, but use the fromString helper function.
const object3 = new Freedo.Entity({id:'object3'});
object3.billboard = new Freedo.BillboardGraphics();
object3.billboard.scale = Freedo.ReferenceProperty.fromString(collection, 'object1#billboard.scale');
collection.add(object3);

//You can refer to an entity with a # or . in id and property names by escaping them.
const object4 = new Freedo.Entity({id:'#object.4'});
object4.billboard = new Freedo.BillboardGraphics();
object4.billboard.scale = new Freedo.ConstantProperty(2.0);
collection.add(object4);

const object5 = new Freedo.Entity({id:'object5'});
object5.billboard = new Freedo.BillboardGraphics();
object5.billboard.scale = Freedo.ReferenceProperty.fromString(collection, '\#object\.4#billboard.scale');
collection.add(object5);
```

--------------------------------

### Cluster Event Listener Example

Source: https://forweb.gbim360.com/latest/freedo/Documentation/EntityCluster

An example of how to add an event listener to the `clusterEvent` to customize the appearance of clusters based on the entities they contain. It sets the label's visibility and text to display the count of entities in the cluster.

```javascript
dataSource.clustering.clusterEvent.addEventListener(function(entities, cluster) {
    cluster.label.show = true;
    cluster.label.text = entities.length.toLocaleString();
});
```
Tokens:
Raw