This example shows how to use the Billboard cloud pipeline
// Copyright (c) Microsoft Corporation.
// Licensed under the MIT License.
#include <string>
#include <stdlib.h>
#include <filesystem>
#include <future>
#include "SimplygonLoader.h"
Simplygon::spScene LoadScene(Simplygon::ISimplygon* sg, const char* path)
{
// Create scene importer
Simplygon::spSceneImporter sgSceneImporter = sg->CreateSceneImporter();
sgSceneImporter->SetImportFilePath(path);
// Run scene importer.
bool importResult = sgSceneImporter->RunImport();
if (!importResult)
{
throw std::exception("Failed to load scene.");
}
Simplygon::spScene sgScene = sgSceneImporter->GetScene();
return sgScene;
}
void SaveScene(Simplygon::ISimplygon* sg, Simplygon::spScene sgScene, const char* path)
{
// Create scene exporter.
Simplygon::spSceneExporter sgSceneExporter = sg->CreateSceneExporter();
sgSceneExporter->SetExportFilePath(path);
sgSceneExporter->SetScene(sgScene);
// Run scene exporter.
bool exportResult = sgSceneExporter->RunExport();
if (!exportResult)
{
throw std::exception("Failed to save scene.");
}
}
void CheckLog(Simplygon::ISimplygon* sg)
{
// Check if any errors occurred.
bool hasErrors = sg->ErrorOccurred();
if (hasErrors)
{
Simplygon::spStringArray errors = sg->CreateStringArray();
sg->GetErrorMessages(errors);
auto errorCount = errors->GetItemCount();
if (errorCount > 0)
{
printf("%s\n", "Errors:");
for (auto errorIndex = 0U; errorIndex < errorCount; ++errorIndex)
{
Simplygon::spString errorString = errors->GetItem((int)errorIndex);
printf("%s\n", errorString.c_str());
}
sg->ClearErrorMessages();
}
}
else
{
printf("%s\n", "No errors.");
}
// Check if any warnings occurred.
bool hasWarnings = sg->WarningOccurred();
if (hasWarnings)
{
Simplygon::spStringArray warnings = sg->CreateStringArray();
sg->GetWarningMessages(warnings);
auto warningCount = warnings->GetItemCount();
if (warningCount > 0)
{
printf("%s\n", "Warnings:");
for (auto warningIndex = 0U; warningIndex < warningCount; ++warningIndex)
{
Simplygon::spString warningString = warnings->GetItem((int)warningIndex);
printf("%s\n", warningString.c_str());
}
sg->ClearWarningMessages();
}
}
else
{
printf("%s\n", "No warnings.");
}
}
void RunBillboardCloudPipeline(Simplygon::ISimplygon* sg)
{
// Load scene to process.
printf("%s\n", "Load scene to process.");
Simplygon::spScene sgScene = LoadScene(sg, "../../../Assets/Cages/Cages.obj");
// For all materials in the scene set the blend mode to blend (instead of opaque)
int materialCount = (int)sgScene->GetMaterialTable()->GetMaterialsCount();
for (int i = 0; i < materialCount; ++i)
{
sgScene->GetMaterialTable()->GetMaterial(i)->SetBlendMode(Simplygon::EMaterialBlendMode::Blend);
}
// Create the Impostor processor.
Simplygon::spBillboardCloudPipeline sgBillboardCloudPipeline = sg->CreateBillboardCloudPipeline();
Simplygon::spBillboardCloudSettings sgBillboardCloudSettings = sgBillboardCloudPipeline->GetBillboardCloudSettings();
Simplygon::spMappingImageSettings sgMappingImageSettings = sgBillboardCloudPipeline->GetMappingImageSettings();
// Set billboard cloud mode to Outer shell.
sgBillboardCloudSettings->SetBillboardMode( Simplygon::EBillboardMode::OuterShell );
sgBillboardCloudSettings->SetBillboardDensity( 0.5f );
sgBillboardCloudSettings->SetGeometricComplexity( 0.9f );
sgBillboardCloudSettings->SetMaxPlaneCount( 20 );
sgBillboardCloudSettings->SetTwoSided( false );
sgMappingImageSettings->SetMaximumLayers( 10 );
Simplygon::spMappingImageOutputMaterialSettings sgOutputMaterialSettings = sgMappingImageSettings->GetOutputMaterialSettings(0);
// Setting the size of the output material for the mapping image. This will be the output size of the
// textures when we do material casting in a later stage.
sgOutputMaterialSettings->SetTextureWidth( 1024 );
sgOutputMaterialSettings->SetTextureHeight( 1024 );
sgOutputMaterialSettings->SetMultisamplingLevel( 2 );
// Add diffuse material caster to pipeline.
Simplygon::spColorCaster sgDiffuseCaster = sg->CreateColorCaster();
Simplygon::spColorCasterSettings sgDiffuseCasterSettings = sgDiffuseCaster->GetColorCasterSettings();
sgDiffuseCasterSettings->SetMaterialChannel( "Diffuse" );
sgDiffuseCasterSettings->SetOutputImageFileFormat( Simplygon::EImageOutputFormat::PNG );
sgDiffuseCasterSettings->SetBakeOpacityInAlpha( false );
sgDiffuseCasterSettings->SetOutputPixelFormat( Simplygon::EPixelFormat::R8G8B8 );
sgDiffuseCasterSettings->SetDilation( 10 );
sgDiffuseCasterSettings->SetFillMode( Simplygon::EAtlasFillMode::Interpolate );
sgBillboardCloudPipeline->AddMaterialCaster( sgDiffuseCaster, 0 );
// Add specular material caster to pipeline.
Simplygon::spColorCaster sgSpecularCaster = sg->CreateColorCaster();
Simplygon::spColorCasterSettings sgSpecularCasterSettings = sgSpecularCaster->GetColorCasterSettings();
sgSpecularCasterSettings->SetMaterialChannel( "Specular" );
sgSpecularCasterSettings->SetOutputImageFileFormat( Simplygon::EImageOutputFormat::PNG );
sgSpecularCasterSettings->SetDilation( 10 );
sgSpecularCasterSettings->SetFillMode( Simplygon::EAtlasFillMode::Interpolate );
sgBillboardCloudPipeline->AddMaterialCaster( sgSpecularCaster, 0 );
// Add normals material caster to pipeline.
Simplygon::spNormalCaster sgNormalsCaster = sg->CreateNormalCaster();
Simplygon::spNormalCasterSettings sgNormalsCasterSettings = sgNormalsCaster->GetNormalCasterSettings();
sgNormalsCasterSettings->SetMaterialChannel( "Normals" );
sgNormalsCasterSettings->SetGenerateTangentSpaceNormals( true );
sgNormalsCasterSettings->SetOutputImageFileFormat( Simplygon::EImageOutputFormat::PNG );
sgNormalsCasterSettings->SetDilation( 10 );
sgNormalsCasterSettings->SetFillMode( Simplygon::EAtlasFillMode::Interpolate );
sgBillboardCloudPipeline->AddMaterialCaster( sgNormalsCaster, 0 );
// Setup and run the opacity material casting. Make sure the there is no dilation or fill.
Simplygon::spOpacityCaster sgOpacityCaster = sg->CreateOpacityCaster();
Simplygon::spOpacityCasterSettings sgOpacityCasterSettings = sgOpacityCaster->GetOpacityCasterSettings();
sgOpacityCasterSettings->SetMaterialChannel( "Opacity" );
sgOpacityCasterSettings->SetOutputImageFileFormat( Simplygon::EImageOutputFormat::PNG );
sgOpacityCasterSettings->SetFillMode( Simplygon::EAtlasFillMode::NoFill );
sgOpacityCasterSettings->SetOutputPixelFormat( Simplygon::EPixelFormat::R8 );
sgBillboardCloudPipeline->AddMaterialCaster( sgOpacityCaster, 0 );
// Start the impostor pipeline.
printf("%s\n", "Start the impostor pipeline.");
sgBillboardCloudPipeline->RunScene(sgScene, Simplygon::EPipelineRunMode::RunInThisProcess);
// Get the processed scene.
Simplygon::spScene sgProcessedScene = sgBillboardCloudPipeline->GetProcessedScene();
// Save processed scene.
printf("%s\n", "Save processed scene.");
SaveScene(sg, sgProcessedScene, "Output.glb");
// Check log for any warnings or errors.
printf("%s\n", "Check log for any warnings or errors.");
CheckLog(sg);
}
int main()
{
Simplygon::ISimplygon* sg = NULL;
Simplygon::EErrorCodes initval = Simplygon::Initialize( &sg );
if( initval != Simplygon::EErrorCodes::NoError )
{
printf( "Failed to initialize Simplygon: ErrorCode(%d)", (int)initval );
return int(initval);
}
RunBillboardCloudPipeline(sg);
Simplygon::Deinitialize(sg);
return 0;
}
// Copyright (c) Microsoft Corporation.
// Licensed under the MIT License.
using System;
using System.IO;
using System.Threading.Tasks;
public class Program
{
static Simplygon.spScene LoadScene(Simplygon.ISimplygon sg, string path)
{
// Create scene importer
using Simplygon.spSceneImporter sgSceneImporter = sg.CreateSceneImporter();
sgSceneImporter.SetImportFilePath(path);
// Run scene importer.
bool importResult = sgSceneImporter.RunImport();
if (!importResult)
{
throw new System.Exception("Failed to load scene.");
}
Simplygon.spScene sgScene = sgSceneImporter.GetScene();
return sgScene;
}
static void SaveScene(Simplygon.ISimplygon sg, Simplygon.spScene sgScene, string path)
{
// Create scene exporter.
using Simplygon.spSceneExporter sgSceneExporter = sg.CreateSceneExporter();
sgSceneExporter.SetExportFilePath(path);
sgSceneExporter.SetScene(sgScene);
// Run scene exporter.
bool exportResult = sgSceneExporter.RunExport();
if (!exportResult)
{
throw new System.Exception("Failed to save scene.");
}
}
static void CheckLog(Simplygon.ISimplygon sg)
{
// Check if any errors occurred.
bool hasErrors = sg.ErrorOccurred();
if (hasErrors)
{
Simplygon.spStringArray errors = sg.CreateStringArray();
sg.GetErrorMessages(errors);
var errorCount = errors.GetItemCount();
if (errorCount > 0)
{
Console.WriteLine("Errors:");
for (uint errorIndex = 0; errorIndex < errorCount; ++errorIndex)
{
string errorString = errors.GetItem((int)errorIndex);
Console.WriteLine(errorString);
}
sg.ClearErrorMessages();
}
}
else
{
Console.WriteLine("No errors.");
}
// Check if any warnings occurred.
bool hasWarnings = sg.WarningOccurred();
if (hasWarnings)
{
Simplygon.spStringArray warnings = sg.CreateStringArray();
sg.GetWarningMessages(warnings);
var warningCount = warnings.GetItemCount();
if (warningCount > 0)
{
Console.WriteLine("Warnings:");
for (uint warningIndex = 0; warningIndex < warningCount; ++warningIndex)
{
string warningString = warnings.GetItem((int)warningIndex);
Console.WriteLine(warningString);
}
sg.ClearWarningMessages();
}
}
else
{
Console.WriteLine("No warnings.");
}
}
static void RunBillboardCloudPipeline(Simplygon.ISimplygon sg)
{
// Load scene to process.
Console.WriteLine("Load scene to process.");
Simplygon.spScene sgScene = LoadScene(sg, "../../../Assets/Cages/Cages.obj");
// For all materials in the scene set the blend mode to blend (instead of opaque)
int materialCount = (int)sgScene.GetMaterialTable().GetMaterialsCount();
for (int i = 0; i < materialCount; ++i)
{
sgScene.GetMaterialTable().GetMaterial(i).SetBlendMode(Simplygon.EMaterialBlendMode.Blend);
}
// Create the Impostor processor.
using Simplygon.spBillboardCloudPipeline sgBillboardCloudPipeline = sg.CreateBillboardCloudPipeline();
using Simplygon.spBillboardCloudSettings sgBillboardCloudSettings = sgBillboardCloudPipeline.GetBillboardCloudSettings();
using Simplygon.spMappingImageSettings sgMappingImageSettings = sgBillboardCloudPipeline.GetMappingImageSettings();
// Set billboard cloud mode to Outer shell.
sgBillboardCloudSettings.SetBillboardMode( Simplygon.EBillboardMode.OuterShell );
sgBillboardCloudSettings.SetBillboardDensity( 0.5f );
sgBillboardCloudSettings.SetGeometricComplexity( 0.9f );
sgBillboardCloudSettings.SetMaxPlaneCount( 20 );
sgBillboardCloudSettings.SetTwoSided( false );
sgMappingImageSettings.SetMaximumLayers( 10 );
using Simplygon.spMappingImageOutputMaterialSettings sgOutputMaterialSettings = sgMappingImageSettings.GetOutputMaterialSettings(0);
// Setting the size of the output material for the mapping image. This will be the output size of the
// textures when we do material casting in a later stage.
sgOutputMaterialSettings.SetTextureWidth( 1024 );
sgOutputMaterialSettings.SetTextureHeight( 1024 );
sgOutputMaterialSettings.SetMultisamplingLevel( 2 );
// Add diffuse material caster to pipeline.
using Simplygon.spColorCaster sgDiffuseCaster = sg.CreateColorCaster();
using Simplygon.spColorCasterSettings sgDiffuseCasterSettings = sgDiffuseCaster.GetColorCasterSettings();
sgDiffuseCasterSettings.SetMaterialChannel( "Diffuse" );
sgDiffuseCasterSettings.SetOutputImageFileFormat( Simplygon.EImageOutputFormat.PNG );
sgDiffuseCasterSettings.SetBakeOpacityInAlpha( false );
sgDiffuseCasterSettings.SetOutputPixelFormat( Simplygon.EPixelFormat.R8G8B8 );
sgDiffuseCasterSettings.SetDilation( 10 );
sgDiffuseCasterSettings.SetFillMode( Simplygon.EAtlasFillMode.Interpolate );
sgBillboardCloudPipeline.AddMaterialCaster( sgDiffuseCaster, 0 );
// Add specular material caster to pipeline.
using Simplygon.spColorCaster sgSpecularCaster = sg.CreateColorCaster();
using Simplygon.spColorCasterSettings sgSpecularCasterSettings = sgSpecularCaster.GetColorCasterSettings();
sgSpecularCasterSettings.SetMaterialChannel( "Specular" );
sgSpecularCasterSettings.SetOutputImageFileFormat( Simplygon.EImageOutputFormat.PNG );
sgSpecularCasterSettings.SetDilation( 10 );
sgSpecularCasterSettings.SetFillMode( Simplygon.EAtlasFillMode.Interpolate );
sgBillboardCloudPipeline.AddMaterialCaster( sgSpecularCaster, 0 );
// Add normals material caster to pipeline.
using Simplygon.spNormalCaster sgNormalsCaster = sg.CreateNormalCaster();
using Simplygon.spNormalCasterSettings sgNormalsCasterSettings = sgNormalsCaster.GetNormalCasterSettings();
sgNormalsCasterSettings.SetMaterialChannel( "Normals" );
sgNormalsCasterSettings.SetGenerateTangentSpaceNormals( true );
sgNormalsCasterSettings.SetOutputImageFileFormat( Simplygon.EImageOutputFormat.PNG );
sgNormalsCasterSettings.SetDilation( 10 );
sgNormalsCasterSettings.SetFillMode( Simplygon.EAtlasFillMode.Interpolate );
sgBillboardCloudPipeline.AddMaterialCaster( sgNormalsCaster, 0 );
// Setup and run the opacity material casting. Make sure the there is no dilation or fill.
using Simplygon.spOpacityCaster sgOpacityCaster = sg.CreateOpacityCaster();
using Simplygon.spOpacityCasterSettings sgOpacityCasterSettings = sgOpacityCaster.GetOpacityCasterSettings();
sgOpacityCasterSettings.SetMaterialChannel( "Opacity" );
sgOpacityCasterSettings.SetOutputImageFileFormat( Simplygon.EImageOutputFormat.PNG );
sgOpacityCasterSettings.SetFillMode( Simplygon.EAtlasFillMode.NoFill );
sgOpacityCasterSettings.SetOutputPixelFormat( Simplygon.EPixelFormat.R8 );
sgBillboardCloudPipeline.AddMaterialCaster( sgOpacityCaster, 0 );
// Start the impostor pipeline.
Console.WriteLine("Start the impostor pipeline.");
sgBillboardCloudPipeline.RunScene(sgScene, Simplygon.EPipelineRunMode.RunInThisProcess);
// Get the processed scene.
using Simplygon.spScene sgProcessedScene = sgBillboardCloudPipeline.GetProcessedScene();
// Save processed scene.
Console.WriteLine("Save processed scene.");
SaveScene(sg, sgProcessedScene, "Output.glb");
// Check log for any warnings or errors.
Console.WriteLine("Check log for any warnings or errors.");
CheckLog(sg);
}
static int Main(string[] args)
{
using var sg = Simplygon.Loader.InitSimplygon(out var errorCode, out var errorMessage);
if (errorCode != Simplygon.EErrorCodes.NoError)
{
Console.WriteLine( $"Failed to initialize Simplygon: ErrorCode({(int)errorCode}) {errorMessage}" );
return (int)errorCode;
}
RunBillboardCloudPipeline(sg);
return 0;
}
}
# Copyright (c) Microsoft Corporation.
# Licensed under the MIT License.
import math
import os
import sys
import glob
import gc
import threading
from pathlib import Path
from simplygon9 import simplygon_loader
from simplygon9 import Simplygon
def LoadScene(sg: Simplygon.ISimplygon, path: str):
# Create scene importer
sgSceneImporter = sg.CreateSceneImporter()
sgSceneImporter.SetImportFilePath(path)
# Run scene importer.
importResult = sgSceneImporter.RunImport()
if not importResult:
raise Exception('Failed to load scene.')
sgScene = sgSceneImporter.GetScene()
return sgScene
def SaveScene(sg: Simplygon.ISimplygon, sgScene:Simplygon.spScene, path: str):
# Create scene exporter.
sgSceneExporter = sg.CreateSceneExporter()
sgSceneExporter.SetExportFilePath(path)
sgSceneExporter.SetScene(sgScene)
# Run scene exporter.
exportResult = sgSceneExporter.RunExport()
if not exportResult:
raise Exception('Failed to save scene.')
def CheckLog(sg: Simplygon.ISimplygon):
# Check if any errors occurred.
hasErrors = sg.ErrorOccurred()
if hasErrors:
errors = sg.CreateStringArray()
sg.GetErrorMessages(errors)
errorCount = errors.GetItemCount()
if errorCount > 0:
print("Errors:")
for errorIndex in range(errorCount):
errorString = errors.GetItem(errorIndex)
print(errorString)
sg.ClearErrorMessages()
else:
print("No errors.")
# Check if any warnings occurred.
hasWarnings = sg.WarningOccurred()
if hasWarnings:
warnings = sg.CreateStringArray()
sg.GetWarningMessages(warnings)
warningCount = warnings.GetItemCount()
if warningCount > 0:
print("Warnings:")
for warningIndex in range(warningCount):
warningString = warnings.GetItem(warningIndex)
print(warningString)
sg.ClearWarningMessages()
else:
print("No warnings.")
def RunBillboardCloudPipeline(sg: Simplygon.ISimplygon):
# Load scene to process.
print("Load scene to process.")
sgScene = LoadScene(sg, "../../../Assets/Cages/Cages.obj")
# For all materials in the scene set the blend mode to blend (instead of opaque)
materialCount = sgScene.GetMaterialTable().GetMaterialsCount()
for i in range(0, materialCount):
sgScene.GetMaterialTable().GetMaterial(i).SetBlendMode(Simplygon.EMaterialBlendMode_Blend)
# Create the Impostor processor.
sgBillboardCloudPipeline = sg.CreateBillboardCloudPipeline()
sgBillboardCloudSettings = sgBillboardCloudPipeline.GetBillboardCloudSettings()
sgMappingImageSettings = sgBillboardCloudPipeline.GetMappingImageSettings()
# Set billboard cloud mode to Outer shell.
sgBillboardCloudSettings.SetBillboardMode( Simplygon.EBillboardMode_OuterShell )
sgBillboardCloudSettings.SetBillboardDensity( 0.5 )
sgBillboardCloudSettings.SetGeometricComplexity( 0.9 )
sgBillboardCloudSettings.SetMaxPlaneCount( 20 )
sgBillboardCloudSettings.SetTwoSided( False )
sgMappingImageSettings.SetMaximumLayers( 10 )
sgOutputMaterialSettings = sgMappingImageSettings.GetOutputMaterialSettings(0)
# Setting the size of the output material for the mapping image. This will be the output size of the
# textures when we do material casting in a later stage.
sgOutputMaterialSettings.SetTextureWidth( 1024 )
sgOutputMaterialSettings.SetTextureHeight( 1024 )
sgOutputMaterialSettings.SetMultisamplingLevel( 2 )
# Add diffuse material caster to pipeline.
sgDiffuseCaster = sg.CreateColorCaster()
sgDiffuseCasterSettings = sgDiffuseCaster.GetColorCasterSettings()
sgDiffuseCasterSettings.SetMaterialChannel( "Diffuse" )
sgDiffuseCasterSettings.SetOutputImageFileFormat( Simplygon.EImageOutputFormat_PNG )
sgDiffuseCasterSettings.SetBakeOpacityInAlpha( False )
sgDiffuseCasterSettings.SetOutputPixelFormat( Simplygon.EPixelFormat_R8G8B8 )
sgDiffuseCasterSettings.SetDilation( 10 )
sgDiffuseCasterSettings.SetFillMode( Simplygon.EAtlasFillMode_Interpolate )
sgBillboardCloudPipeline.AddMaterialCaster( sgDiffuseCaster, 0 )
# Add specular material caster to pipeline.
sgSpecularCaster = sg.CreateColorCaster()
sgSpecularCasterSettings = sgSpecularCaster.GetColorCasterSettings()
sgSpecularCasterSettings.SetMaterialChannel( "Specular" )
sgSpecularCasterSettings.SetOutputImageFileFormat( Simplygon.EImageOutputFormat_PNG )
sgSpecularCasterSettings.SetDilation( 10 )
sgSpecularCasterSettings.SetFillMode( Simplygon.EAtlasFillMode_Interpolate )
sgBillboardCloudPipeline.AddMaterialCaster( sgSpecularCaster, 0 )
# Add normals material caster to pipeline.
sgNormalsCaster = sg.CreateNormalCaster()
sgNormalsCasterSettings = sgNormalsCaster.GetNormalCasterSettings()
sgNormalsCasterSettings.SetMaterialChannel( "Normals" )
sgNormalsCasterSettings.SetGenerateTangentSpaceNormals( True )
sgNormalsCasterSettings.SetOutputImageFileFormat( Simplygon.EImageOutputFormat_PNG )
sgNormalsCasterSettings.SetDilation( 10 )
sgNormalsCasterSettings.SetFillMode( Simplygon.EAtlasFillMode_Interpolate )
sgBillboardCloudPipeline.AddMaterialCaster( sgNormalsCaster, 0 )
# Setup and run the opacity material casting. Make sure the there is no dilation or fill.
sgOpacityCaster = sg.CreateOpacityCaster()
sgOpacityCasterSettings = sgOpacityCaster.GetOpacityCasterSettings()
sgOpacityCasterSettings.SetMaterialChannel( "Opacity" )
sgOpacityCasterSettings.SetOutputImageFileFormat( Simplygon.EImageOutputFormat_PNG )
sgOpacityCasterSettings.SetFillMode( Simplygon.EAtlasFillMode_NoFill )
sgOpacityCasterSettings.SetOutputPixelFormat( Simplygon.EPixelFormat_R8 )
sgBillboardCloudPipeline.AddMaterialCaster( sgOpacityCaster, 0 )
# Start the impostor pipeline.
print("Start the impostor pipeline.")
sgBillboardCloudPipeline.RunScene(sgScene, Simplygon.EPipelineRunMode_RunInThisProcess)
# Get the processed scene.
sgProcessedScene = sgBillboardCloudPipeline.GetProcessedScene()
# Save processed scene.
print("Save processed scene.")
SaveScene(sg, sgProcessedScene, "Output.glb")
# Check log for any warnings or errors.
print("Check log for any warnings or errors.")
CheckLog(sg)
if __name__ == '__main__':
sg = simplygon_loader.init_simplygon()
if sg is None:
exit(Simplygon.GetLastInitializationError())
RunBillboardCloudPipeline(sg)
sg = None
gc.collect()