The ReflectionProbeFeatureProcessorInterface provides an interface to the feature processor for code outside of Atom. More...

#include <ReflectionProbeFeatureProcessorInterface.h>

Inherits AZ::RPI::FeatureProcessor.

Inherited by AZ::Render::ReflectionProbeFeatureProcessor.

Public Member Functions
	AZ_RTTI (AZ::Render::ReflectionProbeFeatureProcessorInterface, "{805FA0F8-765A-4072-A8B1-41C4708B6E36}", AZ::RPI::FeatureProcessor)

virtual ReflectionProbeHandle	AddReflectionProbe (const AZ::Transform &transform, bool useParallaxCorrection)=0
	Add a new reflection probe, returns the handle of the new probe.

virtual void	RemoveReflectionProbe (ReflectionProbeHandle &handle)=0
	Remove an existing reflection probe.

virtual bool	IsValidHandle (const ReflectionProbeHandle &handle) const =0
	Check to see if a reflection probe handle is valid.

virtual void	SetOuterExtents (const ReflectionProbeHandle &handle, const AZ::Vector3 &outerExtents)=0
	Set or retrieve outer extents.

virtual AZ::Vector3	GetOuterExtents (const ReflectionProbeHandle &handle) const =0

virtual void	SetInnerExtents (const ReflectionProbeHandle &handle, const AZ::Vector3 &innerExtents)=0
	Set or retrieve inner extents.

virtual AZ::Vector3	GetInnerExtents (const ReflectionProbeHandle &handle) const =0

virtual AZ::Obb	GetOuterObbWs (const ReflectionProbeHandle &handle) const =0
	Retrieve outer OBB.

virtual AZ::Obb	GetInnerObbWs (const ReflectionProbeHandle &handle) const =0
	Retrieve inner OBB.

virtual void	SetTransform (const ReflectionProbeHandle &handle, const AZ::Transform &transform)=0
	Set or retrieve transform.

virtual AZ::Transform	GetTransform (const ReflectionProbeHandle &handle) const =0

virtual void	SetCubeMap (const ReflectionProbeHandle &handle, Data::Instance< RPI::Image > &cubeMapImage, const AZStd::string &relativePath)=0
	Set or retrieve cubemap.

virtual Data::Instance< RPI::Image >	GetCubeMap (const ReflectionProbeHandle &handle) const =0

virtual void	SetRenderExposure (const ReflectionProbeHandle &handle, float renderExposure)=0
	Set or retrieve render exposure.

virtual float	GetRenderExposure (const ReflectionProbeHandle &handle) const =0

virtual void	SetBakeExposure (const ReflectionProbeHandle &handle, float bakeExposure)=0
	Set or retrieve bake exposure.

virtual float	GetBakeExposure (const ReflectionProbeHandle &handle) const =0

virtual bool	GetUseParallaxCorrection (const ReflectionProbeHandle &handle) const =0
	Retrieve parallax correction setting.

virtual void	ShowVisualization (const ReflectionProbeHandle &handle, bool showVisualization)=0
	Show or Hide visualization sphere.

virtual void	Bake (const ReflectionProbeHandle &handle, BuildCubeMapCallback callback, const AZStd::string &relativePath)=0
	Bake a reflection cubemap.

virtual bool	CheckCubeMapAssetNotification (const AZStd::string &relativePath, Data::Asset< RPI::StreamingImageAsset > &outCubeMapAsset, CubeMapAssetNotificationType &outNotificationType)=0

virtual bool	IsCubeMapReferenced (const AZStd::string &relativePath)=0
	Check to see if a cubemap is referenced by any reflection probes.

virtual void	FindReflectionProbes (const AZ::Vector3 &position, ReflectionProbeHandleVector &reflectionProbeHandles)=0

virtual void	FindReflectionProbes (const AZ::Aabb &aabb, ReflectionProbeHandleVector &reflectionProbeHandles)=0

Public Member Functions inherited from AZ::RPI::FeatureProcessor
	AZ_RTTI (FeatureProcessor, "{B8027170-C65C-4237-964D-B557FC9D7575}")

	AZ_CLASS_ALLOCATOR (FeatureProcessor, AZ::SystemAllocator)

