Blender V4.3
wm_xr_actionmap.cc File Reference
Blender » GUI » Window Manager
#include <cmath>
#include <cstring>
#include "BKE_idprop.hh"
#include "BLI_listbase.h"
#include "BLI_string.h"
#include "MEM_guardedalloc.h"
#include "WM_api.hh"
#include "WM_types.hh"
#include "wm_xr_intern.hh"

Go to the source code of this file.

Macros

Window-Manager XR Action Maps

XR actionmap API, similar to WM keymap API.

#define WM_XR_ACTIONMAP_STR_DEFAULT   "actionmap"
 
#define WM_XR_ACTIONMAP_ITEM_STR_DEFAULT   "action"
 
#define WM_XR_ACTIONMAP_BINDING_STR_DEFAULT   "binding"
 

Functions

Action Map Binding

Binding in an XR action map item, that maps an action to an XR input.

XrActionMapBinding * WM_xr_actionmap_binding_new (XrActionMapItem *ami, const char *name, bool replace_existing)
 
static XrActionMapBinding * wm_xr_actionmap_binding_find_except (XrActionMapItem *ami, const char *name, XrActionMapBinding *ambexcept)
 
void WM_xr_actionmap_binding_ensure_unique (XrActionMapItem *ami, XrActionMapBinding *amb)
 
static XrActionMapBinding * wm_xr_actionmap_binding_copy (XrActionMapBinding *amb_src)
 
XrActionMapBinding * WM_xr_actionmap_binding_add_copy (XrActionMapItem *ami, XrActionMapBinding *amb_src)
 
static void wm_xr_actionmap_binding_clear (XrActionMapBinding *amb)
 
bool WM_xr_actionmap_binding_remove (XrActionMapItem *ami, XrActionMapBinding *amb)
 
XrActionMapBinding * WM_xr_actionmap_binding_find (XrActionMapItem *ami, const char *name)
 
Action Map Item

Item in an XR action map, that maps an XR event to an operator, pose, or haptic output.

static void wm_xr_actionmap_item_properties_set (XrActionMapItem *ami)
 
static void wm_xr_actionmap_item_properties_free (XrActionMapItem *ami)
 
static void wm_xr_actionmap_item_clear (XrActionMapItem *ami)
 
void WM_xr_actionmap_item_properties_update_ot (XrActionMapItem *ami)
 
XrActionMapItem * WM_xr_actionmap_item_new (XrActionMap *actionmap, const char *name, bool replace_existing)
 
static XrActionMapItem * wm_xr_actionmap_item_find_except (XrActionMap *actionmap, const char *name, const XrActionMapItem *amiexcept)
 
void WM_xr_actionmap_item_ensure_unique (XrActionMap *actionmap, XrActionMapItem *ami)
 
static XrActionMapItem * wm_xr_actionmap_item_copy (XrActionMapItem *ami_src)
 
XrActionMapItem * WM_xr_actionmap_item_add_copy (XrActionMap *actionmap, XrActionMapItem *ami_src)
 
bool WM_xr_actionmap_item_remove (XrActionMap *actionmap, XrActionMapItem *ami)
 
XrActionMapItem * WM_xr_actionmap_item_find (XrActionMap *actionmap, const char *name)
 
Action Map

List of XR action map items.

XrActionMap * WM_xr_actionmap_new (wmXrRuntimeData *runtime, const char *name, bool replace_existing)
 
static XrActionMap * wm_xr_actionmap_find_except (wmXrRuntimeData *runtime, const char *name, const XrActionMap *am_except)
 
void WM_xr_actionmap_ensure_unique (wmXrRuntimeData *runtime, XrActionMap *actionmap)
 
static XrActionMap * wm_xr_actionmap_copy (XrActionMap *am_src)
 
XrActionMap * WM_xr_actionmap_add_copy (wmXrRuntimeData *runtime, XrActionMap *am_src)
 
bool WM_xr_actionmap_remove (wmXrRuntimeData *runtime, XrActionMap *actionmap)
 
XrActionMap * WM_xr_actionmap_find (wmXrRuntimeData *runtime, const char *name)
 
void WM_xr_actionmap_clear (XrActionMap *actionmap)
 
