o3de-extras/Gems/ROS2Sensors/Code/Source/Camera/ROS2CameraSensorEditorComponent.cpp

/*
 * Copyright (c) Contributors to the Open 3D Engine Project.
 * For complete copyright and license terms please see the LICENSE at the root of this distribution.
 *
 * SPDX-License-Identifier: Apache-2.0 OR MIT
 *
 */

#include "ROS2CameraSensorEditorComponent.h"
#include "CameraUtilities.h"
#include "ROS2CameraSensorComponent.h"
#include <AzCore/Component/TransformBus.h>

namespace ROS2Sensors
{
    ROS2CameraSensorEditorComponent::ROS2CameraSensorEditorComponent()
    {
        m_sensorConfiguration.m_frequency = 10;
        m_sensorConfiguration.m_publishersConfigurations.insert(
            MakeTopicConfigurationPair("camera_image_color", CameraConstants::ImageMessageType, CameraConstants::ColorImageConfig));
        m_sensorConfiguration.m_publishersConfigurations.insert(
            MakeTopicConfigurationPair("camera_image_depth", CameraConstants::ImageMessageType, CameraConstants::DepthImageConfig));
        m_sensorConfiguration.m_publishersConfigurations.insert(
            MakeTopicConfigurationPair("color_camera_info", CameraConstants::CameraInfoMessageType, CameraConstants::ColorInfoConfig));
        m_sensorConfiguration.m_publishersConfigurations.insert(
            MakeTopicConfigurationPair("depth_camera_info", CameraConstants::CameraInfoMessageType, CameraConstants::DepthInfoConfig));
    }

    ROS2CameraSensorEditorComponent::ROS2CameraSensorEditorComponent(
        const ROS2::SensorConfiguration& sensorConfiguration, const CameraSensorConfiguration& cameraConfiguration)
        : m_sensorConfiguration(sensorConfiguration)
        , m_cameraConfiguration(cameraConfiguration)
    {
    }

    void ROS2CameraSensorEditorComponent::Reflect(AZ::ReflectContext* context)
    {
        if (auto* serialize = azrtti_cast<AZ::SerializeContext*>(context))
        {
            serialize->Class<ROS2CameraSensorEditorComponent, AzToolsFramework::Components::EditorComponentBase>()
                ->Version(4)
                ->Field("CameraSensorConfig", &ROS2CameraSensorEditorComponent::m_cameraConfiguration)
                ->Field("SensorConfig", &ROS2CameraSensorEditorComponent::m_sensorConfiguration);

            if (AZ::EditContext* editContext = serialize->GetEditContext())
            {
                editContext->Class<ROS2CameraSensorEditorComponent>("ROS2 Camera Sensor", "[Camera component]")
                    ->ClassElement(AZ::Edit::ClassElements::EditorData, "")
                    ->Attribute(AZ::Edit::Attributes::Category, "ROS2")
                    ->Attribute(AZ::Edit::Attributes::AppearsInAddComponentMenu, AZ_CRC("Game"))
                    ->Attribute(AZ::Edit::Attributes::Icon, "Editor/Icons/Components/ROS2CameraSensor.svg")
                    ->Attribute(AZ::Edit::Attributes::ViewportIcon, "Editor/Icons/Components/Viewport/ROS2CameraSensor.svg")
                    ->DataElement(
                        AZ::Edit::UIHandlers::Default,
                        &ROS2CameraSensorEditorComponent::m_sensorConfiguration,
                        "Sensor configuration",
                        "Sensor configuration")
                    ->DataElement(
                        AZ::Edit::UIHandlers::Default,
                        &ROS2CameraSensorEditorComponent::m_cameraConfiguration,
                        "Camera configuration",
                        "Camera configuration.");
            }
        }
    }

    void ROS2CameraSensorEditorComponent::Activate()
    {
        AzFramework::EntityDebugDisplayEventBus::Handler::BusConnect(this->GetEntityId());
        AzToolsFramework::Components::EditorComponentBase::Activate();
        CameraConfigurationRequestBus::Handler::BusConnect(GetEntityId());
    }

    void ROS2CameraSensorEditorComponent::Deactivate()
    {
        CameraConfigurationRequestBus::Handler::BusDisconnect(GetEntityId());
        AzToolsFramework::Components::EditorComponentBase::Deactivate();
        AzFramework::EntityDebugDisplayEventBus::Handler::BusDisconnect();
    }

    void ROS2CameraSensorEditorComponent::GetRequiredServices(AZ::ComponentDescriptor::DependencyArrayType& required)
    {
        required.push_back(AZ_CRC("ROS2Frame"));
    }

