Open 3D Engine Atom 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 Types | Public Member Functions | Static Public Member Functions | List of all members
AZ::Render::OcclusionCullingPlaneFeatureProcessor Class Referencefinal

This class manages OcclusionCullingPlanes which are used to cull meshes that are inside the view frustum. More...

#include <OcclusionCullingPlaneFeatureProcessor.h>

Inherits AZ::Render::OcclusionCullingPlaneFeatureProcessorInterface.

Public Types

using OcclusionCullingPlaneVector = AZStd::vector< AZStd::shared_ptr< OcclusionCullingPlane > >
 

Public Member Functions

 AZ_RTTI (AZ::Render::OcclusionCullingPlaneFeatureProcessor, "{C3DE91D7-EF7A-4A82-A55F-E22BC52074EA}", AZ::Render::OcclusionCullingPlaneFeatureProcessorInterface)
 
OcclusionCullingPlaneHandle AddOcclusionCullingPlane (const AZ::Transform &transform) override
 
void RemoveOcclusionCullingPlane (OcclusionCullingPlaneHandle &handle) override
 
bool IsValidOcclusionCullingPlaneHandle (const OcclusionCullingPlaneHandle &occlusionCullingPlane) const override
 
void SetTransform (const OcclusionCullingPlaneHandle &occlusionCullingPlane, const AZ::Transform &transform) override
 
void SetEnabled (const OcclusionCullingPlaneHandle &occlusionCullingPlane, bool enable) override
 
void ShowVisualization (const OcclusionCullingPlaneHandle &occlusionCullingPlane, bool showVisualization) override
 
void SetTransparentVisualization (const OcclusionCullingPlaneHandle &occlusionCullingPlane, bool transparentVisualization) override
 
void Activate () override
 Perform any necessary activation and gives access to owning Scene.
 
void Deactivate () override
 Perform any necessary deactivation.
 
void OnBeginPrepareRender () override
 
OcclusionCullingPlaneVector & GetOcclusionCullingPlanes ()
 
- Public Member Functions inherited from AZ::Render::OcclusionCullingPlaneFeatureProcessorInterface
 AZ_RTTI (AZ::Render::OcclusionCullingPlaneFeatureProcessorInterface, "{50F6B45E-A622-44EC-B962-DE25FBD44095}", AZ::RPI::FeatureProcessor)
 
virtual OcclusionCullingPlaneHandle AddOcclusionCullingPlane (const AZ::Transform &transform)=0
 
virtual void RemoveOcclusionCullingPlane (OcclusionCullingPlaneHandle &handle)=0
 
virtual bool IsValidOcclusionCullingPlaneHandle (const OcclusionCullingPlaneHandle &occlusionCullingPlane) const =0
 
virtual void SetTransform (const OcclusionCullingPlaneHandle &occlusionCullingPlane, const AZ::Transform &transform)=0
 
virtual void SetEnabled (const OcclusionCullingPlaneHandle &occlusionCullingPlane, bool enabled)=0
 
virtual void ShowVisualization (const OcclusionCullingPlaneHandle &occlusionCullingPlane, bool showVisualization)=0
 
virtual void SetTransparentVisualization (const OcclusionCullingPlaneHandle &occlusionCullingPlane, bool transparentVisualization)=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 ()
 

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 ()
 

Detailed Description

This class manages OcclusionCullingPlanes which are used to cull meshes that are inside the view frustum.

Member Function Documentation

◆ Activate()

void AZ::Render::OcclusionCullingPlaneFeatureProcessor::Activate ( )
overridevirtual

Perform any necessary activation and gives access to owning Scene.

Reimplemented from AZ::RPI::FeatureProcessor.

◆ AddOcclusionCullingPlane()

OcclusionCullingPlaneHandle AZ::Render::OcclusionCullingPlaneFeatureProcessor::AddOcclusionCullingPlane ( const AZ::Transform &  transform)
overridevirtual

Implements AZ::Render::OcclusionCullingPlaneFeatureProcessorInterface.

◆ Deactivate()

void AZ::Render::OcclusionCullingPlaneFeatureProcessor::Deactivate ( )
overridevirtual

Perform any necessary deactivation.

Reimplemented from AZ::RPI::FeatureProcessor.

◆ IsValidOcclusionCullingPlaneHandle()

bool AZ::Render::OcclusionCullingPlaneFeatureProcessor::IsValidOcclusionCullingPlaneHandle ( const OcclusionCullingPlaneHandle &  occlusionCullingPlane) const
inlineoverridevirtual

Implements AZ::Render::OcclusionCullingPlaneFeatureProcessorInterface.

◆ RemoveOcclusionCullingPlane()

void AZ::Render::OcclusionCullingPlaneFeatureProcessor::RemoveOcclusionCullingPlane ( OcclusionCullingPlaneHandle &  handle)
overridevirtual

Implements AZ::Render::OcclusionCullingPlaneFeatureProcessorInterface.

◆ SetEnabled()

void AZ::Render::OcclusionCullingPlaneFeatureProcessor::SetEnabled ( const OcclusionCullingPlaneHandle &  occlusionCullingPlane,
bool  enable 
)
overridevirtual

Implements AZ::Render::OcclusionCullingPlaneFeatureProcessorInterface.

◆ SetTransform()

void AZ::Render::OcclusionCullingPlaneFeatureProcessor::SetTransform ( const OcclusionCullingPlaneHandle &  occlusionCullingPlane,
const AZ::Transform &  transform 
)
overridevirtual

Implements AZ::Render::OcclusionCullingPlaneFeatureProcessorInterface.

◆ SetTransparentVisualization()

void AZ::Render::OcclusionCullingPlaneFeatureProcessor::SetTransparentVisualization ( const OcclusionCullingPlaneHandle &  occlusionCullingPlane,
bool  transparentVisualization 
)
overridevirtual

Implements AZ::Render::OcclusionCullingPlaneFeatureProcessorInterface.

◆ ShowVisualization()

void AZ::Render::OcclusionCullingPlaneFeatureProcessor::ShowVisualization ( const OcclusionCullingPlaneHandle &  occlusionCullingPlane,
bool  showVisualization 
)
overridevirtual

Implements AZ::Render::OcclusionCullingPlaneFeatureProcessorInterface.

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