Detailed Description

Member Function Documentation

virtual void iBugPlug::AddCounter

(

const char *

countername,

int

amount = 1

)

[pure virtual]

Add an amount to a counter.

Bugplug will automatically clear this counter every frame and show the last number, the average, the number of frames, and the total for every known counter. You don't have to specficially register a counter. Just by using this function BugPlug will know about the counter.

virtual void iBugPlug::AddCounterEnum

(

const char *

countername,

int

enumval,

int

amount = 1

)

[pure virtual]

Add an amount to a enum-counter.

This is similar to a regular counter except that BugPlug will keep track of how many times every particular value is encountered. Enum-counters are displayed differently. BugPlug will automatically convert a counter to an enum-counter if you use this function on an existing counter and vice versa. BugPlug currently only supports enum values between 0 and 9.

Add some rendering code that will be rendered right before the points and lines are rendered.

If 0 the current object will be removed.

virtual bool iBugPlug::ExecCommand

(

const char *

command

)

[pure virtual]

Execute a bugplug command.

The commands are the same ones you can specify in the bugplug.key file.

Parameters:

command

Command to execute.

Returns:

Whether the command was executed successfully.

virtual void iBugPlug::RemoveCounter

(

const char *

countername

)

[pure virtual]

Remove a counter.

From this point on BugPlug will no longer show this counter (BugPlug will remove the counter internally).

virtual void iBugPlug::ResetCounter

(

const char *

countername,

int

value = 0

)

[pure virtual]

Reset some counter manually.

Normally BugPlug will reset counters every frame but you can also reset it manually. If you reset an enum-counter all enum types are reset at once.

virtual void iBugPlug::SetupDebugSector

(

)

[pure virtual]

Setup the 'debug sector'.

The debug sector is a sector which you can fill with boxes and other objects. BugPlug can then switch the view to that sector so that the objects are rendered. This can be useful for debugging complicated systems in a graphical manner. This function will clear any previously created debug sector.

virtual void iBugPlug::SetupDebugView

(

)

[pure virtual]

Setup the 'debug 2dview'.

To this view a plugin or application can add various 2D objects (lines and points for example). This function will clear any previously created debug view.