Mirrors/overte-JulianGro
3
0
Fork 0
mirror of https://github.com/JulianGro/overte.git synced 2025-04-11 12:32:32 +02:00
Code Issues Projects Releases Packages Wiki Activity Actions

add doxygen comments to VoxelScriptingInterface

Browse source
This commit is contained in:
Stephen Birarda 2013-09-17 10:54:44 -07:00
parent a45d64a214
commit 75c59c4863
1 changed files with 10 additions and 0 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

10
assignment-client/src/VoxelScriptingInterface.h
View file

@ -13,13 +13,23 @@
#include <VoxelEditPacketSender.h>
/// handles scripting of voxel commands from JS passed to assigned clients
class VoxelScriptingInterface : public QObject {
Q_OBJECT
public:
VoxelEditPacketSender* getVoxelPacketSender() { return &_voxelPacketSender; }
public slots:
/// queues the creation of a voxel which will be sent by calling process on the PacketSender
/// \param x the x-coordinate of the voxel (in VS space)
/// \param y the y-coordinate of the voxel (in VS space)
/// \param z the z-coordinate of the voxel (in VS space)
/// \param scale the scale of the voxel (in VS space)
/// \param red the R value for RGB color of voxel
/// \param green the G value for RGB color of voxel
/// \param blue the B value for RGB color of voxel
void queueVoxelAdd(float x, float y, float z, float scale, uchar red, uchar green, uchar blue);
private:
/// attached VoxelEditPacketSender that handles queuing and sending of packets to VS
VoxelEditPacketSender _voxelPacketSender;
};