    void ROS2CameraSensorEditorComponent::GetIncompatibleServices(AZ::ComponentDescriptor::DependencyArrayType& incompatible)
    {
        incompatible.push_back(AZ_CRC_CE("ROS2CameraSensor"));
    }

    void ROS2CameraSensorEditorComponent::GetProvidedServices(AZ::ComponentDescriptor::DependencyArrayType& provided)
    {
        provided.push_back(AZ_CRC_CE("ROS2CameraSensor"));
    }

    void ROS2CameraSensorEditorComponent::BuildGameEntity(AZ::Entity* gameEntity)
    {
        gameEntity->CreateComponent<ROS2CameraSensorComponent>(m_sensorConfiguration, m_cameraConfiguration);
    }

    void ROS2CameraSensorEditorComponent::SetConfiguration(const CameraSensorConfiguration& configuration)
    {
        m_cameraConfiguration = configuration;
    }

    const CameraSensorConfiguration ROS2CameraSensorEditorComponent::GetConfiguration()
    {
        return m_cameraConfiguration;
    }

    AZ::Matrix3x3 ROS2CameraSensorEditorComponent::GetCameraMatrix()
    {
        return CameraUtils::MakeCameraIntrinsics(
            m_cameraConfiguration.m_width, m_cameraConfiguration.m_height, m_cameraConfiguration.m_verticalFieldOfViewDeg);
    }

    float ROS2CameraSensorEditorComponent::GetVerticalFOV()
    {
        return m_cameraConfiguration.m_verticalFieldOfViewDeg;
    }

    void ROS2CameraSensorEditorComponent::SetVerticalFOV(float value)
    {
        if (value < CameraSensorConfiguration::m_minVerticalFieldOfViewDeg ||
            value > CameraSensorConfiguration::m_maxVerticalFieldOfViewDeg)
        {
            AZ_Warning(
                "ROS2CameraSensorEditorComponent",
                false,
                "Vertical field of view value %f is out of bounds [%f, %f].",
                value,
                CameraSensorConfiguration::m_minVerticalFieldOfViewDeg,
                CameraSensorConfiguration::m_maxVerticalFieldOfViewDeg);
            return;
        }
        m_cameraConfiguration.m_verticalFieldOfViewDeg = value;
    }

    int ROS2CameraSensorEditorComponent::GetWidth()
    {
        return m_cameraConfiguration.m_width;
    }

    void ROS2CameraSensorEditorComponent::SetWidth(int value)
    {
        if (value < CameraSensorConfiguration::m_minWidth)
        {
            AZ_Warning(
                "ROS2CameraSensorEditorComponent",
                false,
                "Width value %d is less than the minimum allowed width %d.",
                value,
                CameraSensorConfiguration::m_minWidth);
            return;
        }
        m_cameraConfiguration.m_width = value;
    }

    int ROS2CameraSensorEditorComponent::GetHeight()
    {
        return m_cameraConfiguration.m_height;
    }

    void ROS2CameraSensorEditorComponent::SetHeight(int value)
    {
        if (value < CameraSensorConfiguration::m_minHeight)
        {
            AZ_Warning(
                "ROS2CameraSensorEditorComponent",
                false,
                "Height value %d is less than the minimum allowed height %d.",
                value,
                CameraSensorConfiguration::m_minHeight);
            return;
        }
        m_cameraConfiguration.m_height = value;
    }

    bool ROS2CameraSensorEditorComponent::IsColorCamera()
    {
        return m_cameraConfiguration.m_colorCamera;
    }

    void ROS2CameraSensorEditorComponent::SetColorCamera(bool value)
    {
        m_cameraConfiguration.m_colorCamera = value;
    }

    bool ROS2CameraSensorEditorComponent::IsDepthCamera()
    {
        return m_cameraConfiguration.m_depthCamera;
    }

    void ROS2CameraSensorEditorComponent::SetDepthCamera(bool value)
    {
        m_cameraConfiguration.m_depthCamera = value;
    }

    float ROS2CameraSensorEditorComponent::GetNearClipDistance()
    {
        return m_cameraConfiguration.m_nearClipDistance;
    }

    void ROS2CameraSensorEditorComponent::SetNearClipDistance(float value)
    {
        m_cameraConfiguration.m_nearClipDistance = value;
    }

    float ROS2CameraSensorEditorComponent::GetFarClipDistance()
    {
        return m_cameraConfiguration.m_farClipDistance;
    }

    void ROS2CameraSensorEditorComponent::SetFarClipDistance(float value)
    {
        m_cameraConfiguration.m_farClipDistance = value;
    }