Scene *	GetParentScene () const

virtual void	Activate ()
	Perform any necessary activation and gives access to owning Scene.

virtual void	Deactivate ()
	Perform any necessary deactivation.

virtual void	ApplyRenderPipelineChange (RenderPipeline *pipeline)

virtual void	AddRenderPasses (RenderPipeline *pipeline)

virtual void	PrepareViews (const PrepareViewsPacket &, AZStd::vector< AZStd::pair< PipelineViewTag, ViewPtr > > &)

virtual void	Simulate (const SimulatePacket &)

virtual void	Render (const RenderPacket &)

virtual void	OnEndCulling (const RenderPacket &)

virtual void	OnRenderEnd ()

Additional Inherited Members
Protected Member Functions inherited from AZ::RPI::FeatureProcessor
void	EnableSceneNotification ()

void	DisableSceneNotification ()

Detailed Description

The ReflectionProbeFeatureProcessorInterface provides an interface to the feature processor for code outside of Atom.

Member Function Documentation

◆ AddReflectionProbe()

virtual ReflectionProbeHandle AZ::Render::ReflectionProbeFeatureProcessorInterface::AddReflectionProbe	(	const AZ::Transform &	transform,
		bool	useParallaxCorrection
	)

pure virtual

Add a new reflection probe, returns the handle of the new probe.

Implemented in AZ::Render::ReflectionProbeFeatureProcessor.

◆ Bake()

virtual void AZ::Render::ReflectionProbeFeatureProcessorInterface::Bake	(	const ReflectionProbeHandle &	handle,
		BuildCubeMapCallback	callback,
		const AZStd::string &	relativePath
	)

pure virtual

Bake a reflection cubemap.

Implemented in AZ::Render::ReflectionProbeFeatureProcessor.

◆ CheckCubeMapAssetNotification()

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

pure virtual

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

Implemented in AZ::Render::ReflectionProbeFeatureProcessor.

◆ FindReflectionProbes() [1/2]

virtual void AZ::Render::ReflectionProbeFeatureProcessorInterface::FindReflectionProbes	(	const AZ::Aabb &	aabb,
		ReflectionProbeHandleVector &	reflectionProbeHandles
	)

pure virtual

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

Implemented in AZ::Render::ReflectionProbeFeatureProcessor.

◆ FindReflectionProbes() [2/2]

virtual void AZ::Render::ReflectionProbeFeatureProcessorInterface::FindReflectionProbes	(	const AZ::Vector3 &	position,
		ReflectionProbeHandleVector &	reflectionProbeHandles
	)

pure virtual

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

Implemented in AZ::Render::ReflectionProbeFeatureProcessor.

◆ GetInnerObbWs()

virtual AZ::Obb AZ::Render::ReflectionProbeFeatureProcessorInterface::GetInnerObbWs ( const ReflectionProbeHandle & handle ) const

pure virtual

Retrieve inner OBB.

Implemented in AZ::Render::ReflectionProbeFeatureProcessor.

◆ GetOuterObbWs()

virtual AZ::Obb AZ::Render::ReflectionProbeFeatureProcessorInterface::GetOuterObbWs ( const ReflectionProbeHandle & handle ) const

pure virtual

Retrieve outer OBB.

Implemented in AZ::Render::ReflectionProbeFeatureProcessor.

◆ GetUseParallaxCorrection()

virtual bool AZ::Render::ReflectionProbeFeatureProcessorInterface::GetUseParallaxCorrection ( const ReflectionProbeHandle & handle ) const

pure virtual

Retrieve parallax correction setting.

Implemented in AZ::Render::ReflectionProbeFeatureProcessor.

◆ IsCubeMapReferenced()

virtual bool AZ::Render::ReflectionProbeFeatureProcessorInterface::IsCubeMapReferenced ( const AZStd::string & relativePath )

pure virtual

Check to see if a cubemap is referenced by any reflection probes.

