L3D.Net 0.10.0

L3D .NET library

Intro

.NET Standard 2.0 library for the Luminaire 3D L3D

With the library it is possible to read and build L3D container files. For that the library exposes two classes 'Builder' and 'Reader'. The Builder has a fluent API for defining all the luminaire parts and build the target container file. With the Reader is is possible to read the content of a L3D container and to parse the containing .obj files at once. So there is no other .obj parser needed.

How to get started

Requirements

• .NET Standard 2.0 compatible project

Nuget package

Add the package within your IDE or using the CLI

dotnet add package L3D.Net

Building a L3D container

Simple builder exmaple.

Builder.NewLuminaire()
    .WithTool("Example-Tool")
    .AddGeometry("luminairePartName", "path/to/model.obj", GeometricUnits.m, geomOptions => geomOptions
        .AddRectangularLightEmittingObject("lightEmittingPartName", 0.5, 0.25, leoOptions => leoOptions
            .WithLightEmittingSurfaceOnParent(3)
        )
    )
    .Build("path/to/new/container.l3d");

Reading a L3D container

Read an L3D container from disk:

var reader = new Reader();
var container = reader.ReadContainer("path/to/container.l3d");

foreach (var geometryPartDto in container.Parts)
{
    // ...
    var model = geometryPartDto.GeometryDefinition.Model;
    foreach (var vertex in model.Vertices)
    {
        // .obj-Model vertices
    }

    // ...
    
    foreach (var lightEmittingPartDto in geometryPartDto.LightEmittingObjects)
    {
        // do something for light emitting part 
    }

    // ...
}

Read an L3D container already read from disk in byte array (byte[]) format:

var reader = new Reader();
byte[] l3dContainer = // Get a byte[] representation of an L3D container;
var container = reader.ReadContainer(l3dContainer);

foreach (var geometryPartDto in container.Parts)
{
    // From here on out everything is identical to the reading an L3D container from disk example,
    // see the code sample above.
}

Validating a L3D container

Validation of an L3D container from disk:

var validator = new Validator();
var validationResult = validator.ValidateContainer("path/to/container.l3d");

if (validationResult)
    // Container validation successful
else
    // Container validation unsuccessful

Validation of an L3D container already read from disk in byte array (byte[]) format:

var validator = new Validator();
byte[] l3dContainer = // Get a byte[] representation of an L3D container;
var validationResult = validator.ValidateContainer(l3dContainer);

if (validationResult)
    // Container validation successful
else
    // Container validation unsuccessful

Questions, Issues & Contribution

Please use the discussion section for questions or create issues, when something seems to be wrong. PRs are welcome.