Campbell Barton
c434782e3a
Use a shorter/simpler license convention, stops the header taking so much space. Follow the SPDX license specification: https://spdx.org/licenses - C/C++/objc/objc++ - Python - Shell Scripts - CMake, GNUmakefile While most of the source tree has been included - `./extern/` was left out. - `./intern/cycles` & `./intern/atomic` are also excluded because they use different header conventions. doc/license/SPDX-license-identifiers.txt has been added to list SPDX all used identifiers. See P2788 for the script that automated these edits. Reviewed By: brecht, mont29, sergey Ref D14069
47 lines
1.1 KiB
C++
47 lines
1.1 KiB
C++
/* SPDX-License-Identifier: GPL-2.0-or-later */
|
|
|
|
#pragma once
|
|
|
|
/** \file
|
|
* \ingroup bli
|
|
*
|
|
* \note dials act similar to old rotation based phones and output an angle.
|
|
*
|
|
* They just are initialized with the center of the dial and a threshold value as input.
|
|
*
|
|
* When the distance of the current position of the dial from the center
|
|
* exceeds the threshold, this position is used to calculate the initial direction.
|
|
* After that, the angle from the initial direction is calculated based on
|
|
* current and previous directions of the digit, and returned to the user.
|
|
*
|
|
* Usage examples:
|
|
*
|
|
* \code{.c}
|
|
* float start_position[2] = {0.0f, 0.0f};
|
|
* float current_position[2];
|
|
* float threshold = 0.5f;
|
|
* float angle;
|
|
* Dial *dial;
|
|
*
|
|
* dial = BLI_dial_init(start_position, threshold);
|
|
*
|
|
* angle = BLI_dial_angle(dial, current_position);
|
|
*
|
|
* MEM_freeN(dial);
|
|
* \endcode
|
|
*/
|
|
|
|
#ifdef __cplusplus
|
|
extern "C" {
|
|
#endif
|
|
|
|
typedef struct Dial Dial;
|
|
|
|
Dial *BLI_dial_init(const float start_position[2], float threshold);
|
|
|
|
float BLI_dial_angle(Dial *dial, const float current_position[2]);
|
|
|
|
#ifdef __cplusplus
|
|
}
|
|
#endif
|