Open 3D Engine GradientSignal 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.
GradientSignal::SurfaceAltitudeGradientComponent Class Reference

#include <SurfaceAltitudeGradientComponent.h>

Inherits AZ::Component, GradientRequestBus::Handler, SurfaceAltitudeGradientRequestBus::Handler, LmbrCentral::DependencyNotificationBus::Handler, AZ::TickBus::Handler, and SurfaceData::SurfaceDataSystemNotificationBus::Handler.

Public Member Functions

 AZ_COMPONENT (SurfaceAltitudeGradientComponent, SurfaceAltitudeGradientComponentTypeId)
 
 SurfaceAltitudeGradientComponent (const SurfaceAltitudeGradientConfig &configuration)
 
void Activate () override
 
void Deactivate () override
 
bool ReadInConfig (const AZ::ComponentConfig *baseConfig) override
 
bool WriteOutConfig (AZ::ComponentConfig *outBaseConfig) const override
 
void OnCompositionChanged () override
 
void OnSurfaceChanged (const AZ::EntityId &entityId, const AZ::Aabb &oldBounds, const AZ::Aabb &newBounds, const SurfaceData::SurfaceTagSet &changedSurfaceTags) override
 
void OnTick (float deltaTime, AZ::ScriptTimePoint time) override
 
void UpdateFromShape ()
 
float GetValue (const GradientSampleParams &sampleParams) const override
 
void GetValues (AZStd::span< const AZ::Vector3 > positions, AZStd::span< float > outValues) const override
 

Static Public Member Functions

static void GetProvidedServices (AZ::ComponentDescriptor::DependencyArrayType &services)
 
static void GetIncompatibleServices (AZ::ComponentDescriptor::DependencyArrayType &services)
 
static void GetRequiredServices (AZ::ComponentDescriptor::DependencyArrayType &services)
 
static void Reflect (AZ::ReflectContext *context)
 

Protected Member Functions

AZ::EntityId GetShapeEntityId () const override
 
void SetShapeEntityId (AZ::EntityId entityId) override
 
float GetAltitudeMin () const override
 
void SetAltitudeMin (float altitudeMin) override
 
float GetAltitudeMax () const override
 
void SetAltitudeMax (float altitudeMax) override
 
size_t GetNumTags () const override
 
AZ::Crc32 GetTag (int tagIndex) const override
 
void RemoveTag (int tagIndex) override
 
void AddTag (AZStd::string tag) override
 

Friends

template<typename , typename >
class LmbrCentral::EditorWrappedComponentBase
 

Detailed Description

Component implementing GradientRequestBus based on altitude


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