WaveformGroup.h

Go to the documentation of this file.

/***********************************************************************************************************************
*                                                                                                                      *
* ngscopeclient                                                                                                        *
*                                                                                                                      *
* Copyright (c) 2012-2026 Andrew D. Zonenberg and contributors                                                         *
* All rights reserved.                                                                                                 *
*                                                                                                                      *
* Redistribution and use in source and binary forms, with or without modification, are permitted provided that the     *
* following conditions are met:                                                                                        *
*                                                                                                                      *
*    * Redistributions of source code must retain the above copyright notice, this list of conditions, and the         *
*      following disclaimer.                                                                                           *
*                                                                                                                      *
*    * Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the       *
*      following disclaimer in the documentation and/or other materials provided with the distribution.                *
*                                                                                                                      *
*    * Neither the name of the author nor the names of any contributors may be used to endorse or promote products     *
*      derived from this software without specific prior written permission.                                           *
*                                                                                                                      *
* THIS SOFTWARE IS PROVIDED BY THE AUTHORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED   *
* TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL *
* THE AUTHORS BE HELD LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES        *
* (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR       *
* BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT *
* (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE       *
* POSSIBILITY OF SUCH DAMAGE.                                                                                          *
*                                                                                                                      *
***********************************************************************************************************************/
 
#ifndef WaveformGroup_h
#define WaveformGroup_h
 
#include "WaveformArea.h"
 
class WaveformGroup : public SerializableObject
{
public:
    WaveformGroup(MainWindow* parent, const std::string& title);
    virtual ~WaveformGroup();
 
    void Clear();
 
    bool Render();
    void ToneMapAllWaveforms(vk::raii::CommandBuffer& cmdbuf, std::vector<vk::ImageMemoryBarrier>& barriers);
    void ReferenceWaveformTextures();
 
    void RenderWaveformTextures(
        vk::raii::CommandBuffer& cmdbuf,
        std::vector<std::shared_ptr<InputDescriptor> >& channels,
        bool clearPersistence);
 
    const std::string GetID()
    { return m_title + "###" + m_id; }
 
    const std::string& GetRawID()
    { return m_id; }
 
    const std::string& GetTitle()
    { return m_title; }
 
    void AddArea(std::shared_ptr<WaveformArea>& area);
 
    void AddArea(std::shared_ptr<WaveformArea>& area, size_t position);
 
    size_t GetAreaPosition(WaveformArea& area);
 
    void MoveArea(WaveformArea& area, size_t newPosition);
 
    void OnZoomInHorizontal(int64_t target, float step);
    void OnZoomOutHorizontal(int64_t target, float step);
    void OnPanHorizontal(float step);
    void NavigateToTimestamp(
        int64_t timestamp,
        int64_t duration = 0,
        StreamDescriptor target = StreamDescriptor(nullptr, 0));
 
    void ClearPersistenceOfChannel(OscilloscopeChannel* chan);
 
    Unit GetXAxisUnit()
    { return m_xAxisUnit; }
 
    int64_t XPositionToXAxisUnits(float pix)
    { return m_xAxisOffset + PixelsToXAxisUnits(pix - m_xpos); }
 
    int64_t PixelsToXAxisUnits(float pix)
    { return pix / m_pixelsPerXUnit; }
 
    float XAxisUnitsToPixels(int64_t t)
    { return t * m_pixelsPerXUnit; }
 
    float XAxisUnitsToXPosition(int64_t t)
    { return XAxisUnitsToPixels(t - m_xAxisOffset) + m_xpos; }
 
    float GetPixelsPerXUnit()
    { return m_pixelsPerXUnit; }
 
    int64_t GetXAxisOffset()
    { return m_xAxisOffset; }
 
    void ClearPersistence();
 
    float GetYAxisWidth()
    {
        //Hex numbers need more space to draw
        //Check if we have any UNIT_HEXNUM areas in the group and scale it up
        for(auto a : m_areas)
        {
            if(a->GetYAxisUnit() == Unit::UNIT_HEXNUM)
                return 10 * ImGui::GetFontSize();
        }
        return 6 * ImGui::GetFontSize();
    }
 
    float GetSpacing()
    { return ImGui::GetFrameHeightWithSpacing() - ImGui::GetFrameHeight(); }
 
    std::vector< std::shared_ptr<WaveformArea> > GetWaveformAreas()
    {
        std::lock_guard<std::mutex> lock(m_areaMutex);
        return m_areas;
    }
 
    //Serialization
    bool LoadConfiguration(const YAML::Node& node);
    YAML::Node SerializeConfiguration(IDTable& table);
 
    bool IsDraggingTrigger()
    { return m_dragState == DRAG_STATE_TRIGGER; }
 
    bool IsDraggingXCursor()
    { return (m_dragState == DRAG_STATE_X_CURSOR0) || (m_dragState == DRAG_STATE_X_CURSOR1); }
 
    bool IsDraggingMarker()
    { return (m_dragState == DRAG_STATE_MARKER); }
 
    bool IsDraggingSomething()
    { return (m_dragState != DRAG_STATE_NONE); }
 
    bool IsMouseOverXCursor(int iCursor);
    bool IsMouseOverYCursorInChild(bool ignoreCursorsPlacedThisFrame);
 
    bool IsMouseOverAnyXCursor()
    { return IsMouseOverXCursor(0) || IsMouseOverXCursor(1); }
 
    void AutofitHorizontal(float width);
 
protected:
    void RenderTimeline(float width, float height);
    void RenderTriggerPositionArrows(ImVec2 pos, float height);
    void RenderXAxisCursors(ImVec2 pos, ImVec2 size);
    void RenderMarkers(ImVec2 pos, ImVec2 size);
    void DoCursorReadouts();
 
    void TitleHoverHelp();
 
    float GetInBandPower(WaveformBase* wfm, Unit yunit, int64_t t1, int64_t t2);
 
    bool IsMouseOverButtonInWaveformArea();
 
    enum DragState
    {
        DRAG_STATE_NONE,
        DRAG_STATE_TIMELINE,
        DRAG_STATE_X_CURSOR0,
        DRAG_STATE_X_CURSOR1,
        DRAG_STATE_MARKER,
        DRAG_STATE_TRIGGER
    };
 
    void DoCursor(int iCursor, DragState state);
 
    int64_t GetRoundingDivisor(int64_t width_xunits);
    void OnMouseWheel(float delta);
 
    MainWindow* m_parent;
 
    float m_xpos;
 
    float m_width;
 
    float m_pixelsPerXUnit;
 
    int64_t m_xAxisOffset;
 
    std::string m_title;
 
    std::string m_id;
 
    Unit m_xAxisUnit;
 
    std::vector< std::shared_ptr<WaveformArea> > m_areas;
 
    //Mutex for controlling access to m_areas
    std::mutex m_areaMutex;
 
    DragState m_dragState;
 
    Marker* m_dragMarker;
 
    double m_tLastMouseMove;
 
    std::vector< std::shared_ptr<WaveformArea> > m_areasToClose;
 
    float m_timelineHeight;
 
    std::atomic<bool> m_clearPersistence;
 
    bool m_mouseOverTriggerArrow;
 
    bool m_mouseOverMarker;
 
    std::shared_ptr<Oscilloscope> m_scopeTriggerDuringDrag;
 
    bool m_displayingEye;
 
public:
 
    enum CursorMode_t
    {
        X_CURSOR_NONE,
        X_CURSOR_SINGLE,
        X_CURSOR_DUAL
    } m_xAxisCursorMode;
 
    int64_t m_xAxisCursorPositions[2];
};
 
#endif