VR-Engage  2.2
Loading...
Searching...
No Matches
makVre::DtDebugDrawCommand Class Referenceabstract

Detailed Description

This abstract base class defines the interface for all debug drawing commands. It provides common functionality for handling color, fill mode, clipping, and lifetime management of debug visuals.

#include <debugRenderer.h>

Inheritance diagram for makVre::DtDebugDrawCommand:
[legend]

Public Member Functions

 DtDebugDrawCommand (DtColor color, DtColor::Fill fill, bool clip, const double &time, bool is3D)
 
virtual ~DtDebugDrawCommand ()
 
virtual void draw (DtDebugCanvas &drawList)=0
 
virtual void reduceTime (double delta)
 
virtual bool ended ()
 
virtual bool get3D ()
 

Protected Attributes

DtVector myEyepoint
 
DtColor myColor
 
DtColor::Fill myFill
 
double myTime
 
bool myClip
 
bool my3D
 

Constructor & Destructor Documentation

◆ DtDebugDrawCommand()

makVre::DtDebugDrawCommand::DtDebugDrawCommand ( DtColor color,
DtColor::Fill fill,
bool clip,
const double & time,
bool is3D )
inline

Constructor for debug draw commands.

Parameters
colorColor of the debug visual
fillFill mode (solid, wireframe, etc.)
clipWhether to clip against the view frustum
timeDuration in seconds for this command to remain active
is3DWhether this is a 3D or 2D debug visual

References my3D, myClip, myColor, myFill, and myTime.

◆ ~DtDebugDrawCommand()

virtual makVre::DtDebugDrawCommand::~DtDebugDrawCommand ( )
inlinevirtual

Virtual destructor.

Member Function Documentation

◆ draw()

virtual void makVre::DtDebugDrawCommand::draw ( DtDebugCanvas & drawList)
pure virtual

Pure virtual draw method that must be implemented by derived classes.

Parameters
drawListCanvas to draw the debug visual on

Implemented in makVre::DebugDrawCubeCommand, makVre::DebugDrawGraphCommand, makVre::DebugDrawLineCommand, makVre::DebugDrawSphereCommand, makVre::DebugDrawText2dCommand, makVre::DebugDrawText3dCommand, makVre::DebugDrawTextPanelCommand, and makVre::DebugDrawTrisCommand.

◆ reduceTime()

virtual void makVre::DtDebugDrawCommand::reduceTime ( double delta)
inlinevirtual

Reduces the remaining display time for this command.

Parameters
deltaTime in seconds to subtract from the remaining time

References myTime.

◆ ended()

virtual bool makVre::DtDebugDrawCommand::ended ( )
inlinevirtual

Checks if this command has expired.

Returns
True if the command's display time has elapsed

References myTime.

◆ get3D()

virtual bool makVre::DtDebugDrawCommand::get3D ( )
inlinevirtual

Checks if this is a 3D visual.

Returns
True if this is a 3D visual, false if 2D

References my3D.

Member Data Documentation

◆ myEyepoint

DtVector makVre::DtDebugDrawCommand::myEyepoint
protected

Eye position for view-dependent debug visuals.

◆ myColor

DtColor makVre::DtDebugDrawCommand::myColor
protected

Color of the debug visual.

Referenced by DtDebugDrawCommand().

◆ myFill

DtColor::Fill makVre::DtDebugDrawCommand::myFill
protected

Fill mode for the debug visual.

Referenced by DtDebugDrawCommand().

◆ myTime

double makVre::DtDebugDrawCommand::myTime
protected

Remaining time in seconds for display.

Referenced by DtDebugDrawCommand(), ended(), and reduceTime().

◆ myClip

bool makVre::DtDebugDrawCommand::myClip
protected

Whether to clip against the view frustum.

Referenced by DtDebugDrawCommand().

◆ my3D

bool makVre::DtDebugDrawCommand::my3D
protected

Whether this is a 3D visual.

Referenced by DtDebugDrawCommand(), and get3D().


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