CVectorField3D.h

Go to the documentation of this file.

/* +------------------------------------------------------------------------+
   |                     Mobile Robot Programming Toolkit (MRPT)            |
   |                          https://www.mrpt.org/                         |
   |                                                                        |
   | Copyright (c) 2005-2019, Individual contributors, see AUTHORS file     |
   | See: https://www.mrpt.org/Authors - All rights reserved.               |
   | Released under BSD License. See: https://www.mrpt.org/License          |
   +------------------------------------------------------------------------+ */

#pragma once

#include <mrpt/math/CMatrixF.h>
#include <mrpt/opengl/CRenderizableDisplayList.h>

namespace mrpt::opengl
{
/** A 3D vector field representation, consisting of points and arrows drawn at
 * any spatial position.
 *  This opengl object has been created to represent scene flow, and hence
 * both the vector field and
 *  the coordinates of the points at which the vector field is represented
 * are stored in matrices because
 *  they are computed from intensity and depth images.
 *  \sa opengl::COpenGLScene
 *
 *  <div align="center">
 *  <table border="0" cellspan="4" cellspacing="4" style="border-width: 1px;
 * border-style: solid;">
 *   <tr> <td> mrpt::opengl::CVectorField2D </td> <td> \image html
 * preview_CVectorField2D.png </td> </tr>
 *  </table>
 *  </div>
 *
 * \ingroup mrpt_opengl_grp
 */

class CVectorField3D : public CRenderizableDisplayList
{
    DEFINE_SERIALIZABLE(CVectorField3D)
   protected:
    /** X component of the vector field */
    mrpt::math::CMatrixF x_vf;
    /** Y component of the vector field */
    mrpt::math::CMatrixF y_vf;
    /** Z component of the vector field */
    mrpt::math::CMatrixF z_vf;

    /** X coordinate of the points at which the vector field is plotted */
    mrpt::math::CMatrixF x_p;
    /** Y coordinate of the points at which the vector field is plotted */
    mrpt::math::CMatrixF y_p;
    /** Z coordinate of the points at which the vector field is plotted */
    mrpt::math::CMatrixF z_p;

    /** By default it is 1.0 */
    float m_LineWidth{1.0};
    /** By default it is 1.0 */
    float m_pointSize{1.0};
    /** By default it is true */
    bool m_antiAliasing{true};
    /** By default it is false */
    bool m_colorFromModule{false};
    /** By default it is true */
    bool m_showPoints{true};

    mrpt::img::TColor m_point_color;
    mrpt::img::TColor m_field_color;

    /** Color associated to fields with null module */
    mrpt::img::TColor m_still_color;
    /** Color associated to fields whose module is equal or larger than
     * 'm_maxspeed' */
    mrpt::img::TColor m_maxspeed_color;
    /** Value of the module of the motion field which will correspond to
     * 'm_maxspeed_color' */
    float m_maxspeed;

   public:
    /**
     * Clear the matrices
     */
    inline void clear()
    {
        x_vf.resize(0, 0);
        y_vf.resize(0, 0);
        z_vf.resize(0, 0);
        x_p.resize(0, 0);
        y_p.resize(0, 0);
        z_p.resize(0, 0);

        CRenderizableDisplayList::notifyChange();
    }

    /**
     * Set the point color in the range [0,1]
     */
    inline void setPointColor(
        const float R, const float G, const float B, const float A = 1)
    {
        m_point_color = mrpt::img::TColor(R * 255, G * 255, B * 255, A * 255);
        CRenderizableDisplayList::notifyChange();
    }

    /**
     * Get the point color in the range [0,1]
     */
    inline mrpt::img::TColorf getPointColor() const
    {
        return mrpt::img::TColorf(m_point_color);
    }

    /**
     * Set the arrow color in the range [0,1]
     */
    inline void setVectorFieldColor(
        const float R, const float G, const float B, const float A = 1)
    {
        m_field_color = mrpt::img::TColor(R * 255, G * 255, B * 255, A * 255);
        CRenderizableDisplayList::notifyChange();
    }

    /**
     * Get the motion field min and max colors (colormap) in the range [0,1]
     */
    inline void getVectorFieldColor(
        mrpt::img::TColorf Cmin, mrpt::img::TColorf Cmax) const
    {
        Cmin = m_still_color / 255;
        Cmax = m_maxspeed_color / 255;
    }

