exhibitiondisplay - eisclimber/ExPresS-XR GitHub Wiki
Class in ExPresSXR.Presentation
Inherits from UnityEngine.MonoBehaviour
Implements an exhibition display for VR, allowing displaying objects with additional information. It supports interactables, spinning the objects and displaying information via text, image or video.
public class ExhibitionDisplay : MonoBehaviour| Name | Description |
|---|---|
| GetInfoActivationDuration() | Duration that the info is shown: |
- If 'toggleInfo' is false: The maximum of '_showInfoDuration' and the lengths of the Video and Audio Clips
- If in 'toggleInfo' is true -1| |HideInfo()|Hides the info of the exhibited object.| |SetObjectSpinnerPaused(bool)|Allows pausing spinning of the socket holding the exhibited object, i.e. to not change the rotation of the object while being grabbed.| |ShowInfo()|Shows the info of the exhibited object.|
| Name | Description |
|---|---|
| AllowNonInteractables | If true GameObjects will be added to the socket but won't be able to be picked up. |
| DisplayedPrefab | Prefab of the object to be displayed. |
| InfoActive | If any info is currently shown. |
| InfoAudioClip | Audio clip played when opening the description. |
| InfoAudioSource | Reference to the AudioSource playing when opening the description. |
| InfoCanvas | Reference to the Canvas displaying the description. |
| InfoImage | Image displayed in the description. |
| InfoImageGo | Reference to the Image displayed in the description. |
| InfoText | Text displayed as the description. |
| InfoTextGo | Reference to the Text displaying the description. |
| InfoVideoClip | Video clip played when opening the description. |
| InfoVideoDisplayGo | Reference to the Image used to play the video in when opening the description. |
| InfoVideoPlayer | Reference to the VideoPlayer playing when opening the description. |
| LabelText | Text displayed as the label. |
| LabelTextGo | Reference to the Text displaying the label. |
| PutBackTime | Time until the object is retrieved automatically while not being held. |
| ShowInfoDuration | Duration of how long the info is shown. Audio and Videos will be played until finished even if it is longer than the duration. |
| Socket | Socket holding the exhibited object. |
| SpinObject | If the exhibited object should be spun. |
| SpinObjectAxis | Axis of spinning the exhibited object. |
| SpinObjectRandomizeRotationOffset | If the spinning of the exhibited object should start with a random offset. |
| SpinObjectSpeed | Speed of spinning the exhibited object. |
| ToggleInfo | Whether or not the info automatically closes. When closing automatically Videos and Audio will be played until finished ignoring '_showInfoDuration'. |
| UiShowInfoButton | Reference to the Ui Button for opening the description. |
| UiShowInfoButtonCanvas | Reference to the Canvas containing the Ui Button for opening the description. |
| UsePhysicalInfoButton | If a physical of UI button should be used to open the description. |
| WorldShowInfoButton | Reference to the BaseButton for opening the description. |