pointofinterest.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.
*/


// primary contact: LAPA - secondary contact: JUBA
#ifndef Navigation_PointOfInterest_H
#define Navigation_PointOfInterest_H


#include "gwnavruntime/spatialization/spatializedpoint.h"
#include "gwnavruntime/world/worldelement.h"


namespace Kaim
{

static const KyUInt32 PointOfInterestType_Undefined = 0; 
static const KyUInt32 PointOfInterestType_FirstClient = 16; 


class PointOfInterestInitConfig
{
public:
    // ---------------------------------- Public Member Functions ----------------------------------

    PointOfInterestInitConfig() { SetDefaults(); }

    void SetDefaults()
    {
        m_startPosition.Set(0.0f, 0.0f, 0.0f);
        m_world = KY_NULL;
        m_databaseBinding = KY_NULL;
        m_poiData = KY_NULL;
        m_poiType = PointOfInterestType_Undefined;
        m_height = 0.0f;
    }


    // ---------------------------------- Public Data Members ----------------------------------

    World* m_world;

    Ptr<DatabaseBinding> m_databaseBinding;

    void* m_poiData;
    Vec3f m_startPosition;

    KyFloat32 m_height;

    KyUInt32 m_poiType;
};



class PointOfInterest: public WorldElement
{
    KY_DEFINE_NEW_DELETE_OPERATORS(MemStat_Spatialization)
    KY_CLASS_WITHOUT_COPY(PointOfInterest)

public:
    static  WorldElementType GetStaticType() { return TypePointOfInterest; }
    virtual WorldElementType GetType() const { return TypePointOfInterest; }

    virtual const char*      GetTypeName() const { return "PointOfInterest"; }


    // ---------------------------------- Main API Functions ----------------------------------

    PointOfInterest();
    PointOfInterest(const PointOfInterestInitConfig& initConfig);

    ~PointOfInterest();


    void Init(const PointOfInterestInitConfig& initConfig);

    void Clear();

    void AddToWorld();

    void RemoveFromWorld();


    void SetPosition(const Vec3f& position);

    // ---------------------------------- Getters ----------------------------------

    const SpatializedPoint& GetSpatializedPoint()    const;
    void*                   GetPointOfInterestData() const;
    KyUInt32                GetPointOfInterestType() const;


public: // internal
    virtual void DoSendVisualDebug(VisualDebugServer& server, VisualDebugSendChangeEvent changeEvent); // Inherited from WorldElement

    // Updates the SpatializedPoint position with the data provided
    // in the PointOfInterestUpdateConfig.
    // Computes then the spatialization of the SpatializedPoint.
    void UpdateSpatialization();

private:
    Vec3f m_position;
    Ptr<SpatializedPoint> m_spatializedPoint;
    void* m_poiData;
    KyUInt32 m_poiType;
};


KY_INLINE PointOfInterest::PointOfInterest() : m_poiData(KY_NULL) , m_poiType(PointOfInterestType_Undefined) {}
KY_INLINE PointOfInterest::PointOfInterest(const PointOfInterestInitConfig& initConfig)
    : m_poiData(KY_NULL) , m_poiType(PointOfInterestType_Undefined)
{
    Init(initConfig);
}

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

KY_INLINE void PointOfInterest::SetPosition(const Vec3f& position) { m_position = position; }

KY_INLINE const SpatializedPoint& PointOfInterest::GetSpatializedPoint()    const { return *m_spatializedPoint; }
KY_INLINE void*                   PointOfInterest::GetPointOfInterestData() const { return m_poiData;           }
KY_INLINE KyUInt32                PointOfInterest::GetPointOfInterestType() const { return m_poiType;           }

KY_INLINE void PointOfInterest::UpdateSpatialization()                     { m_spatializedPoint->UpdateSpatialization(m_position); ForceSendAllVisualDebug(); }

} // namespace Kaim

#endif // Navigation_PointOfInterest_H