#include "keyframemanager.hpp" #include #include #include #include #include #include #include #include #include #include #include #include #include #include "animation.hpp" #include "objectcache.hpp" #include "scenemanager.hpp" namespace Resource { RetrieveAnimationsVisitor::RetrieveAnimationsVisitor(SceneUtil::KeyframeHolder& target, osg::ref_ptr animationManager, const std::string& normalized, const VFS::Manager* vfs) : osg::NodeVisitor(TRAVERSE_ALL_CHILDREN) , mTarget(target) , mAnimationManager(std::move(animationManager)) , mNormalized(normalized) , mVFS(vfs) { } bool RetrieveAnimationsVisitor::belongsToLeftUpperExtremity(const std::string& name) { static const std::array boneNames = { "bip01 l clavicle", "left clavicle", "bip01 l upperarm", "left upper arm", "bip01 l forearm", "bip01 l hand", "left hand", "left wrist", "shield bone", "bip01 l pinky1", "bip01 l pinky2", "bip01 l pinky3", "bip01 l ring1", "bip01 l ring2", "bip01 l ring3", "bip01 l middle1", "bip01 l middle2", "bip01 l middle3", "bip01 l pointer1", "bip01 l pointer2", "bip01 l pointer3", "bip01 l thumb1", "bip01 l thumb2", "bip01 l thumb3", "left forearm" }; if (std::find(boneNames.begin(), boneNames.end(), name) != boneNames.end()) return true; return false; } bool RetrieveAnimationsVisitor::belongsToRightUpperExtremity(const std::string& name) { static const std::array boneNames = { "bip01 r clavicle", "right clavicle", "bip01 r upperarm", "right upper arm", "bip01 r forearm", "bip01 r hand", "right hand", "right wrist", "bip01 r thumb1", "bip01 r thumb2", "bip01 r thumb3", "weapon bone", "bip01 r pinky1", "bip01 r pinky2", "bip01 r pinky3", "bip01 r ring1", "bip01 r ring2", "bip01 r ring3", "bip01 r middle1", "bip01 r middle2", "bip01 r middle3", "bip01 r pointer1", "bip01 r pointer2", "bip01 r pointer3", "right forearm" }; if (std::find(boneNames.begin(), boneNames.end(), name) != boneNames.end()) return true; return false; } bool RetrieveAnimationsVisitor::belongsToTorso(const std::string& name) { static const std::array boneNames = { "bip01 spine1", "bip01 spine2", "bip01 neck", "bip01 head", "head", "neck", "chest", "groin" }; if (std::find(boneNames.begin(), boneNames.end(), name) != boneNames.end()) return true; return false; } void RetrieveAnimationsVisitor::addKeyframeController(const std::string& name, const osg::Node& node) { osg::ref_ptr callback = new SceneUtil::OsgAnimationController(); callback->setName(name); std::vector emulatedAnimations; for (const auto& animation : mAnimationManager->getAnimationList()) { if (animation) { //"Default" is osg dae plugin's default naming scheme for unnamed animations if (animation->getName() == "Default") { animation->setName(std::string("idle")); } osg::ref_ptr mergedAnimationTrack = new Resource::Animation; const std::string animationName = animation->getName(); mergedAnimationTrack->setName(animationName); const osgAnimation::ChannelList& channels = animation->getChannels(); for (const auto& channel : channels) { // Replace channel target name to match the renamed bones/transforms channel->setTargetName(Misc::StringUtils::underscoresToSpaces(channel->getTargetName())); if (name == "Bip01 R Clavicle") { if (!belongsToRightUpperExtremity(channel->getTargetName())) continue; } else if (name == "Bip01 L Clavicle") { if (!belongsToLeftUpperExtremity(channel->getTargetName())) continue; } else if (name == "Bip01 Spine1") { if (!belongsToTorso(channel->getTargetName())) continue; } else if (belongsToRightUpperExtremity(channel->getTargetName()) || belongsToLeftUpperExtremity(channel->getTargetName()) || belongsToTorso(channel->getTargetName())) continue; mergedAnimationTrack->addChannel(channel.get()->clone()); } callback->addMergedAnimationTrack(std::move(mergedAnimationTrack)); float startTime = animation->getStartTime(); float stopTime = startTime + animation->getDuration(); SceneUtil::EmulatedAnimation emulatedAnimation; emulatedAnimation.mStartTime = startTime; emulatedAnimation.mStopTime = stopTime; emulatedAnimation.mName = animationName; emulatedAnimations.emplace_back(emulatedAnimation); } } // mTextKeys is a nif-thing, used by OpenMW's animation system // Format is likely "AnimationName: [Keyword_optional] [Start OR Stop]" // AnimationNames are keywords like idle2, idle3... AiPackages and various mechanics control which // animations are played Keywords can be stuff like Loop, Equip, Unequip, Block, InventoryHandtoHand, // InventoryWeaponOneHand, PickProbe, Slash, Thrust, Chop... even "Slash Small Follow" osgAnimation formats // should have a .txt file with the same name, each line holding a textkey and whitespace separated time // value e.g. idle: start 0.0333 try { Files::IStreamPtr textKeysFile = mVFS->get(changeFileExtension(mNormalized, "txt")); std::string line; while (getline(*textKeysFile, line)) { mTarget.mTextKeys.emplace(parseTimeSignature(line), parseTextKey(line)); } } catch (const std::exception& e) { Log(Debug::Warning) << "Failed to use textkey file " << mNormalized << ": " << e.what(); } callback->setEmulatedAnimations(emulatedAnimations); mTarget.mKeyframeControllers.emplace(name, callback); } void RetrieveAnimationsVisitor::apply(osg::Node& node) { if (node.libraryName() == std::string_view("osgAnimation") && node.className() == std::string_view("Bone") && Misc::StringUtils::lowerCase(node.getName()) == std::string_view("bip01")) { addKeyframeController("bip01", node); /* Character root */ addKeyframeController("Bip01 Spine1", node); /* Torso */ addKeyframeController("Bip01 L Clavicle", node); /* Left arm */ addKeyframeController("Bip01 R Clavicle", node); /* Right arm */ } traverse(node); } std::string RetrieveAnimationsVisitor::parseTextKey(const std::string& line) { size_t spacePos = line.find_last_of(' '); if (spacePos != std::string::npos) return line.substr(0, spacePos); return ""; } double RetrieveAnimationsVisitor::parseTimeSignature(const std::string& line) { size_t spacePos = line.find_last_of(' '); double time = 0.0; if (spacePos != std::string::npos && spacePos + 1 < line.size()) time = Misc::StringUtils::toNumeric(line.substr(spacePos + 1), time); return time; } std::string RetrieveAnimationsVisitor::changeFileExtension(const std::string& file, const std::string& ext) { size_t extPos = file.find_last_of('.'); if (extPos != std::string::npos && extPos + 1 < file.size()) { return file.substr(0, extPos + 1) + ext; } return file; } } namespace Resource { KeyframeManager::KeyframeManager(const VFS::Manager* vfs, SceneManager* sceneManager, double expiryDelay, const ToUTF8::StatelessUtf8Encoder* encoder) : ResourceManager(vfs, expiryDelay) , mSceneManager(sceneManager) , mEncoder(encoder) { } osg::ref_ptr KeyframeManager::get(const std::string& name) { const std::string normalized = VFS::Path::normalizeFilename(name); osg::ref_ptr obj = mCache->getRefFromObjectCache(normalized); if (obj) return osg::ref_ptr(static_cast(obj.get())); else { osg::ref_ptr loaded(new SceneUtil::KeyframeHolder); if (Misc::getFileExtension(normalized) == "kf") { auto file = std::make_shared(normalized); Nif::Reader reader(*file, mEncoder); reader.parse(mVFS->getNormalized(normalized)); NifOsg::Loader::loadKf(*file, *loaded.get()); } else { osg::ref_ptr scene = const_cast(mSceneManager->getTemplate(normalized).get()); osg::ref_ptr bam = dynamic_cast(scene->getUpdateCallback()); if (bam) { Resource::RetrieveAnimationsVisitor rav(*loaded.get(), std::move(bam), normalized, mVFS); scene->accept(rav); } } mCache->addEntryToObjectCache(normalized, loaded); return loaded; } } void KeyframeManager::reportStats(unsigned int frameNumber, osg::Stats* stats) const { Resource::reportStats("Keyframe", frameNumber, mCache->getStats(), *stats); } }