ED_select_utils.hh

Go to the documentation of this file.

/* SPDX-FileCopyrightText: 2023 Blender Authors
 *
 * SPDX-License-Identifier: GPL-2.0-or-later */

 
#pragma once
 
#include <string>
 
#include "BLI_compiler_attrs.h"
 
struct KDTree_1d;
struct PointerRNA;
struct wmOperatorType;
 
enum {
  SEL_TOGGLE = 0,
  SEL_SELECT = 1,
  SEL_DESELECT = 2,
  SEL_INVERT = 3,
};
 
enum WalkSelectDirection {
  UI_SELECT_WALK_UP,
  UI_SELECT_WALK_DOWN,
  UI_SELECT_WALK_LEFT,
  UI_SELECT_WALK_RIGHT,
};

enum eSelectOp : int8_t {
  SEL_OP_ADD = 1,
  SEL_OP_SUB,
  SEL_OP_SET,
  SEL_OP_AND,
  SEL_OP_XOR,
};

enum eSimilarCmp {
  SIM_CMP_EQ = 0,
  SIM_CMP_GT,
  SIM_CMP_LT,
};
 
#define SEL_OP_USE_OUTSIDE(sel_op) (ELEM(sel_op, SEL_OP_AND))
#define SEL_OP_USE_PRE_DESELECT(sel_op) (ELEM(sel_op, SEL_OP_SET))
#define SEL_OP_CAN_DESELECT(sel_op) (!ELEM(sel_op, SEL_OP_ADD))

int ED_select_op_action(eSelectOp sel_op, bool is_select, bool is_inside);
int ED_select_op_action_deselected(eSelectOp sel_op, bool is_select, bool is_inside);
 
bool ED_select_similar_compare_float(float delta, float thresh, eSimilarCmp compare);
bool ED_select_similar_compare_float_tree(const KDTree_1d *tree,
                                          float length,
                                          float thresh,
                                          eSimilarCmp compare);

eSelectOp ED_select_op_modal(eSelectOp sel_op, bool is_first);

struct SelectPick_Params {
  eSelectOp sel_op = SEL_OP_SET;
  bool deselect_all = false;
  bool select_passthrough = false;
};

eSelectOp ED_select_op_from_operator(PointerRNA *ptr) ATTR_WARN_UNUSED_RESULT;

SelectPick_Params ED_select_pick_params_from_operator(PointerRNA *ptr) ATTR_NONNULL(1);

std::string ED_select_pick_get_name(wmOperatorType *ot, PointerRNA *ptr);
std::string ED_select_circle_get_name(wmOperatorType *ot, PointerRNA *ptr);