Quantum Phenomena Explorer 7.9.8
Interactive quantum-phenomena Explorer Tutor — source documentation
Loading...
Searching...
No Matches
qpe::PotentialEditor2D Class Reference

Implements the Potential Editor2D component. More...

#include <quantumpotentialeditor2d.h>

Static Public Member Functions

static PotentialEditorShape rectangleFromDrag (float x1, float y1, float x2, float y2, float minimumWidth, float minimumHeight) noexcept
 Performs rectangle from drag.
 
static PotentialEditorShape circleFromDrag (float centerX, float centerY, float edgeX, float edgeY, float minimumRadius) noexcept
 Performs circle from drag.
 

Detailed Description

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.

Definition at line 52 of file quantumpotentialeditor2d.h.

Member Function Documentation

◆ circleFromDrag()

PotentialEditorShape qpe::PotentialEditor2D::circleFromDrag ( float centerX,
float centerY,
float edgeX,
float edgeY,
float minimumRadius )
staticnoexcept

Performs circle from drag.

Parameters
centerXThe center x value used by the operation.
centerYThe center y value used by the operation.
edgeXThe edge x value used by the operation.
edgeYThe edge y value used by the operation.
minimumRadiusThe minimum radius value used by the operation.

Definition at line 51 of file quantumpotentialeditor2d.cpp.

References qpe::PotentialEditorShape::centerX, qpe::PotentialEditorShape::centerY, qpe::Circle, qpe::PotentialEditorShape::radius, and qpe::PotentialEditorShape::tool.

Referenced by QuantumGLView::mouseReleaseEvent(), and qpe::tests::runQuantumPotentialEditor2DTests().

◆ rectangleFromDrag()

PotentialEditorShape qpe::PotentialEditor2D::rectangleFromDrag ( float x1,
float y1,
float x2,
float y2,
float minimumWidth,
float minimumHeight )
staticnoexcept

Performs rectangle from drag.

Parameters
x1The x1 value used by the operation.
y1The y1 value used by the operation.
x2The x2 value used by the operation.
y2The y2 value used by the operation.
minimumWidthThe minimum width value used by the operation.
minimumHeightThe minimum height value used by the operation.

Definition at line 35 of file quantumpotentialeditor2d.cpp.

References qpe::PotentialEditorShape::centerX, qpe::PotentialEditorShape::centerY, qpe::PotentialEditorShape::height, qpe::Rectangle, qpe::PotentialEditorShape::tool, and qpe::PotentialEditorShape::width.

Referenced by QuantumGLView::mouseReleaseEvent(), and qpe::tests::runQuantumPotentialEditor2DTests().


The documentation for this class was generated from the following files: