GuiAtlasMonitorCtrl Class Reference

#include <guiAtlasMonitorCtrl.h>

Inheritance diagram for GuiAtlasMonitorCtrl:

Detailed Description

A utility widget that displays what's going on inside of Atlas.

To use it, just drag it onto your GUI and it will connect to the first Atlas instance it finds on the server connection. The control will monitor all geometry and texture TOCs contained in the Atlas file connected to the Atlas instance.

Please be aware that monitoring is not without its quirks. Sampling a system means interacting with a system. Also, since the GUI runs within the same frame loop as Atlas, you will always see a snapshot of a certain fixed point in Atlas's operation. This is important to keep in mind when evaluating the results of monitoring.

Note:: This control is agnostic as to the type of terrain used (blended or unique).

Public Member Functions

DECLARE_CONOBJECT (GuiAtlasMonitorCtrl)

virtual ~GuiAtlasMonitorCtrl ()

virtual bool onAdd ()

Called when this object is added to the scene.

virtual void onRemove ()

Called when this object is removed.

virtual bool onWake ()

Called when this object is asked to wake up returns true if it's actually awake at the end.

virtual void onSleep ()

Called when this object is asked to sleep.

virtual void onRender (Point2I offset, const RectI &updateRect)

Called when this control is to render itself.

Protected Types

STAT_NumRequests

STAT_BytesPending

STAT_BytesLoading

STAT_LoadPending

STAT_UnpackPending

STAT_InstatePending

STAT_NumRequestsDOA

NUM_STATS

TOC_Geometry

TOC_Texture

enum EStat {
  STAT_NumRequests,
  STAT_BytesPending,
  STAT_BytesLoading,
  STAT_LoadPending,
  STAT_UnpackPending,
  STAT_InstatePending,
  STAT_NumRequestsDOA,
  NUM_STATS
}

Enumeration of different stats that we can display. More...

enum ETOCType {
  TOC_Geometry,
  TOC_Texture
}

Protected Member Functions

void cleanup ()

void initialize ()

void initTOCMonitors ()

void freeTOCMonitors ()

void renderStats (Point2I offset, Point2I extent)

void getStat (EStat stat, char *buffer, U32 bufferSize)

Protected Attributes

SimObjectPtr< AtlasInstance > mAtlasInstance

The Atlas instance we are monitoring.

Vector< TOCMonitor > mTOCMonitors

AtlasFile::IOStatus mIOStatus

Private Types

typedef GuiContainer Parent

Classes

struct TOCMonitor

Bookkeeping for a single TOC in the Atlas file we are monitoring. More...

Member Typedef Documentation

typedef GuiContainer GuiAtlasMonitorCtrl::Parent [private]

Reimplemented from GuiContainer.

Member Enumeration Documentation

enum GuiAtlasMonitorCtrl::EStat [protected]

Enumeration of different stats that we can display.

Enumerator:

STAT_NumRequests
STAT_BytesPending
STAT_BytesLoading
STAT_LoadPending
STAT_UnpackPending
STAT_InstatePending
STAT_NumRequestsDOA
NUM_STATS

enum GuiAtlasMonitorCtrl::ETOCType [protected]

Enumerator:

TOC_Geometry
TOC_Texture

Constructor & Destructor Documentation

virtual GuiAtlasMonitorCtrl::~GuiAtlasMonitorCtrl ( ) [inline, virtual]

Member Function Documentation

void GuiAtlasMonitorCtrl::cleanup ( ) [protected]

void GuiAtlasMonitorCtrl::initialize ( ) [protected]

void GuiAtlasMonitorCtrl::initTOCMonitors ( ) [protected]

void GuiAtlasMonitorCtrl::freeTOCMonitors ( ) [protected]

void GuiAtlasMonitorCtrl::renderStats	(	Point2I	offset,
		Point2I	extent
	)			`[protected]`

void GuiAtlasMonitorCtrl::getStat	(	EStat	stat,
		char *	buffer,
		U32	bufferSize
	)			`[protected]`

GuiAtlasMonitorCtrl::DECLARE_CONOBJECT ( GuiAtlasMonitorCtrl )

virtual bool GuiAtlasMonitorCtrl::onAdd ( ) [virtual]

Called when this object is added to the scene.

Reimplemented from GuiControl.

virtual void GuiAtlasMonitorCtrl::onRemove ( ) [virtual]

Called when this object is removed.

Reimplemented from GuiControl.

virtual bool GuiAtlasMonitorCtrl::onWake ( ) [virtual]

Called when this object is asked to wake up returns true if it's actually awake at the end.

Reimplemented from GuiControl.

virtual void GuiAtlasMonitorCtrl::onSleep ( ) [virtual]

Called when this object is asked to sleep.

Reimplemented from GuiControl.

virtual void GuiAtlasMonitorCtrl::onRender	(	Point2I	offset,
		const RectI &	updateRect
	)			`[virtual]`

Called when this control is to render itself.

Parameters:

	offset	The location this control is to begin rendering
	updateRect	The screen area this control has drawing access to

Reimplemented from GuiControl.

Member Data Documentation

SimObjectPtr< AtlasInstance > GuiAtlasMonitorCtrl::mAtlasInstance [protected]

The Atlas instance we are monitoring.

Vector< TOCMonitor > GuiAtlasMonitorCtrl::mTOCMonitors [protected]

AtlasFile::IOStatus GuiAtlasMonitorCtrl::mIOStatus [protected]