feature!:
This is a breaking change needed to fully implement instancing and stencil highlighting.
Previously, users would work directly with entities (on the Dart side, ThermionEntity), e.g.
final entity = await viewer.loadGlb("some.glb");
However, Filament "entities" are a lower-level abstraction.
Loading a glTF file, for example, inserts multiple entities into the scene.
For example, each mesh, light, and camera within a glTF asset will be assigned an entity. A top-level (non-renderable) entity will also be created for the glTF asset, which can be used to transform the entire hierarchy.
"Asset" is a better representation for loading/inserting objects into the scene; think of this as a bundle of entities.
Unless you need to work directly with transforms, instancing, materials and renderables, you can work directly with ThermionAsset.
This commit is contained in:
Nick Fisher
@@ -1,172 +1,178 @@
|
||||
#include <filament/Material.h>
|
||||
#include <filament/MaterialInstance.h>
|
||||
#include <utils/EntityManager.h>
|
||||
// #include <filament/Material.h>
|
||||
// #include <filament/MaterialInstance.h>
|
||||
// #include <utils/EntityManager.h>
|
||||
|
||||
#include "SceneManager.hpp"
|
||||
// #include "scene/SceneManager.hpp"
|
||||
|
||||
namespace thermion
|
||||
{
|
||||
// namespace thermion
|
||||
// {
|
||||
|
||||
SceneManager::HighlightOverlay::HighlightOverlay(
|
||||
EntityId entityId,
|
||||
SceneManager *const sceneManager,
|
||||
Engine *engine,
|
||||
float r,
|
||||
float g,
|
||||
float b) : _sceneManager(sceneManager), _engine(engine)
|
||||
{
|
||||
// SceneManager::HighlightOverlay::HighlightOverlay(
|
||||
// EntityId entityId,
|
||||
// SceneManager *const sceneManager,
|
||||
// Engine *engine,
|
||||
// float r,
|
||||
// float g,
|
||||
// float b) : _sceneManager(sceneManager), _engine(engine)
|
||||
// {
|
||||
|
||||
auto &rm = engine->getRenderableManager();
|
||||
// auto &rm = engine->getRenderableManager();
|
||||
|
||||
auto &tm = engine->getTransformManager();
|
||||
// auto &tm = engine->getTransformManager();
|
||||
|
||||
// Create the outline/highlight material instance
|
||||
filament::gltfio::MaterialKey dummyKey; // We're not using the key for this simple material
|
||||
filament::gltfio::UvMap dummyUvMap; // We're not using UV mapping for this simple material
|
||||
// // Create the outline/highlight material instance
|
||||
// filament::gltfio::MaterialKey dummyKey; // We're not using the key for this simple material
|
||||
// filament::gltfio::UvMap dummyUvMap; // We're not using UV mapping for this simple material
|
||||
|
||||
auto materialProvider = sceneManager->unlitMaterialProvider();
|
||||
// auto materialProvider = sceneManager->unlitMaterialProvider();
|
||||
|
||||
_highlightMaterialInstance = materialProvider->createMaterialInstance(&dummyKey, &dummyUvMap);
|
||||
_highlightMaterialInstance->setStencilOpStencilFail(filament::backend::StencilOperation::KEEP);
|
||||
_highlightMaterialInstance->setStencilOpDepthFail(filament::backend::StencilOperation::KEEP);
|
||||
_highlightMaterialInstance->setStencilOpDepthStencilPass(filament::backend::StencilOperation::REPLACE);
|
||||
_highlightMaterialInstance->setStencilCompareFunction(filament::backend::SamplerCompareFunc::NE);
|
||||
_highlightMaterialInstance->setStencilReferenceValue(1);
|
||||
// _highlightMaterialInstance = materialProvider->createMaterialInstance(&dummyKey, &dummyUvMap);
|
||||
// _highlightMaterialInstance->setStencilOpStencilFail(filament::backend::StencilOperation::KEEP);
|
||||
// _highlightMaterialInstance->setStencilOpDepthFail(filament::backend::StencilOperation::KEEP);
|
||||
// _highlightMaterialInstance->setStencilOpDepthStencilPass(filament::backend::StencilOperation::REPLACE);
|
||||
// _highlightMaterialInstance->setStencilCompareFunction(filament::backend::SamplerCompareFunc::NE);
|
||||
// _highlightMaterialInstance->setStencilReferenceValue(1);
|
||||
|
||||
_highlightMaterialInstance->setParameter("baseColorFactor", filament::math::float3{r, g, b});
|
||||
_highlightMaterialInstance->setParameter("vertexScale", 1.04f);
|
||||
_highlightMaterialInstance->setCullingMode(filament::backend::CullingMode::FRONT);
|
||||
// _highlightMaterialInstance->setParameter("baseColorFactor", filament::math::float3{r, g, b});
|
||||
// _highlightMaterialInstance->setParameter("vertexScale", 1.04f);
|
||||
// _highlightMaterialInstance->setCullingMode(filament::backend::CullingMode::FRONT);
|
||||
|
||||
// auto scene = sceneManager->getScene();
|
||||
|
||||
auto scene = sceneManager->getScene();
|
||||
// // _isGeometryEntity = sceneManager->isGeometryEntity(entityId);
|
||||
// // _isGltfAsset = sceneManager->isGltfAsset(entityId);
|
||||
|
||||
_isGeometryEntity = sceneManager->isGeometryEntity(entityId);
|
||||
_isGltfAsset = sceneManager->isGltfAsset(entityId);
|
||||
// if (!(_isGeometryEntity || _isGltfAsset))
|
||||
// {
|
||||
// Log("Failed to set stencil outline for entity %d: the entity is a child of another entity. "
|
||||
// "Currently, we only support outlining top-level entities."
|
||||
// "Call getAncestor() to get the ancestor of this entity, then set on that",
|
||||
// entityId);
|
||||
// return;
|
||||
// }
|
||||
|
||||
if (!(_isGeometryEntity || _isGltfAsset))
|
||||
{
|
||||
Log("Failed to set stencil outline for entity %d: the entity is a child of another entity. "
|
||||
"Currently, we only support outlining top-level entities."
|
||||
"Call getAncestor() to get the ancestor of this entity, then set on that",
|
||||
entityId);
|
||||
return;
|
||||
}
|
||||
// if (_isGeometryEntity)
|
||||
// {
|
||||
|
||||
if (_isGeometryEntity)
|
||||
{
|
||||
// auto geometryEntity = Entity::import(entityId);
|
||||
// auto renderable = rm.getInstance(geometryEntity);
|
||||
|
||||
auto geometryEntity = Entity::import(entityId);
|
||||
auto renderable = rm.getInstance(geometryEntity);
|
||||
// auto materialInstance = rm.getMaterialInstanceAt(renderable, 0);
|
||||
|
||||
auto materialInstance = rm.getMaterialInstanceAt(renderable, 0);
|
||||
// // set stencil write on the existing material
|
||||
// materialInstance->setStencilWrite(true);
|
||||
// materialInstance->setDepthWrite(true);
|
||||
// materialInstance->setStencilReferenceValue(1);
|
||||
// materialInstance->setStencilOpStencilFail(filament::backend::StencilOperation::KEEP);
|
||||
// materialInstance->setStencilOpDepthFail(filament::backend::StencilOperation::KEEP);
|
||||
// materialInstance->setStencilOpDepthStencilPass(filament::backend::StencilOperation::KEEP);
|
||||
// materialInstance->setStencilCompareFunction(filament::backend::SamplerCompareFunc::A);
|
||||
// // materialInstance->setCullingMode(filament::MaterialInstance::CullingMode::BACK);
|
||||
|
||||
// set stencil write on the existing material
|
||||
materialInstance->setStencilWrite(true);
|
||||
materialInstance->setDepthWrite(true);
|
||||
materialInstance->setStencilReferenceValue(1);
|
||||
materialInstance->setStencilOpStencilFail(filament::backend::StencilOperation::KEEP);
|
||||
materialInstance->setStencilOpDepthFail(filament::backend::StencilOperation::KEEP);
|
||||
materialInstance->setStencilOpDepthStencilPass(filament::backend::StencilOperation::KEEP);
|
||||
materialInstance->setStencilCompareFunction(filament::backend::SamplerCompareFunc::A);
|
||||
// materialInstance->setCullingMode(filament::MaterialInstance::CullingMode::BACK);
|
||||
// // auto geometry = sceneManager->getGeometry(entityId);
|
||||
|
||||
auto geometry = sceneManager->getGeometry(entityId);
|
||||
// // _entity = geometry->createInstance(materialInstance);
|
||||
|
||||
_entity = geometry->createInstance(materialInstance);
|
||||
// scene->addEntity(_entity);
|
||||
// auto outlineTransformInstance = tm.getInstance(_entity);
|
||||
// auto entityTransformInstance = tm.getInstance(geometryEntity);
|
||||
// tm.setParent(outlineTransformInstance, entityTransformInstance);
|
||||
// }
|
||||
// else if (_isGltfAsset)
|
||||
// {
|
||||
// Log("Entity %d is gltf", entityId);
|
||||
// // auto *asset = sceneManager->getAssetByEntityId(entityId);
|
||||
|
||||
scene->addEntity(_entity);
|
||||
auto outlineTransformInstance = tm.getInstance(_entity);
|
||||
auto entityTransformInstance = tm.getInstance(geometryEntity);
|
||||
tm.setParent(outlineTransformInstance, entityTransformInstance);
|
||||
}
|
||||
else if (_isGltfAsset)
|
||||
{
|
||||
Log("Entity %d is gltf", entityId);
|
||||
auto *asset = sceneManager->getAssetByEntityId(entityId);
|
||||
// // if (asset)
|
||||
// // {
|
||||
|
||||
if (asset)
|
||||
{
|
||||
// // Log("Found glTF FilamentAsset with %d material instances", asset->getInstance()->getMaterialInstanceCount());
|
||||
|
||||
Log("Found glTF FilamentAsset with %d material instances", asset->getInstance()->getMaterialInstanceCount());
|
||||
// // auto materialInstance = asset->getInstance()->getMaterialInstances()[0];
|
||||
|
||||
auto materialInstance = asset->getInstance()->getMaterialInstances()[0];
|
||||
// // // set stencil write on the existing material
|
||||
// // materialInstance->setStencilWrite(true);
|
||||
// // materialInstance->setDepthWrite(true);
|
||||
// // materialInstance->setStencilReferenceValue(1);
|
||||
// // materialInstance->setStencilOpStencilFail(filament::backend::StencilOperation::KEEP);
|
||||
// // materialInstance->setStencilOpDepthFail(filament::backend::StencilOperation::REPLACE);
|
||||
// // materialInstance->setStencilOpDepthStencilPass(filament::backend::StencilOperation::REPLACE);
|
||||
// // materialInstance->setStencilCompareFunction(filament::backend::SamplerCompareFunc::A);
|
||||
|
||||
// set stencil write on the existing material
|
||||
materialInstance->setStencilWrite(true);
|
||||
materialInstance->setDepthWrite(true);
|
||||
materialInstance->setStencilReferenceValue(1);
|
||||
materialInstance->setStencilOpStencilFail(filament::backend::StencilOperation::KEEP);
|
||||
materialInstance->setStencilOpDepthFail(filament::backend::StencilOperation::REPLACE);
|
||||
materialInstance->setStencilOpDepthStencilPass(filament::backend::StencilOperation::REPLACE);
|
||||
materialInstance->setStencilCompareFunction(filament::backend::SamplerCompareFunc::A);
|
||||
// // _newInstance = sceneManager->createGltfAssetInstance(asset);
|
||||
|
||||
_newInstance = sceneManager->createGltfAssetInstance(asset);
|
||||
// // _entity = _newInstance->getRoot();
|
||||
|
||||
_entity = _newInstance->getRoot();
|
||||
// // auto newTransformInstance = tm.getInstance(_entity);
|
||||
|
||||
auto newTransformInstance = tm.getInstance(_entity);
|
||||
// // auto entityTransformInstance = tm.getInstance(asset->getRoot());
|
||||
// // tm.setParent(newTransformInstance, entityTransformInstance);
|
||||
// // if (!_newInstance)
|
||||
// // {
|
||||
// // Log("Couldn't create new instance");
|
||||
// // }
|
||||
// // else
|
||||
// // {
|
||||
// // for (int i = 0; i < _newInstance->getEntityCount(); i++)
|
||||
// // {
|
||||
// // auto entity = _newInstance->getEntities()[i];
|
||||
// // auto renderableInstance = rm.getInstance(entity);
|
||||
// // rm.setPriority(renderableInstance, 7);
|
||||
// // if (renderableInstance.isValid())
|
||||
// // {
|
||||
// // for (int primitiveIndex = 0; primitiveIndex < rm.getPrimitiveCount(renderableInstance); primitiveIndex++)
|
||||
// // {
|
||||
// // rm.setMaterialInstanceAt(renderableInstance, primitiveIndex, _highlightMaterialInstance);
|
||||
// // }
|
||||
// // }
|
||||
// // else
|
||||
// // {
|
||||
// // Log("Not renderable, ignoring");
|
||||
// // }
|
||||
// // }
|
||||
// // scene->addEntities(_newInstance->getEntities(), _newInstance->getEntityCount());
|
||||
// // }
|
||||
// }
|
||||
// else
|
||||
// {
|
||||
// Log("Not FilamentAsset");
|
||||
// }
|
||||
// }
|
||||
|
||||
|
||||
auto entityTransformInstance = tm.getInstance(asset->getRoot());
|
||||
tm.setParent(newTransformInstance, entityTransformInstance);
|
||||
if (!_newInstance)
|
||||
{
|
||||
Log("Couldn't create new instance");
|
||||
}
|
||||
else
|
||||
{
|
||||
for (int i = 0; i < _newInstance->getEntityCount(); i++)
|
||||
{
|
||||
auto entity = _newInstance->getEntities()[i];
|
||||
auto renderableInstance = rm.getInstance(entity);
|
||||
rm.setPriority(renderableInstance, 7);
|
||||
if (renderableInstance.isValid())
|
||||
{
|
||||
for (int primitiveIndex = 0; primitiveIndex < rm.getPrimitiveCount(renderableInstance); primitiveIndex++)
|
||||
{
|
||||
rm.setMaterialInstanceAt(renderableInstance, primitiveIndex, _highlightMaterialInstance);
|
||||
}
|
||||
}
|
||||
else
|
||||
{
|
||||
Log("Not renderable, ignoring");
|
||||
}
|
||||
}
|
||||
scene->addEntities(_newInstance->getEntities(), _newInstance->getEntityCount());
|
||||
}
|
||||
}
|
||||
else
|
||||
{
|
||||
Log("Not FilamentAsset");
|
||||
}
|
||||
}
|
||||
}
|
||||
// SceneManager::HighlightOverlay::~HighlightOverlay()
|
||||
// {
|
||||
// if (_entity.isNull())
|
||||
// {
|
||||
// Log("Null entity");
|
||||
// return;
|
||||
// }
|
||||
|
||||
SceneManager::HighlightOverlay::~HighlightOverlay()
|
||||
{
|
||||
if (_entity.isNull())
|
||||
{
|
||||
Log("Null entity");
|
||||
return;
|
||||
}
|
||||
|
||||
if (_isGltfAsset)
|
||||
{
|
||||
_sceneManager->getScene()->removeEntities(_newInstance->getEntities(), _newInstance->getEntityCount());
|
||||
_newInstance->detachMaterialInstances();
|
||||
_engine->destroy(_highlightMaterialInstance);
|
||||
}
|
||||
else if (_isGeometryEntity)
|
||||
{
|
||||
auto &tm = _engine->getTransformManager();
|
||||
auto transformInstance = tm.getInstance(_entity);
|
||||
_sceneManager->getScene()->remove(_entity);
|
||||
utils::EntityManager::get().destroy(_entity);
|
||||
_engine->destroy(_entity);
|
||||
_engine->destroy(_highlightMaterialInstance);
|
||||
}
|
||||
else
|
||||
{
|
||||
Log("FATAL: Unknown highlight overlay entity type");
|
||||
}
|
||||
}
|
||||
}
|
||||
// if (_isGltfAsset)
|
||||
// {
|
||||
// Log("Destroyed gltf asset highlight overlay");
|
||||
// _sceneManager->getScene()->removeEntities(_newInstance->getEntities(), _newInstance->getEntityCount());
|
||||
// // _sceneManager->destroyGltfAssetInstance(_newInstance);
|
||||
// // auto materialInstances = _newInstance->getMaterialInstances();
|
||||
// // auto numMaterialInstances = _newInstance->getMaterialInstanceCount();
|
||||
// // _newInstance->detachMaterialInstances();
|
||||
// // for(int i = 0; i < numMaterialInstances; i++) {
|
||||
// // _engine->destroy(_highlightMaterialInstance);
|
||||
// // }
|
||||
// // _engine->destroy(_newInstance);
|
||||
// }
|
||||
// else if (_isGeometryEntity)
|
||||
// {
|
||||
// auto &tm = _engine->getTransformManager();
|
||||
// auto transformInstance = tm.getInstance(_entity);
|
||||
// _sceneManager->getScene()->remove(_entity);
|
||||
// utils::EntityManager::get().destroy(_entity);
|
||||
// _engine->destroy(_entity);
|
||||
// _engine->destroy(_highlightMaterialInstance);
|
||||
// }
|
||||
// else
|
||||
// {
|
||||
// Log("FATAL: Unknown highlight overlay entity type");
|
||||
// }
|
||||
// }
|
||||
// }
|
||||
Reference in New Issue
Block a user