Class AnimatedPartSet

source/base/StarAnimatedPartSet.hpp:42–161

Defines a "animated" data set constructed in such a way that it is very useful for doing generic animations with lots of additional animation data. It is made up of two concepts, "states" and "parts". States: There are N "state types" defined, which each defines a set of mutually exclusive states that each "state type" can be in. For example, one state type might be "movement", and the "movemen

// like damage or collision polys can be stored along with the animation
// frames, the part state, the base part, whichever is most applicable.
class AnimatedPartSet {
public:
  struct ActiveStateInformation {
    String stateTypeName;
    String stateName;
    float timer;
    unsigned frame;
    JsonObject properties;
  };

  struct ActivePartInformation {
    String partName;
    // If a state match is found, this will be set.
    Maybe<ActiveStateInformation> activeState;
    JsonObject properties;
  };

    enum AnimationMode {
    End,
    Loop,
    Transition
  };

  struct State {
    unsigned frames;
    float cycle;
    AnimationMode animationMode;
    String transitionState;
    JsonObject stateProperties;
    JsonObject stateFrameProperties;
  };

  struct StateType {
    float priority;
    bool enabled;
    String defaultState;
    JsonObject stateTypeProperties;
    OrderedHashMap<String, shared_ptr<State const>> states;

    ActiveStateInformation activeState;
    State const* activeStatePointer;
    bool activeStateDirty;
  };

  struct PartState {
    JsonObject partStateProperties;
    JsonObject partStateFrameProperties;
  };

  struct Part {
    JsonObject partProperties;
    StringMap<StringMap<PartState>> partStates;

    ActivePartInformation activePart;
    bool activePartDirty;
  };

  AnimatedPartSet();