ED_numinput.hh

Go to the documentation of this file.

/* SPDX-FileCopyrightText: 2023 Blender Authors
 *
 * SPDX-License-Identifier: GPL-2.0-or-later */
 
#pragma once
 
#define NUM_STR_REP_LEN 64
#define NUM_MAX_ELEMENTS 3
 
struct wmEvent;
struct UnitSettings;
 
struct NumInput {
  short idx_max;
  int unit_sys;
  int unit_type[NUM_MAX_ELEMENTS];
  bool unit_use_radians;
 
  short flag;
  short val_flag[NUM_MAX_ELEMENTS];
  float val[NUM_MAX_ELEMENTS];
  float val_org[NUM_MAX_ELEMENTS];
  float val_inc[NUM_MAX_ELEMENTS];
 
  short idx;
  char str[NUM_STR_REP_LEN];
  int str_cur;
};
 
enum {
  NUM_AFFECT_ALL = (1 << 0),
  /* (1 << 9) and above are reserved for internal flags! */
};
 
enum {
  /* Public! */
  NUM_NULL_ONE = (1 << 0),
  NUM_NO_NEGATIVE = (1 << 1),
  NUM_NO_ZERO = (1 << 2),
  NUM_NO_FRACTION = (1 << 3),
  /* (1 << 9) and above are reserved for internal flags! */
};
 
/* -------------------------------------------------------------------- */
void initNumInput(NumInput *n);
void outputNumInput(NumInput *n, char *str, const UnitSettings *unit_settings);
bool hasNumInput(const NumInput *n);
bool applyNumInput(NumInput *n, float *vec);
bool handleNumInput(bContext *C, NumInput *n, const wmEvent *event);
 
#define NUM_MODAL_INCREMENT_UP 18
#define NUM_MODAL_INCREMENT_DOWN 19
 
bool user_string_to_number(bContext *C,
                           const char *str,
                           const UnitSettings *unit,
                           int type,
                           double *r_value,
                           bool use_single_line_error,
                           char **r_error);