querydisplaylistbuilder.h

Go to the documentation of this file.

/*
* Copyright 2016 Autodesk, Inc. All rights reserved.
* Use of this software is subject to the terms of the Autodesk license agreement and any attachments or Appendices thereto provided at the time of installation or download,
* or which otherwise accompanies this software in either electronic or hard copy form, or which is signed by you and accepted by Autodesk.
*/

#pragma once

#include "gwnavruntime/visualsystem/displaylist.h"
#include "gwnavruntime/queries/blobs/querydynamicoutputdisplaylistbuilder.h"

namespace Kaim
{

// Utility base class that helps implementing IDisplayListBuilder for Queries in a consistent way by sharing code and conventions
template<typename TQuery, typename TOutput, typename TSelf>
class QueryDisplayListBuilder : public IDisplayListBuilder
{
public:
    QueryDisplayListBuilder() { Clear(); }

    Color NotProcessedColor() { return Color::Orange; }

protected:
    const TQuery* m_query;
    TOutput* m_output;
    DisplayList* m_displayList;

protected:
    // DoXXX are to be implemented in TSelf
    void PushQueryShape(Color color)    {        static_cast<TSelf*>(this)->DoPushQueryShape(color); }
    const Vec3f& GetStartPos()                { return static_cast<TSelf*>(this)->DoGetStartPos(); }
    void PushStartTriangle(Color color) { return static_cast<TSelf*>(this)->DoPushStartTriangle(color); }
    void PushShapeToArrival(Color color){ return static_cast<TSelf*>(this)->DoPushShapeToArrival(color); }

    // DoXXX defined here are use by default when DoXXX are not defined in TSelf
    const Vec3f& DoGetStartPos()
    {
        return m_query->m_startPos3f;
    }

    void DoPushStartTriangle(Color color)
    {
        m_displayList->PushTriangle(m_output->m_startTriangle.m_triangle.OffsetZ(0.1f), color);
    }




protected:
    void Clear()
    {
        m_query  = nullptr;
        m_output = nullptr;
        m_displayList = nullptr;
    }

    bool Init(DisplayList* displayList, char* blob)
    {
        m_query = (TQuery*)blob;
        m_output = (TOutput*)m_query->m_queryOutput.Ptr();
        m_displayList = displayList;
        return m_output != nullptr;
    }

    void PushStartText(Color color, const char* text)
    {
        m_displayList->PushText(GetStartPos().OffsetZ(1.0f), color, text);
    }

    void PushDestText(Color color, const char* text)
    {
        m_displayList->PushText(m_query->m_destPos3f.OffsetZ(1.0f), color, text);
    }

    void PushArrivalTriangle(Color color)
    {
        m_displayList->PushTriangle(m_output->m_arrivalTriangle.m_triangle.OffsetZ(0.1f), color);
    }

    void PushDestTriangle(Color color)
    {
        m_displayList->PushTriangle(m_output->m_destTriangle.m_triangle.OffsetZ(0.1f), color);
    }

    void PushCollisionPoint(Color color, const char* text)
    {
        m_displayList->PushVerticalTriangleCrossInv(m_output->m_collisionPos3f, 1.0f, 0.25f, color);
        m_displayList->PushText(m_output->m_collisionPos3f.OffsetZ(1.0f), color, text);
    }

    void PushDynamicOutput()
    {
        QueryDynamicOutputBlob* dynOutput = m_output->m_queryDynamicOutputBlobRef.Ptr();
        if (dynOutput != nullptr)
            QueryDynamicOutputDisplayListBuilder().Build(m_displayList, (char*)dynOutput, 0);
    }

    void PushStartError(const char* text)
    {
        PushQueryShape(Color::Red);
        PushStartText(Color::Red, text);
    }

    void Push_NOT_PROCESSED()
    {
        PushStartText(Color::Orange, "Not processed...");
        PushQueryShape(Color::Orange);
    }

    void Push_PROCESSING(const char* text)
    {
        PushStartText(Color::Orange, text);
        PushQueryShape(Color::Orange);
    }

    void Push_START_OUTSIDE()
    {
        PushStartText(Color::Red, "Start outside!");
        PushQueryShape(Color::Red);
    }

    void Push_DEST_OUTSIDE()
    {
        PushStartText(Color::Red, "Destination outside!");
        PushQueryShape(Color::Red);
    }

    void Push_START_NAVTAG_FORBIDDEN()
    {
        PushStartTriangle(Color::Red);
        PushStartText(Color::Red, "Start NavTag forbidden!");
        PushQueryShape(Color::Red);
    }

    void Push_DEST_NAVTAG_FORBIDDEN()
    {
        PushDestTriangle(Color::Red);
        PushDestText(Color::Red, "Destination NavTag forbidden!");
        PushQueryShape(Color::Red);
    }

    void Push_COLLISION_DETECTED()
    {
        PushStartTriangle(Color::Green);
        PushQueryShape(Color::Red);
    }

    void Push_ARRIVAL_WRONG_FLOOR()
    {
        PushStartTriangle(Color::Green);
        PushDestText(Color::Red, "Arrival in wrong floor!");
        PushQueryShape(Color::Red);
    }

    void Push_LACK_OF_WORKING_MEMORY()
    {
        PushStartTriangle(Color::Green);
        PushStartText(Color::Red, "Lack of working memory!");
        PushQueryShape(Color::Red);
    }

    void Push_UNKNOWN_ERROR()
    {
        PushStartText(Color::Red, "Unknown error!");
        PushQueryShape(Color::Red);
    }

    void Push_SUCCESS()
    {
        PushStartTriangle(Color::Green);
        PushDestTriangle(Color::Green);
        PushQueryShape(Color::Green);
    }

    void Push_CANNOT_MOVE()
    {
        PushStartTriangle(Color::Green);
        PushCollisionPoint(Color::Orange, "Collision point (cannot move)");
        PushQueryShape(Color::Orange);
    }

    void Push_ARRIVAL_ERROR()
    {
        PushStartTriangle(Color::Green);
        PushCollisionPoint(Color::Red, "Collision point (arrival error)");
        PushQueryShape(Color::Red);
    }

    void Push_MAXDIST_REACHED()
    {
        PushStartTriangle(Color::Green);
        PushArrivalTriangle(Color::Green);
        PushShapeToArrival(Color::Green);
    }

    void Push_COLLISION()
    {
        PushStartTriangle(Color::Green);
        PushArrivalTriangle(Color::Green);
        PushCollisionPoint(Color::Orange, "Collision");
        PushShapeToArrival(Color::Green);
    }
};

}