    /**
     * Set the motion field min and max colors (colormap) in the range [0,1]
     */
    inline void setMotionFieldColormap(
        const float Rmin, const float Gmin, const float Bmin, const float Rmax,
        const float Gmax, const float Bmax, const float Amin = 1,
        const float Amax = 1)
    {
        m_still_color =
            mrpt::img::TColor(Rmin * 255, Gmin * 255, Bmin * 255, Amin * 255);
        m_maxspeed_color =
            mrpt::img::TColor(Rmax * 255, Gmax * 255, Bmax * 255, Amax * 255);
        CRenderizableDisplayList::notifyChange();
    }

    /**
     * Get the arrow color in the range [0,1]
     */
    inline mrpt::img::TColorf getVectorFieldColor() const
    {
        return mrpt::img::TColorf(m_field_color);
    }

    /**
     * Set the size with which points will be drawn. By default 1.0
     */
    inline void setPointSize(const float p)
    {
        m_pointSize = p;
        CRenderizableDisplayList::notifyChange();
    }

    /**
     * Get the size with which points are drawn. By default 1.0
     */
    inline float getPointSize() const { return m_pointSize; }
    /**
     * Set the width with which lines will be drawn.
     */
    inline void setLineWidth(const float w)
    {
        m_LineWidth = w;
        CRenderizableDisplayList::notifyChange();
    }

    /**
     * Get the width with which lines are drawn.
     */
    float getLineWidth() const { return m_LineWidth; }
    /**
     * Set the max speed associated for the color map ( m_still_color,
     * m_maxspeed_color)
     */
    inline void setMaxSpeedForColor(const float s)
    {
        m_maxspeed = s;
        CRenderizableDisplayList::notifyChange();
    }

    /**
     * Get the max_speed  with which lines are drawn.
     */
    float getMaxSpeedForColor() const { return m_maxspeed; }
    /**
     * Get the vector field in three independent matrices: Matrix_x, Matrix_y
     * and Matrix_z.
     */
    void getVectorField(
        mrpt::math::CMatrixFloat& Matrix_x, mrpt::math::CMatrixFloat& Matrix_y,
        mrpt::math::CMatrixFloat& Matrix_z) const
    {
        Matrix_x = x_vf;
        Matrix_y = y_vf;
        Matrix_z = z_vf;
    }

    template <class MATRIX>
    void getVectorField(
        MATRIX& Matrix_x, MATRIX& Matrix_y, MATRIX& Matrix_z) const
    {
        Matrix_x = x_vf;
        Matrix_y = y_vf;
        Matrix_z = z_vf;
    }

    /**
     * Get the coordiantes of the points at which the vector field is
     * plotted: Coord_x, Coord_y and Coord_z.
     */
    void getPointCoordinates(
        mrpt::math::CMatrixFloat& Coord_x, mrpt::math::CMatrixFloat& Coord_y,
        mrpt::math::CMatrixFloat& Coord_z) const
    {
        Coord_x = x_p;
        Coord_y = y_p;
        Coord_z = z_p;
    }

    template <class MATRIX>
    void getPointCoordinates(
        MATRIX& Coord_x, MATRIX& Coord_y, MATRIX& Coord_z) const
    {
        Coord_x = x_p;
        Coord_y = y_p;
        Coord_z = z_p;
    }

    /** Get the "x" component of the vector field as a matrix. */
    inline const mrpt::math::CMatrixFloat& getVectorField_x() const
    {
        return x_vf;
    }
    /** \overload */
    inline mrpt::math::CMatrixFloat& getVectorField_x() { return x_vf; }
    /** Get the "y" component of the vector field as a matrix. */
    inline const mrpt::math::CMatrixFloat& getVectorField_y() const
    {
        return y_vf;
    }
    /** \overload */
    inline mrpt::math::CMatrixFloat& getVectorField_y() { return y_vf; }
    /** Get the "z" component of the vector field as a matrix. */
    inline const mrpt::math::CMatrixFloat& getVectorField_z() const
    {
        return z_vf;
    }
    /** \overload */
    inline mrpt::math::CMatrixFloat& getVectorField_z() { return z_vf; }
    /**
     * Set the vector field with Matrix_x, Matrix_y and Matrix_z.
     */
    void setVectorField(
        mrpt::math::CMatrixFloat& Matrix_x, mrpt::math::CMatrixFloat& Matrix_y,
        mrpt::math::CMatrixFloat& Matrix_z)
    {
        ASSERT_(
            (Matrix_x.rows() == Matrix_y.rows()) &&
            (Matrix_x.rows() == Matrix_z.rows()));
        ASSERT_(
            (Matrix_x.cols() == Matrix_y.cols()) &&
            (Matrix_x.cols() == Matrix_z.cols()));
        x_vf = Matrix_x;
        y_vf = Matrix_y;
        z_vf = Matrix_z;
        CRenderizableDisplayList::notifyChange();
    }

