shortcuttrajectoryconfig.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: NOBODY
#ifndef Navigation_ShortcutTrajectoryConfig_H
#define Navigation_ShortcutTrajectoryConfig_H

#include "gwnavruntime/base/endianness.h"
#include "gwnavruntime/base/memory.h"

namespace Kaim
{

class ShortcutTrajectoryConfigBlob;

class AdvancedShortcutTrajectoryConfig
{
    KY_DEFINE_NEW_DELETE_OPERATORS(MemStat_Bot)

public:
    AdvancedShortcutTrajectoryConfig() { SetDefaults(); }
    void SetDefaults();

    bool operator==(const AdvancedShortcutTrajectoryConfig& other) const;
    bool operator!=(const AdvancedShortcutTrajectoryConfig& other) const { return !operator==(other); }

public:

    // ---------------------------------- General Shortcut Control Parameters ----------------------------------

    KyFloat32 m_shortcutAttemptDistanceRatio;

    KyFloat32 m_shortcutForceAttemptDistance;

    KyFloat32 m_snapOnPathDistance;

    // ---------------------------------- Forward Shortcut Control Parameters ----------------------------------

    KyFloat32 m_forwardSamplingDistance;

    KyFloat32 m_forwardMaxDistance;

    // ---------------------------------- Backward Sampling Parameters  ----------------------------------

    KyFloat32 m_backwardSamplingDistance;

    KyFloat32 m_backwardMaxDistance;
};
inline void SwapEndianness(Endianness::Target e, AdvancedShortcutTrajectoryConfig& self)
{
    SwapEndianness(e, self.m_snapOnPathDistance);
    SwapEndianness(e, self.m_shortcutAttemptDistanceRatio);
    SwapEndianness(e, self.m_shortcutForceAttemptDistance);
    SwapEndianness(e, self.m_forwardSamplingDistance);
    SwapEndianness(e, self.m_forwardMaxDistance);
    SwapEndianness(e, self.m_backwardSamplingDistance);
    SwapEndianness(e, self.m_backwardMaxDistance);
}


class ShortcutTrajectoryConfig
{
    KY_DEFINE_NEW_DELETE_OPERATORS(MemStat_Bot)

public:
    ShortcutTrajectoryConfig() { SetDefaults(); }
    void SetDefaults();
    void InitFromBlob(const ShortcutTrajectoryConfigBlob& blob);

    bool operator==(const ShortcutTrajectoryConfig& other) const;
    bool operator!=(const ShortcutTrajectoryConfig& other) const { return !operator==(other); }

public:
    bool m_snapOnPath;

    AdvancedShortcutTrajectoryConfig m_advancedConfig;
};



KY_INLINE void AdvancedShortcutTrajectoryConfig::SetDefaults()
{
    m_snapOnPathDistance = 0.05f;
    m_shortcutAttemptDistanceRatio = 0.7f;
    m_shortcutForceAttemptDistance = 0.5f;
    m_forwardSamplingDistance = 1.f;
    m_forwardMaxDistance = 10.f;
    m_backwardSamplingDistance = 1.f;
    m_backwardMaxDistance = 10.f;
}
KY_INLINE bool AdvancedShortcutTrajectoryConfig::operator==(const AdvancedShortcutTrajectoryConfig& other) const
{
    return m_snapOnPathDistance == other.m_snapOnPathDistance
        && m_shortcutAttemptDistanceRatio == other.m_shortcutAttemptDistanceRatio
        && m_shortcutForceAttemptDistance == other.m_shortcutForceAttemptDistance
        && m_forwardSamplingDistance == other.m_forwardSamplingDistance
        && m_forwardMaxDistance == other.m_forwardMaxDistance
        && m_backwardSamplingDistance == other.m_backwardSamplingDistance
        && m_backwardMaxDistance == other.m_backwardMaxDistance;
}


KY_INLINE void ShortcutTrajectoryConfig::SetDefaults()
{
    m_snapOnPath = false;
    m_advancedConfig.SetDefaults();
}

KY_INLINE bool ShortcutTrajectoryConfig::operator==(const ShortcutTrajectoryConfig& other) const
{
    return m_snapOnPath == other.m_snapOnPath
        && m_advancedConfig == m_advancedConfig;
}

} // namespace Kaim

#endif