Files
test/source/blender/blenlib/BLI_dial_2d.h
Bastien Montagne 8045576c60 Cleanup: Avoid some void pointer freeing for type safety
Essentially add some API to properly free non-public data, instead of directly calling `MEM_freeN` on them.

Based on @brecht code from
https://projects.blender.org/mont29/blender/compare/tmp-guardedalloc-api...brecht:free-void

Co-authored-by: Brecht Van Lommel <brecht@blender.org>
Pull Request: https://projects.blender.org/blender/blender/pulls/134765
2025-02-20 11:24:34 +01:00

42 lines
1.1 KiB
C

/* SPDX-FileCopyrightText: 2023 Blender Authors
*
* 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);
*
* BLI_dial_free(dial);
* \endcode
*/
typedef struct Dial Dial;
Dial *BLI_dial_init(const float start_position[2], float threshold);
void BLI_dial_free(Dial *dial);
float BLI_dial_angle(Dial *dial, const float current_position[2]);