void WM_xr_actionmaps_clear (wmXrRuntimeData *runtime)
 
ListBase * WM_xr_actionmaps_get (wmXrRuntimeData *runtime)
 
short WM_xr_actionmap_active_index_get (const wmXrRuntimeData *runtime)
 
void WM_xr_actionmap_active_index_set (wmXrRuntimeData *runtime, short idx)
 
short WM_xr_actionmap_selected_index_get (const wmXrRuntimeData *runtime)
 
void WM_xr_actionmap_selected_index_set (wmXrRuntimeData *runtime, short idx)
 

Macro Definition Documentation

◆ WM_XR_ACTIONMAP_BINDING_STR_DEFAULT

#define WM_XR_ACTIONMAP_BINDING_STR_DEFAULT   "binding"

Definition at line 30 of file wm_xr_actionmap.cc.

Referenced by WM_xr_actionmap_binding_ensure_unique().

◆ WM_XR_ACTIONMAP_ITEM_STR_DEFAULT

#define WM_XR_ACTIONMAP_ITEM_STR_DEFAULT   "action"

Definition at line 29 of file wm_xr_actionmap.cc.

Referenced by WM_xr_actionmap_item_ensure_unique().

◆ WM_XR_ACTIONMAP_STR_DEFAULT

#define WM_XR_ACTIONMAP_STR_DEFAULT   "actionmap"

Definition at line 28 of file wm_xr_actionmap.cc.

Referenced by WM_xr_actionmap_ensure_unique().

Function Documentation

◆ WM_xr_actionmap_active_index_get()

short WM_xr_actionmap_active_index_get ( const wmXrRuntimeData * runtime)

Definition at line 529 of file wm_xr_actionmap.cc.

References wmXrRuntimeData::actactionmap.

◆ WM_xr_actionmap_active_index_set()

void WM_xr_actionmap_active_index_set ( wmXrRuntimeData * runtime,
short idx )

Definition at line 534 of file wm_xr_actionmap.cc.

References wmXrRuntimeData::actactionmap.

◆ WM_xr_actionmap_add_copy()

XrActionMap * WM_xr_actionmap_add_copy ( wmXrRuntimeData * runtime,
XrActionMap * am_src )

Definition at line 460 of file wm_xr_actionmap.cc.

References wmXrRuntimeData::actionmaps, BLI_addtail(), wm_xr_actionmap_copy(), and WM_xr_actionmap_ensure_unique().

◆ WM_xr_actionmap_binding_add_copy()

XrActionMapBinding * WM_xr_actionmap_binding_add_copy ( XrActionMapItem * ami,
XrActionMapBinding * amb_src )

Definition at line 115 of file wm_xr_actionmap.cc.

References XrActionMapItem::bindings, BLI_addtail(), wm_xr_actionmap_binding_copy(), and WM_xr_actionmap_binding_ensure_unique().

◆ wm_xr_actionmap_binding_clear()

static void wm_xr_actionmap_binding_clear ( XrActionMapBinding * amb)
static

Definition at line 127 of file wm_xr_actionmap.cc.

References BLI_freelistN(), and XrActionMapBinding::component_paths.

Referenced by WM_xr_actionmap_binding_remove(), and wm_xr_actionmap_item_clear().

◆ wm_xr_actionmap_binding_copy()

static XrActionMapBinding * wm_xr_actionmap_binding_copy ( XrActionMapBinding * amb_src)
static

Definition at line 101 of file wm_xr_actionmap.cc.

References BLI_addtail(), BLI_listbase_clear(), XrActionMapBinding::component_paths, LISTBASE_FOREACH, MEM_dupallocN, XrActionMapBinding::next, and XrActionMapBinding::prev.

Referenced by WM_xr_actionmap_binding_add_copy(), and wm_xr_actionmap_item_copy().

◆ WM_xr_actionmap_binding_ensure_unique()

void WM_xr_actionmap_binding_ensure_unique ( XrActionMapItem * ami,
XrActionMapBinding * amb )

Definition at line 74 of file wm_xr_actionmap.cc.

References BLI_snprintf(), BLI_strnlen(), MAX_NAME, XrActionMapBinding::name, STRNCPY, wm_xr_actionmap_binding_find_except(), and WM_XR_ACTIONMAP_BINDING_STR_DEFAULT.

