ED_numinput.h

Go to the documentation of this file.

/*
 * This program is free software; you can redistribute it and/or
 * modify it under the terms of the GNU General Public License
 * as published by the Free Software Foundation; either version 2
 * of the License, or (at your option) any later version.
 *
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License
 * along with this program; if not, write to the Free Software Foundation,
 * Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
 */
 
#pragma once
 
#ifdef __cplusplus
extern "C" {
#endif
 
#define NUM_STR_REP_LEN 64
#define NUM_MAX_ELEMENTS 3
 
struct wmEvent;
 
typedef 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;
} NumInput;
 
/* NumInput.flag */
enum {
  NUM_AFFECT_ALL = (1 << 0),
  /* (1 << 9) and above are reserved for internal flags! */
};
 
/* NumInput.val_flag[] */
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! */
};
 
struct UnitSettings;
 
/* -------------------------------------------------------------------- */
void initNumInput(NumInput *n);
void outputNumInput(NumInput *n, char *str, struct UnitSettings *unit_settings);
bool hasNumInput(const NumInput *n);
bool applyNumInput(NumInput *n, float *vec);
bool handleNumInput(struct bContext *C, NumInput *n, const struct 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 struct UnitSettings *unit,
                           int type,
                           double *r_value,
                           const bool use_single_line_error,
                           char **r_error);
 
#ifdef __cplusplus
}
#endif