UmsciUpmixIndicatorPaintNControlComponent.h

Go to the documentation of this file.

/* Copyright (c) 2026, Christian Ahrens
 *
 * This file is part of Umsci <https://github.com/ChristianAhrens/Umsci>
 *
 * This tool is free software; you can redistribute it and/or modify it under
 * the terms of the GNU Lesser General Public License version 3.0 as published
 * by the Free Software Foundation.
 *
 * This tool is distributed in the hope that it will be useful, but WITHOUT
 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
 * FOR A PARTICULAR PURPOSE.  See the GNU Lesser General Public License for more
 * details.
 *
 * You should have received a copy of the GNU Lesser General Public License
 * along with this tool; if not, write to the Free Software Foundation, Inc.,
 * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
 */
 
#pragma once
 
#include <JuceHeader.h>
 
#include "UmsciPaintNControlComponentBase.h"
 
#include <TwoDFieldBase.h>
 
class UmsciUpmixIndicatorPaintNControlComponent :   public UmsciPaintNControlComponentBase, public JUCEAppBasics::TwoDFieldBase, public juce::Timer
{
public:
    enum class IndicatorShape { Circle, Rectangle };
    static juce::String getShapeName(IndicatorShape shape)
    {
        switch (shape)
        {
        case IndicatorShape::Rectangle:
            return "Rectangle";
        case IndicatorShape::Circle:
        default:
            return "Circle";
        }
    }
    static IndicatorShape getShapeForName(const juce::String& name)
    {
        if (name == "Rectangle")
            return IndicatorShape::Rectangle;
        else if (name == "Circle")
            return IndicatorShape::Circle;
        
        jassertfalse; // unknown string passed as name
        return IndicatorShape::Circle;
    }
 
    UmsciUpmixIndicatorPaintNControlComponent();
    ~UmsciUpmixIndicatorPaintNControlComponent() override;
 
    //==============================================================================
    void paint(Graphics&) override;
    void resized() override;
    void setControlsSize(ControlsSize size) override;
    bool hitTest(int x, int y) override;
    void mouseDown(const juce::MouseEvent&) override;
    void mouseDrag(const juce::MouseEvent&) override;
    void mouseUp(const juce::MouseEvent&) override;
    void mouseDoubleClick(const juce::MouseEvent&) override;
 
    //==============================================================================
    void timerCallback() override;
 
    //==============================================================================
    bool setChannelConfiguration(const juce::AudioChannelSet& channelLayout) override;
 
    //==============================================================================
    void setSpeakersRealBoundingCube(const std::array<float, 6>& speakersRealBoundingCube);
 
    void setSourcePositions(const std::map<std::int16_t, std::array<std::float_t, 3>>& sourcePositions);
    void setSourcePosition(std::int16_t sourceId, const std::array<std::float_t, 3>& position);
 
    //==============================================================================
    void setSourceStartId(int startId);
    int  getSourceStartId() const;
 
    //==============================================================================
    void setLiveMode(bool liveMode);
    bool getLiveMode() const;
 
    //==============================================================================
    void setShape(IndicatorShape shape);
    IndicatorShape getShape() const;
 
    //==============================================================================
    void setUpmixTransform(float rot, float trans, float heightTrans, float angleStretch = 1.0f);
    float getUpmixRot() const;          
    float getUpmixTrans() const;        
    float getUpmixHeightTrans() const;  
    float getUpmixAngleStretch() const; 
 
    //==============================================================================
    void  setUpmixOffset(float x, float y);
    float getUpmixOffsetX() const;
    float getUpmixOffsetY() const;
 
    //==============================================================================
    void notifyTransformChanged();
 
    void triggerFlashCheck();
 
    //==============================================================================
    std::function<void(std::int16_t, std::array<std::float_t, 3>)> onSourcePositionChanged;
 
    std::function<void()> onTransformChanged;
 
private:
    //==============================================================================
    void onZoomChanged() override;
 
    //==============================================================================
    struct RenderedChannelPosition
    {
        std::int16_t            sourceId  = 0;       
        juce::Point<float>      screenPos;            
        std::array<float, 3>    realPos   = { 0.0f, 0.0f, 0.0f }; 
        juce::String            label;                
    };
 
    //==============================================================================
    void PrerenderUpmixIndicatorInBounds();
    void updateFlashState();
    juce::Rectangle<int> getRefitButtonBounds() const;
 
    //==============================================================================
    int m_sourceStartId = 1; 
 
    //==============================================================================
    std::array<float, 6>                                m_speakersRealBoundingCube; 
    std::map<std::int16_t, std::array<std::float_t, 3>> m_sourcePositions; 
 
    float m_boundingFitFactor = 0.15f; 
 
    // Prerendered juce::Path objects updated by PrerenderUpmixIndicatorInBounds().
    juce::Path m_upmixIndicator;        
    juce::Path m_upmixHeightIndicator;  
    juce::Path m_centerHandlePath;      
    juce::Path m_stretchHandlePath;     
 
    float m_upmixRot         = 0.0f;  
    float m_upmixTrans       = 1.0f;  
    float m_upmixHeightTrans = 0.6f;  
 
    juce::Point<float>               m_upmixCenter;          
    float                            m_subCircleRadius = 15.0f; 
    std::vector<RenderedChannelPosition> m_renderedFloorPositions;  
    std::vector<RenderedChannelPosition> m_renderedHeightPositions; 
 
    float             m_upmixAngleStretch       = 1.0f;   
    float             m_naturalFloorMaxAngleDeg = 110.0f; 
    juce::Point<float> m_stretchHandlePos;    
    juce::Point<float> m_stretchHandleTangent; 
 
    float m_upmixOffsetX = 0.0f; 
    float m_upmixOffsetY = 0.0f; 
    float m_baseRadius   = 100.0f; 
 
    // Drag state — values captured at mouseDown to allow incremental dragging.
    bool              m_draggingHeightRing    = false;
    bool              m_draggingStretchHandle = false;
    bool              m_draggingCenterHandle  = false;
    float             m_dragStartAngle        = 0.0f;
    float             m_dragStartDist         = 0.0f;
    float             m_dragStartRot          = 0.0f;
    float             m_dragStartTrans        = 0.0f;
    float             m_dragStartHeightTrans  = 0.6f;
    float             m_dragStartStretch      = 1.0f;
    float             m_dragStartOffsetX      = 0.0f;
    float             m_dragStartOffsetY      = 0.0f;
    juce::Point<float> m_dragStartMousePos;
 
    bool           m_flashState = false;                 
    bool           m_liveMode   = false;                 
    int            m_inhibitFlashCount = 0;
    IndicatorShape m_shape      = IndicatorShape::Circle; 
 
    JUCE_DECLARE_NON_COPYABLE_WITH_LEAK_DETECTOR (UmsciUpmixIndicatorPaintNControlComponent)
};