Profiler::ImGuiTreemapImpl Class Reference

Inherits Profiler::ImGuiTreemap.

Public Member Functions
const AZ::Name &	GetName () const override
	Retrieve the Treemap name.
void	SetName (const char *name) override
void	SetName (AZ::Name name) override
void	SetUnitLabel (const char *unitLabel) override
void	AddMask (const char *label, uint32_t mask) override
void	SetRoots (AZStd::vector< TreemapNode > &&roots) override
void	Render (int x, int y, int w, int h) override
void	WeighAndComputeLayout (int w, int h) override
virtual const AZ::Name &	GetName () const =0
	Retrieve the Treemap name.
virtual void	SetName (char const *name)=0
virtual void	SetName (AZ::Name name)=0
virtual void	SetUnitLabel (char const *unitLabel)=0
virtual void	SetRoots (AZStd::vector< TreemapNode > &&roots)=0
virtual void	AddMask (const char *label, uint32_t mask)=0
virtual void	Render (int x, int y, int w, int h)=0
virtual void	WeighAndComputeLayout (int w, int h)=0

Member Function Documentation

AddMask()

void Profiler::ImGuiTreemapImpl::AddMask ( const char *  label, uint32_t  mask  )

overridevirtual

(ADVANCED) Add a UI radio button that renders only nodes possessing a tag that is either 0 or passes the mask

Parameters

label	The UI label used to select this mask
mask	When this mask is active, nodes with a non-zero tag will be included for display if (tag & mask) is non-zero

Implements Profiler::ImGuiTreemap.

GetName()

const AZ::Name & Profiler::ImGuiTreemapImpl::GetName ( ) const

overridevirtual

Retrieve the Treemap name.

Implements Profiler::ImGuiTreemap.

Render()

void Profiler::ImGuiTreemapImpl::Render ( int  x, int  y, int  w, int  h  )

overridevirtual

Submit ImGui directives to draw the treemap

Parameters

x	Horizontal offset
y	Vertical offset
w	UI width
h	UI height

Implements Profiler::ImGuiTreemap.

SetName() [1/2]

void Profiler::ImGuiTreemapImpl::SetName ( AZ::Name  name )

overridevirtual

Set Treemap name

Parameters

name	The name to display in the ImGui titlebar

Implements Profiler::ImGuiTreemap.

SetName() [2/2]

void Profiler::ImGuiTreemapImpl::SetName ( const char *  name )

overridevirtual

Set Treemap name

Parameters

name	The name to display in the ImGui titlebar

Implements Profiler::ImGuiTreemap.

SetRoots()

void Profiler::ImGuiTreemapImpl::SetRoots ( AZStd::vector< TreemapNode > &&  roots )

overridevirtual

Supply the root nodes of the treemap. This is required to supply data to the treemap.

Parameters

roots

A vector of treemap nodes that constitute the top-level nodes in the visualization. Note that the treemap takes ownership of the data. This function may be invoked as often as needed to modify the data the treemap contains.

Implements Profiler::ImGuiTreemap.

SetUnitLabel()

void Profiler::ImGuiTreemapImpl::SetUnitLabel ( const char *  unitLabel )

overridevirtual

Set unit label

Parameters

unitLabel

The unit label (e.g. lbs, square footage, MB, etc.) is shown in tooltips and node descriptions

Implements Profiler::ImGuiTreemap.

WeighAndComputeLayout()

void Profiler::ImGuiTreemapImpl::WeighAndComputeLayout ( int  w, int  h  )

overridevirtual

Weigh entries and perform layout. This occurs automatically on Render but is exposed here if you wish to perform a layout in advance. Note that previously computed scores and the computed layout are cached until entries are modified, added, removed, or the window size is changed.

Parameters

w	UI width
h	UI height

Implements Profiler::ImGuiTreemap.

---

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

• Gems/Profiler/Code/Source/ImGuiTreemapImpl.h