Tutorial_QueryQueue.cpp

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

#include "common/oneworldenv.h"
#include "gwnavruntime/queries/astarquery.h"

//RUN_THIS_FILE

namespace
{

#define TEST_ENV_CLASS OneWorldEnv
    TEST_ENV {}

TUTORIAL
{
    KT_LOG_TITLE_BEGIN("TUTORIAL - How to perform a single atomic query using the default queue of the world");
    CHECK(env.LoadAndAddNavData("GeneratedNavData/plan/plan.NavData") != KY_NULL);

    Kaim::World* navWorld = env.GetWorld();

    // Setup Query.
    Kaim::Ptr<Kaim::RayCanGoQuery<Kaim::DefaultTraverseLogic> > query = *KY_NEW Kaim::RayCanGoQuery<Kaim::DefaultTraverseLogic>;
    query->BindToDatabase(navWorld->GetDatabase(0));

    query->Initialize(Kaim::Vec3f(0.f,0.f,0.f), Kaim::Vec3f(1.0f,0.f,0.f));

    // Push it to the world.
    navWorld->PushAsyncQuery(query);

    // Note that no work will occur if we do not call World::Update.
    navWorld->Update();

    // Query is atomic, therefore should have been performed and finished.
    CHECK(query->IsSafeToReadResult() == true);
    CHECK(query->GetResult() == Kaim::RAYCANGO_DONE_SUCCESS);
}

TUTORIAL
{
    KT_LOG_TITLE_BEGIN("TUTORIAL - How to perform a single time-sliced query using the default queue of the world");
    CHECK(env.LoadAndAddNavData("GeneratedNavData/plan/plan.NavData") != KY_NULL);

    Kaim::World* navWorld = env.GetWorld();

    // Setup Query.
    Kaim::Ptr< Kaim::AStarQuery<Kaim::DefaultTraverseLogic> > query = *KY_NEW Kaim::AStarQuery<Kaim::DefaultTraverseLogic>;
    query->BindToDatabase(navWorld->GetDatabase(0));
    query->Initialize(Kaim::Vec3f(0.f,0.f,0.f), Kaim::Vec3f(1.0f,0.f,0.f));

    // Push it to the world.
    navWorld->PushAsyncQuery(query);

    // Note that no work will occur if we do not call World::Update.  This is a time-sliced query so may take several Updates to complete.
    while (query->IsSafeToReadResult() == false)
    {
        navWorld->Update();
    }

    CHECK(query->GetResult() == Kaim::ASTAR_DONE_PATH_FOUND);
}

TUTORIAL
{
    KT_LOG_TITLE_BEGIN("TUTORIAL - How to perform a single time-sliced query using the default queue of the world");
    CHECK(env.LoadAndAddNavData("GeneratedNavData/plan/plan.NavData") != KY_NULL);

    Kaim::World* navWorld = env.GetWorld();

    // Setup Query.
    Kaim::Ptr< Kaim::AStarQuery<Kaim::DefaultTraverseLogic> > query = *KY_NEW Kaim::AStarQuery<Kaim::DefaultTraverseLogic>;
    query->BindToDatabase(navWorld->GetDatabase(0));
    query->Initialize(Kaim::Vec3f(0.f,0.f,0.f), Kaim::Vec3f(1.0f,0.f,0.f));

    // Push it to the world.
    navWorld->PushAsyncQuery(query);

    // Note that no work will occur if we do not call World::Update.  This is a time-sliced query so may take several Updates to complete.
    while (query->IsSafeToReadResult() == false)
    {
        navWorld->Update();
    }

    CHECK(query->GetResult() == Kaim::ASTAR_DONE_PATH_FOUND);
}

}