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.
Public Member Functions | Static Public Member Functions | Protected Member Functions | Friends | List of all members
GradientSignal::ShapeAreaFalloffGradientComponent Class Reference

#include <ShapeAreaFalloffGradientComponent.h>

Inherits AZ::Component, GradientRequestBus::Handler, ShapeAreaFalloffGradientRequestBus::Handler, LmbrCentral::ShapeComponentNotificationsBus::Handler, and AZ::EntityBus::Handler.

Public Member Functions

 AZ_COMPONENT (ShapeAreaFalloffGradientComponent, ShapeAreaFalloffGradientComponentTypeId)
 
 ShapeAreaFalloffGradientComponent (const ShapeAreaFalloffGradientConfig &configuration)
 
void Activate () override
 
void Deactivate () override
 
bool ReadInConfig (const AZ::ComponentConfig *baseConfig) override
 
bool WriteOutConfig (AZ::ComponentConfig *outBaseConfig) const override
 
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

void OnEntityActivated (const AZ::EntityId &entityId) override
 
void OnEntityDeactivated (const AZ::EntityId &entityId) override
 
void OnShapeChanged (LmbrCentral::ShapeComponentNotifications::ShapeChangeReasons reasons) override
 
AZ::EntityId GetShapeEntityId () const override
 
void SetShapeEntityId (AZ::EntityId entityId) override
 
float GetFalloffWidth () const override
 
void SetFalloffWidth (float falloffWidth) override
 
FalloffType GetFalloffType () const override
 
void SetFalloffType (FalloffType type) override
 
bool Get3dFalloff () const override
 
void Set3dFalloff (bool is3dFalloff) override
 
void CacheShapeBounds ()
 
void NotifyRegionChanged (const AZ::Aabb &region)
 

Friends

template<typename , typename >
class LmbrCentral::EditorWrappedComponentBase
 

Detailed Description

calculates a gradient value based on distance from a shapes surface

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