Implemented in AZ::Render::ReflectionProbeFeatureProcessor.

◆ IsValidHandle()

virtual bool AZ::Render::ReflectionProbeFeatureProcessorInterface::IsValidHandle ( const ReflectionProbeHandle & handle ) const

pure virtual

Check to see if a reflection probe handle is valid.

Implemented in AZ::Render::ReflectionProbeFeatureProcessor.

◆ RemoveReflectionProbe()

virtual void AZ::Render::ReflectionProbeFeatureProcessorInterface::RemoveReflectionProbe ( ReflectionProbeHandle & handle )

pure virtual

Remove an existing reflection probe.

Implemented in AZ::Render::ReflectionProbeFeatureProcessor.

◆ SetBakeExposure()

virtual void AZ::Render::ReflectionProbeFeatureProcessorInterface::SetBakeExposure	(	const ReflectionProbeHandle &	handle,
		float	bakeExposure
	)

pure virtual

Set or retrieve bake exposure.

Implemented in AZ::Render::ReflectionProbeFeatureProcessor.

◆ SetCubeMap()

virtual void AZ::Render::ReflectionProbeFeatureProcessorInterface::SetCubeMap	(	const ReflectionProbeHandle &	handle,
		Data::Instance< RPI::Image > &	cubeMapImage,
		const AZStd::string &	relativePath
	)

pure virtual

Set or retrieve cubemap.

Implemented in AZ::Render::ReflectionProbeFeatureProcessor.

◆ SetInnerExtents()

virtual void AZ::Render::ReflectionProbeFeatureProcessorInterface::SetInnerExtents	(	const ReflectionProbeHandle &	handle,
		const AZ::Vector3 &	innerExtents
	)

pure virtual

Set or retrieve inner extents.

Implemented in AZ::Render::ReflectionProbeFeatureProcessor.

◆ SetOuterExtents()

virtual void AZ::Render::ReflectionProbeFeatureProcessorInterface::SetOuterExtents	(	const ReflectionProbeHandle &	handle,
		const AZ::Vector3 &	outerExtents
	)

pure virtual

Set or retrieve outer extents.

Implemented in AZ::Render::ReflectionProbeFeatureProcessor.

◆ SetRenderExposure()

virtual void AZ::Render::ReflectionProbeFeatureProcessorInterface::SetRenderExposure	(	const ReflectionProbeHandle &	handle,
		float	renderExposure
	)

pure virtual

Set or retrieve render exposure.

Implemented in AZ::Render::ReflectionProbeFeatureProcessor.

◆ SetTransform()

virtual void AZ::Render::ReflectionProbeFeatureProcessorInterface::SetTransform	(	const ReflectionProbeHandle &	handle,
		const AZ::Transform &	transform
	)

pure virtual

Set or retrieve transform.

Implemented in AZ::Render::ReflectionProbeFeatureProcessor.

◆ ShowVisualization()

virtual void AZ::Render::ReflectionProbeFeatureProcessorInterface::ShowVisualization	(	const ReflectionProbeHandle &	handle,
		bool	showVisualization
	)

pure virtual

Show or Hide visualization sphere.

Implemented in AZ::Render::ReflectionProbeFeatureProcessor.

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

Gems/Atom/Feature/Common/Code/Include/Atom/Feature/ReflectionProbe/ReflectionProbeFeatureProcessorInterface.h

Public Member Functions

Additional Inherited Members

Detailed Description

Member Function Documentation

◆ AddReflectionProbe()

◆ Bake()

◆ CheckCubeMapAssetNotification()

◆ FindReflectionProbes() [1/2]

◆ FindReflectionProbes() [2/2]

◆ GetInnerObbWs()

◆ GetOuterObbWs()

◆ GetUseParallaxCorrection()

◆ IsCubeMapReferenced()

◆ IsValidHandle()

◆ RemoveReflectionProbe()

◆ SetBakeExposure()

◆ SetCubeMap()

◆ SetInnerExtents()

◆ SetOuterExtents()

◆ SetRenderExposure()

◆ SetTransform()

◆ ShowVisualization()