Skip to content

Commit

Permalink
Add sample for testing glTF instancing.
Browse files Browse the repository at this point in the history
Fixes #1513.
  • Loading branch information
prideout committed May 28, 2020
1 parent e495b95 commit 1977214
Show file tree
Hide file tree
Showing 4 changed files with 296 additions and 9 deletions.
1 change: 1 addition & 0 deletions RELEASE_NOTES.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,7 @@ A new header is inserted each time a *tag* is created.

## Next release

- gltfio now supports simple instancing of entire assets.
- Add missing JavaScript API for `View::setVisibleLayers()`.
- Add support for DOF with Metal backend.
- SSAO now has an optional high(er) quality upsampler.
Expand Down
9 changes: 6 additions & 3 deletions libs/gltfio/include/gltfio/SimpleViewer.h
Original file line number Diff line number Diff line change
Expand Up @@ -78,8 +78,10 @@ class SimpleViewer {
*
* @param asset The asset to view.
* @param scale Adds a transform to the root to fit the asset into a unit cube at the origin.
* @param instanceToAnimate Optional instance from which to get the animator.
*/
void populateScene(FilamentAsset* asset, bool scale);
void populateScene(FilamentAsset* asset, bool scale,
FilamentInstance* instanceToAnimate = nullptr);

/**
* Removes the current asset from the viewer.
Expand Down Expand Up @@ -270,15 +272,16 @@ SimpleViewer::~SimpleViewer() {
mEngine->destroy(mSunlight);
}

void SimpleViewer::populateScene(FilamentAsset* asset, bool scale) {
void SimpleViewer::populateScene(FilamentAsset* asset, bool scale,
FilamentInstance* instanceToAnimate) {
if (mAsset != asset) {
removeAsset();
mAsset = asset;
if (!asset) {
mAnimator = nullptr;
return;
}
mAnimator = asset->getAnimator();
mAnimator = instanceToAnimate ? instanceToAnimate->getAnimator() : asset->getAnimator();
if (scale) {
auto& tcm = mEngine->getTransformManager();
auto root = tcm.getInstance(mAsset->getRoot());
Expand Down
8 changes: 2 additions & 6 deletions samples/CMakeLists.txt
Original file line number Diff line number Diff line change
Expand Up @@ -221,6 +221,7 @@ if (NOT ANDROID)
add_demo(depthtesting)
add_demo(frame_generator)
add_demo(gltf_viewer)
add_demo(gltf_instances)
add_demo(heightfield)
add_demo(hellopbr)
add_demo(hellotriangle)
Expand All @@ -240,6 +241,7 @@ if (NOT ANDROID)
# Sample app specific
target_link_libraries(frame_generator PRIVATE imageio)
target_link_libraries(gltf_viewer PRIVATE gltf-resources gltfio)
target_link_libraries(gltf_instances PRIVATE gltf-resources gltfio)
target_link_libraries(hellopbr PRIVATE filameshio suzanne-resources)
target_link_libraries(sample_cloth PRIVATE filameshio)
target_link_libraries(sample_normal_map PRIVATE filameshio)
Expand Down Expand Up @@ -293,9 +295,3 @@ add_dependencies(filament assets)

add_custom_target(envs DEPENDS ${target_envmaps})
add_dependencies(filament envs)

add_custom_target(run_gltf_viewer DEPENDS gltf_viewer assets
COMMAND gltf_viewer)

add_custom_target(run_material_sandbox DEPENDS material_sandbox assets
COMMAND material_sandbox --ibl=venetian_crossroads_2k assets/models/material_sphere/material_sphere.obj)
287 changes: 287 additions & 0 deletions samples/gltf_instances.cpp
Original file line number Diff line number Diff line change
@@ -0,0 +1,287 @@
/*
* Copyright (C) 2020 The Android Open Source Project
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/

#define GLTFIO_SIMPLEVIEWER_IMPLEMENTATION

#include <filamentapp/Config.h>
#include <filamentapp/FilamentApp.h>
#include <filamentapp/IBL.h>

#include <filament/Engine.h>
#include <filament/Scene.h>
#include <filament/Skybox.h>
#include <filament/View.h>

#include <gltfio/AssetLoader.h>
#include <gltfio/FilamentAsset.h>
#include <gltfio/ResourceLoader.h>
#include <gltfio/SimpleViewer.h>

#include <camutils/Manipulator.h>

#include <getopt/getopt.h>

#include <utils/NameComponentManager.h>

#include <iostream>
#include <fstream>
#include <string>

#include <math/mat4.h>

#include "generated/resources/gltf_viewer.h"

using namespace filament;
using namespace filament::math;
using namespace gltfio;
using namespace utils;

using InstanceHandle = FilamentInstance*;

struct App {
Engine* engine;
SimpleViewer* viewer;
Config config;
AssetLoader* loader;
FilamentAsset* asset = nullptr;
NameComponentManager* names;
MaterialProvider* materials;
MaterialSource materialSource = GENERATE_SHADERS;
ResourceLoader* resourceLoader = nullptr;
int numInstances = 5;
int instanceToAnimate = -1;
InstanceHandle* instances;
};

static const char* DEFAULT_IBL = "venetian_crossroads_2k";

static void printUsage(char* name) {
std::string exec_name(Path(name).getName());
std::string usage(
"SHOWCASE renders the specified glTF file with instancing\n"
"Usage:\n"
" SHOWCASE [options] <gltf path>\n"
"Options:\n"
" --help, -h\n"
" Prints this message\n\n"
" --api, -a\n"
" Specify the backend API: opengl (default), vulkan, or metal\n\n"
" --ibl=<path to cmgen IBL>, -i <path>\n"
" Override the built-in IBL\n\n"
" --num=<number of instances>, -n <num>\n"
" Number of instances (defaults to 5)\n\n"
" --animate=<instance index>, -m <num>\n"
" Instance to animate (defaults to all instances)\n\n"
" --ubershader, -u\n"
" Enable ubershaders (improves load time, adds shader complexity)\n\n"
);
const std::string from("SHOWCASE");
for (size_t pos = usage.find(from); pos != std::string::npos; pos = usage.find(from, pos)) {
usage.replace(pos, from.length(), exec_name);
}
std::cout << usage;
}

static int handleCommandLineArguments(int argc, char* argv[], App* app) {
static constexpr const char* OPTSTR = "ha:i:un:m:";
static const struct option OPTIONS[] = {
{ "help", no_argument, nullptr, 'h' },
{ "api", required_argument, nullptr, 'a' },
{ "ibl", required_argument, nullptr, 'i' },
{ "num", required_argument, nullptr, 'n' },
{ "animate", required_argument, nullptr, 'm' },
{ "ubershader", no_argument, nullptr, 'u' },
{ nullptr, 0, nullptr, 0 }
};
int opt;
int option_index = 0;
while ((opt = getopt_long(argc, argv, OPTSTR, OPTIONS, &option_index)) >= 0) {
std::string arg(optarg ? optarg : "");
switch (opt) {
default:
case 'h':
printUsage(argv[0]);
exit(0);
case 'a':
if (arg == "opengl") {
app->config.backend = Engine::Backend::OPENGL;
} else if (arg == "vulkan") {
app->config.backend = Engine::Backend::VULKAN;
} else if (arg == "metal") {
app->config.backend = Engine::Backend::METAL;
} else {
std::cerr << "Unrecognized backend. Must be 'opengl'|'vulkan'|'metal'.\n";
}
break;
case 'm':
app->instanceToAnimate = atoi(arg.c_str());
break;
case 'n':
app->numInstances = atoi(arg.c_str());
break;
case 'i':
app->config.iblDirectory = arg;
break;
case 'u':
app->materialSource = LOAD_UBERSHADERS;
break;
}
}
return optind;
}

static std::ifstream::pos_type getFileSize(const char* filename) {
std::ifstream in(filename, std::ifstream::ate | std::ifstream::binary);
return in.tellg();
}

int main(int argc, char** argv) {
App app;

app.config.title = "glTF Instancing";
app.config.iblDirectory = FilamentApp::getRootAssetsPath() + DEFAULT_IBL;

int optionIndex = handleCommandLineArguments(argc, argv, &app);
utils::Path filename;
int num_args = argc - optionIndex;
if (num_args >= 1) {
filename = argv[optionIndex];
if (!filename.exists()) {
std::cerr << "file " << filename << " not found!" << std::endl;
return 1;
}
}

auto loadAsset = [&app](utils::Path filename) {
// Peek at the file size to allow pre-allocation.
long contentSize = static_cast<long>(getFileSize(filename.c_str()));
if (contentSize <= 0) {
std::cerr << "Unable to open " << filename << std::endl;
exit(1);
}

// Consume the glTF file.
std::ifstream in(filename.c_str(), std::ifstream::binary | std::ifstream::in);
std::vector<uint8_t> buffer(static_cast<unsigned long>(contentSize));
if (!in.read((char*) buffer.data(), contentSize)) {
std::cerr << "Unable to read " << filename << std::endl;
exit(1);
}

// Parse the glTF file and create Filament entities.
app.asset = app.loader->createInstancedAsset(buffer.data(), buffer.size(), app.instances,
app.numInstances);
buffer.clear();
buffer.shrink_to_fit();

if (!app.asset) {
std::cerr << "Unable to parse " << filename << std::endl;
exit(1);
}
};

auto loadResources = [&app] (utils::Path filename) {
// Load external textures and buffers.
std::string gltfPath = filename.getAbsolutePath();
ResourceConfiguration configuration;
configuration.engine = app.engine;
configuration.gltfPath = gltfPath.c_str();
configuration.normalizeSkinningWeights = true;
configuration.recomputeBoundingBoxes = false;
if (!app.resourceLoader) {
app.resourceLoader = new gltfio::ResourceLoader(configuration);
}
app.resourceLoader->asyncBeginLoad(app.asset);

// Load animation data then free the source hierarchy.
app.asset->getAnimator();
if (app.instanceToAnimate > -1) {
app.instances[app.instanceToAnimate]->getAnimator();
}
app.asset->releaseSourceData();

auto ibl = FilamentApp::get().getIBL();
if (ibl) {
app.viewer->setIndirectLight(ibl->getIndirectLight(), ibl->getSphericalHarmonics());
}
};

auto setup = [&](Engine* engine, View* view, Scene* scene) {
app.engine = engine;
app.names = new NameComponentManager(EntityManager::get());
app.viewer = new SimpleViewer(engine, scene, view, app.instanceToAnimate);
app.materials = (app.materialSource == GENERATE_SHADERS) ?
createMaterialGenerator(engine) : createUbershaderLoader(engine);
app.loader = AssetLoader::create({engine, app.materials, app.names });
app.instances = new InstanceHandle[app.numInstances];
if (filename.isEmpty()) {
app.asset = app.loader->createInstancedAsset(
GLTF_VIEWER_DAMAGEDHELMET_DATA, GLTF_VIEWER_DAMAGEDHELMET_SIZE,
app.instances, app.numInstances);
} else {
loadAsset(filename);
}

// Arrange all instances into a circle.
auto& tcm = engine->getTransformManager();
auto extent = app.asset->getBoundingBox().extent();
float max_extent = std::max(std::max(extent.x, extent.y), extent.z);
auto translation = mat4f::translation(float3(max_extent, 0, 0));
for (size_t inst = 0; inst < app.numInstances; ++inst) {
FilamentInstance* instance = app.instances[inst];
auto transformRoot = tcm.getInstance(instance->getRoot());
float theta = inst * 2.0 * M_PI / app.numInstances;
auto rotation = mat4f::rotation(theta, float3(0, 0, 1));
tcm.setTransform(transformRoot, rotation * translation);
}

loadResources(filename);
};

auto cleanup = [&app](Engine* engine, View*, Scene*) {
app.loader->destroyAsset(app.asset);
app.materials->destroyMaterials();

delete app.viewer;
delete app.materials;
delete app.names;

AssetLoader::destroy(&app.loader);

delete[] app.instances;
};

auto animate = [&app](Engine* engine, View* view, double now) {
app.resourceLoader->asyncUpdateLoad();
FilamentInstance* instance = nullptr;
if (app.instanceToAnimate > -1) {
instance = app.instances[app.instanceToAnimate];
}
app.viewer->populateScene(app.asset, true, instance);
app.viewer->applyAnimation(now);
};

auto gui = [&app](Engine* engine, View* view) { };

auto preRender = [&app](Engine* engine, View* view, Scene* scene, Renderer* renderer) { };

FilamentApp& filamentApp = FilamentApp::get();
filamentApp.animate(animate);

filamentApp.run(app.config, setup, cleanup, gui, preRender);

return 0;
}

0 comments on commit 1977214

Please sign in to comment.