Struct XrFbRenderModelStepper 

pub struct XrFbRenderModelStepper {
    pub left_controller_model_path: String,
    pub right_controller_model_path: String,
    pub animation_time_code: f32,
    pub with_animation: bool,
    /* private fields */
}

IStepper implementation for XR_FB_render_model integration with StereoKit

This stepper provides controller model rendering and animations using the OpenXR XR_FB_render_model extension. You can configure the model paths for left and right controllers using the public properties or setter methods.

Events this stepper is listening to:

• DRAW_CONTROLLER - Event that triggers when controller rendering is enabled (“true”) or disabled (“false”).

Examples

use stereokit_rust::{
    tools::xr_fb_render_model::{XrFbRenderModelStepper, is_fb_render_model_extension_available, DRAW_CONTROLLER},
    system::{Input, Handed},
    prelude::*,
};

// Check if the extension is available before using the stepper
if is_fb_render_model_extension_available() {
    let mut stepper = XrFbRenderModelStepper::default();
     
    // Optional: customize controller model paths
    stepper.left_controller_model_path = "/model_fb/controller/left".to_string();
    stepper.right_controller_model_path = "/model_fb/controller/right".to_string();
     
    // Add the stepper to StereoKit
    sk.send_event(StepperAction::add_default::<XrFbRenderModelStepper>("animate_controller"));
     
    // Enable controller rendering
    sk.send_event(StepperAction::event("animate_controller", DRAW_CONTROLLER, "true"));
     
    filename_scr = "screenshots/xr_fb_render_model.jpeg"; fov_scr = 45.0;
    test_steps!( // !!!! Get a proper main loop !!!!
        // The stepper will automatically render controllers with animations
        // based on input state (trigger, grip, etc.)
        if iter == number_of_steps / 2 {
            // Disable controller rendering halfway through
            sk.send_event(StepperAction::event("main", DRAW_CONTROLLER, "false"));
        }
    );
}

Animation System

The stepper maps controller inputs to specific animation time codes:

• Stick directions: 8 cardinal points (1.18-1.64 range)
• Trigger pressure: Variable animation (0.6-0.66 range)
• Grip pressure: Variable animation (0.82-0.88 range)
• Button combinations: Discrete animations (0.18, 0.32, 0.46, 0.98)

When multiple inputs are active, the step rotation system cycles through available animations using the animation_time_code property.

Fields

left_controller_model_path: String

Path to the left controller’s render model in the OpenXR runtime Default: “/model_fb/controller/left” (Meta Quest controllers)

right_controller_model_path: String

Path to the right controller’s render model in the OpenXR runtime
Default: “/model_fb/controller/right” (Meta Quest controllers)

animation_time_code: f32

Animation time code for manual control and step rotation system Used in animation_analyser for development and in set_animation for step cycling

with_animation: bool

Controls whether animations are executed in the draw method When false, controllers will be rendered but remain static

Trait Implementations

impl Default for XrFbRenderModelStepper

fn default() -> Self

Returns the “default value” for a type.

impl IStepper for XrFbRenderModelStepper

fn enabled(&self) -> bool

Is this IStepper enabled? When false, StereoKit will not call Step. This can be a good way to temporarily disable the IStepper without removing or shutting it down. https://stereokit.net/Pages/StereoKit.Framework/IStepper/Enabled.html

fn initialize(&mut self, id: StepperId, sk_info: Rc<RefCell<SkInfo>>) -> bool

This is called by StereoKit at the start of the next frame, and on the main thread. This happens before StereoKit’s main Step callback, and always after Sk.initialize. https://stereokit.net/Pages/StereoKit.Framework/IStepper/Initialize.html id : The id of the stepper sk : The SkInfo of the runnin Sk instance.

fn step(&mut self, token: &MainThreadToken)

This Step method will be called every frame of the application, as long as Enabled is true. This happens immediately before the main application’s Step callback. https://stereokit.net/Pages/StereoKit.Framework/IStepper/Step.html

fn shutdown(&mut self)

This is called when the IStepper is removed, or the application shuts down. This is always called on the main thread, and happens at the start of the next frame, before the main application’s Step callback. https://stereokit.net/Pages/StereoKit.Framework/IStepper/Shutdown.html

fn shutdown_done(&mut self) -> bool

If shutdown is to be performed in multiple steps, with or without threads and in order to avoid black or frozen screens, write the on going shutdown here

fn initialize_done(&mut self) -> bool

If initialization is to be performed in multiple steps, with or without threads and in order to avoid black or frozen screens, write the on going initialization here

impl Send for XrFbRenderModelStepper