Kaim::VisualDebugAttributeGroup Class Reference

Kaim::VisualDebugAttributeGroup Class Reference

#include <visualdebugattributes.h>

Class Description

A group of Key / valuetype / arrayof values, where the keys and types are created once, and values updated whenever.

Usage:

  1. Create an enum describing all your items. It will allow you to access your stat in O(1).
  2. Create each item corresponding to each element of your enum, in your enum order.
  3. Update your item value(s) accessing the item with your enum.

Public Member Functions

VisualDebugAttribute * CreateFloatAttribute (const char *name, KyUInt32 statValueEnum, KyUInt32 valueCount=1, VisualDebugAttributeHeader *header=0)
 
bool IsDescriptionSent ()
 
void SendGroupDescription (VisualDebugServer *visualDebugServer)
 
void SendGroupValues (VisualDebugServer *visualDebugServer)
 
void UpdateStringValue (KyUInt32 valEnum, const char *val)
 

Member Function Documentation

VisualDebugAttribute* Kaim::VisualDebugAttributeGroup::CreateFloatAttribute ( const char *  name,
KyUInt32  statValueEnum,
KyUInt32  valueCount = 1,
VisualDebugAttributeHeader *  header = 0 
)

Call these to build your stat group.

bool Kaim::VisualDebugAttributeGroup::IsDescriptionSent ( )
inline

The decription must be sent only once on creation or on reconnection.

void Kaim::VisualDebugAttributeGroup::SendGroupDescription ( VisualDebugServer visualDebugServer)

Send the group description (items' names, types, headers)

void Kaim::VisualDebugAttributeGroup::SendGroupValues ( VisualDebugServer visualDebugServer)

Send the group values (items' values only)

void Kaim::VisualDebugAttributeGroup::UpdateStringValue ( KyUInt32  valEnum,
const char *  val 
)

Call this to update your stat group.


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