Referenced by WM_xr_actionmap_binding_add_copy(), and WM_xr_actionmap_binding_new().

◆ WM_xr_actionmap_binding_find()

XrActionMapBinding * WM_xr_actionmap_binding_find ( XrActionMapItem * ami,
const char * name )

Definition at line 152 of file wm_xr_actionmap.cc.

References XrActionMapItem::bindings, LISTBASE_FOREACH, MAX_NAME, and STREQLEN.

Referenced by WM_xr_actionmap_binding_new().

◆ wm_xr_actionmap_binding_find_except()

static XrActionMapBinding * wm_xr_actionmap_binding_find_except ( XrActionMapItem * ami,
const char * name,
XrActionMapBinding * ambexcept )
static

Definition at line 62 of file wm_xr_actionmap.cc.

References XrActionMapItem::bindings, LISTBASE_FOREACH, MAX_NAME, and STREQLEN.

Referenced by WM_xr_actionmap_binding_ensure_unique().

◆ WM_xr_actionmap_binding_new()

XrActionMapBinding * WM_xr_actionmap_binding_new ( XrActionMapItem * ami,
const char * name,
bool replace_existing )

Definition at line 38 of file wm_xr_actionmap.cc.

References XrActionMapItem::bindings, BLI_addtail(), XrActionMapBinding::float_threshold, MEM_callocN, XrActionMapBinding::name, STRNCPY, WM_xr_actionmap_binding_ensure_unique(), and WM_xr_actionmap_binding_find().

◆ WM_xr_actionmap_binding_remove()

bool WM_xr_actionmap_binding_remove ( XrActionMapItem * ami,
XrActionMapBinding * amb )

Definition at line 132 of file wm_xr_actionmap.cc.

References XrActionMapItem::bindings, BLI_findindex(), BLI_freelinkN(), XrActionMapItem::selbinding, and wm_xr_actionmap_binding_clear().

◆ WM_xr_actionmap_clear()

void WM_xr_actionmap_clear ( XrActionMap * actionmap)

Definition at line 506 of file wm_xr_actionmap.cc.

References BLI_freelistN(), XrActionMap::items, LISTBASE_FOREACH, XrActionMap::selitem, and wm_xr_actionmap_item_clear().

Referenced by WM_xr_actionmap_new(), WM_xr_actionmap_remove(), and WM_xr_actionmaps_clear().

◆ wm_xr_actionmap_copy()

static XrActionMap * wm_xr_actionmap_copy ( XrActionMap * am_src)
static

Definition at line 446 of file wm_xr_actionmap.cc.

References BLI_addtail(), BLI_listbase_clear(), XrActionMap::items, LISTBASE_FOREACH, MEM_dupallocN, XrActionMap::next, XrActionMap::prev, and wm_xr_actionmap_item_copy().

Referenced by WM_xr_actionmap_add_copy().

◆ WM_xr_actionmap_ensure_unique()

void WM_xr_actionmap_ensure_unique ( wmXrRuntimeData * runtime,
XrActionMap * actionmap )

Definition at line 419 of file wm_xr_actionmap.cc.

References BLI_snprintf(), BLI_strnlen(), MAX_NAME, XrActionMap::name, STRNCPY, wm_xr_actionmap_find_except(), and WM_XR_ACTIONMAP_STR_DEFAULT.

Referenced by WM_xr_actionmap_add_copy(), and WM_xr_actionmap_new().

◆ WM_xr_actionmap_find()

XrActionMap * WM_xr_actionmap_find ( wmXrRuntimeData * runtime,
const char * name )

Definition at line 496 of file wm_xr_actionmap.cc.

References wmXrRuntimeData::actionmaps, LISTBASE_FOREACH, MAX_NAME, and STREQLEN.

Referenced by WM_xr_actionmap_new().

◆ wm_xr_actionmap_find_except()

static XrActionMap * wm_xr_actionmap_find_except ( wmXrRuntimeData * runtime,
const char * name,
const XrActionMap * am_except )
static

Definition at line 406 of file wm_xr_actionmap.cc.

