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

Inherits AtomToolsFramework::EntityPreviewViewportContent, AtomToolsFramework::AtomToolsDocumentNotificationBus::Handler, and AtomToolsFramework::GraphDocumentNotificationBus::Handler.

Public Member Functions

 MaterialCanvasViewportContent (const AZ::Crc32 &toolId, AtomToolsFramework::RenderViewportWidget *widget, AZStd::shared_ptr< AzFramework::EntityContext > entityContext)
 
AZ::EntityId GetObjectEntityId () const override
 Entity ID of the primary object displayed in the viewport.
 
AZ::EntityId GetEnvironmentEntityId () const override
 Entity ID of the environment or stage surrounding the primary object.
 
AZ::EntityId GetPostFxEntityId () const override
 Entity ID of the entity containing or controlling post processing effect components.
 
AZ::EntityId GetShadowCatcherEntityId () const
 
AZ::EntityId GetGridEntityId () const
 
- Public Member Functions inherited from AtomToolsFramework::EntityPreviewViewportContent
 EntityPreviewViewportContent (const AZ::Crc32 &toolId, RenderViewportWidget *widget, AZStd::shared_ptr< AzFramework::EntityContext > entityContext)
 
virtual AZ::Aabb GetObjectLocalBounds () const
 Local bounds of the primary object displayed in the viewport.
 
virtual AZ::Aabb GetObjectWorldBounds () const
 World bounds of the primary object displayed in the viewport.
 
virtual AZ::EntityId GetCameraEntityId () const
 Entity ID of the camera used control perspective and view in the viewport.
 
AZ::Entity * CreateEntity (const AZStd::string &name, const AZStd::vector< AZ::Uuid > &componentTypeIds)
 Create and activate a single entity with the listed components.
 
void DestroyEntity (AZ::Entity *&entity)
 Deactivate and destroy a single entity.
 

Additional Inherited Members

- Protected Member Functions inherited from AtomToolsFramework::EntityPreviewViewportContent
void OnViewportSettingsChanged () override
 
- Protected Attributes inherited from AtomToolsFramework::EntityPreviewViewportContent
const AZ::Crc32 m_toolId = {}
 

Member Function Documentation

◆ GetEnvironmentEntityId()

AZ::EntityId MaterialCanvas::MaterialCanvasViewportContent::GetEnvironmentEntityId ( ) const
overridevirtual

Entity ID of the environment or stage surrounding the primary object.

Reimplemented from AtomToolsFramework::EntityPreviewViewportContent.

◆ GetObjectEntityId()

AZ::EntityId MaterialCanvas::MaterialCanvasViewportContent::GetObjectEntityId ( ) const
overridevirtual

Entity ID of the primary object displayed in the viewport.

Reimplemented from AtomToolsFramework::EntityPreviewViewportContent.

◆ GetPostFxEntityId()

AZ::EntityId MaterialCanvas::MaterialCanvasViewportContent::GetPostFxEntityId ( ) const
overridevirtual

Entity ID of the entity containing or controlling post processing effect components.

Reimplemented from AtomToolsFramework::EntityPreviewViewportContent.


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