OgreHapticsDebugRenderer.h

Go to the documentation of this file.

/*
This source file is part of OgreHaptics
 (a library for wrapping haptics devices for use with the open-source
 graphics engine OGRE, http://www.ogre3d.org)

Copyright (c) 2006 - 2008 Jorrit de Vries
Also see acknowledgements in Readme.html

This library is free software; you can redistribute it and/or
modify it under the terms of the GNU Lesser General Public License
as published by the Free Software Foundation; either version 2.1
of the License, or (at your option) any later version.

This library is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
GNU Lesser General Public License for more details.

You should have received a copy of the GNU Lesser General Public
License along with this library; if not, write to the
Free Software Foundation, Inc.,
59 Temple Place, Suite 330, Boston, MA 02111-1307 USA 
*/
#ifndef _OgreHapticsDebugRenderer_H__
#define _OgreHapticsDebugRenderer_H__

#include "OgreHapticsPrerequisites.h"

namespace OgreHaptics {
    
    enum DebugRenderMode
    {
        DRM_TOUCH_WORKSPACE = 0x01,
        DRM_STYLUS = 0x02
    };

    class _OgreHapticsExport DebugRenderer : public MovableObject,
        public Renderable
    {
    public:
        DebugRenderer(SceneManager* sceneMgr, int renderMode = 0);
        virtual ~DebugRenderer();

        void setRenderMode(int mode) { mRenderMode = mode; }
        void setTouchWorkspaceDisplayEnabled(bool enable);
        void setStylusDisplayEnabled(bool enable);

        bool isTouchWorkspaceDisplayEnabled(void) const;
        bool isStylusDisplayEnabled(void) const;

        void addLine(const Vector3& start, const Vector3& end,
            const ColourValue& colour = ColourValue::White);
        void addLine(Real startX, Real startY, Real startZ, Real endX,
            Real endY, Real endZ, const ColourValue& colour = 
            ColourValue::White);
        void addPoint(const Vector3& point, const ColourValue& colour =
            ColourValue::White);
        void addPoint(Real x, Real y, Real z, const ColourValue& colour =
            ColourValue::White);

        void clear(void);
        void draw(void);

        Real getBoundingRadius(void) const;
        const String& getMovableType(void) const;
        const AxisAlignedBox& getBoundingBox(void) const;
        void _updateRenderQueue(RenderQueue* queue);
        void visitRenderables(Renderable::Visitor* visitor, 
            bool debugRenderables = false);

        const MaterialPtr& getMaterial(void) const;
        void getRenderOperation(RenderOperation& op);
        void getWorldTransforms(Matrix4* xform) const;
        Real getSquaredViewDepth(const Camera* cam) const;
        const LightList& getLights(void) const;
    protected:
        SceneManager* mSceneMgr;
        SceneNode* mSceneNode;
        bool mIsDrawn;
        int mRenderMode;
        RenderOperation mRenderOperation;
        MaterialPtr mMaterial;
        AxisAlignedBox mAABB;
        std::vector<std::pair<Vector3, ColourValue>> mPoints;

        void addTouchWorkspace(Device* device);
        void addStylus(Device* device);
    };

}

#endif

---

Last modified Tue Jan 6 22:31:25 2009