1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438
|
#pragma once
#include "globalincs/linklist.h"
#include "math/vecmat.h"
#include "model/model.h"
#include "object/object.h"
#include "parse/parselo.h"
#include <tuple>
#include <functional>
#include <type_traits>
#include <memory>
#include <map>
#include <tl/optional.hpp>
#include <linb/any.hpp>
class ship;
class ship_info;
// Model Animation Position settings
enum EModelAnimationPosition {
MA_POS_NOT_SET = 0, // not yet setup
MA_POS_SET = 1, // set, but is moving
MA_POS_READY = 2 // set, done with move
};
#define ANIMATION_SUBTYPE_ALL INT_MAX
namespace animation {
enum class ModelAnimationDirection { FWD, RWD };
enum class ModelAnimationState { UNTRIGGERED, RUNNING, PAUSED, NEED_RECALC };
enum class ModelAnimationTriggerType : int {
None = -1, // No animation
Initial, // This is just the position the subobject should be placed in
OnSpawn, // starts when a ship is being created.
Docking_Stage1, // following the dock path until just before the end. Triggered when AIS_DOCK_1 begins.
Docking_Stage2, // drag oneself right to the second last point on the dock path. The old docking-type trigger. Triggered when AIS_DOCK_2 begins.
Docking_Stage3, // move directly to the dockpoint using thrusters. Triggered when AIS_DOCK_3 begins.
Docked, // As you dock / the attachment sound is played and the mission log indicates docking. Triggered when AIS_DOCK_4 begins.
PrimaryBank, // Primary banks
SecondaryBank, // Secondary banks
DockBayDoor, // Fighter bays
Afterburner, // Afterburner -C
TurretFiring, // Turret shooting -C
Scripted, // Triggered exclusively by scripting...maybe SEXPs? -C
TurretFired, // Triggered after a turret has fired -The E
PrimaryFired, // Triggered when a primary weapon has fired.
SecondaryFired, // Triggered when a secondary weapon has fired.
MaxAnimationTypes
};
FLAG_LIST(Animation_Flags) {
Auto_Reverse, //Will make the animation automatically transition into reverse mode as opposed to waiting in a completed state
Reset_at_completion, //Will cause the animation to reset once it completes. This usually only makes sense when the state at the end of the animation is identical to the state at the start of the animation. Incompatible with Auto_reverse
Loop, //Will automatically loop the animation once it completes. Is compatible with Reset_at_completion to loop back from the start instead of reversing. Incompatible with Auto_reverse
Random_starting_phase, //When an animation is started from an untriggered state, will randomize its time to any possible time of the animation + possibly on the reverse, if the animation would automatically enter that
Pause_on_reverse, //Will cause any start in RWD direction to behave as a call to pause the animation. Required (and also only really useful) when a looping animation is supposed to be triggered by an internal engine trigger
Seamless_with_startup, //Provides automatic handling of animations that loop with an initialization part (effectively looping from a specific time)
NUM_VALUES
};
FLAG_LIST(Animation_Instance_Flags) {
Stop_after_next_loop, //Once a looping animation would start the next loop, stop the animation instead. Only valid for looping animations
Seamless_loop_shutdown, //Set whenever a seamlessly looping animation is in its final shutdown phase
Seamless_fully_started, //Set once the seamless animation has reached the seamless part
NUM_VALUES
};
enum class ModelAnimationCoordinateRelation : int { RELATIVE_COORDS, LOCAL_ABSOLUTE, ABSOLUTE_COORDS };
template <bool is_optional = false>
struct ModelAnimationData {
private:
template<typename T>
using maybe_optional = typename std::conditional<is_optional, tl::optional<T>, T>::type;
public:
ModelAnimationData() = default;
ModelAnimationData(const vec3d& copy_position, const matrix& copy_orientation) :
position(copy_position),
orientation(copy_orientation) {};
ModelAnimationData(const tl::optional<vec3d>& copy_position, const tl::optional<matrix>& copy_orientation) :
position(*copy_position),
orientation(*copy_orientation) {};
ModelAnimationData(const ModelAnimationData<!is_optional>& other) : ModelAnimationData(other.position, other.orientation) {};
maybe_optional<vec3d> position;
maybe_optional<matrix> orientation;
//This might be a performance bottleneck, but it's the cleanest I can make this without if constexpr and not repeating this code for both types of MAD.
void applyDelta(const ModelAnimationData<true>& delta) {
ModelAnimationData<true> data = *this;
if(delta.orientation) {
if (data.orientation) {
matrix tmp;
vm_matrix_x_matrix(&tmp, &(*delta.orientation), &(*data.orientation));
data.orientation = std::move(tmp);
}
else {
data.orientation = delta.orientation;
}
}
if (delta.position) {
if (data.position) {
vec3d tmp;
vm_vec_add(&tmp, &(*delta.position), &(*data.position));
data.position = std::move(tmp);
}
else {
data.position = delta.position;
}
}
*this = data;
}
};
class ModelAnimationSet;
class ModelAnimationSubmodel {
protected:
SCP_string m_name;
tl::optional<int> m_submodel;
bool is_turret = false;
private:
//Polymodel Instance ID -> ModelAnimationData
SCP_unordered_map<int, ModelAnimationData<>> m_initialData;
static ModelAnimationData<> identity;
public:
ModelAnimationSubmodel(SCP_string submodelName);
virtual ~ModelAnimationSubmodel() = default;
void reset(polymodel_instance* pmi);
bool saveCurrentAsBase(polymodel_instance* pmi, bool isInitialType = false);
const ModelAnimationData<>& getInitialData(polymodel_instance* pmi);
virtual std::pair<submodel_instance*, bsp_info*> findSubmodel(polymodel_instance* pmi);
private:
//Hack needed for potential cloning of animations due to templates, while still allowing changing the subsystem data for turret retrieval later on.
virtual void renameSIP(const SCP_string& /*newSIPname*/) { };
virtual ModelAnimationSubmodel* copy() const;
//Reapply the calculated animation state to the submodel
virtual void copyToSubmodel(const ModelAnimationData<>& data, polymodel_instance* pmi);
void resetPhysicsData(polymodel_instance* pmi);
friend class ModelAnimationSet;
};
class ModelAnimationSubmodelTurret : public ModelAnimationSubmodel {
private:
SCP_string m_SIPname;
bool m_findBarrel;
void copyToSubmodel(const ModelAnimationData<>& data, polymodel_instance* pmi) override;
/*Create a submodel animation by taking the submodel assigned to a subsystem with a given name, or, if requested, the submodel of the turret barrel.
Due to how turrets work in FSO, this should never be given a segment that does anything but rotate the turret around its axis
*/
void renameSIP(const SCP_string& newSIPname) override;
ModelAnimationSubmodel* copy() const override;
friend class ModelAnimationSet;
public:
ModelAnimationSubmodelTurret(SCP_string subsystemName, bool findBarrel, SCP_string SIPname);
std::pair<submodel_instance*, bsp_info*> findSubmodel(polymodel_instance* pmi) override;
};
struct ModelAnimationSubmodelBufferData { ModelAnimationData<> data; bool modified; };
//Submodel -> data + was_set
using ModelAnimationSubmodelBuffer = SCP_unordered_map<std::shared_ptr<ModelAnimationSubmodel>, ModelAnimationSubmodelBufferData>;
class ModelAnimationSegment {
protected:
SCP_unordered_map<int, float> m_duration;
public:
virtual ~ModelAnimationSegment() = default;
float getDuration(int pmi_id) const;
//This function needs to provide a deep copy operation that returns a copy of this segment, including with all potential child segments copied as well.
virtual ModelAnimationSegment* copy() const = 0;
//Will be called to give the animations an opportunity to recalculate based on current ship data, as well as animation data up to that point.
virtual void recalculate(ModelAnimationSubmodelBuffer& base, ModelAnimationSubmodelBuffer& currentAnimDelta, polymodel_instance* pmi) = 0;
//This function needs to contain anything that manipulates ModelAnimationData (such as any movement)
virtual void calculateAnimation(ModelAnimationSubmodelBuffer& base, float time, int pmi_id) const = 0;
//This function needs to contain any animation parts that do not change ModelAnimationData (such as sound or particles)
virtual void executeAnimation(const ModelAnimationSubmodelBuffer& state, float timeboundLower, float timeboundUpper, ModelAnimationDirection direction, int pmi_id) = 0;
//This function must exchange all held submodel pointers of itself and children with ones acquired from replaceWith.
virtual void exchangeSubmodelPointers(ModelAnimationSet& replaceWith) = 0;
};
class ModelAnimation : public std::enable_shared_from_this <ModelAnimation> {
public:
struct instance_data {
ModelAnimationState state = ModelAnimationState::UNTRIGGERED;
ModelAnimationDirection canonicalDirection = ModelAnimationDirection::FWD;
float time = 0.0f;
float duration = 0.0f;
flagset<animation::Animation_Instance_Flags> instance_flags;
float speed = 1.0f;
};
private:
//PMI ID -> Instance Data
SCP_unordered_map<int, instance_data> m_instances;
const ModelAnimationSet* m_set;
//True if the animation doesn't need to be kept in running memory, but needs to be applied to a submodels base
bool m_isInitialType;
//True if the animation is guaranteed to be identical on each client and can be multi-synced
bool m_isMultiCompatible;
//True if the animation can externally have its state changed. Needs special handling
bool m_canChangeState;
SCP_string request;
public:
flagset<animation::Animation_Flags> m_flags;
struct {
//Seamless_with_startup
float loopsFrom = 0.0f;
} m_flagData;
private:
static void driverTime(ModelAnimation& anim, instance_data& instance, polymodel_instance* pmi, float frametime);
ModelAnimationState play(float frametime, polymodel_instance* pmi, ModelAnimationSubmodelBuffer& applyBuffer, bool applyOnly = false);
//The main driver for the animation "time"
std::function<void(ModelAnimation&, instance_data&, polymodel_instance*, float)> m_driver = driverTime;
//The registered animation property drivers
std::vector<std::function<void(ModelAnimation&, instance_data&, polymodel_instance*)>> m_propertyDrivers;
//The registered animation startup property drivers
std::vector<std::function<void(ModelAnimation&, instance_data&, polymodel_instance*)>> m_startupDrivers;
friend class ModelAnimationSet;
friend class ModelAnimationParseHelper;
public:
//Initial type animations must complete within a single frame, and then never modifiy the submodel again. If this is the case, we do not need to remember them being active for massive performance gains with lots of turrets
ModelAnimation(bool isInitialType = false, bool isMultiCompatible = true, bool canStateChange = false, const ModelAnimationSet* defaultSet = nullptr);
void setAnimation(std::shared_ptr<ModelAnimationSegment> animation);
void forceRecalculate(polymodel_instance* pmi);
//Start playing the animation. Will stop other animations that have components running on the same submodels. instant always requires force
void start(polymodel_instance* pmi, ModelAnimationDirection direction, bool force = false, bool instant = false, bool pause = false, const float* multiOverrideTime = nullptr);
//Stops the animation. If cleanup is set, it will remove the animation from the list of running animations. Don't call without cleanup unless you know what you are doing
void stop(polymodel_instance* pmi, bool cleanup = true);
float getTime(int pmi_id) const;
static void stepAnimations(float frametime, polymodel_instance* pmi);
unsigned int id = 0;
std::shared_ptr<ModelAnimationSegment> m_animation;
};
class ModelAnimationMoveable {
protected:
struct instance_data {
std::shared_ptr<ModelAnimation> animation = nullptr;
};
//PMI ID -> Instance Data
SCP_unordered_map<int, instance_data> m_instances;
public:
virtual ~ModelAnimationMoveable() = default;
virtual void update(polymodel_instance* pmi, const SCP_vector<linb::any>& args) = 0;
virtual void initialize(ModelAnimationSet* parentSet, polymodel_instance* pmi) = 0;
};
class ModelAnimationSet {
public:
static int SUBTYPE_DEFAULT;
static SCP_unordered_map<unsigned int, std::shared_ptr<ModelAnimation>> s_animationById;
private:
struct RunningAnimationList { const ModelAnimationSet* parentSet; SCP_list<std::shared_ptr<ModelAnimation>> animationList; };
//Polymodel Instance ID -> set + ModelAnimation* list (naturally ordered by beginning time))
static SCP_unordered_map<int, RunningAnimationList> s_runningAnimations;
SCP_vector< std::shared_ptr<ModelAnimationSubmodel>> m_submodels;
SCP_string m_SIPname;
struct ModelAnimationSubtrigger {
ModelAnimationTriggerType type;
int subtype;
friend constexpr bool operator<(const ModelAnimationSubtrigger& lhs, const ModelAnimationSubtrigger& rhs) {
return lhs.type < rhs.type || (!(rhs.type < lhs.type) && lhs.subtype < rhs.subtype);
}
};
// Trigger Type + Subtype -> (Trigger name -> list of Animation*)
SCP_map<ModelAnimationSubtrigger, SCP_unordered_map<SCP_string, std::vector<std::shared_ptr<ModelAnimation>>>> m_animationSet;
SCP_unordered_map<SCP_string, std::shared_ptr<ModelAnimationMoveable>> m_moveableSet;
static void apply(polymodel_instance* pmi, const ModelAnimationSubmodelBuffer& applyBuffer);
static void cleanRunning();
void initializeSubmodelBuffer(polymodel_instance* pmi, ModelAnimationSubmodelBuffer& applyBuffer) const;
friend class ModelAnimation;
friend class ModelAnimationParseHelper;
public:
ModelAnimationSet(SCP_string SIPname = "");
ModelAnimationSet(const ModelAnimationSet& other);
ModelAnimationSet& operator=(ModelAnimationSet&& other) noexcept;
ModelAnimationSet& operator=(const ModelAnimationSet& other);
//Helper function to shorten animation emplaces
std::shared_ptr<ModelAnimation> emplace(const std::shared_ptr<ModelAnimation>& animation, const SCP_string& request, const SCP_string& name, ModelAnimationTriggerType type, int subtype, unsigned int uniqueId);
void changeShipName(const SCP_string& name);
static void stopAnimations(polymodel_instance* pmi = nullptr);
void clearShipData(polymodel_instance* pmi);
class AnimationList {
SCP_vector<std::shared_ptr<ModelAnimation>> animations;
int pmi_id;
AnimationList(polymodel_instance* pmi_) : pmi_id(pmi_ == nullptr ? -1 : pmi_->id) {}
AnimationList(int pmi_id_) : pmi_id(pmi_id_) {}
friend class ModelAnimationSet;
public:
inline AnimationList() : AnimationList(-1) {}
bool start(ModelAnimationDirection direction, bool forced = false, bool instant = false, bool pause = false) const;
int getTime() const;
void setFlag(Animation_Instance_Flags flag, bool set = true) const;
void setSpeed(float speed = 1.0f) const;
AnimationList& operator+=(const AnimationList& rhs);
AnimationList operator+(const AnimationList& rhs);
};
//Get Animations of the specified type, with a specified name, and optionally specified subtype. Will always find corresponding animations that have the default subtype
AnimationList get(polymodel_instance* pmi, ModelAnimationTriggerType type, const SCP_string& name, int subtype = SUBTYPE_DEFAULT) const;
//Get Animations of the specified type and optionally specified subtype regardless of the name. Will find corresponding animations that have the default subtype if strict is false
AnimationList getAll(polymodel_instance* pmi, ModelAnimationTriggerType type, int subtype = SUBTYPE_DEFAULT, bool strict = false) const;
//Get all Animations of the specified type
AnimationList getBlanket(polymodel_instance* pmi, ModelAnimationTriggerType type) const;
//Get DockBayDoor Animations with proper handling for dock bay door subtypes
AnimationList getDockBayDoors(polymodel_instance* pmi, int subtype) const;
//Get Animations from SEXP/Scripting specifiers using the TriggeredBy field. Parses TriggeredBy and defers to getX functions depending on animation type
AnimationList parseScripted(polymodel_instance* pmi, ModelAnimationTriggerType type, const SCP_string& triggeredBy) const;
struct RegisteredTrigger { ModelAnimationTriggerType type; int subtype; const SCP_string& name; };
SCP_vector<RegisteredTrigger> getRegisteredTriggers() const;
SCP_set<SCP_string> getRegisteredAnimNames() const;
bool updateMoveable(polymodel_instance* pmi, const SCP_string& name, const std::vector<linb::any>& args) const;
void initializeMoveables(polymodel_instance* pmi);
std::vector<SCP_string> getRegisteredMoveables() const;
bool isEmpty() const;
std::shared_ptr<ModelAnimationSubmodel> getSubmodel(SCP_string submodelName);
std::shared_ptr<ModelAnimationSubmodel> getSubmodel(SCP_string submodelName, const SCP_string& SIP_name, bool findBarrel);
std::shared_ptr<ModelAnimationSubmodel> getSubmodel(const std::shared_ptr<ModelAnimationSubmodel>& other);
};
//Start of parsing functions
class ModelAnimationParseHelper {
//Parsing Registrars
using ModelAnimationSegmentParser = std::function<std::shared_ptr<ModelAnimationSegment>(ModelAnimationParseHelper*)>;
static SCP_unordered_map<SCP_string, ModelAnimationSegmentParser> s_segmentParsers;
using ModelAnimationMoveableParser = std::function<std::shared_ptr<ModelAnimationMoveable>()>;
static SCP_unordered_map<SCP_string, ModelAnimationMoveableParser> s_moveableParsers;
//Parsed Animations
struct ParsedModelAnimation {
std::shared_ptr<ModelAnimation> anim;
ModelAnimationTriggerType type;
SCP_string name;
int subtype;
};
static SCP_unordered_map<SCP_string, ParsedModelAnimation> s_animationsById;
static SCP_unordered_map<SCP_string, std::shared_ptr<ModelAnimationMoveable>> s_moveablesById;
static unsigned int getUniqueAnimationID(const SCP_string& animName, char uniquePrefix, const SCP_string& parentName);
//Internal Parsing Methods
static void parseSingleAnimation();
static void parseSingleMoveable();
static void parseTableFile(const char* filename);
public:
std::shared_ptr<ModelAnimationSegment> parseSegment();
//Per Animation parsing Data
SCP_string m_animationName;
std::shared_ptr<ModelAnimationSubmodel> parentSubmodel = nullptr;
static std::shared_ptr<ModelAnimationSubmodel> parseSubmodel();
static ModelAnimationCoordinateRelation parseCoordinateRelation();
static void parseTables();
static void parseAnimsetInfo(ModelAnimationSet& set, ship_info* sip);
static void parseAnimsetInfo(ModelAnimationSet& set, char uniqueTypePrefix, const SCP_string& uniqueParentName);
static void parseAnimsetInfoDrivers(ModelAnimationSet& set, ship_info* sip);
static void parseAnimsetInfoDrivers(ModelAnimationSet& set, char uniquePrefix, const SCP_string& parentName, std::function<std::function<float(polymodel_instance *)>()> driverSourceParser);
static void parseMoveablesetInfo(ModelAnimationSet& set);
//Parses the legacy animation table in ships.tbl of a single subsystem. Currently initial animations only
static void parseLegacyAnimationTable(model_subsystem* sp, ship_info* sip);
};
//Start of section of helper functions, mostly to complement the old modelanim functions as required
//Type -> Name + Requires reset flag (== will never be triggered in reverse)
extern const SCP_unordered_map<animation::ModelAnimationTriggerType, std::pair<const char*, bool>> Animation_types;
void anim_set_initial_states(ship* shipp);
//Returns function bindings to start the targeted animation, and to get its runtime
std::pair<std::function<bool(ModelAnimationDirection, bool, bool, bool)>, std::function<int()>> anim_parse_scripted_start(const ModelAnimationSet& set, polymodel_instance* pmi, ModelAnimationTriggerType type, const SCP_string& triggeredBy);
ModelAnimationTriggerType anim_match_type(const char* p);
SCP_string anim_name_from_subsys(model_subsystem* ss);
}
|