ivisualgeometry.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/kernel/SF_RefCount.h"
#include "gwnavruntime/base/memory.h"
#include "gwnavruntime/basesystem/coordsystem.h"
#include "gwnavruntime/visualsystem/color.h"

namespace Kaim
{

class VisualTriangle
{
public:
    VisualTriangle() {}
    VisualTriangle(const Vec3f& A_, const Vec3f& B_, const Vec3f& C_, Color color) : A(A_), B(B_), C(C_), m_color(color) {}
    Vec3f ComputeNormal() const { return CrossProduct(B - A, C - A).GetNormalized(); }
    Vec3f A, B, C;
    Color m_color;
};

class VisualLine
{
public:
    VisualLine() {}
    VisualLine(const Vec3f& A_, const Vec3f& B_, Color color) : A(A_), B(B_), m_color(color) {}
    Vec3f A, B;
    Color m_color;
};


class VisualText
{
public:
    VisualText() : m_text(nullptr), m_byteCount(0) {}
    VisualText(const char* text, KyUInt32 byteCount, const Vec3f& pos, Color color) : m_text(text), m_pos(pos), m_byteCount(byteCount), m_color(color) {}
    const char* m_text; // be careful, VisualText does not own the m_text buffer
    Vec3f m_pos;
    KyUInt32 m_byteCount; // "abc" byteCount = 4
    Color m_color;
};


class VisualGeometryPrimitiveCounts
{
public:
    VisualGeometryPrimitiveCounts() { Clear(); }

    void Clear()
    {
        m_opaqueTriangleCount = 0;
        m_transparentTriangleCount = 0;
        m_lineCount = 0;
        m_textCount = 0;
    }

    KyUInt32 m_opaqueTriangleCount;
    KyUInt32 m_transparentTriangleCount;
    KyUInt32 m_lineCount;
    KyUInt32 m_textCount;
};

class IVisualGeometry : public RefCountBase<IVisualGeometry, MemStat_VisualSystem>
{
public:
    IVisualGeometry() {}
    virtual ~IVisualGeometry() {}

    virtual void DoBegin(const VisualGeometryPrimitiveCounts& primitiveCounts) = 0;

    virtual void DoPushTriangle(const VisualTriangle& triangle) = 0;
    virtual void DoPushLine(const VisualLine& line) { KY_UNUSED(line); }
    virtual void DoPushText(const VisualText& text) { KY_UNUSED(text); }

    virtual void DoEnd() = 0;

    // We may consider using this prototype instead of void DoPushLine(const VisualLine& line):
    // void DoPushLine(const Vec3f& A, const Vec3f& B, Color color, KyFloat32 width)
};

class IVisualGeometryFactory : public RefCountBase<IVisualGeometry, MemStat_VisualSystem>
{
public:
    virtual ~IVisualGeometryFactory() {}
    virtual Kaim::Ptr<IVisualGeometry> CreateIVisualGeometryForDatabase(KyUInt32 databaseIdx) = 0;
    virtual void OnDatabaseClear(KyUInt32 databaseIdx) = 0;
};

}