PsyTask | API Docs
    Preparing search index...

    Variable VirtualChinrestConst

    VirtualChinrest: (
        props: {
            blindspot_deg?: number;
            i18n?: Record<
                | "ok"
                | "line_distance"
                | "pix_per_cm"
                | "view_distance"
                | "confirmation"
                | "physical_width_title"
                | "physical_width_text"
                | "view_distance_title"
                | "view_distance_text",
                string,
            >;
            usePreviousData?: boolean;
        },
    ) => {
        node: string;
        data(): {
            deg2cm: (deg: number) => number;
            deg2csspix: (deg: number) => number;
            deg2pix: (deg: number) => number;
            distance_cm: number;
            pix_per_cm: number;
        };
    } & {
        key: "psytask:virtual-chinrest";
        get(): { distance_cm: number; pix_per_cm: number };
        set(data: { distance_cm: number; pix_per_cm: number }): void;
    } = ...

    Virtual chinrest for acquiring window physical width and distance.

    Type Declaration

      • (
            props: {
                blindspot_deg?: number;
                i18n?: Record<
                    | "ok"
                    | "line_distance"
                    | "pix_per_cm"
                    | "view_distance"
                    | "confirmation"
                    | "physical_width_title"
                    | "physical_width_text"
                    | "view_distance_title"
                    | "view_distance_text",
                    string,
                >;
                usePreviousData?: boolean;
            },
        ): {
            node: string;
            data(): {
                deg2cm: (deg: number) => number;
                deg2csspix: (deg: number) => number;
                deg2pix: (deg: number) => number;
                distance_cm: number;
                pix_per_cm: number;
            };
        }

      • Parameters

        • props: {
              blindspot_deg?: number;
              i18n?: Record<
                  | "ok"
                  | "line_distance"
                  | "pix_per_cm"
                  | "view_distance"
                  | "confirmation"
                  | "physical_width_title"
                  | "physical_width_text"
                  | "view_distance_title"
                  | "view_distance_text",
                  string,
              >;
              usePreviousData?: boolean;
          }
          • Optionalblindspot_deg?: number

            Blindspot degree to ViewDistanceDetector

          • Optionali18n?: Record<
                | "ok"
                | "line_distance"
                | "pix_per_cm"
                | "view_distance"
                | "confirmation"
                | "physical_width_title"
                | "physical_width_text"
                | "view_distance_title"
                | "view_distance_text",
                string,
            >

            Internationalization strings

          • OptionalusePreviousData?: boolean

            Use previous chinrest data. If not provided, it will show a confirmation.

        Returns {
            node: string;
            data(): {
                deg2cm: (deg: number) => number;
                deg2csspix: (deg: number) => number;
                deg2pix: (deg: number) => number;
                distance_cm: number;
                pix_per_cm: number;
            };
        }

    • Readonlykey: "psytask:virtual-chinrest"

      localStorage key

    • get: function
      • get(): { distance_cm: number; pix_per_cm: number }

        Get previous data

        Returns { distance_cm: number; pix_per_cm: number }

        Error if no valid data found

    • set: function
      • set(data: { distance_cm: number; pix_per_cm: number }): void

        Set previous data

        Parameters

        • data: { distance_cm: number; pix_per_cm: number }

        Returns void

    Basic usage

    using vc = app.scene(VirtualChinrest, {
      defaultProps: {
        usePreviousData: true,
        blindspot_deg: 13.5,
      },
    });
    const { distance_cm, pix_per_cm, deg2cm, deg2pix, deg2csspix } =
      await vc.show();

    Settings

    Member Visibility