quantumpotentialeditor2d.h

Go to the documentation of this file.

/**
 * @file quantumpotentialeditor2d.h
 * @brief Declares the quantumpotentialeditor2d visualization component used by QPE.
 * @ingroup qpe_graphics
 *
 * Source: @c graphics/renderer/quantumpotentialeditor2d.h. This file is part of Quantum Phenomena Explorer (QPE),
 * maintained by Officina Turini. See LICENSE_IT.txt / LICENSE.txt for the
 * QPE freeware source-available terms and THIRD_PARTY_NOTICES.txt for
 * third-party components.
 */
 
#pragma once
 
namespace qpe {
 
/**
 * @brief Enumerates the supported Potential Editor Tool values.
 *
 * The enumeration is part of the typed interface used to keep experiment configuration and analysis routing explicit.
 */
enum class PotentialEditorTool
{
    Rectangle = 0,
    Circle
};
 
/**
 * @brief Data structure used by the Potential Editor Shape component.
 *
 * The structure keeps related values explicit and testable across the QPE physics, analysis, or persistence layers.
 */
struct PotentialEditorShape
{
    PotentialEditorTool tool = PotentialEditorTool::Rectangle;
    float centerX = 0.0f;
    float centerY = 0.0f;
    float width = 0.0f;
    float height = 0.0f;
    float radius = 0.0f;
 
    /**
     * @brief Performs valid.
     */
    bool valid() const noexcept;
};
 
/**
 * @brief Implements the Potential Editor2D component.
 *
 * The class provides one focused service within the QPE architecture and is documented here independently of the experiment-level Help.
 */
class PotentialEditor2D
{
public:
    /**
     * @brief Performs rectangle from drag.
     * @param x1 The x1 value used by the operation.
     * @param y1 The y1 value used by the operation.
     * @param x2 The x2 value used by the operation.
     * @param y2 The y2 value used by the operation.
     * @param minimumWidth The minimum width value used by the operation.
     * @param minimumHeight The minimum height value used by the operation.
     */
    static PotentialEditorShape rectangleFromDrag(float x1,
                                                  float y1,
                                                  float x2,
                                                  float y2,
                                                  float minimumWidth,
                                                  float minimumHeight) noexcept;
 
    /**
     * @brief Performs circle from drag.
     * @param centerX The center x value used by the operation.
     * @param centerY The center y value used by the operation.
     * @param edgeX The edge x value used by the operation.
     * @param edgeY The edge y value used by the operation.
     * @param minimumRadius The minimum radius value used by the operation.
     */
    static PotentialEditorShape circleFromDrag(float centerX,
                                               float centerY,
                                               float edgeX,
                                               float edgeY,
                                               float minimumRadius) noexcept;
};
 
} // namespace qpe