XrViewfinderState(bpy_struct)

base class — bpy_struct

class bpy.types.XrViewfinderState(bpy_struct)

Runtime state information about the VR Location Scouting Viewfinder

active_action_confirm

Active viewfinder confirm action (default 'CONFIRM')

Type:

Literal[‘CANCEL’, ‘CONFIRM’]

active_action_live

Active viewfinder live action (default 'LENS')

Type:

Literal[‘LENS’, ‘DOF’, ‘FOCUS’, ‘APERTURE’]

active_action_playback

Active viewfinder playback action (default 'BROWSE')

Type:

Literal[‘BROWSE’, ‘PREVIEW’, ‘DELETE’]

active_mode

Active viewfinder mode, live or playback (default 'LIVE')

  • LIVE Live Mode – Capture a shot using the viewfinder.

  • PLAYBACK Playback Mode – Preview and playback captured shots in the viewfinder.

  • CONFIRM Confirmation Mode – Confirm user action.

Type:

Literal[‘LIVE’, ‘PLAYBACK’, ‘CONFIRM’]

capture_dof_distance

Viewfinder capture distance to the focus point for depth of field (in [-inf, inf], default 0.0)

Type:

float

capture_dof_enabled

Enable viewfinder capture depth of field (default False)

Type:

bool

capture_dof_fstop

Viewfinder capture f-stop ratio (in [-inf, inf], default 0.0)

Type:

float

capture_lens_focal

Viewfinder capture focal length value in millimeters (in [-inf, inf], default 0.0)

Type:

float

location

Last known location of the viewfinder in world space (array of 3 items, in [-inf, inf], default (0.0, 0.0, 0.0), readonly)

Type:

mathutils.Vector

orientation

Last known orientation of the viewfinder in world space (array of 4 items, in [-inf, inf], default (0.0, 0.0, 0.0, 0.0), readonly)

Type:

mathutils.Quaternion

playback_show_active_capture_in_space_enabled

Display active capture in space when in Viewfinder Playback mode (default False)

Type:

bool

trigger_flash()

Trigger the Viewfinder flash to indicate a shot was captured

trigger_focus_indicator(hit_success)

Blink the Viewfinder crosshair to indicate whether a focus action hit a target

Parameters:

hit_success (bool) – Hit success, True to blink the success color, False to blink the miss color

reset_view_smoothing()

Reset the Viewfinder continuous view smoothing

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