Code/Engine/RendererCore/Components/SpriteComponent.h - dev - redgpu/ezEngine

Code/Engine/RendererCore/Components/SpriteComponent.h
131 строка4 KB
Evan Fish
Feature: Animated Sprite Component Addition (#1967)
02 июл 2026, 10:17
02 июл 2026, 10:17f814ffe
#pragma once

#include <Core/ResourceManager/ResourceHandle.h>
#include <Core/World/World.h>
#include <Foundation/Math/Color16f.h>
#include <Foundation/Time/Time.h>
#include <RendererCore/Components/RenderComponent.h>
#include <RendererCore/Pipeline/RenderData.h>

struct ezMsgSetColor;
using ezTexture2DResourceHandle = ezTypedResourceHandle<class ezTexture2DResource>;

struct ezSpriteBlendMode
{
  using StorageType = ezUInt8;

  enum Enum
  {
    Masked,
    Transparent,
    Additive,
    ShapeIcon,

    Default = Masked
  };

  static ezTempHashedString GetPermutationValue(Enum blendMode);
};

EZ_DECLARE_REFLECTABLE_TYPE(EZ_RENDERERCORE_DLL, ezSpriteBlendMode);

class EZ_RENDERERCORE_DLL ezSpriteRenderData : public ezRenderData
{
  EZ_ADD_DYNAMIC_REFLECTION(ezSpriteRenderData, ezRenderData);

public:
  void FillSortingKey();
  virtual bool CanBatch(const ezRenderData& other) const override;

  ezTexture2DResourceHandle m_hTexture;
  ezEnum<ezSpriteBlendMode> m_BlendMode;

  float m_fSize;
  float m_fMaxScreenSize;
  float m_fAspectRatio;

  ezColorLinear16f m_color;

  ezFloat16Vec2 m_texCoordScale;
  ezFloat16Vec2 m_texCoordOffset;

  ezUInt32 m_uiUniqueID;
};

using ezSpriteComponentManager = ezComponentManagerSimple<class ezSpriteComponent, ezComponentUpdateType::Always, ezBlockStorageType::Compact>;

/// \brief Renders a screen-oriented quad (billboard) with a maximum screen size.
///
/// This component is typically used to attach an icon to a game object.
/// The sprite becomes smaller the farther away it is, but when you come closer, its screen size gets clamped to a fixed maximum.
///
/// It can also be used to render simple projectiles.
///
/// If you want to render a glow effect for a lightsource, use the ezLensFlareComponent instead.
class EZ_RENDERERCORE_DLL ezSpriteComponent : public ezRenderComponent
{
  EZ_DECLARE_COMPONENT_TYPE(ezSpriteComponent, ezRenderComponent, ezSpriteComponentManager);

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

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

  //////////////////////////////////////////////////////////////////////////
  // ezRenderComponent

public:
  virtual ezResult GetLocalBounds(ezBoundingBoxSphere& ref_bounds, bool& ref_bAlwaysVisible, ezMsgUpdateLocalBounds& ref_msg) override;

  //////////////////////////////////////////////////////////////////////////
  // ezSpriteComponent

public:
  ezSpriteComponent();
  ~ezSpriteComponent();

  void Update();

  void SetTexture(const ezTexture2DResourceHandle& hTexture); // [ property ]
  const ezTexture2DResourceHandle& GetTexture() const;        // [ property ]

  void SetColor(ezColor color);                               // [ property ]
  ezColor GetColor() const;                                   // [ property ]

  /// \brief Sets the size of the sprite in world-space units. This determines how large the sprite will be at certain distances.
  void SetSize(float fSize); // [ property ]
  float GetSize() const;     // [ property ]

  /// \brief Sets the maximum screen-space size in pixels. Once a sprite is close enough to have reached this size, it will not grow larger.
  void SetMaxScreenSize(float fSize);                             // [ property ]
  float GetMaxScreenSize() const;                                 // [ property ]

private:
  void OnMsgSetColor(ezMsgSetColor& ref_msg);                     // [ msg handler ]
  void OnMsgDeleteGameObject(ezMsgDeleteGameObject& msg);         // [ msg handler ]
  void OnMsgExtractRenderData(ezMsgExtractRenderData& msg) const; // [ msg handler ]

  ezTexture2DResourceHandle m_hTexture;
  ezColor m_Color = ezColor::White;

  ezEnum<ezSpriteBlendMode> m_BlendMode;
  ezEnum<ezOnComponentFinishedAction> m_OnFinishedAction = ezOnComponentFinishedAction::Default;
  bool m_bUseMaxScreenSize = true;
  bool m_bIsAnimated = false;

  float m_fSize = 1.0f;
  float m_fMaxScreenSize = 64.0f;
  float m_fAspectRatio = 1.0f;

  float m_fFramerate = 24.0f;

  ezUInt32 m_uiLoops = 0;

  ezTime m_TimeSinceStart;
  ezUInt32 m_uiCurrentLoop = 0;

  ezUInt8 m_uiColumns = 1;
  ezUInt8 m_uiRows = 1;
};