bubblearray.h

Go to the documentation of this file.

/*
* Copyright 2015 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.
*/

#ifndef Navigation_BubbleArray_H
#define Navigation_BubbleArray_H


#include "gwnavruntime/channel/bubble.h"
#include "gwnavruntime/containers/kyarray.h"
#include "gwnavruntime/visualsystem/visualshapecolor.h"


namespace Kaim
{

class World;
class BubbleArrayDisplayConfig;

class BubbleArray
{
public:
    BubbleArray();
    ~BubbleArray();

    //-------------------- Array wrapping methods --------------------

    void Clear();
    void Reserve(KyUInt32 bubbleCount);
    void Resize(KyUInt32 bubbleCount);
    void PushBack(const Bubble& bubble);
    void Append(const BubbleArray& other);

    bool     IsEmpty()  const;
    KyUInt32 GetCount() const;

    Bubble&       At(KyUInt32 nodeIdx);
    const Bubble& At(KyUInt32 nodeIdx) const;

    Bubble&       operator[](KyUInt32 nodeIdx);
    const Bubble& operator[](KyUInt32 nodeIdx) const;


    //-------------------- Specific methods --------------------
    void SendVisualDebug(World* world, const BubbleArrayDisplayConfig& displayConfig, const char* listBaseName = "",
        const char* groupName = "BubbleArray", KyUInt32 visualDebugId = KyUInt32MAXVAL) const;

private:
    KyArray<Bubble> m_bubbleArray;
};

KY_INLINE BubbleArray::BubbleArray() {}
KY_INLINE BubbleArray::~BubbleArray(){ Clear(); }

KY_INLINE void          BubbleArray::Clear()                            { m_bubbleArray.Clear();                     }
KY_INLINE void          BubbleArray::Reserve(KyUInt32 bubbleCount)      { m_bubbleArray.Reserve(bubbleCount);        }
KY_INLINE void          BubbleArray::Resize(KyUInt32 bubbleCount)       { m_bubbleArray.Resize(bubbleCount);         }
KY_INLINE void          BubbleArray::PushBack(const Bubble& bubble)     { m_bubbleArray.PushBack(bubble);            }
KY_INLINE void          BubbleArray::Append(const BubbleArray& other)   { m_bubbleArray.Append(other.m_bubbleArray); }
KY_INLINE bool          BubbleArray::IsEmpty()                    const { return m_bubbleArray.IsEmpty();            }
KY_INLINE KyUInt32      BubbleArray::GetCount()                   const { return m_bubbleArray.GetCount();           }
KY_INLINE Bubble&       BubbleArray::At(KyUInt32 nodeIdx)               { return m_bubbleArray.At(nodeIdx);          }
KY_INLINE const Bubble& BubbleArray::At(KyUInt32 nodeIdx)         const { return m_bubbleArray.At(nodeIdx);          }
KY_INLINE Bubble&       BubbleArray::operator[](KyUInt32 nodeIdx)       { return m_bubbleArray[nodeIdx];             }
KY_INLINE const Bubble& BubbleArray::operator[](KyUInt32 nodeIdx) const { return m_bubbleArray[nodeIdx];             }


class BubbleArrayPersistentDisplayListIds
{
public:
    BubbleArrayPersistentDisplayListIds();
    ~BubbleArrayPersistentDisplayListIds() {}

    void Initialize(World* world);
    void Release();

public:
    World* m_world;
    bool m_singleFrame;

    KyUInt32 m_displayListId_Bubbles;
    KyUInt32 m_displayListId_BubbleIdx;
};

class BubbleArrayDisplayConfig
{
public:
    BubbleArrayDisplayConfig() { SetDefaults(); }

    void SetDefaults();

    VisualShapeColor m_bubbleColor_CCW;
    VisualShapeColor m_bubbleColor_CW;
    VisualColor m_bubbleIdxColor;

    KyUInt32 m_diskSubdivision;
    KyFloat32 m_verticalOffset;

    BubbleArrayPersistentDisplayListIds m_persistentDisplayListIds;
};

} // namespace Kaim

#endif // Navigation_BubbleArray_H