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.
Public Member Functions | List of all members
WhiteBox::RenderMeshInterface Class Referenceabstract

#include <WhiteBoxRenderMeshInterface.h>

Inherited by WhiteBox::AtomRenderMesh, and WhiteBox::WhiteBoxNullRenderMesh.

Public Member Functions

 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 generic interface for the White Box Component to communicate with regardless of the rendering backend.

Member Function Documentation

◆ BuildMesh()

virtual void WhiteBox::RenderMeshInterface::BuildMesh ( const WhiteBoxRenderData &  renderData,
const AZ::Transform &  worldFromLocal 
)
pure virtual

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

Implemented in WhiteBox::AtomRenderMesh, and WhiteBox::WhiteBoxNullRenderMesh.

◆ SetVisiblity()

virtual void WhiteBox::RenderMeshInterface::SetVisiblity ( bool  visibility)
pure virtual

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

Implemented in WhiteBox::AtomRenderMesh, and WhiteBox::WhiteBoxNullRenderMesh.

◆ UpdateMaterial()

virtual void WhiteBox::RenderMeshInterface::UpdateMaterial ( const WhiteBoxMaterial &  material)
pure virtual

Update the material of the render mesh.

Implemented in WhiteBox::AtomRenderMesh, and WhiteBox::WhiteBoxNullRenderMesh.

◆ UpdateTransform()

virtual void WhiteBox::RenderMeshInterface::UpdateTransform ( const AZ::Transform &  worldFromLocal)
pure virtual

Update the transform of the render mesh.

Implemented in WhiteBox::AtomRenderMesh, and WhiteBox::WhiteBoxNullRenderMesh.

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