#include "bulletnifloader.hpp" #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'); } } 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::NiAVObject* node = dynamic_cast(r); if (node) roots.emplace_back(node); } mShape->mFileName = nif.getFilename(); if (roots.empty()) { warn("Found no root nodes in NIF file " + mShape->mFileName.value()); return mShape; } for (const Nif::NiAVObject* node : roots) if (findBoundingBox(*node)) break; HandleNodeArgs args; // 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. args.mAnimated = pathFileNameStartsWithX(mShape->mFileName); for (const Nif::NiAVObject* node : roots) handleRoot(nif, *node, args); if (mCompoundShape) mShape->mCollisionShape = std::move(mCompoundShape); if (mAvoidCompoundShape) mShape->mAvoidCollisionShape = std::move(mAvoidCompoundShape); return mShape; } // Find a bounding box in the node hierarchy to use for actor collision bool BulletNifLoader::findBoundingBox(const Nif::NiAVObject& node) { if (Misc::StringUtils::ciEqual(node.mName, "Bounding Box")) { if (node.mBounds.mType == Nif::BoundingVolume::Type::BOX_BV && std::ranges::all_of(node.mBounds.mBox.mExtents._v, [](float extent) { return extent > 0.f; })) { mShape->mCollisionBox.mExtents = node.mBounds.mBox.mExtents; mShape->mCollisionBox.mCenter = node.mBounds.mBox.mCenter; } else { warn("Invalid Bounding Box node bounds in file " + mShape->mFileName.value()); } return true; } if (auto ninode = dynamic_cast(&node)) for (const auto& child : ninode->mChildren) if (!child.empty() && findBoundingBox(child.get())) return true; return false; } void BulletNifLoader::handleRoot(Nif::FileView nif, const Nif::NiAVObject& node, HandleNodeArgs args) { // Gamebryo/Bethbryo meshes if (nif.getVersion() >= Nif::NIFStream::generateVersion(10, 0, 1, 0)) { // Handle BSXFlags const Nif::NiIntegerExtraData* bsxFlags = nullptr; for (const auto& e : node.getExtraList()) { if (e->recType == Nif::RC_BSXFlags) { bsxFlags = static_cast(e.getPtr()); break; } } // Collision flag if (!bsxFlags || !(bsxFlags->mData & 2)) return; // Editor marker flag if (bsxFlags->mData & 32) args.mHasMarkers = true; // FIXME: hack, using rendered geometry instead of Bethesda Havok data args.mAutogenerated = true; } // Pre-Gamebryo meshes else { // Handle RootCollisionNode const Nif::NiNode* colNode = nullptr; if (const Nif::NiNode* ninode = dynamic_cast(&node)) { for (const auto& child : ninode->mChildren) { if (!child.empty() && child.getPtr()->recType == Nif::RC_RootCollisionNode) { colNode = static_cast(child.getPtr()); break; } } } args.mAutogenerated = colNode == nullptr; // Check for extra data for (const auto& e : node.getExtraList()) { if (e->recType == Nif::RC_NiStringExtraData) { // String markers may contain important information // affecting the entire subtree of this node auto sd = static_cast(e.getPtr()); // Editor marker flag if (sd->mData == "MRK") args.mHasTriMarkers = true; else if (Misc::StringUtils::ciStartsWith(sd->mData, "NC")) { // NC prefix is case-insensitive but the second C in NCC flag needs be uppercase. // Collide only with camera. if (sd->mData.length() > 2 && sd->mData[2] == 'C') mShape->mVisualCollisionType = Resource::VisualCollisionType::Camera; // No collision. else mShape->mVisualCollisionType = Resource::VisualCollisionType::Default; } } } // FIXME: BulletNifLoader should never have to provide rendered geometry for camera collision if (colNode && colNode->mChildren.empty()) { args.mAutogenerated = true; mShape->mVisualCollisionType = Resource::VisualCollisionType::Camera; } } handleNode(node, nullptr, args); } void BulletNifLoader::handleNode(const Nif::NiAVObject& node, const Nif::Parent* parent, HandleNodeArgs args) { // TODO: allow on-the fly collision switching via toggling this flag if (node.recType == Nif::RC_NiCollisionSwitch && !node.collisionActive()) return; for (Nif::NiTimeControllerPtr ctrl = node.mController; !ctrl.empty(); ctrl = ctrl->mNext) { if (args.mAnimated) break; if (!ctrl->isActive()) continue; switch (ctrl->recType) { case Nif::RC_NiKeyframeController: case Nif::RC_NiPathController: case Nif::RC_NiRollController: args.mAnimated = true; break; default: continue; } } if (node.recType == Nif::RC_RootCollisionNode) { if (args.mAutogenerated) { // Encountered a RootCollisionNode inside an autogenerated mesh. // We treat empty RootCollisionNodes as NCC flag (set collisionType to `Camera`) // and generate the camera collision shape based on rendered geometry. if (mShape->mVisualCollisionType == Resource::VisualCollisionType::Camera) return; // Otherwise we'll want to notify the user. Log(Debug::Info) << "BulletNifLoader: RootCollisionNode is not attached to the root node in " << mShape->mFileName << ". Treating it as a NiNode."; } else { args.mIsCollisionNode = true; } } // Don't collide with AvoidNode shapes if (node.recType == Nif::RC_AvoidNode) args.mAvoid = true; if (args.mAutogenerated || args.mIsCollisionNode) { auto geometry = dynamic_cast(&node); if (geometry) handleGeometry(*geometry, parent, args); } // For NiNodes, loop through children if (const Nif::NiNode* ninode = dynamic_cast(&node)) { const Nif::Parent currentParent{ *ninode, parent }; for (const auto& child : ninode->mChildren) { if (!child.empty()) { assert(std::find(child->mParents.begin(), child->mParents.end(), ninode) != child->mParents.end()); handleNode(child.get(), ¤tParent, args); } // For NiSwitchNodes and NiFltAnimationNodes, only use the first child // TODO: must synchronize with the rendering scene graph somehow // Doing this for NiLODNodes is unsafe (the first level might not be the closest) if (node.recType == Nif::RC_NiSwitchNode || node.recType == Nif::RC_NiFltAnimationNode) break; } } } void BulletNifLoader::handleGeometry( const Nif::NiGeometry& niGeometry, const Nif::Parent* nodeParent, HandleNodeArgs args) { // This flag comes from BSXFlags if (args.mHasMarkers && Misc::StringUtils::ciStartsWith(niGeometry.mName, "EditorMarker")) return; // This flag comes from Morrowind if (args.mHasTriMarkers && Misc::StringUtils::ciStartsWith(niGeometry.mName, "Tri EditorMarker")) return; if (!niGeometry.mSkin.empty()) args.mAnimated = false; std::unique_ptr childShape = niGeometry.getCollisionShape(); if (childShape == nullptr) return; osg::Matrixf transform = niGeometry.mTransform.toMatrix(); for (const Nif::Parent* parent = nodeParent; parent != nullptr; parent = parent->mParent) transform *= parent->mNiNode.mTransform.toMatrix(); if (childShape->getShapeType() == TRIANGLE_MESH_SHAPE_PROXYTYPE) { auto scaledShape = std::make_unique( static_cast(childShape.get()), Misc::Convert::toBullet(transform.getScale())); std::ignore = childShape.release(); childShape = std::move(scaledShape); } else { 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 (!args.mAvoid) { if (!mCompoundShape) mCompoundShape.reset(new btCompoundShape); if (args.mAnimated) 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