PsyTask | API Docs
    Preparing search index...

    Variable VirtualChinrestConst

    VirtualChinrest: (
        props: {
            blindspotDegree?: number;
            i18n?: {
                confirmation: string;
                line_distance: string;
                no: string;
                screen_width: string;
                screen_width_guide: string;
                view_distance: string;
                view_distance_guide: string;
                yes: string;
            };
            usePreviousData?: boolean;
        },
        ctx: Scene<any>,
    ) => {
        node: HTMLDivElement;
        data(): {
            deg2cm: (deg: number) => number;
            deg2csspix: (deg: number) => number;
            deg2pix: (deg: number) => number;
            distance_cm: number;
            pix_per_cm: number;
        };
    } = ...

    Virtual chinrest for acquiring screen physical width and distance.

    Type Declaration

      • (
            props: {
                blindspotDegree?: number;
                i18n?: {
                    confirmation: string;
                    line_distance: string;
                    no: string;
                    screen_width: string;
                    screen_width_guide: string;
                    view_distance: string;
                    view_distance_guide: string;
                    yes: string;
                };
                usePreviousData?: boolean;
            },
            ctx: Scene<any>,
        ): {
            node: HTMLDivElement;
            data(): {
                deg2cm: (deg: number) => number;
                deg2csspix: (deg: number) => number;
                deg2pix: (deg: number) => number;
                distance_cm: number;
                pix_per_cm: number;
            };
        }

      • Parameters

        • props: {
              blindspotDegree?: number;
              i18n?: {
                  confirmation: string;
                  line_distance: string;
                  no: string;
                  screen_width: string;
                  screen_width_guide: string;
                  view_distance: string;
                  view_distance_guide: string;
                  yes: string;
              };
              usePreviousData?: boolean;
          }
          • OptionalblindspotDegree?: number

            Blindspot degree

            13.5
          • Optionali18n?: {
                confirmation: string;
                line_distance: string;
                no: string;
                screen_width: string;
                screen_width_guide: string;
                view_distance: string;
                view_distance_guide: string;
                yes: string;
            }

            Internationalization strings

          • OptionalusePreviousData?: boolean

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

        • ctx: Scene<any>

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

    Show chinrest and get data

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