Open 3D Engine Vegetation Gem API Reference 23.10.0
O3DE is an open-source, fully-featured, high-fidelity, modular 3D engine for building games and simulations, available to every industry.
Public Member Functions | Static Public Member Functions | Public Attributes | List of all members
Vegetation::Descriptor Struct Referencefinal

#include <Descriptor.h>

Public Member Functions

 AZ_CLASS_ALLOCATOR (Descriptor, AZ::SystemAllocator)
 
 AZ_TYPE_INFO (Descriptor, VegetationDescriptorTypeId)
 
bool operator== (const Descriptor &rhs) const
 
bool HasEquivalentInstanceSpawners (const Descriptor &rhs) const
 
AZ_INLINE AZStd::string GetDescriptorName ()
 
AZ_INLINE void LoadAssets ()
 
AZ_INLINE void UnloadAssets ()
 
AZ_INLINE void OnRegisterUniqueDescriptor ()
 
AZ_INLINE void OnReleaseUniqueDescriptor ()
 
AZ_INLINE float GetInstanceRadius () const
 
AZ_INLINE bool HasEmptyAssetReferences () const
 
AZ_INLINE bool IsLoaded () const
 
AZ_INLINE bool IsSpawnable () const
 
AZ_INLINE InstancePtr CreateInstance (const InstanceData &instanceData)
 
AZ_INLINE void DestroyInstance (InstanceId id, InstancePtr instance)
 
void * GetDescriptorNotificationBusId () const
 
AZ_INLINE AZStd::shared_ptr< InstanceSpawner > GetInstanceSpawner () const
 
AZ_INLINE void SetInstanceSpawner (const AZStd::shared_ptr< InstanceSpawner > &spawner)
 
AZ_INLINE float GetRadius () const
 
AZ_INLINE AZ::Vector3 GetPositionMin () const
 
AZ_INLINE AZ::Vector3 GetPositionMax () const
 
AZ_INLINE AZ::Vector3 GetRotationMin () const
 
AZ_INLINE AZ::Vector3 GetRotationMax () const
 
size_t GetNumInclusiveSurfaceFilterTags () const
 
AZ::Crc32 GetInclusiveSurfaceFilterTag (int tagIndex) const
 
void RemoveInclusiveSurfaceFilterTag (int tagIndex)
 
void AddInclusiveSurfaceFilterTag (const AZStd::string &tag)
 
size_t GetNumExclusiveSurfaceFilterTags () const
 
AZ::Crc32 GetExclusiveSurfaceFilterTag (int tagIndex) const
 
void RemoveExclusiveSurfaceFilterTag (int tagIndex)
 
void AddExclusiveSurfaceFilterTag (const AZStd::string &tag)
 
AZStd::vector< AZStd::pair< AZ::TypeId, AZStd::string > > GetSpawnerTypeList () const
 
AZ::u32 SpawnerTypeChanged ()
 
void RefreshSpawnerTypeList () const
 

Static Public Member Functions

static void Reflect (AZ::ReflectContext *context)
 

Public Attributes

AZ::TypeId m_spawnerType
 
float m_weight = 1.0f
 
bool m_advanced = false
 
SurfaceTagDistance m_surfaceTagDistance
 
OverrideMode m_surfaceFilterOverrideMode = OverrideMode::Disable
 
SurfaceData::SurfaceTagVector m_inclusiveSurfaceFilterTags
 
SurfaceData::SurfaceTagVector m_exclusiveSurfaceFilterTags
 
bool m_radiusOverrideEnabled = false
 
BoundMode m_boundMode = BoundMode::Radius
 
float m_radiusMin = 0.0f
 
bool m_surfaceAlignmentOverrideEnabled = false
 
float m_surfaceAlignmentMin = 0.0f
 
float m_surfaceAlignmentMax = 1.0f
 
bool m_positionOverrideEnabled = false
 
float m_positionMinX = -0.3f
 
float m_positionMaxX = 0.3f
 
float m_positionMinY = -0.3f
 
float m_positionMaxY = 0.3f
 
float m_positionMinZ = 0.0f
 
float m_positionMaxZ = 0.0f
 
bool m_rotationOverrideEnabled = false
 
float m_rotationMinX = 0.0f
 
float m_rotationMaxX = 0.0f
 
float m_rotationMinY = 0.0f
 
float m_rotationMaxY = 0.0f
 
float m_rotationMinZ = -180.0f
 
float m_rotationMaxZ = 180.0f
 
bool m_scaleOverrideEnabled = false
 
float m_scaleMin = 0.1f
 
float m_scaleMax = 1.0f
 
bool m_altitudeFilterOverrideEnabled = false
 
float m_altitudeFilterMin = 0.0f
 
float m_altitudeFilterMax = 128.0f
 
bool m_slopeFilterOverrideEnabled = false
 
float m_slopeFilterMin = 0.0f
 
float m_slopeFilterMax = 20.0f
 

Detailed Description

Details used to create vegetation instances

The documentation for this struct was generated from the following file: