Open 3D Engine Atom Gem API Reference  23.05.0
O3DE is an open-source, fully-featured, high-fidelity, modular 3D engine for building games and simulations, available to every industry.
AZ::Render::ReflectionProbeFeatureProcessor Class Referencefinal

Inherits AZ::Render::ReflectionProbeFeatureProcessorInterface, and MultiHandler.

Public Member Functions

 AZ_RTTI (AZ::Render::ReflectionProbeFeatureProcessor,"{A08C591F-D2AB-4550-852A-4436533DB137}", AZ::Render::ReflectionProbeFeatureProcessorInterface)
 
ReflectionProbeHandle AddReflectionProbe (const AZ::Transform &transform, bool useParallaxCorrection) override
 Add a new reflection probe, returns the handle of the new probe.
 
void RemoveReflectionProbe (ReflectionProbeHandle &handle) override
 Remove an existing reflection probe.
 
bool IsValidHandle (const ReflectionProbeHandle &handle) const override
 Check to see if a reflection probe handle is valid.
 
void SetOuterExtents (const ReflectionProbeHandle &handle, const AZ::Vector3 &outerExtents) override
 Set or retrieve outer extents.
 
AZ::Vector3 GetOuterExtents (const ReflectionProbeHandle &handle) const override
 
void SetInnerExtents (const ReflectionProbeHandle &handle, const AZ::Vector3 &innerExtents) override
 Set or retrieve inner extents.
 
AZ::Vector3 GetInnerExtents (const ReflectionProbeHandle &handle) const override
 
AZ::Obb GetOuterObbWs (const ReflectionProbeHandle &handle) const override
 Retrieve outer OBB.
 
AZ::Obb GetInnerObbWs (const ReflectionProbeHandle &handle) const override
 Retrieve inner OBB.
 
void SetTransform (const ReflectionProbeHandle &handle, const AZ::Transform &transform) override
 Set or retrieve transform.
 
AZ::Transform GetTransform (const ReflectionProbeHandle &handle) const override
 
void SetCubeMap (const ReflectionProbeHandle &handle, Data::Instance< RPI::Image > &cubeMapImage, const AZStd::string &relativePath) override
 Set or retrieve cubemap.
 
Data::Instance< RPI::ImageGetCubeMap (const ReflectionProbeHandle &handle) const override
 
void SetRenderExposure (const ReflectionProbeHandle &handle, float renderExposure) override
 Set or retrieve render exposure.
 
float GetRenderExposure (const ReflectionProbeHandle &handle) const override
 
void SetBakeExposure (const ReflectionProbeHandle &handle, float bakeExposure) override
 Set or retrieve bake exposure.
 
float GetBakeExposure (const ReflectionProbeHandle &handle) const override
 
bool GetUseParallaxCorrection (const ReflectionProbeHandle &handle) const override
 Retrieve parallax correction setting.
 
void Bake (const ReflectionProbeHandle &handle, BuildCubeMapCallback callback, const AZStd::string &relativePath) override
 Bake a reflection cubemap.
 
bool CheckCubeMapAssetNotification (const AZStd::string &relativePath, Data::Asset< RPI::StreamingImageAsset > &outCubeMapAsset, CubeMapAssetNotificationType &outNotificationType) override
 
bool IsCubeMapReferenced (const AZStd::string &relativePath) override
 Check to see if a cubemap is referenced by any reflection probes.
 
void ShowVisualization (const ReflectionProbeHandle &handle, bool showVisualization) override
 Show or Hide visualization sphere.
 
void FindReflectionProbes (const AZ::Vector3 &position, ReflectionProbeHandleVector &reflectionProbeHandles) override
 
void FindReflectionProbes (const AZ::Aabb &aabb, ReflectionProbeHandleVector &reflectionProbeHandles) override
 
void Activate () override
 Perform any necessary activation and gives access to owning Scene.
 
void Deactivate () override
 Perform any necessary deactivation.
 
void Simulate (const FeatureProcessor::SimulatePacket &packet) override
 
void OnRenderEnd () override
 
- Public Member Functions inherited from AZ::Render::ReflectionProbeFeatureProcessorInterface
 AZ_RTTI (AZ::Render::ReflectionProbeFeatureProcessorInterface,"{805FA0F8-765A-4072-A8B1-41C4708B6E36}", AZ::RPI::FeatureProcessor)
 
- Public Member Functions inherited from AZ::RPI::FeatureProcessor
 AZ_RTTI (FeatureProcessor,"{B8027170-C65C-4237-964D-B557FC9D7575}")
 
 AZ_CLASS_ALLOCATOR (FeatureProcessor, AZ::SystemAllocator)
 
SceneGetParentScene () const
 
virtual void ApplyRenderPipelineChange ([[maybe_unused]] RenderPipeline *pipeline)
 
virtual void AddRenderPasses ([[maybe_unused]] RenderPipeline *pipeline)
 
virtual void PrepareViews (const PrepareViewsPacket &, AZStd::vector< AZStd::pair< PipelineViewTag, ViewPtr >> &)
 
virtual void Simulate (const SimulatePacket &)
 
virtual void Render (const RenderPacket &)
 

Static Public Member Functions

static void Reflect (AZ::ReflectContext *context)
 

Additional Inherited Members

- Protected Member Functions inherited from AZ::RPI::FeatureProcessor
void EnableSceneNotification ()
 
void DisableSceneNotification ()
 

Member Function Documentation

bool AZ::Render::ReflectionProbeFeatureProcessor::CheckCubeMapAssetNotification ( const AZStd::string &  relativePath,
Data::Asset< RPI::StreamingImageAsset > &  outCubeMapAsset,
CubeMapAssetNotificationType &  outNotificationType 
)
overridevirtual

Check the status of a cubemap bake Note: For new cubemap bakes only, re-bakes of an existing cubemap are automatically hot-reloaded by the RPI

Implements AZ::Render::ReflectionProbeFeatureProcessorInterface.

void AZ::Render::ReflectionProbeFeatureProcessor::FindReflectionProbes ( const AZ::Vector3 &  position,
ReflectionProbeHandleVector &  reflectionProbeHandles 
)
overridevirtual

Find all reflection probes that overlap the specified position Note: result list is sorted by descending inner volume size

Implements AZ::Render::ReflectionProbeFeatureProcessorInterface.

void AZ::Render::ReflectionProbeFeatureProcessor::FindReflectionProbes ( const AZ::Aabb &  aabb,
ReflectionProbeHandleVector &  reflectionProbeHandles 
)
overridevirtual

Find all reflection probes that overlap the specified AABB Note: result list is sorted by descending inner volume size

Implements AZ::Render::ReflectionProbeFeatureProcessorInterface.

void AZ::Render::ReflectionProbeFeatureProcessor::OnRenderEnd ( )
overridevirtual

The feature processor may do clean up when the current render frame is finished

  • This is called every RPI::RenderTick.

Reimplemented from AZ::RPI::FeatureProcessor.


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