Debug Drawer Object. More...
#include <deDebugDrawer.h>
Public Member Functions | |
Constructors and Destructors | |
| deDebugDrawer (deDebugDrawerManager *manager) | |
| Creates a new debug drawer object with the given resource manager. | |
| virtual | ~deDebugDrawer () |
| Cleans up the debug drawer. | |
Management | |
| bool | GetVisible () const |
| Determines if the debug drawer is visible. | |
| bool | GetXRay () const |
| Determines if the debug drawer is rendered in x-ray mode. | |
| void | SetVisible (bool visible) |
| Sets if the debug drawer is visible. | |
| void | SetXRay (bool xray) |
| Sets if the debug drawer is rendered in x-ray mode. | |
Shape Management | |
| int | GetShapeCount () const |
| Retrieves the count of shapes. | |
| deDebugDrawerShape * | GetShapeAt (int index) const |
| Retrieves the shape at the given index. | |
| int | FindShape (deDebugDrawerShape *shape) const |
| Retrieve index of the given shape. | |
| bool | HasShape (deDebugDrawerShape *shape) const |
| Determines if the shape exists. | |
| void | SetShapeAt (int index, deDebugDrawerShape *shape) |
| Sets the shape at the given index. | |
| void | AddShape (deDebugDrawerShape *shape) |
| Adds a collision shape. | |
| void | RemoveShape (deDebugDrawerShape *shape) |
| Removes the collision shape. | |
| void | RemoveShapeFrom (int index) |
| Removes the collision shape at the given index. | |
| void | RemoveAllShapes () |
| Removes all collision shapes. | |
| void | NotifyShapeChangedAt (int index) |
| Notifies that the content of a shape changed. | |
System Peers | |
| deBaseGraphicDebugDrawer * | GetGraphicDebugDrawer () const |
| Retrieves the graphics system peer object. | |
| void | SetGraphicDebugDrawer (deBaseGraphicDebugDrawer *graDebugDrawer) |
| Sets the graphics system peer object. | |
Detailed Description
Debug Drawer Object.
A debug drawer is a helper object useful for debuging various engine modules. The graphic module knows how to render efficiently shapes ontop of a rendered world. Engine modules can register a debug drawer with world objects to display useful informations. Every debug drawer object specifies a series of shapes and visual informations on how to render them. Every engine module can register more than one debug drawer. Debug drawers can be individually set invisible if required.
- Parameters
- There are a couple of parameters that can be set for a debug drawer to define the appearance on screen. The visible flag determines if the debug drawer is rendered at all. The X-Ray flag determines if the shape can be seen through the already rendered geometry or if it is clipped by the depth buffer. The edge and fill color flag determine the color and transparency of the edges and the faces of the shape. By default the edge is set to white fully opaque and the fill is set to white fully transparent.
- Version:
- 1.0
- Date:
- 2008
Constructor & Destructor Documentation
| deDebugDrawer::deDebugDrawer | ( | deDebugDrawerManager * | manager ) |
Creates a new debug drawer object with the given resource manager.
| virtual deDebugDrawer::~deDebugDrawer | ( | ) | [virtual] |
Cleans up the debug drawer.
Member Function Documentation
| void deDebugDrawer::AddShape | ( | deDebugDrawerShape * | shape ) |
Adds a collision shape.
| int deDebugDrawer::FindShape | ( | deDebugDrawerShape * | shape ) | const |
Retrieve index of the given shape.
| deBaseGraphicDebugDrawer* deDebugDrawer::GetGraphicDebugDrawer | ( | ) | const [inline] |
Retrieves the graphics system peer object.
| deDebugDrawerShape* deDebugDrawer::GetShapeAt | ( | int | index ) | const |
Retrieves the shape at the given index.
| int deDebugDrawer::GetShapeCount | ( | ) | const [inline] |
Retrieves the count of shapes.
| bool deDebugDrawer::GetVisible | ( | ) | const [inline] |
Determines if the debug drawer is visible.
| bool deDebugDrawer::GetXRay | ( | ) | const [inline] |
Determines if the debug drawer is rendered in x-ray mode.
| bool deDebugDrawer::HasShape | ( | deDebugDrawerShape * | shape ) | const |
Determines if the shape exists.
| void deDebugDrawer::NotifyShapeChangedAt | ( | int | index ) |
Notifies that the content of a shape changed.
| void deDebugDrawer::RemoveAllShapes | ( | ) |
Removes all collision shapes.
| void deDebugDrawer::RemoveShape | ( | deDebugDrawerShape * | shape ) |
Removes the collision shape.
| void deDebugDrawer::RemoveShapeFrom | ( | int | index ) |
Removes the collision shape at the given index.
| void deDebugDrawer::SetGraphicDebugDrawer | ( | deBaseGraphicDebugDrawer * | graDebugDrawer ) |
Sets the graphics system peer object.
| void deDebugDrawer::SetShapeAt | ( | int | index, |
| deDebugDrawerShape * | shape | ||
| ) |
Sets the shape at the given index.
| void deDebugDrawer::SetVisible | ( | bool | visible ) |
Sets if the debug drawer is visible.
| void deDebugDrawer::SetXRay | ( | bool | xray ) |
Sets if the debug drawer is rendered in x-ray mode.
The documentation for this class was generated from the following file:
