Open 3D Engine WhiteBox 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.
WhiteBox::AtomRenderMesh Class Reference

A concrete implementation of RenderMeshInterface to support Atom rendering for the White Box Tool. More...

#include <WhiteBoxAtomRenderMesh.h>

Inherits WhiteBox::RenderMeshInterface, AZ::Render::MeshHandleStateRequestBus::Handler, and AZ::TickBus::Handler.

Public Member Functions

 AZ_RTTI (AtomRenderMesh, "{1F48D2F5-037C-400B-977C-7C0C9A34B84C}", RenderMeshInterface)
 
 AtomRenderMesh (AZ::EntityId entityId)
 
void BuildMesh (const WhiteBoxRenderData &renderData, const AZ::Transform &worldFromLocal) override
 Take White Box render data and populate the render mesh from it.
 
void UpdateTransform (const AZ::Transform &worldFromLocal) override
 Update the transform of the render mesh.
 
void UpdateMaterial (const WhiteBoxMaterial &material) override
 Update the material of the render mesh.
 
bool IsVisible () const override
 
void SetVisiblity (bool visibility) override
 Set the White Box mesh visible (true) or invisible (false).
 
void OnTick (float deltaTime, AZ::ScriptTimePoint time) override
 
- Public Member Functions inherited from WhiteBox::RenderMeshInterface
 AZ_RTTI (RenderMeshInterface, "{F3ADF2DC-6A40-4943-95BE-6C7E24605BE9}")
 
virtual void BuildMesh (const WhiteBoxRenderData &renderData, const AZ::Transform &worldFromLocal)=0
 Take White Box render data and populate the render mesh from it.
 
virtual void UpdateTransform (const AZ::Transform &worldFromLocal)=0
 Update the transform of the render mesh.
 
virtual void UpdateMaterial (const WhiteBoxMaterial &material)=0
 Update the material of the render mesh.
 
virtual bool IsVisible () const =0
 
virtual void SetVisiblity (bool visibility)=0
 Set the White Box mesh visible (true) or invisible (false).
 

Detailed Description

A concrete implementation of RenderMeshInterface to support Atom rendering for the White Box Tool.

Member Function Documentation

◆ BuildMesh()

void WhiteBox::AtomRenderMesh::BuildMesh ( const WhiteBoxRenderData renderData,
const AZ::Transform &  worldFromLocal 
)
overridevirtual

Take White Box render data and populate the render mesh from it.

Implements WhiteBox::RenderMeshInterface.

◆ IsVisible()

bool WhiteBox::AtomRenderMesh::IsVisible ( ) const
overridevirtual

◆ SetVisiblity()

void WhiteBox::AtomRenderMesh::SetVisiblity ( bool  visibility)
overridevirtual

Set the White Box mesh visible (true) or invisible (false).

Implements WhiteBox::RenderMeshInterface.

◆ UpdateMaterial()

void WhiteBox::AtomRenderMesh::UpdateMaterial ( const WhiteBoxMaterial material)
overridevirtual

Update the material of the render mesh.

Implements WhiteBox::RenderMeshInterface.

◆ UpdateTransform()

void WhiteBox::AtomRenderMesh::UpdateTransform ( const AZ::Transform &  worldFromLocal)
overridevirtual

Update the transform of the render mesh.

Implements WhiteBox::RenderMeshInterface.


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