ConnectionViz.h

Go to the documentation of this file.

#ifndef CONNECTIONVIZ_H
#define CONNECTIONVIZ_H

#include <vrecko/Ability.h>
#include <osg/Group>
#include <osg/ShapeDrawable>
#include <helpers/DynamicArray.h>

using namespace vrecko;

namespace APObjectUtils
{
    // Flags for ConnectionViz::Connection::dwFlags and ConnectionViz::createConnection() method
    #define CVC_F_DEFAULT           0x00000001
        // Signalizes a default connection


    class ConnectionViz: public Ability {
    public:
        ConnectionViz();
        virtual ~ConnectionViz();

        virtual void preInitialize();
        virtual void postInitialize();
        virtual bool loadXMLParameters(XERCES_CPP_NAMESPACE_QUALIFIER DOMNode *pParametersNode);
        virtual void update();
        virtual void clean();

    protected:
        EnvironmentObject *owner;

        bool bOnlyOutput; // show only output connetions
        bool bColorize; // use nice(?) colors to display the connections

        class Connection {
        public:
            Ability *ability;

            enum ConnectionType { Input, Output, InputRequest, OutputRequest };
            ConnectionType type;

            unsigned long dwFlags; // a combination of CVC_F_*

            std::string pinName; // name of the output/input/request pin

            bool bUsedInUpdate; // auxiliary variable used when updating

            osg::ref_ptr<osg::Cone> shapeCone;
            osg::ref_ptr<osg::ShapeDrawable> shapeDraw;
        };

        osg::ref_ptr<EnvironmentObject> graphicObject;
        osg::ref_ptr<osg::Geode> osgGeode;

        DynamicArray<Connection> cons;
        /* Creates the specified connection and returns its index (to the [cons] array).
            It will return -1 in the case of an error.
            May reuese some of the unused connection, which has [bUsedInUpdate] set to false.
            The [bUsedInUpdate] will be set to true in this method for the returned connection.
            [dwFlags] is a combination of CVC_F_* */
        int createConnection(Connection::ConnectionType cType, const char *sender, const char *receiver, unsigned int dwFlags);
        void deleteConnection(int iIndex);

        /* Creates the main objects if not created before. */
        bool createMainObject();
    };

}


#endif