Create(CIMVoxelDataConnection) Method

In This Topic

Create a VoxelLayerCreationParams using the given CIMVoxelDataConnection. This method must be called on the MCT. Use QueuedTask.Run.

Syntax

C#
Visual Basic (Declaration)

public static VoxelLayerCreationParams Create( 
   CIMVoxelDataConnection dataConnection
)

Public Overloads Shared Function Create( _
   ByVal dataConnection As CIMVoxelDataConnection _
) As VoxelLayerCreationParams

Parameters

dataConnection: A valid CIMVoxelDataConnection

Return Value

VoxelLayerCreationParams

Exceptions

Exception	Description
ArcGIS.Core.CalledOnWrongThreadException	Thrown when a method is called on the wrong Pro thread
System.ArgumentNullException	dataConnection is null
System.IO.FileNotFoundException	'dataConnection URI' does not exist
System.ArgumentException	'dataConnection URI' must be a NetCDF file (.nc)

Remarks

Valid datasources for voxel layers are:
- NetCDF (.nc) data files
Voxel layers can only be added to local scenes. If a voxel layer is added to a global scene the layer will not draw. If a voxel layer is added to a 2D map or stereo map a System.InvalidOperationException is thrown when calling LayerFactory.CreateLayer<T>
If adding to a group layer, it must be SceneLayerType.SceneLayer3D or a System.InvalidOperationException is thrown when calling LayerFactory.CreateLayer<T>

Example

Create Voxel Layer

//Must be on the QueuedTask.Run()

//Must be a .NetCDF file for voxels
var url = @"C:\MyData\AirQuality_Redlands.nc";
var cim_connection = new CIMVoxelDataConnection()
{
    URI = url
};
//Create a VoxelLayerCreationParams
var createParams = VoxelLayerCreationParams.Create(cim_connection);
createParams.IsVisible = true;

//Can also just use the path directly...
//var createParams = VoxelLayerCreationParams.Create(url);

//Use VoxelLayerCreationParams to enumerate the variables within
//the voxel
var variables = createParams.Variables;
foreach (var variable in variables)
{
    var line = $"{variable.Variable}: {variable.DataType}, " +
       $"{variable.Description}, {variable.IsDefault}, {variable.IsSelected}";
    System.Diagnostics.Debug.WriteLine(line);
}
//Optional: set the default variable
createParams.SetDefaultVariable(variables.Last());

//Create the layer - map must be a local scene
VoxelLayer voxelLayer = LayerFactory.Instance.CreateLayer<VoxelLayer>(createParams, map);

Requirements

Target Platforms: Windows 11, Windows 10

ArcGIS Pro version: 3 or higher.

Reference

VoxelLayerCreationParams Class
VoxelLayerCreationParams Members
Overload List

Send feedback