References wmXrRuntimeData::actionmaps, LISTBASE_FOREACH, MAX_NAME, and STREQLEN.

Referenced by WM_xr_actionmap_ensure_unique().

◆ WM_xr_actionmap_item_add_copy()

XrActionMapItem * WM_xr_actionmap_item_add_copy ( XrActionMap * actionmap,
XrActionMapItem * ami_src )

Definition at line 338 of file wm_xr_actionmap.cc.

References BLI_addtail(), XrActionMap::items, wm_xr_actionmap_item_copy(), and WM_xr_actionmap_item_ensure_unique().

◆ wm_xr_actionmap_item_clear()

static void wm_xr_actionmap_item_clear ( XrActionMapItem * ami)
static

Definition at line 189 of file wm_xr_actionmap.cc.

References XrActionMapItem::bindings, BLI_freelistN(), LISTBASE_FOREACH, XrActionMapItem::selbinding, XrActionMapItem::user_paths, wm_xr_actionmap_binding_clear(), and wm_xr_actionmap_item_properties_free().

Referenced by WM_xr_actionmap_clear(), and WM_xr_actionmap_item_remove().

◆ wm_xr_actionmap_item_copy()

static XrActionMapItem * wm_xr_actionmap_item_copy ( XrActionMapItem * ami_src)
static

Definition at line 306 of file wm_xr_actionmap.cc.

References XrActionMapItem::bindings, BLI_addtail(), BLI_listbase_clear(), PointerRNA::data, IDP_CopyProperty(), LISTBASE_FOREACH, MEM_callocN, MEM_dupallocN, XrActionMapItem::next, XrActionMapItem::op, XrActionMapItem::op_properties, XrActionMapItem::op_properties_ptr, XrActionMapItem::prev, XrActionMapItem::user_paths, WM_operator_properties_create(), and wm_xr_actionmap_binding_copy().

Referenced by wm_xr_actionmap_copy(), and WM_xr_actionmap_item_add_copy().

◆ WM_xr_actionmap_item_ensure_unique()

void WM_xr_actionmap_item_ensure_unique ( XrActionMap * actionmap,
XrActionMapItem * ami )

Definition at line 279 of file wm_xr_actionmap.cc.

References BLI_snprintf(), BLI_strnlen(), MAX_NAME, XrActionMapItem::name, STRNCPY, wm_xr_actionmap_item_find_except(), and WM_XR_ACTIONMAP_ITEM_STR_DEFAULT.

Referenced by WM_xr_actionmap_item_add_copy(), and WM_xr_actionmap_item_new().

◆ WM_xr_actionmap_item_find()

XrActionMapItem * WM_xr_actionmap_item_find ( XrActionMap * actionmap,
const char * name )

Definition at line 369 of file wm_xr_actionmap.cc.

References XrActionMap::items, LISTBASE_FOREACH, MAX_NAME, and STREQLEN.

Referenced by WM_xr_actionmap_item_new().

◆ wm_xr_actionmap_item_find_except()

static XrActionMapItem * wm_xr_actionmap_item_find_except ( XrActionMap * actionmap,
const char * name,
const XrActionMapItem * amiexcept )
static

Definition at line 267 of file wm_xr_actionmap.cc.

References XrActionMap::items, LISTBASE_FOREACH, MAX_NAME, and STREQLEN.

Referenced by WM_xr_actionmap_item_ensure_unique().

◆ WM_xr_actionmap_item_new()

XrActionMapItem * WM_xr_actionmap_item_new ( XrActionMap * actionmap,
const char * name,
bool replace_existing )

Definition at line 242 of file wm_xr_actionmap.cc.

References BLI_addtail(), XrActionMap::items, MEM_callocN, XrActionMapItem::name, STRNCPY, XrActionMapItem::type, WM_xr_actionmap_item_ensure_unique(), WM_xr_actionmap_item_find(), wm_xr_actionmap_item_properties_free(), and XR_FLOAT_INPUT.

◆ wm_xr_actionmap_item_properties_free()

static void wm_xr_actionmap_item_properties_free ( XrActionMapItem * ami)
static

Definition at line 176 of file wm_xr_actionmap.cc.