    template <class MATRIX>
    void setVectorField(MATRIX& Matrix_x, MATRIX& Matrix_y, MATRIX& Matrix_z)
    {
        ASSERT_(
            (Matrix_x.rows() == Matrix_y.rows()) &&
            (Matrix_x.rows() == Matrix_z.rows()));
        ASSERT_(
            (Matrix_x.cols() == Matrix_y.cols()) &&
            (Matrix_x.cols() == Matrix_z.cols()));
        x_vf = Matrix_x;
        y_vf = Matrix_y;
        z_vf = Matrix_z;
        CRenderizableDisplayList::notifyChange();
    }

    /**
     * Set the coordinates of the points at which the vector field is plotted
     * with Matrix_x, Matrix_y and Matrix_z.
     */
    void setPointCoordinates(
        mrpt::math::CMatrixFloat& Matrix_x, mrpt::math::CMatrixFloat& Matrix_y,
        mrpt::math::CMatrixFloat& Matrix_z)
    {
        ASSERT_(
            (Matrix_x.rows() == Matrix_y.rows()) &&
            (Matrix_x.rows() == Matrix_z.rows()));
        ASSERT_(
            (Matrix_x.cols() == Matrix_y.cols()) &&
            (Matrix_x.cols() == Matrix_z.cols()));
        x_p = Matrix_x;
        y_p = Matrix_y;
        z_p = Matrix_z;
        CRenderizableDisplayList::notifyChange();
    }

    template <class MATRIX>
    void setPointCoordinates(
        MATRIX& Matrix_x, MATRIX& Matrix_y, MATRIX& Matrix_z)
    {
        ASSERT_(
            (Matrix_x.rows() == Matrix_y.rows()) &&
            (Matrix_x.rows() == Matrix_z.rows()));
        ASSERT_(
            (Matrix_x.cols() == Matrix_y.cols()) &&
            (Matrix_x.cols() == Matrix_z.cols()));
        x_p = Matrix_x;
        y_p = Matrix_y;
        z_p = Matrix_z;
        CRenderizableDisplayList::notifyChange();
    }

    /**
     * Resizes the set.
     */
    void resize(size_t rows, size_t cols)
    {
        x_vf.resize(rows, cols);
        y_vf.resize(rows, cols);
        z_vf.resize(rows, cols);
        x_p.resize(rows, cols);
        y_p.resize(rows, cols);
        z_p.resize(rows, cols);
        CRenderizableDisplayList::notifyChange();
    }

    /** Returns the total count of rows used to represent the vector field. */
    inline size_t cols() const { return x_vf.cols(); }
    /** Returns the total count of columns used to represent the vector field.
     */
    inline size_t rows() const { return x_vf.rows(); }
    /** Render
     */
    void render_dl() const override;

    /** Evaluates the bounding box of this object (including possible children)
     * in the coordinate frame of the object parent. */
    void getBoundingBox(
        mrpt::math::TPoint3D& bb_min,
        mrpt::math::TPoint3D& bb_max) const override;

    void enableAntiAliasing(bool enable = true)
    {
        m_antiAliasing = enable;
        CRenderizableDisplayList::notifyChange();
    }
    void enableColorFromModule(bool enable = true)
    {
        m_colorFromModule = enable;
        CRenderizableDisplayList::notifyChange();
    }
    void enableShowPoints(bool enable = true)
    {
        m_showPoints = enable;
        CRenderizableDisplayList::notifyChange();
    }
    bool isAntiAliasingEnabled() const { return m_antiAliasing; }
    bool isColorFromModuleEnabled() const { return m_colorFromModule; }
    /** Constructor */
    CVectorField3D();
    /** Constructor with a initial set of lines. */
    CVectorField3D(
        mrpt::math::CMatrixFloat x_vf_ini, mrpt::math::CMatrixFloat y_vf_ini,
        mrpt::math::CMatrixFloat z_vf_ini, mrpt::math::CMatrixFloat x_p_ini,
        mrpt::math::CMatrixFloat y_p_ini, mrpt::math::CMatrixFloat z_p_ini);
    /** Private, virtual destructor: only can be deleted from smart pointers. */
    ~CVectorField3D() override = default;
};

}  // namespace mrpt::opengl