This example shows how to use the Aggregation pipeline with a visibility occluder.
// 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.
auto importResult = sgSceneImporter->Run();
if (Simplygon::Failed(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();
std::string outputScenePath = std::string("output\\") + std::string("AggregationPipelineWithVisibilityOccluder") + std::string("_") + std::string(path);
sgSceneExporter->SetExportFilePath(outputScenePath.c_str());
sgSceneExporter->SetScene(sgScene);
// Run scene exporter.
auto exportResult = sgSceneExporter->Run();
if (Simplygon::Failed(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.");
}
// Error out if Simplygon has errors.
if (hasErrors)
{
throw std::exception("Processing failed with an error");
}
}
void RunAggregation(Simplygon::ISimplygon* sg)
{
// Load scene to process.
printf("%s\n", "Load scene to process.");
Simplygon::spScene sgScene = LoadScene(sg, "../../../Assets/ObscuredTeapot/ObscuredTeapot.obj");
// Create the aggregation pipeline.
Simplygon::spAggregationPipeline sgAggregationPipeline = sg->CreateAggregationPipeline();
Simplygon::spAggregationSettings sgAggregationSettings = sgAggregationPipeline->GetAggregationSettings();
Simplygon::spVisibilitySettings sgVisibilitySettings = sgAggregationPipeline->GetVisibilitySettings();
// Merge all geometries into a single geometry.
sgAggregationSettings->SetMergeGeometries( true );
// Add a selection set to the scene. We'll use this later as a occluder.
Simplygon::spSelectionSetTable sgSceneSelectionSetTable = sgScene->GetSelectionSetTable();
Simplygon::spSelectionSet sgOccluderSelectionSet = sg->CreateSelectionSet();
sgOccluderSelectionSet->SetName("Occluder");
Simplygon::spSceneNode sgRootBox002 = sgScene->GetNodeFromPath("Root/Box002");
if (!sgRootBox002.IsNull())
sgOccluderSelectionSet->AddItem(sgRootBox002->GetNodeGUID());
sgSceneSelectionSetTable->AddSelectionSet(sgOccluderSelectionSet);
// Use the occluder previously added.
sgVisibilitySettings->SetOccluderSelectionSetName( "Occluder" );
// Enabled GPU based visibility calculations.
sgVisibilitySettings->SetComputeVisibilityMode( Simplygon::EComputeVisibilityMode::DirectX );
// Disabled conservative mode.
sgVisibilitySettings->SetConservativeMode( false );
// Remove all non visible geometry.
sgVisibilitySettings->SetCullOccludedGeometry( true );
// Skip filling nonvisible regions.
sgVisibilitySettings->SetFillNonVisibleAreaThreshold( 0.0f );
// Don't remove non occluding triangles.
sgVisibilitySettings->SetRemoveTrianglesNotOccludingOtherTriangles( false );
// Remove all back facing triangles.
sgVisibilitySettings->SetUseBackfaceCulling( true );
// Don't use visibility weights.
sgVisibilitySettings->SetUseVisibilityWeightsInReducer( false );
// Start the aggregation pipeline.
printf("%s\n", "Start the aggregation pipeline.");
sgAggregationPipeline->RunScene(sgScene, Simplygon::EPipelineRunMode::RunInThisProcess);
// Get the processed scene.
Simplygon::spScene sgProcessedScene = sgAggregationPipeline->GetProcessedScene();
// Save processed scene.
printf("%s\n", "Save processed scene.");
SaveScene(sg, sgProcessedScene, "Output.fbx");
// 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);
}
RunAggregation(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.
var importResult = sgSceneImporter.Run();
if (Simplygon.Simplygon.Failed(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();
string outputScenePath = string.Join("", new string[] { "output\\", "AggregationPipelineWithVisibilityOccluder", "_", path });
sgSceneExporter.SetExportFilePath(outputScenePath);
sgSceneExporter.SetScene(sgScene);
// Run scene exporter.
var exportResult = sgSceneExporter.Run();
if (Simplygon.Simplygon.Failed(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.");
}
// Error out if Simplygon has errors.
if (hasErrors)
{
throw new System.Exception("Processing failed with an error");
}
}
static void RunAggregation(Simplygon.ISimplygon sg)
{
// Load scene to process.
Console.WriteLine("Load scene to process.");
Simplygon.spScene sgScene = LoadScene(sg, "../../../Assets/ObscuredTeapot/ObscuredTeapot.obj");
// Create the aggregation pipeline.
using Simplygon.spAggregationPipeline sgAggregationPipeline = sg.CreateAggregationPipeline();
using Simplygon.spAggregationSettings sgAggregationSettings = sgAggregationPipeline.GetAggregationSettings();
using Simplygon.spVisibilitySettings sgVisibilitySettings = sgAggregationPipeline.GetVisibilitySettings();
// Merge all geometries into a single geometry.
sgAggregationSettings.SetMergeGeometries( true );
// Add a selection set to the scene. We'll use this later as a occluder.
using Simplygon.spSelectionSetTable sgSceneSelectionSetTable = sgScene.GetSelectionSetTable();
using Simplygon.spSelectionSet sgOccluderSelectionSet = sg.CreateSelectionSet();
sgOccluderSelectionSet.SetName("Occluder");
Simplygon.spSceneNode sgRootBox002 = sgScene.GetNodeFromPath("Root/Box002");
if (!sgRootBox002.IsNull())
sgOccluderSelectionSet.AddItem(sgRootBox002.GetNodeGUID());
sgSceneSelectionSetTable.AddSelectionSet(sgOccluderSelectionSet);
// Use the occluder previously added.
sgVisibilitySettings.SetOccluderSelectionSetName( "Occluder" );
// Enabled GPU based visibility calculations.
sgVisibilitySettings.SetComputeVisibilityMode( Simplygon.EComputeVisibilityMode.DirectX );
// Disabled conservative mode.
sgVisibilitySettings.SetConservativeMode( false );
// Remove all non visible geometry.
sgVisibilitySettings.SetCullOccludedGeometry( true );
// Skip filling nonvisible regions.
sgVisibilitySettings.SetFillNonVisibleAreaThreshold( 0.0f );
// Don't remove non occluding triangles.
sgVisibilitySettings.SetRemoveTrianglesNotOccludingOtherTriangles( false );
// Remove all back facing triangles.
sgVisibilitySettings.SetUseBackfaceCulling( true );
// Don't use visibility weights.
sgVisibilitySettings.SetUseVisibilityWeightsInReducer( false );
// Start the aggregation pipeline.
Console.WriteLine("Start the aggregation pipeline.");
sgAggregationPipeline.RunScene(sgScene, Simplygon.EPipelineRunMode.RunInThisProcess);
// Get the processed scene.
using Simplygon.spScene sgProcessedScene = sgAggregationPipeline.GetProcessedScene();
// Save processed scene.
Console.WriteLine("Save processed scene.");
SaveScene(sg, sgProcessedScene, "Output.fbx");
// 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;
}
RunAggregation(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 simplygon10 import simplygon_loader
from simplygon10 import Simplygon
def LoadScene(sg: Simplygon.ISimplygon, path: str):
# Create scene importer
sgSceneImporter = sg.CreateSceneImporter()
sgSceneImporter.SetImportFilePath(path)
# Run scene importer.
importResult = sgSceneImporter.Run()
if Simplygon.Failed(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()
outputScenePath = ''.join(['output\\', 'AggregationPipelineWithVisibilityOccluder', '_', path])
sgSceneExporter.SetExportFilePath(outputScenePath)
sgSceneExporter.SetScene(sgScene)
# Run scene exporter.
exportResult = sgSceneExporter.Run()
if Simplygon.Failed(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.')
# Error out if Simplygon has errors.
if hasErrors:
raise Exception('Processing failed with an error')
def RunAggregation(sg: Simplygon.ISimplygon):
# Load scene to process.
print("Load scene to process.")
sgScene = LoadScene(sg, '../../../Assets/ObscuredTeapot/ObscuredTeapot.obj')
# Create the aggregation pipeline.
sgAggregationPipeline = sg.CreateAggregationPipeline()
sgAggregationSettings = sgAggregationPipeline.GetAggregationSettings()
sgVisibilitySettings = sgAggregationPipeline.GetVisibilitySettings()
# Merge all geometries into a single geometry.
sgAggregationSettings.SetMergeGeometries( True )
# Add a selection set to the scene. We'll use this later as a occluder.
sgSceneSelectionSetTable = sgScene.GetSelectionSetTable()
sgOccluderSelectionSet = sg.CreateSelectionSet()
sgOccluderSelectionSet.SetName("Occluder")
sgRootBox002 = sgScene.GetNodeFromPath('Root/Box002')
if sgRootBox002 is not None:
sgOccluderSelectionSet.AddItem(sgRootBox002.GetNodeGUID())
sgSceneSelectionSetTable.AddSelectionSet(sgOccluderSelectionSet)
# Use the occluder previously added.
sgVisibilitySettings.SetOccluderSelectionSetName( 'Occluder' )
# Enabled GPU based visibility calculations.
sgVisibilitySettings.SetComputeVisibilityMode( Simplygon.EComputeVisibilityMode_DirectX )
# Disabled conservative mode.
sgVisibilitySettings.SetConservativeMode( False )
# Remove all non visible geometry.
sgVisibilitySettings.SetCullOccludedGeometry( True )
# Skip filling nonvisible regions.
sgVisibilitySettings.SetFillNonVisibleAreaThreshold( 0.0 )
# Don't remove non occluding triangles.
sgVisibilitySettings.SetRemoveTrianglesNotOccludingOtherTriangles( False )
# Remove all back facing triangles.
sgVisibilitySettings.SetUseBackfaceCulling( True )
# Don't use visibility weights.
sgVisibilitySettings.SetUseVisibilityWeightsInReducer( False )
# Start the aggregation pipeline.
print("Start the aggregation pipeline.")
sgAggregationPipeline.RunScene(sgScene, Simplygon.EPipelineRunMode_RunInThisProcess)
# Get the processed scene.
sgProcessedScene = sgAggregationPipeline.GetProcessedScene()
# Save processed scene.
print("Save processed scene.")
SaveScene(sg, sgProcessedScene, 'Output.fbx')
# 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())
RunAggregation(sg)
sg = None
gc.collect()