Code/EnginePlugins/GameComponentsPlugin/Animation/MoveToComponent.h - dev - redgpu/ezEngine

Code/EnginePlugins/GameComponentsPlugin/Animation/MoveToComponent.h
85 строк3 KB
C-Core
Event message improvements (#1862)
11 мар 2026, 17:35
11 мар 2026, 17:35ef16a7e
#pragma once

#include <GameComponentsPlugin/GameComponentsDLL.h>

#include <Core/Messages/CommonMessages.h>
#include <Core/Messages/EventMessageSender.h>

struct ezMoveToComponentFlags
{
  using StorageType = ezUInt16;

  enum Enum
  {
    None = 0,
    Running = EZ_BIT(0),
    Default = None
  };

  struct Bits
  {
    StorageType Running : 1;
  };
};

using ezMoveToComponentManager = ezComponentManagerSimple<class ezMoveToComponent, ezComponentUpdateType::WhenSimulating>;

EZ_DECLARE_FLAGS_OPERATORS(ezMoveToComponentFlags);

/// \brief A light-weight component that moves the owner object towards a single position.
///
/// The functionality of this component can only be controlled through (script) code.
/// The component is given a single point in global space. When it is set to 'running' it will move
/// the owning object towards this point. Optionally it may use acceleration or deceleration and a maximum speed
/// to reach that point.
///
/// Since the target position is given through code and can be modified at any time, this component can be used
/// for moving objects to a point that is decided dynamically. For example an elevator can be moved to a
/// specific height, depending on which floor was selected. Or an object could follow a character,
/// by updating the target position regularly.
///
/// The component sends the event 'ezMsgAnimationReachedEnd' and resets its running state when it reaches the target position.
class EZ_GAMECOMPONENTS_DLL ezMoveToComponent : public ezComponent
{
  EZ_DECLARE_COMPONENT_TYPE(ezMoveToComponent, ezComponent, ezMoveToComponentManager);

  //////////////////////////////////////////////////////////////////////////
  // ezComponent

protected:
  virtual void OnSimulationStarted() override;

public:
  virtual void SerializeComponent(ezWorldWriter& inout_stream) const override;
  virtual void DeserializeComponent(ezWorldReader& inout_stream) override;


  //////////////////////////////////////////////////////////////////////////
  // ezTransformComponent

public:
  ezMoveToComponent();
  ~ezMoveToComponent();

  /// If set to false, the animation stops immediately.
  void SetRunning(bool bRunning); // [ property ]

  /// Returns false, when the component has reached the target position.
  bool IsRunning() const; // [ property ]

  /// Automatically sets the component to 'running'.
  void SetTargetPosition(const ezVec3& vPos); // [ scriptable ]

protected:
  void Update();

  ezEventMessageSender<ezMsgAnimationReachedEnd> m_ReachedEndMsgSender; // [ event ]

  float m_fCurTranslationSpeed = 0;
  float m_fMaxTranslationSpeed = 1;                                     // [ property ]
  float m_fTranslationAcceleration = 0;                                 // [ property ]
  float m_fTranslationDeceleration = 0;                                 // [ property ]

  ezVec3 m_vTargetPosition;
  ezBitflags<ezMoveToComponentFlags> m_Flags;
};