References BLI_assert, MEM_freeN(), XrActionMapItem::op_properties, XrActionMapItem::op_properties_ptr, and WM_operator_properties_free().

Referenced by wm_xr_actionmap_item_clear(), WM_xr_actionmap_item_new(), and WM_xr_actionmap_item_properties_update_ot().

◆ wm_xr_actionmap_item_properties_set()

static void wm_xr_actionmap_item_properties_set ( XrActionMapItem * ami)
static

Definition at line 170 of file wm_xr_actionmap.cc.

References XrActionMapItem::op, XrActionMapItem::op_properties, XrActionMapItem::op_properties_ptr, WM_operator_properties_alloc(), and WM_operator_properties_sanitize().

Referenced by WM_xr_actionmap_item_properties_update_ot().

◆ WM_xr_actionmap_item_properties_update_ot()

void WM_xr_actionmap_item_properties_update_ot ( XrActionMapItem * ami)

Definition at line 202 of file wm_xr_actionmap.cc.

References PointerRNA::data, XrActionMapItem::op, XrActionMapItem::op_properties, XrActionMapItem::op_properties_ptr, ot, wmOperatorType::srna, PointerRNA::type, XrActionMapItem::type, WM_operator_properties_create_ptr(), WM_operator_properties_sanitize(), WM_operatortype_find(), wm_xr_actionmap_item_properties_free(), wm_xr_actionmap_item_properties_set(), XR_BOOLEAN_INPUT, XR_FLOAT_INPUT, XR_POSE_INPUT, XR_VECTOR2F_INPUT, and XR_VIBRATION_OUTPUT.

◆ WM_xr_actionmap_item_remove()

bool WM_xr_actionmap_item_remove ( XrActionMap * actionmap,
XrActionMapItem * ami )

Definition at line 349 of file wm_xr_actionmap.cc.

References BLI_findindex(), BLI_freelinkN(), XrActionMap::items, XrActionMap::selitem, and wm_xr_actionmap_item_clear().

◆ WM_xr_actionmap_new()

XrActionMap * WM_xr_actionmap_new ( wmXrRuntimeData * runtime,
const char * name,
bool replace_existing )

Definition at line 387 of file wm_xr_actionmap.cc.

References wmXrRuntimeData::actionmaps, BLI_addtail(), MEM_callocN, XrActionMap::name, STRNCPY, WM_xr_actionmap_clear(), WM_xr_actionmap_ensure_unique(), and WM_xr_actionmap_find().

◆ WM_xr_actionmap_remove()

bool WM_xr_actionmap_remove ( wmXrRuntimeData * runtime,
XrActionMap * actionmap )

Definition at line 471 of file wm_xr_actionmap.cc.

References wmXrRuntimeData::actactionmap, wmXrRuntimeData::actionmaps, BLI_findindex(), BLI_freelinkN(), wmXrRuntimeData::selactionmap, and WM_xr_actionmap_clear().

◆ WM_xr_actionmap_selected_index_get()

short WM_xr_actionmap_selected_index_get ( const wmXrRuntimeData * runtime)

Definition at line 539 of file wm_xr_actionmap.cc.

References wmXrRuntimeData::selactionmap.

◆ WM_xr_actionmap_selected_index_set()

void WM_xr_actionmap_selected_index_set ( wmXrRuntimeData * runtime,
short idx )

Definition at line 544 of file wm_xr_actionmap.cc.

References wmXrRuntimeData::selactionmap.

◆ WM_xr_actionmaps_clear()

void WM_xr_actionmaps_clear ( wmXrRuntimeData * runtime)

Definition at line 515 of file wm_xr_actionmap.cc.

References wmXrRuntimeData::actactionmap, wmXrRuntimeData::actionmaps, BLI_freelistN(), LISTBASE_FOREACH, wmXrRuntimeData::selactionmap, and WM_xr_actionmap_clear().

Referenced by wm_xr_runtime_data_free().

◆ WM_xr_actionmaps_get()

ListBase * WM_xr_actionmaps_get ( wmXrRuntimeData * runtime)

Definition at line 524 of file wm_xr_actionmap.cc.

References wmXrRuntimeData::actionmaps.

Generated on Thu Feb 6 2025 07:36:39 for Blender by  doxygen 1.11.0