#include "bulletnifloader.hpp" #include #include #include #include #include #include #include #include #include #include #include #include #include #include #include namespace { bool pathFileNameStartsWithX(const std::string& path) { const std::size_t slashpos = path.find_last_of("/\\"); const std::size_t letterPos = slashpos == std::string::npos ? 0 : slashpos + 1; return letterPos < path.size() && (path[letterPos] == 'x' || path[letterPos] == 'X'); } void prepareTriangleMesh(btTriangleMesh& mesh, const Nif::NiTriBasedGeomData& data) { // FIXME: copying vertices/indices individually is unreasonable const std::vector& vertices = data.vertices; mesh.preallocateVertices(static_cast(vertices.size())); for (const osg::Vec3f& vertex : vertices) mesh.findOrAddVertex(Misc::Convert::toBullet(vertex), false); mesh.preallocateIndices(static_cast(data.mNumTriangles * 3)); } void fillTriangleMesh(btTriangleMesh& mesh, const Nif::NiTriShapeData& data) { prepareTriangleMesh(mesh, data); const std::vector& triangles = data.triangles; for (std::size_t i = 0; i < triangles.size(); i += 3) mesh.addTriangleIndices(triangles[i + 0], triangles[i + 1], triangles[i + 2]); } void fillTriangleMesh(btTriangleMesh& mesh, const Nif::NiTriStripsData& data) { prepareTriangleMesh(mesh, data); for (const std::vector& strip : data.strips) { if (strip.size() < 3) continue; unsigned short a; unsigned short b = strip[0]; unsigned short c = strip[1]; for (size_t i = 2; i < strip.size(); i++) { a = b; b = c; c = strip[i]; if (a == b || b == c || a == c) continue; if (i % 2 == 0) mesh.addTriangleIndices(a, b, c); else mesh.addTriangleIndices(a, c, b); } } } template auto handleNiGeometry(const Nif::NiGeometry& geometry, Function&& function) -> decltype(function(static_cast(geometry.data.get()))) { if (geometry.recType == Nif::RC_NiTriShape || geometry.recType == Nif::RC_BSLODTriShape) { if (geometry.data->recType != Nif::RC_NiTriShapeData) return {}; auto data = static_cast(geometry.data.getPtr()); if (data->triangles.empty()) return {}; return function(static_cast(*data)); } if (geometry.recType == Nif::RC_NiTriStrips) { if (geometry.data->recType != Nif::RC_NiTriStripsData) return {}; auto data = static_cast(geometry.data.getPtr()); if (data->strips.empty()) return {}; return function(static_cast(*data)); } return {}; } std::unique_ptr makeChildMesh(const Nif::NiGeometry& geometry) { return handleNiGeometry(geometry, [&](const auto& data) { auto mesh = std::make_unique(); fillTriangleMesh(*mesh, data); return mesh; }); } } namespace NifBullet { osg::ref_ptr BulletNifLoader::load(Nif::FileView nif) { mShape = new Resource::BulletShape; mCompoundShape.reset(); mAvoidCompoundShape.reset(); mShape->mFileHash = nif.getHash(); const size_t numRoots = nif.numRoots(); std::vector roots; for (size_t i = 0; i < numRoots; ++i) { const Nif::Record* r = nif.getRoot(i); if (!r) continue; const Nif::Node* node = dynamic_cast(r); if (node) roots.emplace_back(node); } const std::string filename = Files::pathToUnicodeString(nif.getFilename()); mShape->mFileName = filename; if (roots.empty()) { warn("Found no root nodes in NIF file " + filename); return mShape; } // Try to find a valid bounding box first. If one's found for any root node, use that. for (const Nif::Node* node : roots) { if (findBoundingBox(*node, filename)) { const btVector3 extents = Misc::Convert::toBullet(mShape->mCollisionBox.mExtents); const btVector3 center = Misc::Convert::toBullet(mShape->mCollisionBox.mCenter); auto compound = std::make_unique(); auto boxShape = std::make_unique(extents); btTransform transform = btTransform::getIdentity(); transform.setOrigin(center); compound->addChildShape(transform, boxShape.get()); std::ignore = boxShape.release(); mShape->mCollisionShape.reset(compound.release()); return mShape; } } // files with the name convention xmodel.nif usually have keyframes stored in a separate file xmodel.kf (see // Animation::addAnimSource). assume all nodes in the file will be animated // TODO: investigate whether this should and could be optimized. const bool isAnimated = pathFileNameStartsWithX(filename); // If there's no bounding box, we'll have to generate a Bullet collision shape // from the collision data present in every root node. for (const Nif::Node* node : roots) { bool hasCollisionNode = hasRootCollisionNode(*node); bool hasCollisionShape = hasCollisionNode && !collisionShapeIsEmpty(*node); if (hasCollisionNode && !hasCollisionShape) mShape->mVisualCollisionType = Resource::VisualCollisionType::Camera; bool generateCollisionShape = !hasCollisionShape; handleNode(filename, *node, nullptr, 0, generateCollisionShape, isAnimated, generateCollisionShape, false, mShape->mVisualCollisionType); } if (mCompoundShape) mShape->mCollisionShape = std::move(mCompoundShape); if (mAvoidCompoundShape) mShape->mAvoidCollisionShape = std::move(mAvoidCompoundShape); return mShape; } // Find a boundingBox in the node hierarchy. // Return: use bounding box for collision? bool BulletNifLoader::findBoundingBox(const Nif::Node& node, const std::string& filename) { if (node.hasBounds) { unsigned int type = node.bounds.type; switch (type) { case Nif::NiBoundingVolume::Type::BOX_BV: mShape->mCollisionBox.mExtents = node.bounds.box.extents; mShape->mCollisionBox.mCenter = node.bounds.box.center; break; default: { std::stringstream warning; warning << "Unsupported NiBoundingVolume type " << type << " in node " << node.recIndex; warning << " in file " << filename; warn(warning.str()); } } if (node.hasBBoxCollision()) { return true; } } if (const Nif::NiNode* ninode = dynamic_cast(&node)) { const Nif::NodeList& list = ninode->children; for (const auto& child : list) if (!child.empty() && findBoundingBox(child.get(), filename)) return true; } return false; } bool BulletNifLoader::hasRootCollisionNode(const Nif::Node& rootNode) const { if (const Nif::NiNode* ninode = dynamic_cast(&rootNode)) { for (const auto& child : ninode->children) { if (child.empty()) continue; if (child.getPtr()->recType == Nif::RC_RootCollisionNode) return true; } } return false; } bool BulletNifLoader::collisionShapeIsEmpty(const Nif::Node& rootNode) const { if (const Nif::NiNode* ninode = dynamic_cast(&rootNode)) { for (const auto& child : ninode->children) { if (child.empty()) continue; const Nif::Node* childNode = child.getPtr(); if (childNode->recType != Nif::RC_RootCollisionNode) continue; const Nif::NiNode* niChildnode = static_cast(childNode); // RootCollisionNode is always a NiNode if (childNode->hasBounds || niChildnode->children.size() > 0) return false; } } return true; } void BulletNifLoader::handleNode(const std::string& fileName, const Nif::Node& node, const Nif::Parent* parent, int flags, bool isCollisionNode, bool isAnimated, bool autogenerated, bool avoid, Resource::VisualCollisionType& visualCollisionType) { // TODO: allow on-the fly collision switching via toggling this flag if (node.recType == Nif::RC_NiCollisionSwitch && !node.collisionActive()) return; // If RootCollisionNode is empty we treat it as NCC flag and autogenerate collision shape as there was no // RootCollisionNode. So ignoring it here if `autogenerated` is true and collisionType was set to `Camera`. if (node.recType == Nif::RC_RootCollisionNode && autogenerated && visualCollisionType == Resource::VisualCollisionType::Camera) return; // Accumulate the flags from all the child nodes. This works for all // the flags we currently use, at least. flags |= node.flags; if (!node.controller.empty() && node.controller->recType == Nif::RC_NiKeyframeController && node.controller->isActive()) isAnimated = true; isCollisionNode = isCollisionNode || (node.recType == Nif::RC_RootCollisionNode); // Don't collide with AvoidNode shapes avoid = avoid || (node.recType == Nif::RC_AvoidNode); // We encountered a RootCollisionNode inside autogenerated mesh. It is not right. if (node.recType == Nif::RC_RootCollisionNode && autogenerated) Log(Debug::Info) << "RootCollisionNode is not attached to the root node in " << fileName << ". Treating it as a common NiTriShape."; // Check for extra data for (Nif::ExtraPtr e = node.extra; !e.empty(); e = e->next) { if (e->recType == Nif::RC_NiStringExtraData) { // String markers may contain important information // affecting the entire subtree of this node Nif::NiStringExtraData* sd = (Nif::NiStringExtraData*)e.getPtr(); if (Misc::StringUtils::ciStartsWith(sd->string, "NC")) { // NCC flag in vanilla is partly case sensitive: prefix NC is case insensitive but second C needs be // uppercase if (sd->string.length() > 2 && sd->string[2] == 'C') // Collide only with camera. visualCollisionType = Resource::VisualCollisionType::Camera; else // No collision. visualCollisionType = Resource::VisualCollisionType::Default; } else if (sd->string == "MRK" && autogenerated) { // Marker can still have collision if the model explicitely specifies it via a RootCollisionNode. return; } } } if (isCollisionNode) { // NOTE: a trishape with hasBounds=true, but no BBoxCollision flag should NOT go through handleNiTriShape! // It must be ignored completely. // (occurs in tr_ex_imp_wall_arch_04.nif) if (!node.hasBounds && (node.recType == Nif::RC_NiTriShape || node.recType == Nif::RC_NiTriStrips || node.recType == Nif::RC_BSLODTriShape)) { handleNiTriShape(static_cast(node), parent, isAnimated, avoid); } } // For NiNodes, loop through children if (const Nif::NiNode* ninode = dynamic_cast(&node)) { const Nif::NodeList& list = ninode->children; const Nif::Parent currentParent{ *ninode, parent }; for (const auto& child : list) { if (child.empty()) continue; assert(std::find(child->parents.begin(), child->parents.end(), ninode) != child->parents.end()); handleNode(fileName, child.get(), ¤tParent, flags, isCollisionNode, isAnimated, autogenerated, avoid, visualCollisionType); } } } void BulletNifLoader::handleNiTriShape( const Nif::NiGeometry& niGeometry, const Nif::Parent* nodeParent, bool isAnimated, bool avoid) { if (niGeometry.data.empty() || niGeometry.data->vertices.empty()) return; if (!niGeometry.skin.empty()) isAnimated = false; std::unique_ptr childMesh = makeChildMesh(niGeometry); if (childMesh == nullptr || childMesh->getNumTriangles() == 0) return; auto childShape = std::make_unique(childMesh.get(), true); std::ignore = childMesh.release(); osg::Matrixf transform = niGeometry.trafo.toMatrix(); for (const Nif::Parent* parent = nodeParent; parent != nullptr; parent = parent->mParent) transform *= parent->mNiNode.trafo.toMatrix(); childShape->setLocalScaling(Misc::Convert::toBullet(transform.getScale())); transform.orthoNormalize(transform); btTransform trans; trans.setOrigin(Misc::Convert::toBullet(transform.getTrans())); for (int i = 0; i < 3; ++i) for (int j = 0; j < 3; ++j) trans.getBasis()[i][j] = transform(j, i); if (!avoid) { if (!mCompoundShape) mCompoundShape.reset(new btCompoundShape); if (isAnimated) mShape->mAnimatedShapes.emplace(niGeometry.recIndex, mCompoundShape->getNumChildShapes()); mCompoundShape->addChildShape(trans, childShape.get()); } else { if (!mAvoidCompoundShape) mAvoidCompoundShape.reset(new btCompoundShape); mAvoidCompoundShape->addChildShape(trans, childShape.get()); } std::ignore = childShape.release(); } } // namespace NifBullet