    void ROS2CameraSensorEditorComponent::DisplayEntityViewport(
        [[maybe_unused]] const AzFramework::ViewportInfo& viewportInfo, AzFramework::DebugDisplayRequests& debugDisplay)
    {
        if (!m_sensorConfiguration.m_visualize)
        {
            return;
        }
        const AZ::u32 stateBefore = debugDisplay.GetState();
        AZ::Transform transform = GetEntity()->GetTransform()->GetWorldTM();

        const float distance = m_cameraConfiguration.m_farClipDistance * 0.1f;
        const float tangent = static_cast<float>(tan(0.5f * AZ::DegToRad(m_cameraConfiguration.m_verticalFieldOfViewDeg)));

        float height = distance * tangent;
        float width = height * m_cameraConfiguration.m_width / m_cameraConfiguration.m_height;

        AZ::Vector3 farPoints[4];
        farPoints[0] = AZ::Vector3(width, height, distance);
        farPoints[1] = AZ::Vector3(-width, height, distance);
        farPoints[2] = AZ::Vector3(-width, -height, distance);
        farPoints[3] = AZ::Vector3(width, -height, distance);

        AZ::Vector3 nearPoints[4];
        nearPoints[0] = farPoints[0].GetNormalizedSafe() * m_cameraConfiguration.m_nearClipDistance;
        nearPoints[1] = farPoints[1].GetNormalizedSafe() * m_cameraConfiguration.m_nearClipDistance;
        nearPoints[2] = farPoints[2].GetNormalizedSafe() * m_cameraConfiguration.m_nearClipDistance;
        nearPoints[3] = farPoints[3].GetNormalizedSafe() * m_cameraConfiguration.m_nearClipDistance;

        // dimension of drawing
        const float arrowRise = 0.11f;
        const float arrowSize = 0.05f;

        const AZ::Vector3 pt0(0, 0, 0);
        const auto ptz = AZ::Vector3::CreateAxisZ(0.2f);
        const auto pty = AZ::Vector3::CreateAxisY(0.2f);
        const auto ptx = AZ::Vector3::CreateAxisX(0.2f);

        debugDisplay.PushMatrix(transform);

        debugDisplay.SetColor(AZ::Color(0.f, 1.f, 1.f, 1.f));
        debugDisplay.DrawLine(nearPoints[0], farPoints[0]);
        debugDisplay.DrawLine(nearPoints[1], farPoints[1]);
        debugDisplay.DrawLine(nearPoints[2], farPoints[2]);
        debugDisplay.DrawLine(nearPoints[3], farPoints[3]);
        debugDisplay.DrawPolyLine(nearPoints, AZ_ARRAY_SIZE(nearPoints));
        debugDisplay.DrawPolyLine(farPoints, AZ_ARRAY_SIZE(farPoints));

        // up-arrow drawing
        const AZ::Vector3 pa1(-arrowSize * height, -arrowRise * width, 1.f);
        const AZ::Vector3 pa2(arrowSize * height, -arrowRise * width, 1.f);
        const AZ::Vector3 pa3(0, (-arrowRise - arrowSize) * width, 1.f);

        debugDisplay.SetColor(AZ::Color(0.f, 0.6f, 1.f, 1.f));
        debugDisplay.SetLineWidth(1);
        debugDisplay.DrawLine(pa1, pa2);
        debugDisplay.DrawLine(pa2, pa3);
        debugDisplay.DrawLine(pa3, pa1);

        // coordinate system drawing
        debugDisplay.SetColor(AZ::Color(1.f, 0.f, 0.f, 1.f));
        debugDisplay.SetLineWidth(2);
        debugDisplay.DrawLine(ptx, pt0);

        debugDisplay.SetColor(AZ::Color(0.f, 1.f, 0.f, 1.f));
        debugDisplay.SetLineWidth(2);
        debugDisplay.DrawLine(pty, pt0);

        debugDisplay.SetColor(AZ::Color(0.f, 0.f, 1.f, 1.f));
        debugDisplay.SetLineWidth(2);
        debugDisplay.DrawLine(ptz, pt0);

        debugDisplay.PopMatrix();

        debugDisplay.SetState(stateBefore);
    }

    AZStd::pair<AZStd::string, ROS2::TopicConfiguration> ROS2CameraSensorEditorComponent::MakeTopicConfigurationPair(
        const AZStd::string& topic, const AZStd::string& messageType, const AZStd::string& configName) const
    {
        ROS2::TopicConfiguration config;
        config.m_topic = topic;
        config.m_type = messageType;
        return AZStd::make_pair(configName, config);
    }

} // namespace ROS2Sensors