Code/Engine/Core/Collection/CollectionComponent.h - dev - redgpu/ezEngine

Code/Engine/Core/Collection/CollectionComponent.h

45 строк2 KB

Jan Krassnigg

Fixed #1164: Made it easier to reflect resource handles (#1376)

23 авг 2024, 08:36

23 авг 2024, 08:368a46458

#pragma once

#include <Core/Collection/CollectionResource.h>
#include <Core/CoreDLL.h>
#include <Core/World/Component.h>
#include <Core/World/World.h>

using ezCollectionComponentManager = ezComponentManager<class ezCollectionComponent, ezBlockStorageType::Compact>;

/// \brief An ezCollectionComponent references an ezCollectionResource and triggers resource preloading when needed
///
/// Placing an ezCollectionComponent in a scene or a model makes it possible to tell the engine to preload certain resources
/// that are likely to be needed soon.
///
/// If a deactivated ezCollectionComponent is part of the scene, it will not trigger a preload, but will do so once
/// the component is activated.
class EZ_CORE_DLL ezCollectionComponent : public ezComponent
{
  EZ_DECLARE_COMPONENT_TYPE(ezCollectionComponent, ezComponent, ezCollectionComponentManager);

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

protected:
  virtual void OnSimulationStarted() override;

  //////////////////////////////////////////////////////////////////////////
  // ezCollectionComponent
public:
  ezCollectionComponent();
  ~ezCollectionComponent();

  void SetCollection(const ezCollectionResourceHandle& hPrefab);                                     // [ property ]
  EZ_ALWAYS_INLINE const ezCollectionResourceHandle& GetCollection() const { return m_hCollection; } // [ property ]

protected:
  /// \brief Triggers the preload on the referenced ezCollectionResource
  void InitiatePreload();

  bool m_bRegisterNames = false;
  ezCollectionResourceHandle m_hCollection;
};