XrSessionSettings(bpy_struct)

base class — bpy_struct

class bpy.types.XrSessionSettings(bpy_struct)
base_pose_angle

Rotation angle around the Z-Axis to apply the rotation deltas from the VR headset to (in [-inf, inf], default 0.0)

Type:

float

base_pose_location

Coordinates to apply translation deltas from the VR headset to (array of 3 items, in [-inf, inf], default (0.0, 0.0, 0.0))

Type:

mathutils.Vector

base_pose_object

Object to take the location and rotation to which translation and rotation deltas from the VR headset will be applied to

Type:

Object

base_pose_type

Define where the location and rotation for the VR view come from, to which translation and rotation deltas from the VR headset will be applied to (default 'SCENE_CAMERA')

  • SCENE_CAMERA Scene Camera – Follow the active scene camera to define the VR view’s base pose.

  • OBJECT Object – Follow the transformation of an object to define the VR view’s base pose.

  • CUSTOM Custom – Follow a custom transformation to define the VR view’s base pose.

Type:

Literal[‘SCENE_CAMERA’, ‘OBJECT’, ‘CUSTOM’]

base_scale

Uniform base pose scale to apply to VR view (in [1e-06, inf], default 1.0)

Type:

float

clip_end

VR viewport far clipping distance (in [1e-06, inf], default 0.0)

Type:

float

clip_start

VR viewport near clipping distance (in [1e-06, inf], default 0.0)

Type:

float

controller_draw_style

Style to use when drawing VR controllers (default 'DARK')

  • DARK Dark – Draw dark controller.

  • LIGHT Light – Draw light controller.

  • DARK_RAY Dark + Ray – Draw dark controller with aiming axis ray.

  • LIGHT_RAY Light + Ray – Draw light controller with aiming axis ray.

Type:

Literal[‘DARK’, ‘LIGHT’, ‘DARK_RAY’, ‘LIGHT_RAY’]

fly_speed

Fly speed in meters per second (in [1e-06, inf], default 0.0)

Type:

float

icon_from_show_object_viewport

(in [-inf, inf], default 0, readonly)

Type:

int

shading

(readonly, never None)

Type:

View3DShading

show_annotation

Show annotations for this view (default False)

Type:

bool

show_controllers

Show VR controllers (requires VR actions for controller poses) (default False)

Type:

bool

show_custom_overlays

Show custom VR overlays (default False)

Type:

bool

show_floor

Show the ground plane grid (default False)

Type:

bool

show_object_extras

Show object extras, including empties, lights, and cameras (default False)

Type:

bool

show_object_select_armature

Allow selection of armatures (default True)

Type:

bool

show_object_select_camera

Allow selection of cameras (default True)

Type:

bool

show_object_select_curve

Allow selection of curves (default True)

Type:

bool

show_object_select_curves

Allow selection of hair curves (default True)

Type:

bool

show_object_select_empty

Allow selection of empties (default True)

Type:

bool

show_object_select_font

Allow selection of text objects (default True)

Type:

bool

show_object_select_grease_pencil

Allow selection of Grease Pencil objects (default True)

Type:

bool

show_object_select_lattice

Allow selection of lattices (default True)

Type:

bool

show_object_select_light

Allow selection of lights (default True)

Type:

bool

show_object_select_light_probe

Allow selection of light probes (default True)

Type:

bool

show_object_select_mesh

Allow selection of mesh objects (default True)

Type:

bool

show_object_select_meta

Allow selection of metaballs (default True)

Type:

bool

show_object_select_pointcloud

Allow selection of point clouds (default True)

Type:

bool

show_object_select_speaker

Allow selection of speakers (default True)

Type:

bool

show_object_select_surf

Allow selection of surfaces (default True)

Type:

bool

show_object_select_volume

Allow selection of volumes (default True)

Type:

bool

show_object_viewport_armature

Show armatures (default True)

Type:

bool

show_object_viewport_camera

Show cameras (default True)

Type:

bool

show_object_viewport_curve

Show curves (default True)

Type:

bool

show_object_viewport_curves

Show hair curves (default True)

Type:

bool

show_object_viewport_empty

Show empties (default True)

Type:

bool

show_object_viewport_font

Show text objects (default True)

Type:

bool

show_object_viewport_grease_pencil

Show Grease Pencil objects (default True)

Type:

bool

show_object_viewport_lattice

Show lattices (default True)

Type:

bool

show_object_viewport_light

Show lights (default True)

Type:

bool

show_object_viewport_light_probe

Show light probes (default True)

Type:

bool

show_object_viewport_mesh

Show mesh objects (default True)

Type:

bool

show_object_viewport_meta

Show metaballs (default True)

Type:

bool

show_object_viewport_pointcloud

Show point clouds (default True)

Type:

bool

show_object_viewport_speaker

Show speakers (default True)

Type:

bool

show_object_viewport_surf

Show surfaces (default True)

Type:

bool

show_object_viewport_volume

Show volumes (default True)

Type:

bool

show_passthrough

Show the passthrough view (default False)

Type:

bool

show_selection

Show selection outlines (default False)

Type:

bool

use_absolute_tracking

Allow the VR tracking origin to be defined independently of the headset location (default False)

Type:

bool

use_positional_tracking

Allow VR headsets to affect the location in virtual space, in addition to the rotation (default False)

Type:

bool

view_scale

Scaling factor applied to the VR view for fine adjustements. Modifying this value will keep the viewer at the same world relative position (in [1e-06, inf], default 1.0)

Type:

float

classmethod bl_rna_get_subclass(id, default=None, /)
Parameters:

  • id (str) – The RNA type identifier.

  • default (bpy.types.Struct | None) – The value to return when not found.

Returns:

The RNA type or default when not found.

Return type:

bpy.types.Struct

classmethod bl_rna_get_subclass_py(id, default=None, /)
Parameters:

  • id (str) – The RNA type identifier.

  • default (type | None) – The value to return when not found.

Returns:

The class or default when not found.

Return type:

type

Inherited Properties

Inherited Functions

References