DNA_xr_types.h

Go to the documentation of this file.

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

 
#pragma once
 
#include "DNA_view3d_types.h"
 
/* -------------------------------------------------------------------- */
 
typedef struct XrSessionSettings {
  struct View3DShading shading;
 
  float base_scale;
  char _pad[3];
  char base_pose_type; /* #eXRSessionBasePoseType */
  Object *base_pose_object;
  float base_pose_location[3];
  float base_pose_angle;

  char draw_flags;
  char controller_draw_style;
  char _pad2[2];

  float clip_start, clip_end;
 
  int flag;

  int object_type_exclude_viewport;
  int object_type_exclude_select;

  float fly_speed;
  float padding;
} XrSessionSettings;
 
typedef enum eXrSessionFlag {
  XR_SESSION_USE_POSITION_TRACKING = (1 << 0),
  XR_SESSION_USE_ABSOLUTE_TRACKING = (1 << 1),
} eXrSessionFlag;
 
typedef enum eXRSessionBasePoseType {
  XR_BASE_POSE_SCENE_CAMERA = 0,
  XR_BASE_POSE_OBJECT = 1,
  XR_BASE_POSE_CUSTOM = 2,
} eXRSessionBasePoseType;
 
typedef enum eXrSessionControllerDrawStyle {
  XR_CONTROLLER_DRAW_DARK = 0,
  XR_CONTROLLER_DRAW_LIGHT = 1,
  XR_CONTROLLER_DRAW_DARK_RAY = 2,
  XR_CONTROLLER_DRAW_LIGHT_RAY = 3,
} eXrSessionControllerDrawStyle;

typedef enum eXrActionType {
  XR_BOOLEAN_INPUT = 1,
  XR_FLOAT_INPUT = 2,
  XR_VECTOR2F_INPUT = 3,
  XR_POSE_INPUT = 4,
  XR_VIBRATION_OUTPUT = 100,
} eXrActionType;

typedef enum eXrOpFlag {
  XR_OP_PRESS = 0,
  XR_OP_RELEASE = 1,
  XR_OP_MODAL = 2,
} eXrOpFlag;
 
typedef enum eXrActionFlag {
  XR_ACTION_BIMANUAL = (1 << 0),
} eXrActionFlag;
 
typedef enum eXrHapticFlag {
  XR_HAPTIC_MATCHUSERPATHS = (1 << 0),
  XR_HAPTIC_PRESS = (1 << 1),
  XR_HAPTIC_RELEASE = (1 << 2),
  XR_HAPTIC_REPEAT = (1 << 3),
} eXrHapticFlag;

typedef enum eXrAxisFlag {
  XR_AXIS0_POS = (1 << 0),
  XR_AXIS0_NEG = (1 << 1),
  XR_AXIS1_POS = (1 << 2),
  XR_AXIS1_NEG = (1 << 3),
} eXrAxisFlag;
 
typedef enum eXrPoseFlag {
  /* Pose represents controller grip/aim. */
  XR_POSE_GRIP = (1 << 0),
  XR_POSE_AIM = (1 << 1),
} eXrPoseFlag;

#define XR_MAX_USER_PATH_LENGTH 64
#define XR_MAX_COMPONENT_PATH_LENGTH 192
 
/* -------------------------------------------------------------------- */
 
typedef struct XrComponentPath {
  struct XrComponentPath *next, *prev;
  char path[/*XR_MAX_COMPONENT_PATH_LENGTH*/ 192];
} XrComponentPath;
 
typedef struct XrActionMapBinding {
  struct XrActionMapBinding *next, *prev;

  char name[/*MAX_NAME*/ 64];

  char profile[256];
  ListBase component_paths; /* XrComponentPath */

  float float_threshold;
  short axis_flag; /* eXrAxisFlag */
  char _pad[2];

  float pose_location[3];
  float pose_rotation[3];
} XrActionMapBinding;
 
/* -------------------------------------------------------------------- */
 
typedef struct XrUserPath {
  struct XrUserPath *next, *prev;
  char path[/*XR_MAX_USER_PATH_LENGTH*/ 64];
} XrUserPath;
 
typedef struct XrActionMapItem {
  struct XrActionMapItem *next, *prev;

  char name[/*MAX_NAME*/ 64];
  char type; 
  char _pad[7];

  ListBase user_paths; /* XrUserPath */

  char op[/*OP_MAX_TYPENAME*/ 64];
  IDProperty *op_properties;
  struct PointerRNA *op_properties_ptr;
 
  short op_flag;     /* eXrOpFlag */
  short action_flag; /* eXrActionFlag */
  short haptic_flag; /* eXrHapticFlag */

  short pose_flag; /* eXrPoseFlag */

  char haptic_name[/*MAX_NAME*/ 64];
  float haptic_duration;
  float haptic_frequency;
  float haptic_amplitude;
 
  short selbinding;
  char _pad3[2];
  ListBase bindings; /* XrActionMapBinding */
} XrActionMapItem;
 
/* -------------------------------------------------------------------- */
 
typedef struct XrActionMap {
  struct XrActionMap *next, *prev;

  char name[/*MAX_NAME*/ 64];
 
  ListBase items; /* XrActionMapItem */
  short selitem;
  char _pad[6];
} XrActionMap;
 
/* -------------------------------------------------------------------- */