|
Open 3D Engine Vegetation Gem API Reference
24.09
O3DE is an open-source, fully-featured, high-fidelity, modular 3D engine for building games and simulations, available to every industry.
|
|
Open 3D Engine Vegetation Gem API Reference
24.09
O3DE is an open-source, fully-featured, high-fidelity, modular 3D engine for building games and simulations, available to every industry.
|
#include <PrefabInstanceSpawner.h>
Inherits Vegetation::InstanceSpawner, and AZ::Data::AssetBus::MultiHandler.
Public Member Functions | |
| AZ_RTTI (PrefabInstanceSpawner, "{74BEEDB5-81CF-409F-B375-0D93D81EF2E3}", InstanceSpawner) | |
| AZ_CLASS_ALLOCATOR (PrefabInstanceSpawner, AZ::SystemAllocator) | |
| void | LoadAssets () override |
| Start loading any assets that the spawner will need. | |
| void | UnloadAssets () override |
| Unload any assets that the spawner loaded. | |
| void | OnRegisterUniqueDescriptor () override |
| Perform any extra initialization needed at the point of registering with the vegetation system. | |
| void | OnReleaseUniqueDescriptor () override |
| Perform any extra cleanup needed at the point of unregistering with the vegetation system. | |
| bool | HasEmptyAssetReferences () const override |
| Does this exist but have empty asset references? | |
| bool | IsLoaded () const override |
| Has this finished loading any assets that are needed? | |
| bool | IsSpawnable () const override |
| Are the assets loaded, initialized, and spawnable? | |
| AZStd::string | GetName () const override |
| Display name of the instances that will be spawned. | |
| InstancePtr | CreateInstance (const InstanceData &instanceData) override |
| Create a single instance. | |
| void | DestroyInstance (InstanceId id, InstancePtr instance) override |
| Destroy a single instance. | |
| AZStd::string | GetSpawnableAssetPath () const |
| void | SetSpawnableAssetPath (const AZStd::string &assetPath) |
| AZ::Data::AssetId | GetSpawnableAssetId () const |
| void | SetSpawnableAssetId (const AZ::Data::AssetId &assetId) |
 Public Member Functions inherited from Vegetation::InstanceSpawner | |
| AZ_RTTI (InstanceSpawner, "{01AD0758-B04A-4B43-BC2B-BDCD77F4EF6A}") | |
| AZ_CLASS_ALLOCATOR (InstanceSpawner, AZ::SystemAllocator) | |
| virtual bool | HasRadiusData () const |
| Does this spawner have the capability to provide radius data? | |
| virtual float | GetRadius () const |
| Radius of the instances that will be spawned, used by the Distance Between filter. | |
| bool | operator== (const InstanceSpawner &rhs) const |
| Check for data equivalency. Subclasses are expected to implement this. | |
Static Public Member Functions | |
| static void | Reflect (AZ::ReflectContext *context) |
| Static Public Member Functions inherited from Vegetation::InstanceSpawner | |
| static void | Reflect (AZ::ReflectContext *context) |
Additional Inherited Members | |
| Protected Member Functions inherited from Vegetation::InstanceSpawner | |
| void | NotifyOnAssetsLoaded () |
| Subclasses are expected to call this whenever assets have loaded / reloaded. | |
| void | NotifyOnAssetsUnloaded () |
| Subclasses are expected to call this whenever assets have unloaded. | |
Instance spawner of prefab instances.
1.9.1