Documenting the lissajous explorer application

Author

Berthold Höllmann

Time-stamp

<2022-10-15 15:13:50 hoel>

Copyright

Copyright © 2022 by Berthold Höllmann

Application

Calculates Lissajous curves. The user provides frequencies in \(x\) and \(y\) direction, as well phase shift for both direcions.

Frequencies can range from \(1\) to \(255\), phase shift values from \(-\pi\) to \(\pi\).

Animation of the iterative calculation of the intermediate calculation points. Parameters: \(x_\text{frequency} := 1\), \(y_\text{frequency} := 1\), \(x_\text{phase} := 0.0\), \(y_\text{phase} := 0.0\).

Animation of the iterative calculation of the intermediate calculation points. Parameters: \(x\text{frequency} := 2\), \(y_\text{frequency} := 3\), \(x_\text{phase} := 1.8\), \(y_\text{phase} := 0.8\).

API

class LissajousExplorer : public QWidget

#include <mainwindow.h>

Inheritence diagram for LissajousExplorer:

Collaboration diagram for LissajousExplorer:

Wrapper for main widget generated from Qt Designer.

Public Functions

explicit LissajousExplorer(double xPhase, double yPhase, int xFreq, int yFreq, bool gen_pics, QWidget *parent = nullptr)

void changeEvent(QEvent*) override

Handle windws resize and other changes.

Public Slots

void on_quitButton_clicked()

Handle the quit button: quit the program.

void on_pdfButton_clicked()

void on_pngButton_clicked()

void on_svgButton_clicked()

void setXPhaseValue(double)

void setYPhaseValue(double)

void setXFreqValue(int)

void setYFreqValue(int)

Protected Functions

void keyPressEvent(QKeyEvent *event) override

Private Functions

void drawLissajous()

void plot(QQueue<QPair<double, QPointF>>&, QPen *pen = nullptr, bool addScatter = false)

void exportPdf()

void exportSvg()

void exportPng(int iteration = -1)

Private Members

int xFreq

int yFreq

double xPhase

double yPhase

bool gen_pics

QLineSeries *lissajousCurve

Ui::LissajousExplorerUi *ui

QT Designer created main widget.

namespace Ui

file config.h

This graph shows which files directly or indirectly include config.h:

Confioguration for qHeiseReg.

Time-stamp: <2022-10-09 17:43:13 hoel>

Author

Berthold Höllmann berhoel@gmail.com

Copyright

Copyright © 2022 by Berthold Höllmann

Defines

PROJECT_NAME

Project name from CMakeLists.txt.

PROJECT_VER

Project version from CMakeLists.txt.

PROJECT_VER_MAJOR

Project major version number from CMakeLists.txt.

PROJECT_VER_MINOR

Project minor version number from CMakeLists.txt.

PTOJECT_VER_PATCH

Project patch version number from CMakeLists.txt.

file main.cpp

#include “mainwindow.h”

#include <QApplication>

#include <QCommandLineOption>

#include <QCommandLineParser>

#include <QTranslator>

Include dependency graph for main.cpp:

Explore Lissajous figures.

Time-stamp: <2022-10-21 20:52:14 hoel>

Detailed description

Author

Berthold Höllmann berhoel@gmail.com

Copyright

Copyright © 2019 by Berthold Höllmann

Functions

auto main(int argc, char *argv[]) -> int

file mainwindow.cpp

#include “mainwindow.h”

#include “ui_lissajous_explorer.h”

#include <algorithm>

#include <iostream>

#include <numbers>

#include <QTranslator>

#include <QVector>

#include <QPainter>

#include <QPdfWriter>

#include <QApplication>

#include <QLineSeries>

#include <QPixmap>

#include <QScatterSeries>

#include <QSvgGenerator>

Include dependency graph for mainwindow.cpp:

Main window widget.

Time-stamp: <2022-10-21 20:52:13 hoel>

Detailed description

Author

Berthold Höllmann berhoel@gmail.com

Copyright

Copyright © 2022 by Berthold Höllmann

file mainwindow.h

#include “config.h”

#include <cmath>

#include <QPair>

#include <QQueue>

#include <QWidget>

Include dependency graph for mainwindow.h:

This graph shows which files directly or indirectly include mainwindow.h:

Definition for lissajous explorer.

Time-stamp: <2022-10-21 21:08:37 hoel>

More to come?

Author

Berthold Höllmann berhoel@gmail.com

Copyright

Copyright © 2022 by Berthold Höllmann

dir qlissajousexplorer/src/lissajous_explorer

dir qlissajousexplorer

dir qlissajousexplorer/src