Babylon.Blazor
1.4.0
dotnet add package Babylon.Blazor --version 1.4.0
NuGet\Install-Package Babylon.Blazor -Version 1.4.0
<PackageReference Include="Babylon.Blazor" Version="1.4.0" />
paket add Babylon.Blazor --version 1.4.0
#r "nuget: Babylon.Blazor, 1.4.0"
// Install Babylon.Blazor as a Cake Addin #addin nuget:?package=Babylon.Blazor&version=1.4.0 // Install Babylon.Blazor as a Cake Tool #tool nuget:?package=Babylon.Blazor&version=1.4.0
Babylon.Blazor
This library packages the well-known 3D library Babylon.js into a Razor component that can be used in a C# Blazor project. The library is intended to use for creation of molecules visualization and used limited API of Babylon library.
Demo application .NET 5.0 - Demo application to show different parts of the library.
Demo application .NET 8.0 - Demo application to show different parts of the library.
Pubchem Viewer - Demo application using library reference. Show chemical information from pubchem.ncbi.nlm.nih.gov
Getting Started
You can find the old version (.NET 5.0 and 6.0 commpatible) on the branch net50 New version supports .NET 8.0 and I use Blazor Web App template with server prerendring for demo purposes.
Prerequisites
To create Blazor Apps, install the latest version of Visual Studio with the ASP.NET and web development workload. For using .Net 8.0 you need at least Visual Studio 2022 17.8+. Another alternative would be to use Visual Studio code. Click here for more information.
Library used IJSObjectReference
Installing
After you have created your Blazor project, you need to do the following steps:
Install the latest NuGet Package
Using Package Manager
Install-Package Babylon.Blazor
Using .NET CLI
dotnet add package Babylon.Blazor
Using MS VS Manage NuGet Packages
Search for Babylon.Blazor
Add reference to babylon js library. Add 2 lines (with babylonjs) into app.razor You will also need to add a reference to babylonInterop.js.
<body>
<Routes />
<script src="https://preview.babylonjs.com/babylon.js"></script>
<script src="https://preview.babylonjs.com/loaders/babylonjs.loaders.min.js"></script>
<script type="module" src="_content/Babylon.Blazor/babylonInterop.js"></script>
<script src="_framework/blazor.web.js"></script>
</body>
Add InstanceCreator to DI
Server Part
public class Program
{
public static async Task Main(string[] args)
{
...
builder.Services.AddTransient<InstanceCreatorBase>(sp => new InstanceCreatorAsyncMode(sp.GetService<IJSRuntime>()));
var app = builder.Build();
}
}
Note Server side support only
IJSObjectReference
Client Part
builder.Services.AddTransient<InstanceCreatorBase>(sp => new InstanceCreator(sp.GetService<IJSRuntime>()));
await builder.Build().RunAsync();
Add Razor page and replace context to similar code
@page "/test"
@using Babylon.Blazor.Chemical
@rendermode InteractiveAuto
<h1>Water</h1>
<p> Chemical formula of water is H<sub>2</sub>O</p>
<div style="height: 600px;">
<BabylonCanvas CanvasId="Canvas1" SceneData=@PanelData/>
</div>
@code {
ChemicalData PanelData { get; } = new ChemicalData();
async Task InitDataAsync()
{
// Fake await line
await Task.FromResult(1);
PanelData.Atoms.Add(new AtomDescription() { Name = "O", X = 2.5369, Y = -0.1550, Z = 0.0000 });
PanelData.Atoms.Add(new AtomDescription() { Name = "H", X = 3.0739, Y = 0.1550, Z = 0.0000 });
PanelData.Atoms.Add(new AtomDescription() { Name = "H", X = 2.0000, Y = 0.1550, Z = 0.0000 });
PanelData.Bonds.Add(new BondDescription(1, 2, BondDescription.BondType.Single));
PanelData.Bonds.Add(new BondDescription(1, 3, BondDescription.BondType.Single));
}
protected override async Task OnInitializedAsync()
{
await InitDataAsync();
}
}
Add to _Imports.razor
@using Babylon.Blazor
NOTE: You can skip this step
Demo Application
For demo application I implemented: Water, Benzene, Epinephrine and Sprite example. All descriptions was get from PubChem catalog. As I not found atom size into description - I not set it. The same is for double and triple bonds - the parallel lines rotation vector mostly oriented along the Y axis. Colors selected automatically from color palette. If chemist sees something wrong then please tell me. My goal was to create a C# interface to a Java Script library. Not to draw molecules absolutely correctly.
Water H<sub>2</sub>O
Benzene C<sub>6</sub>H<sub>6</sub>
Epinephrine C<sub>9</sub>H<sub>13</sub>NO<sub>3</sub>
In addition, I draw some tests
Test1 (not used anymore)
Test2
How it works?
With .NET 5.0 and above, it is very easy to transfer objects between Java Script and C#. Calling functions from a JS object in C# is also easy.
You can read more in article Using JS Object References in Blazor WASM to wrap JS libraries
Here is the steps you need to wrap JS library for Blazor Web Assembly application:
- Create Razor library with LibraryName.
- Create under wwwroot js export file with functions like this:
export function functionName(parameters) {
...
return javaObject;
}
- Create library wrapper
IJSInProcessObjectReference libraryWrapper = await _jSInstance.InvokeAsync<IJSInProcessObjectReference>("import",
"./_content/LibraryName/LibraryJSExport.js");
NOTE: You can get _jSInstance into main application over dependency injection or service provider call
- Create C# wrapper
public async Task<CsharpObj> CsFunctionName(int parameter)
{
var jsObjRef = await _libraryWrapper.InvokeAsync<IJSObjectReference>("jsFunctionName", parameter);
return new CsharpObj(jsObjRef);
}
- Call the wrapped function
var CsharpObj = await LibraryWrapper.CsFunctionName(2);
NOTE: you can use JS object as function parameter. Use jsObjRef for it.
How to create custom scene?
If you don't want to draw molecules then it is possible to create your own component
- Create your own creator class
public class MySceneCreator : SceneCreator
{
public override async Task CreateAsync(BabylonCanvasBase canvas)
{
...
}
}
- Create Data class
public class MyCustomData:IData
{
}
- Create new canvas
public class MyCustomCanvas : BabylonCanvasBase
{
protected virtual async Task InitializeSzene(LibraryWrapper LibraryWrapper, string canvasId)
{
MyCustomData panelData;
if (ChemicalData is MyCustomData)
{
panelData = (MyCustomData)SceneData;
MySceneCreator creator = new MySceneCreator(LibraryWrapper, canvasId, panelData);
await creator.CreateAsync(this);
}
}
}
- Create new Rasor component
@inherits MyCustomCanvas
<canvas id=@CanvasId touch-action="none" />
What's New
in Version 1.4
- update to .NET 8.0
- added show loading component. Currently we use server-side prerendering, but the babylog engine could only work client-side. The Babylon engine takes some time to render. We want to show the user a 'loading' notification instead of an empty area. The default text is "Loading...". You can change it to something else using 'LoadingTemplate'
<BabylonCanvas CanvasId="Canvas1" SceneData=@PanelData>
<LoadingTemplate>
<div>Loading Custom Demo...</div>
</LoadingTemplate>
</BabylonCanvas>
in Version 1.3
- added sprite manager
- added sprite with base attributes
- added callback function sample JS to .NET
- added sprite sample
in Version 1.2
- added single color Box
- added Torus
- added sample of custom scene drawing
in Version 1.1
New features:
- Show errors on 3D canvas
- Added new component ChemFormulaViewer
- Expand ChemicalData. Added new properties: ErrorText, MolecularFormula, Name, ShowErrorText
##Developer notes
If you want to change the library then don't use IIS express by debugging because JS files will be not easy to change.
In some cases, you can try to refresh the page from developer mode with the cache disabled.
| Product | Versions Compatible and additional computed target framework versions. |
|---|---|
| .NET | net8.0 is compatible. net8.0-android was computed. net8.0-browser was computed. net8.0-ios was computed. net8.0-maccatalyst was computed. net8.0-macos was computed. net8.0-tvos was computed. net8.0-windows was computed. |
-
net8.0
- Microsoft.AspNetCore.Components.Web (>= 8.0.0)
- Microsoft.AspNetCore.Html.Abstractions (>= 2.2.0)
NuGet packages
This package is not used by any NuGet packages.
GitHub repositories
This package is not used by any popular GitHub repositories.