Code/EnginePlugins/JoltPlugin/Actors/JoltDynamicActorComponent.h - dev - redgpu/ezEngine

Code/EnginePlugins/JoltPlugin/Actors/JoltDynamicActorComponent.h
178 строк8 KB
C-Core
Water volume and VSE water shader (#1808)
04 фев 2026, 16:54
04 фев 2026, 16:545ad89f2
#pragma once

#include <Foundation/Math/Float16.h>
#include <JoltPlugin/Actors/JoltActorComponent.h>

//////////////////////////////////////////////////////////////////////////

class EZ_JOLTPLUGIN_DLL ezJoltDynamicActorComponentManager : public ezComponentManager<class ezJoltDynamicActorComponent, ezBlockStorageType::FreeList>
{
public:
  ezJoltDynamicActorComponentManager(ezWorld* pWorld);
  ~ezJoltDynamicActorComponentManager();

private:
  friend class ezJoltWorldModule;
  friend class ezJoltDynamicActorComponent;

  void UpdateKinematicActors(ezTime deltaTime);
  void UpdateDynamicActors();

  ezDynamicArray<ezJoltDynamicActorComponent*> m_KinematicActorComponents;
};

//////////////////////////////////////////////////////////////////////////

/// \brief Turns an object into a fully physically simulated movable object.
///
/// By default dynamic objects push each other and collide with static obstacles.
/// They can be switched to be "kinematic" in which case they act like static objects, but can be moved around and will
/// still push aside other dynamic objects.
///
/// Dynamic actors can also be moved through forces and impulses.
///
/// Dynamic actors must be made up of convex collision meshes. They cannot use concave meshes.
class EZ_JOLTPLUGIN_DLL ezJoltDynamicActorComponent : public ezJoltActorComponent
{
  EZ_DECLARE_COMPONENT_TYPE(ezJoltDynamicActorComponent, ezJoltActorComponent, ezJoltDynamicActorComponentManager);

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

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

protected:
  virtual void OnSimulationStarted() override;
  virtual void OnDeactivated() override;

  //////////////////////////////////////////////////////////////////////////
  // ezJoltDynamicActorComponent

public:
  ezJoltDynamicActorComponent();
  ~ezJoltDynamicActorComponent();

  /// \brief Turns the actor into a 'kinematic' actor.
  ///
  /// If an actor is kinematic, it isn't fully simulated anymore, meaning forces do not affect it further.
  /// Thus it does not fall down, it can't be pushed by other actors, it is mostly like a static actor.
  ///
  /// However, it can be moved programmatically. If other code changes the position of this object,
  /// it will move to that location and while doing so, it pushes other dynamic actors out of the way.
  ///
  /// Kinematic actors are typically used for moving platforms, doors and other objects that need to move and push aside
  /// dynamic actors.
  void SetKinematic(bool b);                         // [ property ]
  bool GetKinematic() const { return m_bKinematic; } // [ property ]

  /// \brief Adjusts how strongly gravity affects this actor. Has no effect for kinematic actors.
  ///
  /// Set this to zero to fully disable gravity.
  void SetGravityFactor(float fFactor);                       // [ property ]
  float GetGravityFactor() const { return m_fGravityFactor; } // [ property ]

  void SetSurfaceFile(ezStringView sFile);                    // [ property ]
  ezStringView GetSurfaceFile() const;                        // [ property ]

  /// \brief If enabled, a more precise simulation method is used, preventing fast moving actors from tunneling through walls.
  /// This comes at an extra performance cost.
  bool m_bCCD = false; // [ property ]

  /// \brief If true, the actor will not be simulated right away, but only after another actor starts interacting with it.
  /// This is a performance optimization to prevent performance spikes after loading a level.
  bool m_bStartAsleep = false; // [ property ]

  /// \brief Whether this actor is allowed to go to sleep. Disabling sleeping will come with a performance impact and
  /// should only be done in very rare cases.
  bool m_bAllowSleeping = true;        // [ property ]

  ezUInt8 m_uiWeightCategory = 0;      // [ property ]
  ezFloat16 m_fWeightMass = 10.0f;     // [ property ]
  ezFloat16 m_fWeightDensity = 100.0f; // [ property ]
  ezFloat16 m_fWeightScale = 1.0f;     // [ property ]

  /// \brief How much buoyancy to apply when the actor is submerged in a fluid. 1.0 means neutral buoyancy, <1.0 sinks, >1.0 floats.
  ezFloat16 m_fBuoyancyFactor = 1.1f; // [ property ]

  /// \brief How much to dampen linear motion. The higher the value, the quicker a moving object comes to rest.
  float m_fLinearDamping = 0.1f; // [ property ]

  /// \brief How much to dampen angular motion. The higher the value, the quicker a rotating object comes to rest.
  float m_fAngularDamping = 0.05f; // [ property ]

  /// \brief Which surface to use for all shapes. The surface defines various physical properties and interactions.
  ezSurfaceResourceHandle m_hSurface; // [ property ]

  /// \brief What reactions should be triggered when an actor gets into contact with another.
  ezBitflags<ezOnJoltContact> m_OnContact; // [ property ]

  /// \brief A local offset for the center of mass. \see SetUseCustomCoM()
  ezVec3 m_vCenterOfMass = ezVec3::MakeZero(); // [ property ]

  /// \brief Whether a custom center-of-mass shall be used.
  void SetUseCustomCoM(bool b) { SetUserFlag(0, b); }     // [ property ]
  bool GetUseCustomCoM() const { return GetUserFlag(0); } // [ property ]

  /// \brief Adds a physics impulse to this body at the given location.
  ///
  /// An impulse is a force that is applied only once, e.g. a sudden push.
  void AddLinearImpulseAtPos(ezMsgPhysicsAddImpulse& ref_msg); // [ message ]

  /// \brief Adds a linear impulse to the center-of-mass of this actor. Unless there are other constraints, this would push the object, but not introduce any rotation.
  ///
  /// For uiImpulseType see ezImpulseTypeConfig. Use 0 to use vImpulse without modification.
  void AddLinearImpulse(const ezVec3& vImpulse, ezUInt8 uiImpulseType = 0); // [ scriptable ]

  /// \brief Adds an angular impulse to the center-of-mass of this actor. Unless there are other constraints, this would make the object rotate, but not move away.
  ///
  /// For uiImpulseType see ezImpulseTypeConfig. Use 0 to use vImpulse without modification.
  void AddAngularImpulse(const ezVec3& vImpulse, ezUInt8 uiImpulseType = 0); // [ scriptable ]

  /// \brief Should be called by components that add Jolt constraints to this body.
  ///
  /// All registered components receive ezJoltMsgDisconnectConstraints in case the body is deleted.
  /// It is necessary to react to that by removing the Jolt constraint, otherwise Jolt will crash during the next update.
  void AddConstraint(ezComponentHandle hComponent);

  /// \brief Should be called when a constraint is removed (though not strictly required) to prevent unnecessary message sending.
  void RemoveConstraint(ezComponentHandle hComponent);

  /// \brief Returns the actual mass of this actor which is either the user defined mass or has been calculated from density.
  /// For kinematic actors this function will return 0.
  float GetMass() const;

  /// \brief Adds a force that will be applied to this actor every frame for the given duration.
  ///
  /// Returns a force ID. Pass in an invalid ID (such as 0) to create a new force.
  /// If an existing force shall be updated, pass in the ID that was returned last time.
  ///
  /// Once the duration has elapsed and no update was done to reset the duration, the force is automatically removed.
  /// If a force ID of such a force is used again, it will be ignored and a new force is created instead,
  /// so just always store the returned ID, to replaced force IDs that became invalid.
  ///
  /// If this is called multiple times with invalid force IDs, multiple forces are created to act on the body.
  ezUInt32 AddOrUpdateForce(ezUInt32 uiForceID, ezTime duration, const ezVec3& vForce);

  /// \brief Removes the force with the given ID. Does nothing, if the ID is invalid.
  void ClearForce(ezUInt32 uiForceID);

protected:
  const ezJoltMaterial* GetJoltMaterial() const;

  float GetWeight_Scale() const { return m_fWeightScale; }
  float GetWeight_Mass() const { return m_fWeightMass; }
  float GetWeight_Density() const { return m_fWeightDensity; }
  float GetBuoyancyFactor() const { return m_fBuoyancyFactor; }

  void SetWeight_Scale(float fValue) { m_fWeightScale = fValue; }
  void SetWeight_Mass(float fValue) { m_fWeightMass = fValue; }
  void SetWeight_Density(float fValue) { m_fWeightDensity = fValue; }
  void SetBuoyancyFactor(float fValue) { m_fBuoyancyFactor = fValue; }

  bool m_bKinematic = false;
  float m_fGravityFactor = 1.0f; // [ property ]

  ezSmallArray<ezComponentHandle, 1> m_Constraints;
};