mirror of
https://github.com/scp-fs2open/fs2open.github.com.git
synced 2026-11-07 22:56:30 -10:00
The Force
da05081405
* Fix C4709 Warnings on latest VS * more * suppress false positive * Switch to using any/none_of * Address Feedback * Fix Line endings? * Fix commits and strip out flag_combinator * more fixes * nolint
1852 lines
69 KiB
C++
1852 lines
69 KiB
C++
#include "math/curve.h"
|
|
#include "model/animation/modelanimation.h"
|
|
#include "model/animation/modelanimation_driver.h"
|
|
#include "model/animation/modelanimation_segments.h"
|
|
#include "model/animation/modelanimation_moveables.h"
|
|
#include "network/multi.h"
|
|
#include "network/multimsgs.h"
|
|
#include "parse/encrypt.h"
|
|
#include "ship/ship.h"
|
|
#include "utils/Random.h"
|
|
|
|
|
|
extern float flFrametime;
|
|
|
|
namespace animation {
|
|
|
|
special_flag_def_list_new<animation::Animation_Flags, ModelAnimation&> Animation_flags[] = {
|
|
{ "auto reverse", animation::Animation_Flags::Auto_Reverse, true },
|
|
{ "reset at completion", animation::Animation_Flags::Reset_at_completion, true },
|
|
{ "loop", animation::Animation_Flags::Loop, true },
|
|
{ "random starting phase", animation::Animation_Flags::Random_starting_phase, true },
|
|
{ "pause on reverse", animation::Animation_Flags::Pause_on_reverse, true },
|
|
{ "seamless with startup", animation::Animation_Flags::Seamless_with_startup, true, [](const SCP_string& from, ModelAnimation& anim) {
|
|
anim.m_flagData.loopsFrom = static_cast<float>(std::atof(from.c_str()));
|
|
anim.m_flags.set(animation::Animation_Flags::Loop);
|
|
anim.m_flags.set(animation::Animation_Flags::Seamless_with_startup);
|
|
|
|
//While this flag implies Reset_at_completion semantically, it's implemented in a conflicting manner. Hence, make sure that seamless will take priority, and force-disable reset at completion if set
|
|
anim.m_flags.set(animation::Animation_Flags::Reset_at_completion, false);
|
|
}}
|
|
};
|
|
|
|
SCP_unordered_map<int, ModelAnimationSet::RunningAnimationList> ModelAnimationSet::s_runningAnimations;
|
|
SCP_unordered_map<unsigned int, std::shared_ptr<ModelAnimation>> ModelAnimationSet::s_animationById;
|
|
|
|
ModelAnimation::ModelAnimation(bool isInitialType, bool isMultiCompatible, bool canStateChange, const ModelAnimationSet* defaultSet)
|
|
: m_set(defaultSet), m_isInitialType(isInitialType), m_isMultiCompatible(isMultiCompatible), m_canChangeState(canStateChange)
|
|
{ }
|
|
|
|
void ModelAnimation::setAnimation(std::shared_ptr<ModelAnimationSegment> animation) {
|
|
m_animation = std::move(animation);
|
|
}
|
|
|
|
void ModelAnimation::forceRecalculate(polymodel_instance* pmi) {
|
|
Assertion(m_canChangeState, "Attempted to force recalculation of an animation that is not allowed to state-change!");
|
|
if(!m_canChangeState)
|
|
return;
|
|
|
|
instance_data& instanceData = m_instances[pmi->id];
|
|
|
|
instanceData.state = ModelAnimationState::NEED_RECALC;
|
|
}
|
|
|
|
enum class AnimationTimeWrapMode { BOUNCE, BOUNCE_ONCE, TRUNC, WRAP };
|
|
static std::pair<float, bool> animationTimeWrap(float frametime, float minBounds, float maxBounds, AnimationTimeWrapMode mode) {
|
|
bool flip = false;
|
|
switch (mode){
|
|
//BOUNCE mode will assume that on reaching any bounds, direction would have changed.
|
|
case AnimationTimeWrapMode::BOUNCE:
|
|
while(frametime > maxBounds || frametime < minBounds) {
|
|
flip = !flip;
|
|
frametime = 2.0f * (frametime > maxBounds ? maxBounds : minBounds) - frametime;
|
|
}
|
|
break;
|
|
//BOUNCE_ONCE mode will assume that on reaching any bounds the first time, direction would have changed.
|
|
case AnimationTimeWrapMode::BOUNCE_ONCE:
|
|
if(frametime > maxBounds || frametime < minBounds) {
|
|
flip = true;
|
|
frametime = 2.0f * (frametime > maxBounds ? maxBounds : minBounds) - frametime;
|
|
}
|
|
CAP(frametime, minBounds, maxBounds);
|
|
break;
|
|
//TRUNC mode will stop on bounds.
|
|
case AnimationTimeWrapMode::TRUNC:
|
|
CAP(frametime, minBounds, maxBounds);
|
|
break;
|
|
//WRAP mode will assume that on reaching any bounds, time will be set to the other bound and direction will keep constant
|
|
case AnimationTimeWrapMode::WRAP:
|
|
frametime = std::fmod(frametime - minBounds, maxBounds - minBounds);
|
|
frametime += (frametime < 0.0f ? maxBounds : minBounds);
|
|
break;
|
|
}
|
|
return std::make_pair(frametime, flip);
|
|
}
|
|
|
|
void ModelAnimation::driverTime(ModelAnimation& anim, instance_data& instanceData, polymodel_instance* pmi, float frametime) {
|
|
switch (instanceData.canonicalDirection){
|
|
case ModelAnimationDirection::FWD:
|
|
instanceData.time += frametime;
|
|
|
|
if (anim.m_flags[Animation_Flags::Seamless_with_startup] && !instanceData.instance_flags[Animation_Instance_Flags::Seamless_fully_started] && instanceData.time > anim.m_flagData.loopsFrom){
|
|
instanceData.instance_flags.set(Animation_Instance_Flags::Seamless_fully_started);
|
|
}
|
|
|
|
//Cap time if needed
|
|
if (instanceData.time > instanceData.duration) {
|
|
if (anim.m_flags[Animation_Flags::Auto_Reverse]) {
|
|
// Reverse
|
|
instanceData.canonicalDirection = ModelAnimationDirection::RWD;
|
|
instanceData.time = animationTimeWrap(instanceData.time, 0, instanceData.duration, AnimationTimeWrapMode::BOUNCE_ONCE).first;
|
|
}
|
|
else if (anim.m_flags[Animation_Flags::Loop]) {
|
|
if (anim.m_flags[Animation_Flags::Reset_at_completion]) {
|
|
//Loop from start
|
|
instanceData.time = animationTimeWrap(instanceData.time, 0, instanceData.duration, AnimationTimeWrapMode::WRAP).first;
|
|
|
|
//Reset at completion triggers count as a full next loop, so we need to stop here.
|
|
if (instanceData.instance_flags[Animation_Instance_Flags::Stop_after_next_loop])
|
|
anim.stop(pmi, false);
|
|
}
|
|
else if (anim.m_flags[Animation_Flags::Seamless_with_startup]) {
|
|
//We need to go into final shutdown mode. Go to start of seamless segment, and play backwards
|
|
if (instanceData.instance_flags[Animation_Instance_Flags::Stop_after_next_loop]) {
|
|
instanceData.time = animationTimeWrap(instanceData.time - instanceData.duration, 0, anim.m_flagData.loopsFrom, AnimationTimeWrapMode::BOUNCE_ONCE).first;
|
|
instanceData.canonicalDirection = ModelAnimationDirection::RWD;
|
|
instanceData.instance_flags.set(Animation_Instance_Flags::Seamless_loop_shutdown);
|
|
}
|
|
else {
|
|
//Loop from start
|
|
instanceData.time = animationTimeWrap(instanceData.time, anim.m_flagData.loopsFrom, instanceData.duration, AnimationTimeWrapMode::WRAP).first;
|
|
}
|
|
}
|
|
else {
|
|
//Loop back
|
|
auto newState = animationTimeWrap(instanceData.time, 0, instanceData.duration, AnimationTimeWrapMode::BOUNCE);
|
|
instanceData.time = newState.first;
|
|
instanceData.canonicalDirection = newState.second ? ModelAnimationDirection::RWD : ModelAnimationDirection::FWD;
|
|
}
|
|
}
|
|
else if (anim.m_flags[Animation_Flags::Reset_at_completion])
|
|
//Stop animation at start, not end
|
|
anim.stop(pmi, false);
|
|
else {
|
|
instanceData.time = animationTimeWrap(instanceData.time, 0, instanceData.duration, AnimationTimeWrapMode::TRUNC).first;
|
|
// Normal execution, stop aniamtion at end
|
|
instanceData.state = ModelAnimationState::PAUSED;
|
|
instanceData.canonicalDirection = ModelAnimationDirection::RWD;
|
|
}
|
|
}
|
|
return;
|
|
|
|
case ModelAnimationDirection::RWD:
|
|
instanceData.time -= frametime;
|
|
|
|
//Cap time at 0, but don't clean up the animations here since this function is called in a loop over the running animations, and cleaning now would invalidate the iterator
|
|
if (instanceData.time < 0) {
|
|
if (anim.m_flags[Animation_Flags::Loop]) {
|
|
if (anim.m_flags[Animation_Flags::Reset_at_completion]) {
|
|
//Loop from end. This happens when a Loop + Reset at completion animation is started in reverse.
|
|
instanceData.time = animationTimeWrap(instanceData.time, 0, instanceData.duration, AnimationTimeWrapMode::WRAP).first;
|
|
}
|
|
else if (anim.m_flags[Animation_Flags::Seamless_with_startup]) {
|
|
if (instanceData.instance_flags[Animation_Instance_Flags::Seamless_loop_shutdown] || !instanceData.instance_flags[Animation_Instance_Flags::Seamless_fully_started]) {
|
|
// We're either in final shutdown, or reversed before we reached the seamless part. Either way, ensure the stop flag is set to fully stop
|
|
instanceData.instance_flags.set(Animation_Instance_Flags::Stop_after_next_loop);
|
|
}
|
|
else {
|
|
instanceData.time = animationTimeWrap(instanceData.time, anim.m_flagData.loopsFrom, instanceData.duration, AnimationTimeWrapMode::WRAP).first;
|
|
}
|
|
}
|
|
else {
|
|
//Loop back
|
|
auto newState = animationTimeWrap(instanceData.time, 0, instanceData.duration, AnimationTimeWrapMode::BOUNCE);
|
|
instanceData.time = newState.first;
|
|
instanceData.canonicalDirection = newState.second ? ModelAnimationDirection::FWD : ModelAnimationDirection::RWD;
|
|
}
|
|
//For backwards, ALL completion triggers are considered finishes, so always stop if we need to
|
|
if (instanceData.instance_flags[Animation_Instance_Flags::Stop_after_next_loop])
|
|
anim.stop(pmi, false);
|
|
}
|
|
else
|
|
anim.stop(pmi, false);
|
|
}
|
|
else if (anim.m_flags[Animation_Flags::Seamless_with_startup] && !instanceData.instance_flags[Animation_Instance_Flags::Seamless_loop_shutdown] && instanceData.time < anim.m_flagData.loopsFrom) {
|
|
//Loop from end. This happens when a seamless loop is reversed after entering the seamless part. If stop is set, set the shutdown flag instead
|
|
if (instanceData.instance_flags[Animation_Instance_Flags::Stop_after_next_loop])
|
|
instanceData.instance_flags.set(Animation_Instance_Flags::Seamless_loop_shutdown);
|
|
else
|
|
instanceData.time = animationTimeWrap(instanceData.time, anim.m_flagData.loopsFrom, instanceData.duration, AnimationTimeWrapMode::WRAP).first;
|
|
}
|
|
return;
|
|
}
|
|
}
|
|
|
|
ModelAnimationState ModelAnimation::play(float frametime, polymodel_instance* pmi, ModelAnimationSubmodelBuffer& applyBuffer, bool applyOnly) {
|
|
instance_data& instanceData = m_instances[pmi->id];
|
|
|
|
if (applyOnly) {
|
|
m_animation->calculateAnimation(applyBuffer, instanceData.time, pmi->id);
|
|
|
|
return instanceData.state;
|
|
}
|
|
|
|
float prevTime = instanceData.time;
|
|
|
|
switch (instanceData.state) {
|
|
case ModelAnimationState::UNTRIGGERED:
|
|
//We have a new animation starting up in this phase. Put it in the list of running animations to track and step it later
|
|
if (!m_isInitialType) {
|
|
auto& animEntry = ModelAnimationSet::s_runningAnimations[pmi->id];
|
|
animEntry.parentSet = m_set;
|
|
|
|
auto thisPtr = shared_from_this();
|
|
|
|
animEntry.animationList.push_back(std::move(thisPtr));
|
|
}
|
|
|
|
/* fall-thru */
|
|
case ModelAnimationState::NEED_RECALC: {
|
|
ModelAnimationSubmodelBuffer currentAnimationDelta;
|
|
m_set->initializeSubmodelBuffer(pmi, currentAnimationDelta);
|
|
//Store the submodels current data as the base for this animation and calculate this animations parameters
|
|
m_animation->recalculate(applyBuffer, currentAnimationDelta, pmi);
|
|
|
|
instanceData.duration = m_animation->getDuration(pmi->id);
|
|
instanceData.canonicalDirection = ModelAnimationDirection::FWD;
|
|
instanceData.state = ModelAnimationState::RUNNING;
|
|
instanceData.time = 0;
|
|
|
|
for (const auto& initialDriver : m_startupDrivers) {
|
|
initialDriver(*this, instanceData, pmi);
|
|
}
|
|
|
|
if (m_flags[Animation_Flags::Random_starting_phase]) {
|
|
instanceData.time = util::Random::next() * util::Random::INV_F_MAX_VALUE * instanceData.duration;
|
|
//Check if we might be on the way backwards
|
|
if (m_flags.any_of(Animation_Flags::Loop,Animation_Flags::Auto_Reverse) &&
|
|
!m_flags[Animation_Flags::Reset_at_completion] && util::Random::flip_coin()) {
|
|
prevTime = instanceData.duration;
|
|
instanceData.canonicalDirection = ModelAnimationDirection::RWD;
|
|
}
|
|
}
|
|
}
|
|
|
|
/* fall-thru */
|
|
case ModelAnimationState::RUNNING:
|
|
m_driver(*this, instanceData, pmi, frametime);
|
|
|
|
for (const auto& driver : m_propertyDrivers) {
|
|
driver(*this, instanceData, pmi);
|
|
}
|
|
|
|
m_animation->calculateAnimation(applyBuffer, instanceData.time, pmi->id);
|
|
|
|
if ((prevTime > instanceData.time && instanceData.canonicalDirection == ModelAnimationDirection::FWD) || (prevTime < instanceData.time && instanceData.canonicalDirection == ModelAnimationDirection::RWD)) {
|
|
//We _should_ have been going FWD, but we appear to have gone backwards (or we _should_ have been going FWD, but we appear to have gone forwards).
|
|
//This indicates that we looped around, or that we did a hard reset. Unfortunately, we can't quite differentiate that.
|
|
m_animation->executeAnimation(applyBuffer, 0.0f, MIN(prevTime, instanceData.time), instanceData.canonicalDirection, pmi->id);
|
|
m_animation->executeAnimation(applyBuffer, MAX(prevTime, instanceData.time), instanceData.duration, instanceData.canonicalDirection, pmi->id);
|
|
}
|
|
else
|
|
m_animation->executeAnimation(applyBuffer, MIN(prevTime, instanceData.time), MAX(prevTime, instanceData.time), instanceData.canonicalDirection, pmi->id);
|
|
break;
|
|
|
|
case ModelAnimationState::PAUSED:
|
|
//Shouldn't happen. Paused Animations are only allowed to be apply only.
|
|
UNREACHABLE("Tried to play a paused animation without starting it. Get a coder.");
|
|
break;
|
|
}
|
|
|
|
return instanceData.state;
|
|
}
|
|
|
|
void ModelAnimation::start(polymodel_instance* pmi, ModelAnimationDirection direction, bool force, bool instant, bool pause, const float* multiOverrideTime) {
|
|
if (pmi == nullptr)
|
|
return;
|
|
|
|
instance_data& instanceData = m_instances[pmi->id];
|
|
|
|
if (multiOverrideTime == nullptr && m_isMultiCompatible && (Game_mode & GM_MULTIPLAYER) && id != 0) {
|
|
//We are in multiplayer. Send animation to server to start. Server starts animation online, and sends start request back (which'll have multiOverride == true).
|
|
//If we _are_ the server, also just start the animation
|
|
|
|
object* objp = pmi->objnum >= 0 ? &Objects[pmi->objnum] : nullptr;
|
|
|
|
if(objp != nullptr)
|
|
send_animation_triggered_packet(id, objp, 0, direction, force, instant, pause);
|
|
else {
|
|
//Find special mode based on id and send
|
|
}
|
|
|
|
if(MULTIPLAYER_CLIENT)
|
|
return;
|
|
}
|
|
|
|
if (pause || (direction == ModelAnimationDirection::RWD && m_flags[Animation_Flags::Pause_on_reverse])) {
|
|
if(instanceData.state != ModelAnimationState::UNTRIGGERED && instanceData.state != ModelAnimationState::NEED_RECALC)
|
|
instanceData.state = ModelAnimationState::PAUSED;
|
|
return;
|
|
}
|
|
else if (instanceData.state == ModelAnimationState::PAUSED) {
|
|
instanceData.state = ModelAnimationState::RUNNING;
|
|
return;
|
|
}
|
|
|
|
float timeOffset = multiOverrideTime != nullptr ? *multiOverrideTime : 0.0f;
|
|
|
|
//Make sure to recalculate the animation here, as otherwise we cannot inquire about things like length after starting.
|
|
//Don't apply just yet if it's a non-initial type, as there might be other animations this'd need to depend upon
|
|
ModelAnimationSubmodelBuffer applyBuffer;
|
|
m_set->initializeSubmodelBuffer(pmi, applyBuffer);
|
|
auto runningAnims = m_set->s_runningAnimations.find(pmi->id);
|
|
if (runningAnims != m_set->s_runningAnimations.end()) {
|
|
for (const auto& anim : runningAnims->second.animationList)
|
|
anim->play(0, pmi, applyBuffer, true);
|
|
}
|
|
play(0, pmi, applyBuffer);
|
|
|
|
if (direction == ModelAnimationDirection::RWD) {
|
|
instanceData.state = ModelAnimationState::RUNNING;
|
|
instanceData.time -= timeOffset;
|
|
instanceData.canonicalDirection = ModelAnimationDirection::RWD;
|
|
if (force)
|
|
instanceData.time = instant ? 0 : instanceData.duration - timeOffset;
|
|
}
|
|
else {
|
|
instanceData.state = ModelAnimationState::RUNNING;
|
|
instanceData.time += timeOffset;
|
|
instanceData.canonicalDirection = ModelAnimationDirection::FWD;
|
|
if (force)
|
|
instanceData.time = instant ? instanceData.duration : 0 + timeOffset;
|
|
}
|
|
|
|
//Since initial types never get stepped, they need to be manually applied here once.
|
|
if (m_isInitialType) {
|
|
m_set->initializeSubmodelBuffer(pmi, applyBuffer);
|
|
play(0, pmi, applyBuffer);
|
|
ModelAnimationSet::apply(pmi, applyBuffer);
|
|
|
|
//Save the things modified by initial animations as actual baseline
|
|
for (const auto& initialModified : applyBuffer) {
|
|
if (initialModified.second.modified)
|
|
initialModified.first->saveCurrentAsBase(pmi, true);
|
|
}
|
|
}
|
|
}
|
|
|
|
void ModelAnimation::stop(polymodel_instance* pmi, bool cleanup, bool forceStop) {
|
|
//If inaccuracies occur, this needs to reset again, but only if no other animation is running on this submodel
|
|
/*for (const auto& animation : m_submodelAnimation) {
|
|
animation->reset(pmi);
|
|
}*/
|
|
|
|
if (!pmi)
|
|
return;
|
|
|
|
if (forceStop)
|
|
m_animation->forceStopAnimation(pmi->id);
|
|
|
|
instance_data& instanceData = m_instances[pmi->id];
|
|
instanceData.time = 0.0f;
|
|
instanceData.state = ModelAnimationState::UNTRIGGERED;
|
|
instanceData.instance_flags.reset();
|
|
|
|
if (cleanup)
|
|
ModelAnimationSet::cleanRunning();
|
|
}
|
|
|
|
float ModelAnimation::getTime(int pmi_id) const{
|
|
auto instance = m_instances.find(pmi_id);
|
|
if (instance != m_instances.end())
|
|
return instance->second.time;
|
|
return 0.0f;
|
|
}
|
|
|
|
void ModelAnimation::stepAnimations(float frametime, polymodel_instance* pmi) {
|
|
auto animListIt = ModelAnimationSet::s_runningAnimations.find(pmi->id);
|
|
|
|
if (animListIt == ModelAnimationSet::s_runningAnimations.end())
|
|
return;
|
|
|
|
const auto& animList = animListIt->second;
|
|
|
|
ModelAnimationSubmodelBuffer applyBuffer;
|
|
animList.parentSet->initializeSubmodelBuffer(pmi, applyBuffer);
|
|
|
|
for (const auto& anim : animList.animationList) {
|
|
const auto& instanceData = anim->m_instances[pmi->id];
|
|
switch (instanceData.state) {
|
|
case ModelAnimationState::RUNNING:
|
|
case ModelAnimationState::NEED_RECALC:
|
|
anim->play(frametime * instanceData.speed, pmi, applyBuffer);
|
|
break;
|
|
case ModelAnimationState::PAUSED:
|
|
anim->play(frametime, pmi, applyBuffer, true);
|
|
//Currently not moving. Keep in buffer in case some other animation starts on that submodel, but don't play without manual starting
|
|
break;
|
|
case ModelAnimationState::UNTRIGGERED:
|
|
UNREACHABLE("An untriggered animation should not be in the runningAnimations buffer");
|
|
break;
|
|
}
|
|
|
|
}
|
|
|
|
ModelAnimationSet::apply(pmi, applyBuffer);
|
|
|
|
//Clear Animations that might have completed this frame.
|
|
ModelAnimationSet::cleanRunning();
|
|
}
|
|
|
|
ModelAnimationData<> ModelAnimationSubmodel::identity(ZERO_VECTOR, IDENTITY_MATRIX);
|
|
|
|
ModelAnimationSubmodel::ModelAnimationSubmodel(SCP_string submodelName) {
|
|
SCP_tolower(submodelName);
|
|
m_name = std::move(submodelName);
|
|
}
|
|
|
|
ModelAnimationSubmodel* ModelAnimationSubmodel::copy() const {
|
|
return new ModelAnimationSubmodel(*this);
|
|
}
|
|
|
|
const ModelAnimationData<>& ModelAnimationSubmodel::getInitialData(polymodel_instance* pmi) {
|
|
auto dataIt = m_initialData.find({ pmi->id });
|
|
if (dataIt == m_initialData.end()) {
|
|
if (!saveCurrentAsBase(pmi)) {
|
|
return identity;
|
|
}
|
|
}
|
|
|
|
return m_initialData.at(pmi->id);
|
|
}
|
|
|
|
void ModelAnimationSubmodel::reset(polymodel_instance* pmi) {
|
|
auto cache_it = m_submodel.find(pmi->model_num);
|
|
if (cache_it == m_submodel.end())
|
|
findSubmodel(pmi);
|
|
|
|
auto dataIt = m_initialData.find({ pmi->id });
|
|
if (dataIt == m_initialData.end())
|
|
return;
|
|
|
|
//Since resetting the submodel animation also has to happen for the submodel itself, copy its state at the animation's start back to the submodel
|
|
copyToSubmodel(dataIt->second, pmi);
|
|
}
|
|
|
|
void ModelAnimationSubmodel::copyToSubmodel(const ModelAnimationData<>& data, polymodel_instance* pmi) {
|
|
submodel_instance* submodel = findSubmodel(pmi).first;
|
|
if (!submodel)
|
|
return;
|
|
|
|
// rotation -----
|
|
|
|
submodel->canonical_prev_orient = submodel->canonical_orient;
|
|
submodel->canonical_orient = data.orientation;
|
|
|
|
matrix delta;
|
|
vm_copy_transpose(&delta, &submodel->canonical_prev_orient);
|
|
vm_matrix_x_matrix(&delta, &submodel->canonical_orient, &delta);
|
|
|
|
float deltaAngle;
|
|
vm_matrix_to_rot_axis_and_angle(&delta, &deltaAngle, &submodel->rotation_axis);
|
|
submodel->current_turn_rate = deltaAngle / flFrametime;
|
|
|
|
// translation -----
|
|
|
|
submodel->canonical_prev_offset = submodel->canonical_offset;
|
|
submodel->canonical_offset = data.position;
|
|
|
|
vec3d delta_vec;
|
|
vm_vec_sub(&delta_vec, &submodel->canonical_offset, &submodel->canonical_prev_offset);
|
|
|
|
// figure out the sign of the displacement based on whether it is along or against the axis
|
|
int sign = (vm_vec_dot(&delta_vec, &submodel->translation_axis) < 0.0f) ? -1 : 1;
|
|
|
|
float deltaMag = sign * vm_vec_mag(&delta_vec);
|
|
submodel->current_shift_rate = deltaMag / flFrametime;
|
|
}
|
|
|
|
void ModelAnimationSubmodel::resetPhysicsData(polymodel_instance* pmi) {
|
|
submodel_instance* submodel = findSubmodel(pmi).first;
|
|
if (!submodel)
|
|
return;
|
|
|
|
submodel->canonical_prev_orient = submodel->canonical_orient;
|
|
submodel->current_turn_rate = 0.0f;
|
|
}
|
|
|
|
bool ModelAnimationSubmodel::saveCurrentAsBase(polymodel_instance* pmi, bool isInitialType) {
|
|
auto submodel = findSubmodel(pmi);
|
|
|
|
if (!submodel.first || !submodel.second)
|
|
return false;
|
|
|
|
ModelAnimationData<>& data = m_initialData[{ pmi->id }];
|
|
|
|
if(!submodel.second->flags[Model::Submodel_flags::Can_move]){
|
|
mprintf(("Submodel %s of model %s is animated and has movement enabled.\n", submodel.second->name, model_get(pmi->model_num)->filename));
|
|
submodel.second->flags.set(Model::Submodel_flags::Can_move);
|
|
|
|
if (submodel.second->rotation_type == MOVEMENT_TYPE_NONE) {
|
|
submodel.second->rotation_type = MOVEMENT_TYPE_TRIGGERED;
|
|
}
|
|
if (submodel.second->translation_type == MOVEMENT_TYPE_NONE) {
|
|
submodel.second->translation_type = MOVEMENT_TYPE_TRIGGERED;
|
|
}
|
|
}
|
|
|
|
data.orientation = submodel.first->canonical_orient;
|
|
data.position = submodel.first->canonical_offset;
|
|
|
|
//In this case, we just initial-type initialized the submodel. Properly set its last frame data as well
|
|
if (isInitialType) {
|
|
submodel.first->canonical_prev_orient = submodel.first->canonical_orient;
|
|
submodel.first->canonical_prev_offset = submodel.first->canonical_offset;
|
|
}
|
|
|
|
return true;
|
|
}
|
|
|
|
std::pair<submodel_instance*, bsp_info*> ModelAnimationSubmodel::findSubmodel(polymodel_instance* pmi) {
|
|
//Ship was deleted
|
|
if(pmi->id < 0)
|
|
return { nullptr, nullptr };
|
|
|
|
int submodelNumber = -1;
|
|
|
|
polymodel* pm = model_get(pmi->model_num);
|
|
|
|
//Do we have a submodel number already cached?
|
|
auto cache_it = m_submodel.find(pm->id);
|
|
if (cache_it != m_submodel.end())
|
|
submodelNumber = cache_it->second;
|
|
//We seem to have a submodel name
|
|
else {
|
|
for (int i = 0; i < pm->n_models; i++) {
|
|
if (!subsystem_stricmp(pm->submodel[i].name, m_name.c_str())) {
|
|
submodelNumber = i;
|
|
break;
|
|
}
|
|
}
|
|
|
|
m_submodel.emplace(pm->id, submodelNumber);
|
|
}
|
|
|
|
//If the model does not exist, return null. The system is expected to just silently tolerate this,
|
|
//as this needs to be the case to be able to handle turrets whose barrels may or may not exist, depending on the pof which is not loaded at table parse time
|
|
if (submodelNumber < 0 || submodelNumber >= pm->n_models)
|
|
return { nullptr, nullptr };
|
|
|
|
return { &pmi->submodel[submodelNumber], &pm->submodel[submodelNumber] };
|
|
}
|
|
|
|
ModelAnimationSubmodelTurret::ModelAnimationSubmodelTurret(SCP_string subsystemName, bool findBarrel, SCP_string SIPname) : ModelAnimationSubmodel(std::move(subsystemName)), m_SIPname(std::move(SIPname)), m_findBarrel(findBarrel) {
|
|
is_turret = true;
|
|
}
|
|
|
|
ModelAnimationSubmodel* ModelAnimationSubmodelTurret::copy() const {
|
|
return new ModelAnimationSubmodelTurret(*this);
|
|
}
|
|
|
|
void ModelAnimationSubmodelTurret::renameSIP(const SCP_string& newSIPname) {
|
|
m_SIPname = newSIPname;
|
|
}
|
|
|
|
std::pair<submodel_instance*, bsp_info*> ModelAnimationSubmodelTurret::findSubmodel(polymodel_instance* pmi) {
|
|
//Ship was deleted
|
|
if (pmi->id < 0)
|
|
return { nullptr, nullptr };
|
|
|
|
int submodelNumber = -1;
|
|
|
|
polymodel* pm = model_get(pmi->model_num);
|
|
|
|
//Do we have a submodel number already cached?
|
|
auto cache_it = m_submodel.find(pm->id);
|
|
if (cache_it != m_submodel.end())
|
|
submodelNumber = cache_it->second;
|
|
//Do we know if we were told to find the barrel submodel or not? This implies we have a subsystem name, not a submodel name
|
|
else {
|
|
const ship_info* sip = nullptr;
|
|
if (pmi->objnum >= 0) {
|
|
sip = &Ship_info[Ships[Objects[pmi->objnum].instance].ship_info_index];
|
|
}
|
|
else {
|
|
//No objnum present. Check by SIP name we have saved (slow, so don't do if not absolutely necessary)
|
|
int sip_index = ship_info_lookup(m_SIPname.c_str());
|
|
|
|
if(sip_index < 0) //Give up
|
|
return { nullptr, nullptr };
|
|
|
|
sip = &Ship_info[sip_index];
|
|
}
|
|
|
|
for (int i = 0; i < sip->n_subsystems; i++) {
|
|
if (!subsystem_stricmp(sip->subsystems[i].subobj_name, m_name.c_str())) {
|
|
if (m_findBarrel) {
|
|
//Check if the barrel subobj is a dedicated existing subobj or just the base turret.
|
|
if (sip->subsystems[i].turret_gun_sobj != sip->subsystems[i].subobj_num)
|
|
submodelNumber = sip->subsystems[i].turret_gun_sobj;
|
|
else
|
|
submodelNumber = -1;
|
|
}
|
|
else
|
|
submodelNumber = sip->subsystems[i].subobj_num;
|
|
break;
|
|
}
|
|
}
|
|
|
|
m_submodel.emplace(pm->id, submodelNumber);
|
|
}
|
|
|
|
//If the model does not exist, return null. The system is expected to just silently tolerate this,
|
|
//as this needs to be the case to be able to handle turrets whose barrels may or may not exist, depending on the pof which is not loaded at table parse time
|
|
if (submodelNumber < 0 || submodelNumber >= pm->n_models)
|
|
return { nullptr, nullptr };
|
|
|
|
return { &pmi->submodel[submodelNumber], &pm->submodel[submodelNumber] };
|
|
}
|
|
|
|
//To handle Multipart-turrets properly, they need a modified version that sets the actual angle, not just the orientation matrix.
|
|
void ModelAnimationSubmodelTurret::copyToSubmodel(const ModelAnimationData<>& data, polymodel_instance* pmi) {
|
|
const auto& submodels = findSubmodel(pmi);
|
|
submodel_instance* submodel = submodels.first;
|
|
bsp_info* sm = submodels.second;
|
|
|
|
if (!submodel)
|
|
return;
|
|
|
|
// rotation -----
|
|
|
|
submodel->canonical_prev_orient = submodel->canonical_orient;
|
|
submodel->canonical_orient = data.orientation;
|
|
|
|
submodel->rotation_axis = sm->rotation_axis;
|
|
|
|
float angle = 0.0f;
|
|
vm_closest_angle_to_matrix(&submodel->canonical_orient, &sm->rotation_axis, &angle);
|
|
|
|
submodel->cur_angle = angle;
|
|
submodel->turret_idle_angle = angle;
|
|
|
|
// translation -----
|
|
|
|
submodel->canonical_prev_offset = submodel->canonical_offset;
|
|
submodel->canonical_offset = data.position;
|
|
|
|
submodel->translation_axis = sm->translation_axis;
|
|
|
|
// figure out the sign of the displacement based on whether it is along or against the axis
|
|
int sign = (vm_vec_dot(&submodel->canonical_offset, &submodel->translation_axis) < 0.0f) ? -1 : 1;
|
|
|
|
submodel->cur_offset = sign * vm_vec_mag(&submodel->canonical_offset);
|
|
}
|
|
|
|
|
|
float ModelAnimationSegment::getDuration(int pmi_id) const {
|
|
return m_duration.at(pmi_id);
|
|
}
|
|
|
|
|
|
int ModelAnimationSet::SUBTYPE_DEFAULT = ANIMATION_SUBTYPE_ALL;
|
|
|
|
ModelAnimationSet::ModelAnimationSet(SCP_string SIPname) : m_SIPname(std::move(SIPname)) { };
|
|
|
|
ModelAnimationSet::ModelAnimationSet(const ModelAnimationSet& other) {
|
|
operator=(other);
|
|
}
|
|
|
|
ModelAnimationSet::ModelAnimationSet(ModelAnimationSet&& other) noexcept {
|
|
*this = std::move(other);
|
|
}
|
|
|
|
ModelAnimationSet& ModelAnimationSet::operator=(ModelAnimationSet&& other) noexcept {
|
|
if (this == &other)
|
|
return *this;
|
|
|
|
std::swap(m_submodels, other.m_submodels);
|
|
std::swap(m_animationSet, other.m_animationSet);
|
|
std::swap(m_moveableSet, other.m_moveableSet);
|
|
std::swap(m_SIPname, other.m_SIPname);
|
|
|
|
for (const auto& animationTypes : m_animationSet) {
|
|
for (const auto& animations : animationTypes.second) {
|
|
for (const auto& animation : animations.second) {
|
|
animation->m_animation->exchangeSubmodelPointers(*this);
|
|
animation->m_set = this;
|
|
}
|
|
}
|
|
}
|
|
|
|
return *this;
|
|
}
|
|
|
|
ModelAnimationSet& ModelAnimationSet::operator=(const ModelAnimationSet& other) {
|
|
m_SIPname = other.m_SIPname;
|
|
|
|
for (const auto& submodel : other.m_submodels) {
|
|
auto newSubmodel = std::shared_ptr<ModelAnimationSubmodel>(submodel->copy());
|
|
newSubmodel->m_submodel = {};
|
|
m_submodels.push_back(std::move(newSubmodel));
|
|
}
|
|
|
|
for (const auto& animationTypes : other.m_animationSet) {
|
|
auto& newAnimations = m_animationSet[animationTypes.first];
|
|
for (const auto& oldAnimations : animationTypes.second) {
|
|
for (const auto& oldAnimation : oldAnimations.second) {
|
|
std::shared_ptr<ModelAnimation> newAnimation = std::make_shared<ModelAnimation>(*oldAnimation);
|
|
newAnimation->m_animation = std::shared_ptr<ModelAnimationSegment>(newAnimation->m_animation->copy());
|
|
|
|
newAnimation->m_animation->exchangeSubmodelPointers(*this);
|
|
newAnimation->m_set = this;
|
|
|
|
newAnimations[oldAnimations.first].push_back(std::move(newAnimation));
|
|
}
|
|
}
|
|
}
|
|
|
|
m_moveableSet = other.m_moveableSet;
|
|
|
|
return *this;
|
|
}
|
|
|
|
std::shared_ptr<ModelAnimation> ModelAnimationSet::emplace(const std::shared_ptr<ModelAnimation>& animation, const SCP_string& request, const SCP_string& name, ModelAnimationTriggerType type, int subtype, unsigned int uniqueId) {
|
|
auto newAnim = std::make_shared<ModelAnimation>(*animation);
|
|
newAnim->m_set = this;
|
|
newAnim->m_animation = std::shared_ptr<ModelAnimationSegment>(animation->m_animation->copy());
|
|
newAnim->m_animation->exchangeSubmodelPointers(*this);
|
|
newAnim->id = uniqueId;
|
|
newAnim->request = request;
|
|
ModelAnimationSet::s_animationById[uniqueId] = newAnim;
|
|
m_animationSet[{type, subtype}][name].push_back(newAnim);
|
|
return newAnim;
|
|
}
|
|
|
|
void ModelAnimationSet::changeShipName(const SCP_string& name) {
|
|
unsigned int hash_change = hash_fnv1a(m_SIPname) ^ hash_fnv1a(name);
|
|
|
|
m_SIPname = name;
|
|
for (const auto& submodel : m_submodels) {
|
|
submodel->renameSIP(name);
|
|
}
|
|
|
|
for (const auto& animationTypes : m_animationSet) {
|
|
for (const auto& animations : animationTypes.second) {
|
|
for (const auto& animation : animations.second) {
|
|
animation->id ^= hash_change;
|
|
ModelAnimationSet::s_animationById[animation->id] = animation;
|
|
}
|
|
}
|
|
}
|
|
}
|
|
|
|
void ModelAnimationSet::cleanRunning() {
|
|
auto removeIt = s_runningAnimations.begin();
|
|
while (removeIt != s_runningAnimations.end()) {
|
|
auto animIt = removeIt->second.animationList.cbegin();
|
|
while (animIt != removeIt->second.animationList.cend()) {
|
|
if ((*animIt)->m_instances[removeIt->first].state == ModelAnimationState::UNTRIGGERED) {
|
|
animIt = removeIt->second.animationList.erase(animIt);
|
|
}
|
|
else
|
|
animIt++;
|
|
}
|
|
|
|
if (removeIt->second.animationList.empty()) {
|
|
removeIt = s_runningAnimations.erase(removeIt);
|
|
}
|
|
else
|
|
removeIt++;
|
|
}
|
|
}
|
|
|
|
void ModelAnimationSet::stopAnimations(polymodel_instance* pmi) {
|
|
if (pmi != nullptr) {
|
|
for (const auto& anim : s_runningAnimations[pmi->id].animationList) {
|
|
anim->stop(pmi, false, true);
|
|
}
|
|
s_runningAnimations.erase(pmi->id);
|
|
}
|
|
else {
|
|
for (const auto& animList : s_runningAnimations) {
|
|
for (const auto& anim : animList.second.animationList) {
|
|
anim->stop(model_get_instance(animList.first), false, true);
|
|
}
|
|
}
|
|
|
|
s_runningAnimations.clear();
|
|
}
|
|
}
|
|
|
|
void ModelAnimationSet::clearShipData(polymodel_instance* pmi) {
|
|
for (const auto& submodel : m_submodels) {
|
|
submodel->m_initialData.erase(pmi->id);
|
|
}
|
|
for (const auto& animations : m_animationSet) {
|
|
for (const auto& namedAnimations : animations.second) {
|
|
for (const auto& namedAnimation : namedAnimations.second) {
|
|
namedAnimation->m_instances.erase(pmi->id);
|
|
}
|
|
}
|
|
}
|
|
}
|
|
|
|
void ModelAnimationSet::apply(polymodel_instance* pmi, const ModelAnimationSubmodelBuffer& applyBuffer) {
|
|
for (const auto& toApply : applyBuffer) {
|
|
if (toApply.second.modified)
|
|
toApply.first->copyToSubmodel(toApply.second.data, pmi);
|
|
else
|
|
toApply.first->resetPhysicsData(pmi);
|
|
}
|
|
}
|
|
|
|
void ModelAnimationSet::initializeSubmodelBuffer(polymodel_instance* pmi, ModelAnimationSubmodelBuffer& applyBuffer) const {
|
|
for (const auto& submodel : m_submodels) {
|
|
ModelAnimationData<> base = submodel->getInitialData(pmi);
|
|
applyBuffer[submodel].data = base;
|
|
applyBuffer[submodel].modified = false;
|
|
}
|
|
}
|
|
|
|
ModelAnimationSet::AnimationList ModelAnimationSet::get(polymodel_instance* pmi, ModelAnimationTriggerType type, const SCP_string& name, int subtype) const {
|
|
if (pmi == nullptr || pmi->id < 0)
|
|
return ModelAnimationSet::AnimationList();
|
|
|
|
ModelAnimationSet::AnimationList list{ pmi };
|
|
|
|
auto animations = m_animationSet.find({ type, subtype });
|
|
if (animations != m_animationSet.end()) {
|
|
auto namedAnimations = animations->second.find(name);
|
|
if (namedAnimations != animations->second.end()) {
|
|
list.animations.insert(list.animations.end(), namedAnimations->second.cbegin(), namedAnimations->second.cend());
|
|
}
|
|
}
|
|
|
|
//Only search for default anims again if these weren't looked for in the first place
|
|
if (subtype == SUBTYPE_DEFAULT)
|
|
return list;
|
|
|
|
animations = m_animationSet.find({ type, SUBTYPE_DEFAULT });
|
|
if (animations != m_animationSet.end()) {
|
|
auto namedAnimations = animations->second.find(name);
|
|
if (namedAnimations != animations->second.end()) {
|
|
list.animations.insert(list.animations.end(), namedAnimations->second.cbegin(), namedAnimations->second.cend());
|
|
}
|
|
}
|
|
|
|
return list;
|
|
}
|
|
|
|
ModelAnimationSet::AnimationList ModelAnimationSet::getAll(polymodel_instance* pmi, ModelAnimationTriggerType type, int subtype, bool strict) const {
|
|
if (pmi == nullptr || pmi->id < 0)
|
|
return ModelAnimationSet::AnimationList();
|
|
|
|
ModelAnimationSet::AnimationList list{ pmi };
|
|
|
|
auto animations = m_animationSet.find({ type, subtype });
|
|
if (animations != m_animationSet.end()) {
|
|
for (auto& namedAnimations : animations->second) {
|
|
list.animations.insert(list.animations.end(), namedAnimations.second.cbegin(), namedAnimations.second.cend());
|
|
}
|
|
}
|
|
|
|
//Only search for default anims again if these weren't looked for in the first place
|
|
if (strict || subtype == SUBTYPE_DEFAULT)
|
|
return list;
|
|
|
|
animations = m_animationSet.find({ type, SUBTYPE_DEFAULT });
|
|
if (animations != m_animationSet.end()) {
|
|
for (auto& namedAnimations : animations->second) {
|
|
list.animations.insert(list.animations.end(), namedAnimations.second.cbegin(), namedAnimations.second.cend());
|
|
}
|
|
}
|
|
return list;
|
|
}
|
|
|
|
ModelAnimationSet::AnimationList ModelAnimationSet::getBlanket(polymodel_instance* pmi, ModelAnimationTriggerType type) const {
|
|
if (pmi == nullptr || pmi->id < 0)
|
|
return ModelAnimationSet::AnimationList();
|
|
|
|
ModelAnimationSet::AnimationList list{ pmi };
|
|
|
|
for (const auto& animations : m_animationSet) {
|
|
if (animations.first.type != type)
|
|
continue;
|
|
|
|
for (const auto& namedAnimation : animations.second) {
|
|
list.animations.insert(list.animations.end(), namedAnimation.second.cbegin(), namedAnimation.second.cend());
|
|
}
|
|
}
|
|
|
|
return list;
|
|
}
|
|
|
|
//Yes why of course does this need special handling...
|
|
ModelAnimationSet::AnimationList ModelAnimationSet::getDockBayDoors(polymodel_instance* pmi, int subtype) const {
|
|
if (pmi == nullptr || pmi->id < 0)
|
|
return ModelAnimationSet::AnimationList();
|
|
|
|
ModelAnimationSet::AnimationList list{ pmi };
|
|
subtype++;
|
|
|
|
for (const auto& animList : m_animationSet) {
|
|
if (animList.first.type != ModelAnimationTriggerType::DockBayDoor)
|
|
continue;
|
|
|
|
if (animList.first.subtype != ModelAnimationSet::SUBTYPE_DEFAULT) {
|
|
//Trigger on all but x type
|
|
if (animList.first.subtype < 0 && animList.first.subtype == subtype)
|
|
continue;
|
|
|
|
//Trigger only on x type. For the record, animsubtype 0 cannot happen here.
|
|
if (animList.first.subtype > 0 && animList.first.subtype != subtype)
|
|
continue;
|
|
}
|
|
for (auto& namedAnimations : animList.second) {
|
|
list.animations.insert(list.animations.end(), namedAnimations.second.cbegin(), namedAnimations.second.cend());
|
|
}
|
|
}
|
|
return list;
|
|
}
|
|
|
|
SCP_vector<ModelAnimationSet::RegisteredTrigger> ModelAnimationSet::getRegisteredTriggers() const {
|
|
SCP_vector<RegisteredTrigger> ret;
|
|
|
|
for (const auto& animList : m_animationSet) {
|
|
for (const auto& animation : animList.second) {
|
|
ret.push_back({ animList.first.type, animList.first.subtype, animation.first });
|
|
}
|
|
}
|
|
|
|
return ret;
|
|
};
|
|
|
|
SCP_set<SCP_string> ModelAnimationSet::getRegisteredAnimNames() const {
|
|
SCP_set<SCP_string> ret;
|
|
|
|
for (const auto& animList : m_animationSet) {
|
|
for (const auto& animationL : animList.second) {
|
|
for (const auto& animation : animationL.second) {
|
|
ret.emplace(animation->request);
|
|
}
|
|
}
|
|
}
|
|
|
|
return ret;
|
|
}
|
|
|
|
bool ModelAnimationSet::AnimationList::start(ModelAnimationDirection direction, bool forced, bool instant, bool pause) const {
|
|
if (pmi_id < 0)
|
|
return false;
|
|
|
|
polymodel_instance* pmi = model_get_instance(pmi_id);
|
|
for(const auto& anim : animations)
|
|
anim->start(pmi, direction, forced, instant, pause);
|
|
|
|
return !animations.empty();
|
|
}
|
|
|
|
int ModelAnimationSet::AnimationList::getTime() const {
|
|
if (pmi_id < 0)
|
|
return 0;
|
|
|
|
float duration = 0.0f;
|
|
|
|
for (const auto& anim : animations) {
|
|
if (anim->m_instances[pmi_id].state == ModelAnimationState::UNTRIGGERED)
|
|
continue;
|
|
float localDur = anim->m_instances[pmi_id].duration;
|
|
duration = duration < localDur ? localDur : duration;
|
|
}
|
|
|
|
return (int)(duration * 1000.0f);
|
|
}
|
|
|
|
void ModelAnimationSet::AnimationList::setFlag(Animation_Instance_Flags flag, bool set) const {
|
|
if (pmi_id < 0)
|
|
return;
|
|
|
|
for (const auto& anim : animations)
|
|
anim->m_instances[pmi_id].instance_flags.set(flag, set);
|
|
}
|
|
|
|
void ModelAnimationSet::AnimationList::setSpeed(float speed) const {
|
|
if (pmi_id < 0)
|
|
return;
|
|
|
|
for (const auto& anim : animations)
|
|
anim->m_instances[pmi_id].speed = speed;
|
|
};
|
|
|
|
ModelAnimationSet::AnimationList& ModelAnimationSet::AnimationList::operator+=(const AnimationList& rhs) {
|
|
Assertion(pmi_id == rhs.pmi_id, "Tried to concatenate two AnimationLists of different model instances!");
|
|
animations.insert(animations.end(), rhs.animations.cbegin(), rhs.animations.cend());
|
|
return *this;
|
|
}
|
|
|
|
ModelAnimationSet::AnimationList ModelAnimationSet::AnimationList::operator+(const AnimationList& rhs) {
|
|
Assertion(pmi_id == rhs.pmi_id, "Tried to concatenate two AnimationLists of different model instances!");
|
|
AnimationList result = *this;
|
|
result.animations.insert(result.animations.end(), rhs.animations.cbegin(), rhs.animations.cend());
|
|
return result;
|
|
}
|
|
|
|
ModelAnimationSet::AnimationList ModelAnimationSet::parseScripted(polymodel_instance* pmi, ModelAnimationTriggerType type, const SCP_string& triggeredBy) const {
|
|
int subtype = ModelAnimationSet::SUBTYPE_DEFAULT;
|
|
|
|
switch (type) {
|
|
case ModelAnimationTriggerType::Docking_Stage1:
|
|
case ModelAnimationTriggerType::Docking_Stage2:
|
|
case ModelAnimationTriggerType::Docking_Stage3:
|
|
case ModelAnimationTriggerType::Docked: {
|
|
//The index of the dock port or name of the dock port.
|
|
if (can_construe_as_integer(triggeredBy.c_str()))
|
|
subtype = atoi(triggeredBy.c_str());
|
|
else
|
|
subtype = model_find_dock_name_index(pmi->model_num, triggeredBy.c_str());
|
|
|
|
SCP_string dock_name = model_get_dock_name(pmi->model_num, subtype);
|
|
|
|
ModelAnimationSet::AnimationList list = get(pmi, type, dock_name);
|
|
list += get(pmi, type, "");
|
|
list += getAll(pmi, type, subtype, true);
|
|
|
|
return list;
|
|
}
|
|
case ModelAnimationTriggerType::PrimaryBank:
|
|
case ModelAnimationTriggerType::SecondaryBank:
|
|
case ModelAnimationTriggerType::PrimaryFired:
|
|
case ModelAnimationTriggerType::SecondaryFired:
|
|
//The index of the bank
|
|
subtype = atoi(triggeredBy.c_str());
|
|
|
|
return getAll(pmi, type, subtype);
|
|
|
|
case ModelAnimationTriggerType::DockBayDoor:
|
|
//Index of the dock bay door
|
|
subtype = atoi(triggeredBy.c_str());
|
|
|
|
return getDockBayDoors(pmi, subtype);
|
|
|
|
case ModelAnimationTriggerType::Scripted:
|
|
//More accurate name of scripted animation
|
|
case ModelAnimationTriggerType::TurretFired:
|
|
case ModelAnimationTriggerType::TurretFiring: {
|
|
//Name of the turret subsys that needs to be firing
|
|
SCP_string name(triggeredBy);
|
|
SCP_tolower(name);
|
|
|
|
return get(pmi, type, name);
|
|
}
|
|
|
|
case ModelAnimationTriggerType::Afterburner:
|
|
case ModelAnimationTriggerType::OnSpawn:
|
|
//No triggered by specialization
|
|
return getAll(pmi, type);
|
|
|
|
case ModelAnimationTriggerType::Initial:
|
|
default:
|
|
// Can't trigger by script
|
|
Warning(LOCATION, "Initial-type animations cannot be triggered by script/SEXP!");
|
|
return ModelAnimationSet::AnimationList{};
|
|
}
|
|
}
|
|
|
|
bool ModelAnimationSet::updateMoveable(polymodel_instance* pmi, const SCP_string& name, const SCP_vector<std::any>& args) const {
|
|
SCP_string lowername = name;
|
|
SCP_tolower(lowername);
|
|
auto moveable = m_moveableSet.find(lowername);
|
|
if (moveable == m_moveableSet.end())
|
|
return false;
|
|
|
|
moveable->second->update(pmi, args);
|
|
return true;
|
|
}
|
|
|
|
bool ModelAnimationSet::advanceMoveableToFinal(polymodel_instance* pmi, const SCP_string& name) const {
|
|
SCP_string lowername = name;
|
|
SCP_tolower(lowername);
|
|
auto moveable = m_moveableSet.find(lowername);
|
|
if (moveable == m_moveableSet.end())
|
|
return false;
|
|
|
|
moveable->second->advanceToFinalState(pmi);
|
|
return true;
|
|
}
|
|
|
|
void ModelAnimationSet::initializeMoveables(polymodel_instance* pmi) {
|
|
for(const auto& moveable : m_moveableSet){
|
|
moveable.second->initialize(this, pmi);
|
|
}
|
|
}
|
|
|
|
void ModelAnimationMoveable::advanceToFinalState(polymodel_instance* pmi) {
|
|
auto it = m_instances.find(pmi->id);
|
|
if (it == m_instances.end() || !it->second.animation)
|
|
return;
|
|
|
|
it->second.animation->start(pmi, ModelAnimationDirection::FWD, true, true);
|
|
}
|
|
|
|
SCP_vector<SCP_string> ModelAnimationSet::getRegisteredMoveables() const {
|
|
SCP_vector<SCP_string> ret;
|
|
|
|
for (const auto& moveable : m_moveableSet) {
|
|
ret.push_back(moveable.first);
|
|
}
|
|
|
|
return ret;
|
|
};
|
|
|
|
bool ModelAnimationSet::isEmpty() const {
|
|
for (const auto& animSet : m_animationSet) {
|
|
if (!animSet.second.empty())
|
|
return false;
|
|
}
|
|
|
|
return true;
|
|
};
|
|
|
|
std::shared_ptr<ModelAnimationSubmodel> ModelAnimationSet::getSubmodel(SCP_string submodelName) {
|
|
SCP_tolower(submodelName);
|
|
|
|
for (const auto& submodel : m_submodels) {
|
|
if (!submodel->is_turret && submodel->m_name == submodelName)
|
|
return submodel;
|
|
}
|
|
|
|
auto submodel = std::make_shared<ModelAnimationSubmodel>(std::move(submodelName));
|
|
m_submodels.push_back(submodel);
|
|
return submodel;
|
|
}
|
|
|
|
std::shared_ptr<ModelAnimationSubmodel> ModelAnimationSet::getSubmodel(SCP_string submodelName, const SCP_string& SIP_name, bool findBarrel) {
|
|
SCP_tolower(submodelName);
|
|
|
|
for (const auto& submodel : m_submodels) {
|
|
if (submodel->is_turret && submodel->m_name == submodelName) {
|
|
auto submodelTurret = ((ModelAnimationSubmodelTurret*)submodel.get());
|
|
if (submodelTurret->m_SIPname == SIP_name && submodelTurret->m_findBarrel == findBarrel)
|
|
return submodel;
|
|
}
|
|
}
|
|
|
|
auto submodel = std::make_shared<ModelAnimationSubmodelTurret>(std::move(submodelName), findBarrel, SIP_name);
|
|
m_submodels.push_back(submodel);
|
|
return submodel;
|
|
}
|
|
|
|
std::shared_ptr<ModelAnimationSubmodel> ModelAnimationSet::getSubmodel(const std::shared_ptr<ModelAnimationSubmodel>& other) {
|
|
if (other->is_turret) {
|
|
auto const turret = (const ModelAnimationSubmodelTurret*)other.get();
|
|
return getSubmodel(turret->m_name, m_SIPname, turret->m_findBarrel);
|
|
}
|
|
else
|
|
return getSubmodel(other->m_name);
|
|
}
|
|
|
|
|
|
void anim_set_initial_states(ship* shipp) {
|
|
ship_info* sip = &Ship_info[shipp->ship_info_index];
|
|
|
|
polymodel_instance* pmi = model_get_instance(shipp->model_instance_num);
|
|
|
|
sip->animations.clearShipData(pmi);
|
|
sip->animations.getAll(pmi, animation::ModelAnimationTriggerType::Initial).start(ModelAnimationDirection::FWD, true, true);
|
|
sip->animations.initializeMoveables(pmi);
|
|
sip->animations.getAll(pmi, animation::ModelAnimationTriggerType::OnSpawn).start(ModelAnimationDirection::FWD);
|
|
}
|
|
|
|
const SCP_unordered_map<ModelAnimationTriggerType, std::pair<const char*, bool>> Animation_types = {
|
|
{ModelAnimationTriggerType::Initial, {"initial", false}}, //Atypical case. Will only ever be run in fully triggered state and then applied as base transformation
|
|
{ModelAnimationTriggerType::OnSpawn, {"on-spawn", false}}, //Atypical case. While no reverse trigger occurs, it is also guaranteed to not trigger more than once per model, hence non-resetting animations are fine here.
|
|
{ModelAnimationTriggerType::Docking_Stage1, {"docking-stage-1", false}},
|
|
{ModelAnimationTriggerType::Docking_Stage2, {"docking-stage-2", false}},
|
|
{ModelAnimationTriggerType::Docking_Stage3, {"docking-stage-3", false}},
|
|
{ModelAnimationTriggerType::Docked, {"docked", false}},
|
|
{ModelAnimationTriggerType::PrimaryBank, {"primary-bank", false}},
|
|
{ModelAnimationTriggerType::SecondaryBank, {"secondary-bank", false}},
|
|
{ModelAnimationTriggerType::DockBayDoor, {"fighterbay", false}},
|
|
{ModelAnimationTriggerType::Afterburner, {"afterburner", false}},
|
|
{ModelAnimationTriggerType::TurretFiring, {"turret-firing", false}},
|
|
{ModelAnimationTriggerType::Scripted, {"scripted", false}},
|
|
{ModelAnimationTriggerType::TurretFired, {"turret-fired", true}},
|
|
{ModelAnimationTriggerType::PrimaryFired, {"primary-fired", true}},
|
|
{ModelAnimationTriggerType::SecondaryFired, {"secondary-fired", true}}
|
|
};
|
|
|
|
ModelAnimationTriggerType anim_match_type(const char* p)
|
|
{
|
|
// standard match
|
|
for (const auto& entry : Animation_types) {
|
|
if (!strnicmp(p, entry.second.first, strlen(entry.second.first)))
|
|
return entry.first;
|
|
}
|
|
|
|
// Goober5000 - misspelling
|
|
if (!strnicmp(p, "inital", 6) || !strnicmp(p, "\"inital\"", 8)) {
|
|
Warning(LOCATION, "Spelling error in table file. Please change \"inital\" to \"initial\".");
|
|
return ModelAnimationTriggerType::Initial;
|
|
}
|
|
|
|
// Goober5000 - deprecation
|
|
if (!strnicmp(p, "docking", 7) || !strnicmp(p, "\"docking\"", 9)) {
|
|
auto docking_string = Animation_types.find(ModelAnimationTriggerType::Docking_Stage2)->second.first;
|
|
mprintf(("The \"docking\" animation type name is deprecated. Specify \"%s\" instead.\n", docking_string));
|
|
return ModelAnimationTriggerType::Docking_Stage2;
|
|
}
|
|
else if (!strnicmp(p, "primary_bank", 12) || !strnicmp(p, "\"primary_bank\"", 14)) {
|
|
auto pbank_string = Animation_types.find(ModelAnimationTriggerType::PrimaryBank)->second.first;
|
|
mprintf(("The \"primary_bank\" animation type name is deprecated. Specify \"%s\" instead.\n", pbank_string));
|
|
return ModelAnimationTriggerType::PrimaryBank;
|
|
}
|
|
else if (!strnicmp(p, "secondary_bank", 14) || !strnicmp(p, "\"secondary_bank\"", 16)) {
|
|
auto sbank_string = Animation_types.find(ModelAnimationTriggerType::SecondaryBank)->second.first;
|
|
mprintf(("The \"secondary_bank\" animation type name is deprecated. Specify \"%s\" instead.\n", sbank_string));
|
|
return ModelAnimationTriggerType::SecondaryBank;
|
|
}
|
|
else if (!strnicmp(p, "door", 4) || !strnicmp(p, "\"door\"", 6)) {
|
|
auto docking_string = Animation_types.find(ModelAnimationTriggerType::DockBayDoor)->second.first;
|
|
mprintf(("The \"door\" animation type name is deprecated. Specify \"%s\" instead.\n", docking_string));
|
|
return ModelAnimationTriggerType::DockBayDoor;
|
|
}
|
|
else if (!strnicmp(p, "turret firing", 13) || !strnicmp(p, "\"turret firing\"", 15)) {
|
|
auto turret_string = Animation_types.find(ModelAnimationTriggerType::TurretFiring)->second.first;
|
|
mprintf(("The \"turret firing\" animation type name is deprecated. Specify \"%s\" instead.\n", turret_string));
|
|
return ModelAnimationTriggerType::TurretFiring;
|
|
}
|
|
|
|
// Goober5000 - with quotes
|
|
for (const auto& entry : Animation_types) {
|
|
char quoted_name[NAME_LENGTH + 2];
|
|
strcpy(quoted_name, "\"");
|
|
strcat(quoted_name, entry.second.first);
|
|
strcat(quoted_name, "\"");
|
|
|
|
if (!strnicmp(p, quoted_name, strlen(quoted_name))) {
|
|
mprintf(("Old usage warning: Please remove quotes from animation type %s.\n", quoted_name));
|
|
return entry.first;
|
|
}
|
|
}
|
|
|
|
return ModelAnimationTriggerType::None;
|
|
}
|
|
|
|
SCP_string anim_name_from_subsys(model_subsystem* ss) {
|
|
char namelower[MAX_NAME_LEN];
|
|
strncpy(namelower, ss->subobj_name, MAX_NAME_LEN);
|
|
strlwr(namelower);
|
|
return namelower;
|
|
}
|
|
|
|
//Parsing functions
|
|
SCP_unordered_map<SCP_string, ModelAnimationParseHelper::ParsedModelAnimation> ModelAnimationParseHelper::s_animationsById;
|
|
SCP_unordered_map<SCP_string, std::shared_ptr<ModelAnimationMoveable>> ModelAnimationParseHelper::s_moveablesById;
|
|
|
|
std::shared_ptr<ModelAnimationSegment> ModelAnimationParseHelper::parseSegment() {
|
|
ignore_white_space();
|
|
char segment_type[NAME_LENGTH];
|
|
stuff_string(segment_type, F_NAME, NAME_LENGTH);
|
|
|
|
auto segment_parser = s_segmentParsers.find(segment_type);
|
|
if (segment_parser != s_segmentParsers.end())
|
|
return segment_parser->second(this);
|
|
else {
|
|
error_display(1, "Unknown segment type %s in animation with ID %s!", segment_type, m_animationName.c_str());
|
|
return nullptr;
|
|
}
|
|
}
|
|
|
|
std::shared_ptr<ModelAnimationSubmodel> ModelAnimationParseHelper::parseSubmodel() {
|
|
int turretStatus = optional_string_one_of(3, "+Submodel:", "+Turret Base:", "+Turret Arm:");
|
|
|
|
if (turretStatus == -1)
|
|
return nullptr;
|
|
|
|
char name[NAME_LENGTH];
|
|
stuff_string(name, F_NAME, NAME_LENGTH);
|
|
|
|
switch (turretStatus) {
|
|
case 0: //Submodel
|
|
return std::make_shared<ModelAnimationSubmodel>(name);
|
|
case 1: //Turret Base
|
|
return std::make_shared<ModelAnimationSubmodelTurret>(name, false, "");
|
|
case 2: //Turret Arm
|
|
return std::make_shared<ModelAnimationSubmodelTurret>(name, true, "");
|
|
default: //Not specified
|
|
return nullptr;
|
|
}
|
|
|
|
}
|
|
|
|
ModelAnimationCoordinateRelation ModelAnimationParseHelper::parseCoordinateRelation() {
|
|
int result = optional_string_one_of(3, "+Relative", "+Local", "+Absolute");
|
|
return static_cast<ModelAnimationCoordinateRelation>(result < 0 ? 0 : result);
|
|
}
|
|
|
|
void ModelAnimationParseHelper::parseSingleAnimation() {
|
|
|
|
ModelAnimationParseHelper helper;
|
|
required_string("$Name:");
|
|
char animID[NAME_LENGTH];
|
|
stuff_string(animID, F_NAME, NAME_LENGTH);
|
|
helper.m_animationName = animID;
|
|
|
|
if (s_animationsById.count(helper.m_animationName))
|
|
error_display(1, "Animation with name %s already exists!", animID);
|
|
|
|
required_string("$Type:");
|
|
char atype[NAME_LENGTH];
|
|
stuff_string(atype, F_NAME, NAME_LENGTH);
|
|
ModelAnimationTriggerType type = anim_match_type(atype);
|
|
|
|
if (type == ModelAnimationTriggerType::None) {
|
|
error_display(1, "Animation with unknown trigger type %s!", atype);
|
|
return;
|
|
}
|
|
|
|
auto animation = std::make_shared<ModelAnimation>(type == ModelAnimationTriggerType::Initial);
|
|
|
|
int subtype = ModelAnimationSet::SUBTYPE_DEFAULT;
|
|
SCP_string name;
|
|
|
|
if (optional_string("+Triggered By:")) {
|
|
switch (type) {
|
|
case ModelAnimationTriggerType::Docking_Stage1:
|
|
case ModelAnimationTriggerType::Docking_Stage2:
|
|
case ModelAnimationTriggerType::Docking_Stage3:
|
|
case ModelAnimationTriggerType::Docked: {
|
|
//The index of the dock port or name of the dock port.
|
|
char parsedname[NAME_LENGTH];
|
|
stuff_string(parsedname, F_NAME, NAME_LENGTH);
|
|
|
|
if (can_construe_as_integer(parsedname))
|
|
subtype = atoi(parsedname);
|
|
else {
|
|
strlwr(parsedname);
|
|
name = parsedname;
|
|
}
|
|
|
|
break;
|
|
}
|
|
case ModelAnimationTriggerType::PrimaryBank:
|
|
case ModelAnimationTriggerType::SecondaryBank:
|
|
case ModelAnimationTriggerType::PrimaryFired:
|
|
case ModelAnimationTriggerType::SecondaryFired:
|
|
//The index of the bank
|
|
stuff_int(&subtype);
|
|
|
|
break;
|
|
case ModelAnimationTriggerType::DockBayDoor: {
|
|
//Index of the dock bay door, if NOT before, then all but this door
|
|
bool flip = optional_string("NOT");
|
|
stuff_int(&subtype);
|
|
subtype++;
|
|
if (flip)
|
|
subtype *= -1;
|
|
|
|
break;
|
|
}
|
|
case ModelAnimationTriggerType::Scripted:
|
|
//More accurate name of scripted animation
|
|
case ModelAnimationTriggerType::TurretFired:
|
|
case ModelAnimationTriggerType::TurretFiring: {
|
|
//Name of the turret subsys that needs to be firing
|
|
char parsedname[NAME_LENGTH];
|
|
stuff_string(parsedname, F_NAME, NAME_LENGTH);
|
|
strlwr(parsedname);
|
|
name = parsedname;
|
|
break;
|
|
}
|
|
|
|
case ModelAnimationTriggerType::Initial:
|
|
case ModelAnimationTriggerType::Afterburner:
|
|
case ModelAnimationTriggerType::OnSpawn:
|
|
default:
|
|
error_display(0, "Animation trigger type %s does not use any trigger specification!", atype);
|
|
//These shouldn't have further specifications. Ignore
|
|
}
|
|
}
|
|
|
|
if (optional_string("$Flags:")) {
|
|
SCP_vector<SCP_string> unparsed;
|
|
parse_string_flag_list_special(animation->m_flags, Animation_flags, &unparsed, *animation);
|
|
for (const auto& flag : unparsed) {
|
|
error_display(0, "Unknown flag %s in flag list!", flag.c_str());
|
|
}
|
|
}
|
|
|
|
if (Animation_types.find(type)->second.second) {
|
|
//This is a type where the code does not reset the animation. The animation is expected to auto-reset in one way or another.
|
|
//If it doesn't, nothing will crash, but the result is most likely unintended.
|
|
if (animation->m_flags.none_of(Animation_Flags::Auto_Reverse,Animation_Flags::Reset_at_completion)) {
|
|
error_display(0, "Animation trigger type %s expects an auto-reset flag to be set.", atype);
|
|
}
|
|
|
|
if (animation->m_flags[Animation_Flags::Loop]) {
|
|
//Looping animations for these trigger types are probably unintended as well, but rare cases could exist, hence no explicit warning.
|
|
mprintf(("Animation %s with trigger type %s has an unexpected loop flag.\n", helper.m_animationName.c_str(), atype));
|
|
}
|
|
}
|
|
|
|
animation->setAnimation(helper.parseSegment());
|
|
|
|
s_animationsById.emplace(helper.m_animationName, ParsedModelAnimation { std::move(animation), type, std::move(name), subtype });
|
|
}
|
|
|
|
void ModelAnimationParseHelper::parseSingleMoveable() {
|
|
volatile ModelAnimationMoveableOrientation o = ModelAnimationMoveableOrientation(nullptr, angles{ 0,0,0 });
|
|
volatile ModelAnimationMoveableRotation r = ModelAnimationMoveableRotation(nullptr, angles{ 0,0,0 }, angles{0,0,0}, std::nullopt);
|
|
|
|
required_string("$Name:");
|
|
char animID[NAME_LENGTH];
|
|
stuff_string(animID, F_NAME, NAME_LENGTH);
|
|
|
|
SCP_string name = animID;
|
|
SCP_tolower(name);
|
|
|
|
if (s_moveablesById.count(name))
|
|
error_display(1, "Moveable with name %s already exists!", animID);
|
|
|
|
required_string("$Type:");
|
|
|
|
char segment_type[NAME_LENGTH];
|
|
stuff_string(segment_type, F_NAME, NAME_LENGTH);
|
|
|
|
auto segment_parser = s_moveableParsers.find(segment_type);
|
|
if (segment_parser != s_moveableParsers.end()){
|
|
s_moveablesById.emplace(name, segment_parser->second());
|
|
}
|
|
else {
|
|
error_display(1, "Could not create moveable %s: Unknown moveable type %s!", animID, segment_type);
|
|
return;
|
|
}
|
|
|
|
}
|
|
|
|
void ModelAnimationParseHelper::parseTableFile(const char* filename) {
|
|
try {
|
|
read_file_text(filename, CF_TYPE_TABLES);
|
|
reset_parse();
|
|
|
|
required_string("#Animations");
|
|
ignore_white_space();
|
|
|
|
while (!optional_string("#End")) {
|
|
parseSingleAnimation();
|
|
ignore_white_space();
|
|
}
|
|
|
|
if(optional_string("#Moveables")){
|
|
while (!optional_string("#End")) {
|
|
parseSingleMoveable();
|
|
ignore_white_space();
|
|
}
|
|
}
|
|
}
|
|
catch (const parse::ParseException& e) {
|
|
mprintf(("TABLES: Unable to parse '%s'! Error message = %s.\n", filename, e.what()));
|
|
return;
|
|
}
|
|
|
|
}
|
|
|
|
void ModelAnimationParseHelper::parseTables() {
|
|
s_animationsById.clear();
|
|
s_moveablesById.clear();
|
|
parse_modular_table("*-anim.tbm", parseTableFile, CF_TYPE_TABLES);
|
|
}
|
|
|
|
unsigned int ModelAnimationParseHelper::getUniqueAnimationID(const SCP_string& animName, char uniquePrefix, const SCP_string& parentName) {
|
|
return hash_fnv1a(animName + uniquePrefix) ^ hash_fnv1a(parentName);
|
|
}
|
|
|
|
void ModelAnimationParseHelper::parseAnimsetInfo(ModelAnimationSet& set, char uniqueTypePrefix, const SCP_string& uniqueParentName) {
|
|
SCP_vector<SCP_string> requestedAnimations;
|
|
stuff_string_list(requestedAnimations);
|
|
|
|
set.m_animationSet.clear();
|
|
|
|
for (const SCP_string& request : requestedAnimations) {
|
|
auto animIt = s_animationsById.find(request);
|
|
if (animIt != s_animationsById.end()) {
|
|
const ParsedModelAnimation& foundAnim = animIt->second;
|
|
set.emplace(foundAnim.anim, request, foundAnim.name, foundAnim.type, foundAnim.subtype, ModelAnimationParseHelper::getUniqueAnimationID(animIt->first, uniqueTypePrefix, uniqueParentName));
|
|
}
|
|
else {
|
|
error_display(0, "Animation with name %s not found!", request.c_str());
|
|
}
|
|
}
|
|
}
|
|
|
|
void ModelAnimationParseHelper::parseAnimsetInfo(ModelAnimationSet& set, ship_info* sip) {
|
|
Assert(sip != nullptr);
|
|
|
|
set.changeShipName(sip->name);
|
|
|
|
ModelAnimationParseHelper::parseAnimsetInfo(set, 's', sip->name);
|
|
}
|
|
|
|
void ModelAnimationParseHelper::parseAnimsetInfoDrivers(ModelAnimationSet& set, char uniquePrefix, const SCP_string& parentName, std::function<std::function<float(polymodel_instance *)>()> driverSourceParser) {
|
|
set.m_animationSet.clear();
|
|
|
|
while(optional_string("+Driver Set:")) {
|
|
decltype(ModelAnimation::m_driver) driver;
|
|
decltype(ModelAnimation::m_propertyDrivers) propertyDrivers;
|
|
decltype(ModelAnimation::m_startupDrivers) startupDrivers;
|
|
|
|
if (optional_string("+Time Remap:")) {
|
|
required_string("+Source:");
|
|
std::function<float(polymodel_instance *)> remap_driver_source = driverSourceParser();
|
|
if (!remap_driver_source) {
|
|
error_display(0, "Unknown driver specifier encountered! Driver will be disabled!");
|
|
continue;
|
|
}
|
|
|
|
std::optional<Curve> curve = std::nullopt;
|
|
if (optional_string("+Curve:")) {
|
|
int curve_id = curve_parse(" The driver will not use a curve.");
|
|
if (curve_id >= 0)
|
|
curve = Curves[curve_id];
|
|
}
|
|
|
|
driver = [remap_driver_source = std::move(remap_driver_source), curve = std::move(curve)](ModelAnimation &, ModelAnimation::instance_data &instance, polymodel_instance *pmi, float) {
|
|
float oldFrametime = instance.time;
|
|
instance.time = curve ? curve->GetValue(remap_driver_source(pmi)) : remap_driver_source(pmi);
|
|
CLAMP(instance.time, 0.0f, instance.duration);
|
|
instance.canonicalDirection = oldFrametime < instance.time ? ModelAnimationDirection::FWD : ModelAnimationDirection::RWD;
|
|
};
|
|
}
|
|
while (optional_string("+Property Driver:")){
|
|
required_string("+Source:");
|
|
std::function<float(polymodel_instance *)> driver_source = parse_ship_property_driver_source();
|
|
if (!driver_source) {
|
|
error_display(0, "Unknown driver specifier encountered! Driver will be disabled!");
|
|
continue;
|
|
}
|
|
|
|
required_string("+Target:");
|
|
ModelAnimationPropertyDriverTarget target = parse_property_driver_target();
|
|
|
|
std::optional<Curve> curve = std::nullopt;
|
|
if (optional_string("+Curve:")) {
|
|
int curve_id = curve_parse(" The driver will not use a curve.");
|
|
if (curve_id >= 0)
|
|
curve = Curves[curve_id];
|
|
}
|
|
|
|
propertyDrivers.emplace_back([driver_source = std::move(driver_source), curve = std::move(curve), target](ModelAnimation &, ModelAnimation::instance_data &instance, polymodel_instance *pmi) {
|
|
float& property = instance.*(target.target);
|
|
property = curve ? curve->GetValue(driver_source(pmi)) : driver_source(pmi);
|
|
if(target.clamp) {
|
|
CLAMP(property, 0.0f, instance.*(*target.clamp));
|
|
}
|
|
});
|
|
}
|
|
while (optional_string("+Startup Driver:")){
|
|
required_string("+Source:");
|
|
std::function<float(polymodel_instance *)> driver_source = parse_ship_property_driver_source();
|
|
if (!driver_source) {
|
|
error_display(0, "Unknown driver specifier encountered! Driver will be disabled!");
|
|
continue;
|
|
}
|
|
|
|
required_string("+Target:");
|
|
ModelAnimationPropertyDriverTarget target = parse_property_driver_target();
|
|
|
|
std::optional<Curve> curve = std::nullopt;
|
|
if (optional_string("+Curve:")) {
|
|
int curve_id = curve_parse(" The driver will not use a curve.");
|
|
if (curve_id >= 0)
|
|
curve = Curves[curve_id];
|
|
}
|
|
|
|
startupDrivers.emplace_back([driver_source = std::move(driver_source), curve = std::move(curve), target](ModelAnimation &, ModelAnimation::instance_data &instance, polymodel_instance *pmi) {
|
|
float& property = instance.*(target.target);
|
|
property = curve ? curve->GetValue(driver_source(pmi)) : driver_source(pmi);
|
|
if(target.clamp) {
|
|
CLAMP(property, 0.0f, instance.*(*target.clamp));
|
|
}
|
|
});
|
|
}
|
|
|
|
required_string("+Affected Animations:");
|
|
SCP_vector<SCP_string> requestedAnimations;
|
|
stuff_string_list(requestedAnimations);
|
|
|
|
for (const SCP_string& request : requestedAnimations) {
|
|
auto animIt = s_animationsById.find(request);
|
|
if (animIt != s_animationsById.end()) {
|
|
const ParsedModelAnimation& foundAnim = animIt->second;
|
|
auto anim = set.emplace(foundAnim.anim, request, foundAnim.name, foundAnim.type, foundAnim.subtype, ModelAnimationParseHelper::getUniqueAnimationID(animIt->first, uniquePrefix, parentName));
|
|
|
|
if (driver)
|
|
anim->m_driver = driver;
|
|
anim->m_propertyDrivers = propertyDrivers;
|
|
anim->m_startupDrivers = startupDrivers;
|
|
}
|
|
else {
|
|
error_display(0, "Animation with name %s not found!", request.c_str());
|
|
}
|
|
}
|
|
}
|
|
}
|
|
|
|
void ModelAnimationParseHelper::parseAnimsetInfoDrivers(ModelAnimationSet& set, ship_info* sip) {
|
|
set.m_animationSet.clear();
|
|
set.changeShipName(sip->name);
|
|
|
|
parseAnimsetInfoDrivers(set, 's', sip->name, parse_ship_property_driver_source);
|
|
}
|
|
|
|
void ModelAnimationParseHelper::parseMoveablesetInfo(ModelAnimationSet& set) {
|
|
SCP_vector<SCP_string> requestedAnimations;
|
|
stuff_string_list(requestedAnimations);
|
|
|
|
set.m_moveableSet.clear();
|
|
|
|
for (SCP_string request : requestedAnimations) {
|
|
SCP_tolower(request);
|
|
auto animIt = s_moveablesById.find(request);
|
|
if (animIt != s_moveablesById.end()) {
|
|
set.m_moveableSet.emplace(animIt->first, animIt->second);
|
|
}
|
|
else {
|
|
error_display(0, "Moveable with name %s not found!", request.c_str());
|
|
}
|
|
}
|
|
}
|
|
|
|
|
|
void ModelAnimationParseHelper::parseLegacyAnimationTable(model_subsystem* sp, ship_info* sip) {
|
|
//the only thing initial animation type needs is the angle,
|
|
//so to save space lets just make everything optional in this case
|
|
|
|
//Most of these properties were read and allowed, but never actually used for anything.
|
|
//Hence, still allow them in tables, but now just skip reading them
|
|
|
|
required_string("$type:");
|
|
char atype[NAME_LENGTH];
|
|
stuff_string(atype, F_NAME, NAME_LENGTH);
|
|
animation::ModelAnimationTriggerType type = anim_match_type(atype);
|
|
if (type == ModelAnimationTriggerType::None) {
|
|
Warning(LOCATION, "Unknown animation type %s, not adding animation!", atype);
|
|
skip_to_start_of_string_one_of({"$animation:", "$Subsystem:", "#End"});
|
|
return;
|
|
}
|
|
|
|
int subtype = ModelAnimationSet::SUBTYPE_DEFAULT;
|
|
char sub_name[NAME_LENGTH];
|
|
SCP_string name = anim_name_from_subsys(sp);
|
|
|
|
if (optional_string("+sub_type:")) {
|
|
stuff_int(&subtype);
|
|
|
|
if (type == ModelAnimationTriggerType::DockBayDoor) {
|
|
if (subtype == 0) {
|
|
//Apparently the legacy code treated a 0 here like subtype default (this is incorrect in a lot of places).
|
|
subtype = ModelAnimationSet::SUBTYPE_DEFAULT;
|
|
}
|
|
else {
|
|
//Increase by 1, so that -x != x is true for all possible values
|
|
subtype += subtype < 0 ? -1 : 1;
|
|
}
|
|
|
|
//Also set name to empty for compatibility with naming and subtyping in the new table while being compatible with legacy subtypes
|
|
name = "";
|
|
}
|
|
}
|
|
|
|
if (optional_string("+sub_name:")) {
|
|
stuff_string(sub_name, F_NAME, NAME_LENGTH);
|
|
}
|
|
else {
|
|
strcpy_s(sub_name, "<none>");
|
|
}
|
|
|
|
if (type == animation::ModelAnimationTriggerType::Initial) {
|
|
angles angle;
|
|
bool isRelative;
|
|
|
|
if (optional_string("+delay:"))
|
|
skip_token();
|
|
|
|
if (optional_string("+reverse_delay:"))
|
|
skip_token();
|
|
|
|
if (optional_string("+absolute_angle:")) {
|
|
stuff_angles_deg_phb(&angle);
|
|
|
|
isRelative = false;
|
|
}
|
|
else {
|
|
required_string("+relative_angle:");
|
|
|
|
stuff_angles_deg_phb(&angle);
|
|
|
|
isRelative = true;
|
|
}
|
|
|
|
if (optional_string("+velocity:"))
|
|
skip_token();
|
|
|
|
if (optional_string("+acceleration:"))
|
|
skip_token();
|
|
|
|
if (optional_string("+time:"))
|
|
skip_token();
|
|
|
|
auto anim = std::make_shared<ModelAnimation>(true);
|
|
|
|
char namelower[MAX_NAME_LEN];
|
|
strncpy(namelower, sp->subobj_name, MAX_NAME_LEN);
|
|
strlwr(namelower);
|
|
//since sp->type is not set without reading the pof, we need to infer it by subsystem name (which works, since the same name is used to match the submodels name, which is used to match the type in pof parsing)
|
|
//sadly, we also need to check for engine and radar, since these take precedent (as in, an engineturret is an engine before a turret type)
|
|
if (!strstr(namelower, "engine") && !strstr(namelower, "radar") && strstr(namelower, "turret")) {
|
|
auto subsysBase = sip->animations.getSubmodel(sp->subobj_name, sip->name, false);
|
|
auto rotBase = std::make_shared<ModelAnimationSegmentSetAngle>(std::move(subsysBase), angle.h);
|
|
|
|
auto subsysBarrel = sip->animations.getSubmodel(sp->subobj_name, sip->name, true);
|
|
auto rotBarrel = std::make_shared<ModelAnimationSegmentSetAngle>(std::move(subsysBarrel), angle.p);
|
|
|
|
auto rot = std::make_shared<ModelAnimationSegmentParallel>();
|
|
rot->addSegment(std::move(rotBase));
|
|
rot->addSegment(std::move(rotBarrel));
|
|
|
|
anim->setAnimation(std::move(rot));
|
|
}
|
|
else {
|
|
auto subsys = sip->animations.getSubmodel(sp->subobj_name);
|
|
auto rot = std::make_shared<ModelAnimationSegmentSetOrientation>(std::move(subsys), angle, isRelative ? ModelAnimationCoordinateRelation::RELATIVE_COORDS : ModelAnimationCoordinateRelation::ABSOLUTE_COORDS);
|
|
anim->setAnimation(std::move(rot));
|
|
}
|
|
|
|
//Initial Animations in legacy style will continue to be fully supported and allowed, given the frequency of these (especially for turrets) and the fact that these are more intuitive to be directly in the subsystem section of the ship table, as these are closer to representing a property of the subsystem rather than an animation.
|
|
//Hence, there will not be any warning displayed if the legacy table is used for these. -Lafiel
|
|
sip->animations.emplace(anim, name, name, ModelAnimationTriggerType::Initial, ModelAnimationSet::SUBTYPE_DEFAULT, ModelAnimationParseHelper::getUniqueAnimationID(name + Animation_types.at(ModelAnimationTriggerType::Initial).first + std::to_string(subtype), 'b', sip->name));
|
|
}
|
|
else {
|
|
auto anim = std::make_shared<ModelAnimation>();
|
|
auto subsys = sip->animations.getSubmodel(sp->subobj_name);
|
|
|
|
if (type == ModelAnimationTriggerType::TurretFired) {
|
|
//Turret fireds won't get reset by code, so make them auto-resetting
|
|
anim->m_flags += Animation_Flags::Reset_at_completion;
|
|
}
|
|
|
|
auto mainSegment = std::make_shared<ModelAnimationSegmentSerial>();
|
|
|
|
if (optional_string("+delay:")) {
|
|
int delayByMs;
|
|
stuff_int(&delayByMs);
|
|
auto delay = std::make_shared<ModelAnimationSegmentWait>(((float)delayByMs) * 0.001f);
|
|
mainSegment->addSegment(delay);
|
|
}
|
|
|
|
int delayByMsReverse = -1;
|
|
if (optional_string("+reverse_delay:")) {
|
|
stuff_int(&delayByMsReverse);
|
|
}
|
|
|
|
angles target{ 0,0,0 };
|
|
bool absolute = false;
|
|
|
|
if (optional_string("+absolute_angle:")) {
|
|
absolute = true;
|
|
|
|
stuff_angles_deg_phb(&target);
|
|
}
|
|
else {
|
|
absolute = false;
|
|
|
|
required_string("+relative_angle:");
|
|
stuff_angles_deg_phb(&target);
|
|
}
|
|
|
|
angles velocity{ 0,0,0 };
|
|
required_string("+velocity:");
|
|
stuff_angles_deg_phb(&velocity);
|
|
|
|
std::optional<angles> acceleration;
|
|
|
|
if (optional_string("+acceleration:")) {
|
|
angles accel{ 0,0,0 };
|
|
stuff_angles_deg_phb(&accel);
|
|
|
|
bool allZero = accel.p == 0 && accel.b == 0 && accel.h == 0;
|
|
|
|
if (!allZero) {
|
|
acceleration = std::move(accel);
|
|
}
|
|
}
|
|
|
|
if (optional_string("+time:")) {
|
|
skip_token();
|
|
|
|
//Time is ignored if acceleration is set in legacy animations. Even if it isn't set, time seems to only affect metadata and not the actual animation.
|
|
//Hence, throw time away, and let the segment handle calculating how long it actually takes
|
|
}
|
|
|
|
auto rotation = std::make_shared<ModelAnimationSegmentRotation>(std::move(subsys), target, velocity, std::nullopt, acceleration, absolute ? ModelAnimationCoordinateRelation::ABSOLUTE_COORDS : ModelAnimationCoordinateRelation::RELATIVE_COORDS);
|
|
|
|
if (optional_string("$Sound:")) {
|
|
gamesnd_id start_sound;
|
|
gamesnd_id loop_sound;
|
|
gamesnd_id end_sound;
|
|
float snd_rad;
|
|
|
|
parse_game_sound("+Start:", &start_sound);
|
|
|
|
parse_game_sound("+Loop:", &loop_sound);
|
|
|
|
parse_game_sound("+End:", &end_sound);
|
|
|
|
required_string("+Radius:");
|
|
stuff_float(&snd_rad);
|
|
|
|
auto sound = std::make_shared<ModelAnimationSegmentSoundDuring>(rotation, start_sound, end_sound, loop_sound, true);
|
|
mainSegment->addSegment(sound);
|
|
}
|
|
else
|
|
mainSegment->addSegment(rotation);
|
|
|
|
if (delayByMsReverse != -1) {
|
|
auto delay = std::make_shared<ModelAnimationSegmentWait>(((float)delayByMsReverse) * 0.001f);
|
|
mainSegment->addSegment(delay);
|
|
}
|
|
|
|
anim->setAnimation(mainSegment);
|
|
|
|
//TODO maybe handle sub_name? Not documented in Wiki, maybe no one actually uses it...
|
|
sip->animations.emplace(anim, name, name, type, subtype, ModelAnimationParseHelper::getUniqueAnimationID(name + Animation_types.at(type).first + std::to_string(subtype), 'b', sip->name));
|
|
|
|
mprintf(("Specified deprecated non-initial type animation on subsystem %s of ship class %s. Consider using *-anim.tbm's instead.\n", sp->subobj_name, sip->name));
|
|
}
|
|
}
|
|
|
|
SCP_unordered_map<SCP_string, ModelAnimationParseHelper::ModelAnimationSegmentParser> ModelAnimationParseHelper::s_segmentParsers = {
|
|
{"$Segment Sequential:", ModelAnimationSegmentSerial::parser},
|
|
{"$Segment Parallel:", ModelAnimationSegmentParallel::parser},
|
|
{"$Wait:", ModelAnimationSegmentWait::parser},
|
|
{"$Set Orientation:", ModelAnimationSegmentSetOrientation::parser},
|
|
{"$Set Offset:", ModelAnimationSegmentSetOffset::parser},
|
|
{"$Set Angle:", ModelAnimationSegmentSetAngle::parser},
|
|
{"$Rotation:", ModelAnimationSegmentRotation::parser},
|
|
{"$Axis Rotation:", ModelAnimationSegmentAxisRotation::parser},
|
|
{"$Translation:", ModelAnimationSegmentTranslation::parser},
|
|
{"$Sound During:", ModelAnimationSegmentSoundDuring::parser},
|
|
{"$Particles During:", ModelAnimationSegmentParticlesDuring::parser},
|
|
{"$Inverse Kinematics:", ModelAnimationSegmentIK::parser}
|
|
};
|
|
|
|
SCP_unordered_map<SCP_string, ModelAnimationParseHelper::ModelAnimationMoveableParser> ModelAnimationParseHelper::s_moveableParsers = {
|
|
{"Orientation", ModelAnimationMoveableOrientation::parser},
|
|
{"Rotation", ModelAnimationMoveableRotation::parser},
|
|
{"Axis Rotation", ModelAnimationMoveableAxisRotation::parser},
|
|
{"Translation", ModelAnimationMoveableTranslation::parser},
|
|
{"Inverse Kinematics", ModelAnimationMoveableIK::parser}
|
|
};
|
|
|
|
|
|
} |