iBugPlug Struct Reference
Using this interface you can communicate with the BugPlug plugin. More...
#include <bugplug.h>
Inheritance diagram for iBugPlug:

Public Methods | |
virtual void | SetupDebugSector ()=0 |
Setup the 'debug sector'. | |
virtual void | DebugSectorBox (const csBox3 &box, float r, float g, float b, const char *name=0, iMeshObject *mesh=0)=0 |
Add a colored filled box to the debug sector. | |
virtual void | DebugSectorTriangle (const csVector3 &s1, const csVector3 &s2, const csVector3 &s3, float r, float g, float b)=0 |
Add a transparent filled triangle to the debug sector. | |
virtual void | SwitchDebugSector (const csReversibleTransform &trans)=0 |
Switch BugPlug view to the debug sector. | |
virtual bool | CheckDebugSector () const=0 |
Returns true if the debug sector is currently visible. | |
virtual void | SetupDebugView ()=0 |
Setup the 'debug 2dview'. | |
virtual int | DebugViewPoint (const csVector2 &point)=0 |
Add a dragable point. | |
virtual void | DebugViewLine (int i1, int i2)=0 |
Add a line. | |
virtual void | DebugViewBox (int i1, int i2)=0 |
Add a box. | |
virtual int | DebugViewPointCount () const=0 |
Return the current number of points. | |
virtual const csVector2 & | DebugViewGetPoint (int i) const=0 |
Return a point. | |
virtual int | DebugViewLineCount () const=0 |
Return the current number of lines. | |
virtual void | DebugViewGetLine (int i, int &i1, int &i2) const=0 |
Return a line. | |
virtual int | DebugViewBoxCount () const=0 |
Return the current number of boxes. | |
virtual void | DebugViewGetBox (int i, int &i1, int &i2) const=0 |
Return a box. | |
virtual void | DebugViewRenderObject (iBugPlugRenderObject *obj)=0 |
Add some rendering code that will be rendered right before the points and lines are rendered. | |
virtual void | DebugViewClearScreen (bool cs)=0 |
Indicate if BugPlug should clear the screen before rendering the debug view. | |
virtual void | SwitchDebugView ()=0 |
Switch BugPlug view to the debug view. | |
virtual bool | CheckDebugView () const=0 |
Returns true if the debug view is currently visible. | |
virtual void | AddCounter (const char *countername, int amount=1)=0 |
Add an amount to a counter. | |
virtual void | AddCounterEnum (const char *countername, int enumval, int amount=1)=0 |
Add an amount to a enum-counter. | |
virtual void | ResetCounter (const char *countername, int value=0)=0 |
Reset some counter manually. | |
virtual void | RemoveCounter (const char *countername)=0 |
Remove a counter. |
Detailed Description
Using this interface you can communicate with the BugPlug plugin.This can be useful for specialized debugging operations.
Definition at line 51 of file bugplug.h.
Member Function Documentation
|
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. |
|
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. |
|
Returns true if the debug sector is currently visible.
|
|
Returns true if the debug view is currently visible.
|
|
Add a colored filled box to the debug sector. If name is not 0 it will be shown in BugPlug when the mouse is over the object. If iMeshObject* is not 0 it will be shown inside the box when the mouse is over the object. |
|
Add a transparent filled triangle to the debug sector. The color will be max at s1 and completely black at s2 and s3. |
|
Add a box. The two indices are as returned from DebugViewPoint(). |
|
Return the current number of boxes.
|
|
Indicate if BugPlug should clear the screen before rendering the debug view. True by default. |
|
Return a box.
|
|
Return a line.
|
|
Return a point.
|
|
Add a line. The two indices are as returned from DebugViewPoint(). |
|
Return the current number of lines.
|
|
Add a dragable point. Returns an index that can be used in a line. |
|
Return the current number of points.
|
|
Add some rendering code that will be rendered right before the points and lines are rendered. If 0 the current object will be removed. |
|
Remove a counter. From this point on BugPlug will no longer show this counter (BugPlug will remove the counter internally). |
|
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. |
|
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. |
|
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. |
|
Switch BugPlug view to the debug sector. The given transform is given to the camera. |
|
Switch BugPlug view to the debug view.
|
The documentation for this struct was generated from the following file:
- ivaria/bugplug.h
Generated for Crystal Space by doxygen 1.2.18