Advanced Search
Search Results
88 total results found
IVoxelFarmReportLambda
The IVoxelFarmReportLambda interface provides a way to supply custom execution code for a report process in the platform. The interface is declared as follows: namespace VoxelFarm.SpatialLambda { public interface IVoxelFarmReportLambda { ...
IVoxelFarmReportLambdaHost
The IVoxelFarmReportLambdaHost interface provides access to platform features. Methods: double Input(string id, string label, double defaultValue) Inputs a floating point value. The parameter provided as id should be unique for the set of inpu...
IVoxelFarmReportDoneLambdaHost
The IVoxelFarmReportLambdaHost interface provides access to platform features during the final stage of a report's execution. Methods: string CreateTempFolder(string name) Creates a temporary folder and returns the path to it. bool At...
Report Lambda Examples
using System; using System.IO; using System.IO.Compression; using VoxelFarm.SpatialLambda; namespace TestLambdas { // This Report Lambda uses a Sum to compute the volume of an object public class EntityVolume : VoxelFarm.SpatialLambda.IVoxel...
Introduction
The Embed Viewer is a React component that encapsulates a viewer to show 3D spatial data. The Embed Viewer developer manual includes the following sections Properties : Definition of the Embed Viewer React Component' Props (Properties) and each prop values...
Properties
Name JS Data Type Description projectId string The ID of the project streamingUrl string The URL of the streaming server restUrl string The URL of rest server viewId strin...
Functions
Name Parameters Description fetchProgramInputs - programId: string - callback: function => callback returning the inputs Return the current PYTHON programs inputs refreshView - selectedViewContainerMeta: View...
Introduction
The Voxel Farm solution includes a thin C# client library. This client allows applications running on .NET to connect and access data hosted by Voxel Farm servers. The C# Client Library allows the application to create a “view” of content in the Voxel Farm pl...
Threading Model
The C# Client is designed to operate in high-frequency, real-time systems like VR rendering. It can only be used asynchronously. The C# client uses worker threads to perform operations like downloading and decompressing data in the background. Before anything...
Coordinate Systems
When working with Voxel Farm projects, it is possible to encounter up to three different coordinate systems. These systems are: Project’s native coordinate system. These are the real-world coordinates, typically involving an Earth ellipsoid model (WSG84, et...
Spatial Indexing
A grid is assumed to divide the world into equally-sized 3D cells. Each cell measures VoxelFarmConstant.CELL_SIZE units along each direction. From a given 3D point in Voxel Farm coordinates, it is possible to determine the coordinates of the cell containing t...
Creating a View
In order to access spatial information from the Voxel Farm, the application will have to create at least one instance of the “VoxelFarmView” class. MyView = new VoxelFarm.VoxelFarmView(); The view object will connect to the server to request data...
View Configuration
Once the project loads, the application must determine how to configure the client view. A single project may contain multiple datasets. Configuring the view in the client involves selecting which datasets should be used and how will they be combined and prese...
Using Views for Rendering
The C# Client Library allows to integrate the Voxel Farm platform into existing rendering environments. The VoxelFarmView object in the library has the concept of a “focus” scope. Typically, a 3D application will have a camera, and the camera is expected to m...
Using Views for Data Retrieval
The C# Client library allows a simpler interaction model for applications that just want to read spatial data from Voxel Farm servers. This is the case of a client-side report for instance, where multiple datasets can be requested and inspected by a client app...
Example - Mesh Export
The following C# program connects to a Voxel Farm server and exports the terrain surface within a 3D region as a mesh: using System; using System.Collections.Generic; using System.IO; using System.Linq; using System.Net; using System.Text; using Syste...
Introduction
The Voxel Farm SDK contains a packaged Unity3D plugin you may add to any existing or new Unity3D project. The SDK also contains a working Unity3D example that uses this plugin.
Unity3D Example
The Unity3D example is located in the “<SDKRoot>\Client.Unity\Example” folder. Use that folder to load the project inside the Unity3D editor: Once the project loads, make sure the scene “SampleScene” is the active scene in the editor. The “New Voxel Farm Vie...
Using the Unity3D Plugin
To add the Voxel Farm Unity3D plugin to a new project, select “Assets > Import Package > Import Custom Package…” from the Unity3D editor menu. In the file selection dialog that appears, browser to the “<SDKRoot>\Client.Unity\Plugin” folder and select the file ...
Introduction
The platform features a component for material tracking. This is a voxel layer that can be used to track the location of material in space across time. It is possible to interact with the Material Tracking Layer in two main general ways: Submit new facts a...