FollowPathComponent.h

#pragma once
 
#include <Core/Messages/EventMessage.h>
#include <Core/World/Component.h>
#include <Core/World/ComponentManager.h>
#include <GameEngine/Animation/PathComponent.h>
#include <GameEngine/Animation/PropertyAnimResource.h>
 
struct plMsgAnimationReachedEnd;
 
 
using plFollowPathComponentManager = plComponentManagerSimple<class plFollowPathComponent, plComponentUpdateType::WhenSimulating>;
 
struct PL_GAMEENGINE_DLL plFollowPathMode
{
  using StorageType = plUInt8;
 
  enum Enum
  {
    OnlyPosition,
    AlignUpZ,
    FullRotation,
 
    Default = OnlyPosition
  };
};
 
PL_DECLARE_REFLECTABLE_TYPE(PL_GAMEENGINE_DLL, plFollowPathMode)
 
 
class PL_GAMEENGINE_DLL plFollowPathComponent : public plComponent
{
  PL_DECLARE_COMPONENT_TYPE(plFollowPathComponent, plComponent, plFollowPathComponentManager);
 
  // plComponent
 
public:
  virtual void SerializeComponent(plWorldWriter& ref_stream) const override;
  virtual void DeserializeComponent(plWorldReader& ref_stream) override;
 
protected:
  virtual void OnActivated() override;
  virtual void OnSimulationStarted() override;
 
  // plFollowPathComponent
 
public:
  plFollowPathComponent();
  ~plFollowPathComponent();
 
  void SetPathObject(const char* szReference); // [ property ]
 
  plEnum<plPropertyAnimMode> m_Mode;                    
  plEnum<plFollowPathMode> m_FollowMode;                
  float m_fSpeed = 1.0f;                                
  float m_fLookAhead = 1.0f;                            
  float m_fSmoothing = 0.5f;                            
  float m_fTiltAmount = 5.0f;                           
  plAngle m_MaxTilt = plAngle::MakeFromDegree(30.0f);   
 
  void SetDistanceAlongPath(float fDistance); // [ property ]
  float GetDistanceAlongPath() const;         // [ property ]
 
  void SetDirectionForwards(bool bForwards); // [ scriptable ]
 
  void ToggleDirection(); // [ scriptable ]
 
  bool IsDirectionForwards() const; // [ scriptable ]
 
  bool IsRunning() const; // [ property ]
 
  void SetRunning(bool bRunning); // [ property ]
 
protected:
  void Update(bool bForce = false);
 
  plEventMessageSender<plMsgAnimationReachedEnd> m_ReachedEndEvent; // [ event ]
  plGameObjectHandle m_hPathObject;                                 // [ property ]
  plPathComponent::LinearSampler m_PathSampler;
 
  float m_fStartDistance = 0.0f; // [ property ]
  bool m_bLastStateValid = false;
  bool m_bIsRunning = true;
  bool m_bIsRunningForwards = true;
  plVec3 m_vLastPosition;
  plVec3 m_vLastTargetPosition;
  plVec3 m_vLastUpDir;
  plAngle m_LastTiltAngle;
 
  const char* DummyGetter() const { return nullptr; }
};