Fudge Core
    Preparing search index...

    Class ComponentVRDevice

    VR Component Class, for Session Management, Controller Management and Reference Space Management.

    Valentin Schmidberger, HFU, 2022

    Hierarchy (View Summary)

    Index

    Constructors

    Properties

    clrBackground: Color = ...
    leftCntrl: VRController = ...
    mtxPivot: Matrix4x4 = ...
    mtxWorld: Matrix4x4 = ...
    rightCntrl: VRController = ...
    baseClass: typeof Component = Component

    refers back to this class from any subclass e.g. in order to find compatible other resources

    iSubclass: number = ...

    subclasses get a iSubclass number for identification

    subclasses: typeof Component[] = []

    list of all the subclasses derived from this class, if they registered properly

    Accessors

    • get backgroundEnabled(): boolean

      Returns true if the background of the camera should be rendered, false if not.

      Returns boolean

    • get isSingleton(): boolean

      Is true, when only one instance of the component class can be attached to a node

      Returns boolean

    • get type(): string

      Retrieves the type of this mutable subclass as the name of the runtime class

      Returns string

      The type of the mutable

    Methods

    • Collect applicable attributes of the instance and copies of their values in a Mutator-object. By default, a mutator cannot be extended, since extensions are not available in the object the mutator belongs to. A mutator may be reduced by the descendants of Mutable to contain only the properties needed.

      Parameters

      • _extendable: boolean = false

      Returns Mutator

    • Returns a scaling factor that, given a position in world space, scales an object at that position so that one unit equals one (logical) pixel on the screen when seen through this camera. e.g., after setting the scaling, 1 unit in the world equals one (logical) pixel on the screen.

      Parameters

      Returns number

    • Updates the attribute values of the instance according to the state of the mutator. The mutation may be restricted to a subset of the mutator and the event dispatching suppressed. Uses mutateBase, but can be overwritten in subclasses

      Parameters

      • _mutator: Mutator
      • _selection: string[] = null
      • _dispatchMutate: boolean = true

      Returns Promise<void>

    • Set the camera to perspective projection. The world origin is in the center of the canvaselement.

      Parameters

      • _aspect: number = ...

        The aspect ratio between width and height of projectionspace.(Default = canvas.clientWidth / canvas.ClientHeight)

      • _fieldOfView: number = ...

        The field of view in Degrees. (Default = 45)

      • _direction: FIELD_OF_VIEW = ...

        The plane on which the fieldOfView-Angle is given

      • _near: number = ...
      • _far: number = ...

      Returns void

    • Set the camera to orthographic projection. Default values are derived the canvas client dimensions

      Parameters

      • Optional_left: number

        The positionvalue of the projectionspace's left border.

      • Optional_right: number

        The positionvalue of the projectionspace's right border.

      • Optional_bottom: number

        The positionvalue of the projectionspace's bottom border.

      • Optional_top: number

        The positionvalue of the projectionspace's top border.

      Returns void