FirstModulAR 0.1.0
Loading...
Searching...
No Matches
FMAR.UI.Widgets.Inspector.Inspector Class Reference

The Inspector widget, used to display information about generic IInspectable objects. More...

Inheritance diagram for FMAR.UI.Widgets.Inspector.Inspector:
FMAR.UI.Widgets.Widget

Public Member Functions

override void SetWidgetContainer (WidgetContainer widgetContainer)
 Sets the widget container and updates the UI activation based on the container's scale factor.
 
- Public Member Functions inherited from FMAR.UI.Widgets.Widget
void SetBorderPositions (Vector2 size)
 Sets the border positions.
 
void UpdateBorderTransparency ()
 Updates the border transparency based on the widget container's border transparency.
 
void DetachFromContainer ()
 Detaches the widget from the widget container.
 
void PlaySound (AudioClip clip)
 Plays a sound localized to the widget.
 
bool TryMove ()
 Tries to move the widget out of the widget container.
 
void SetBackgroundEnabled (bool enabled)
 Sets the background's enabled state.
 

Protected Member Functions

override void Awake ()
 Initializes the Inspector widget.
 
- Protected Member Functions inherited from FMAR.UI.Widgets.Widget
virtual void Start ()
 
virtual void Update ()
 
void CreateBorder (Vector2 size)
 Creates a border for the widget, around the edges.
 

Additional Inherited Members

- Public Attributes inherited from FMAR.UI.Widgets.Widget
Sprite widgetIcon
 
- Protected Attributes inherited from FMAR.UI.Widgets.Widget
Image bg
 
RectTransform rt
 
AudioSource aud
 
- Properties inherited from FMAR.UI.Widgets.Widget
WidgetContainer WidgetContainer [get]
 
Vector2 PreferredFloatingDisplaySize [get]
 
Color BackgroundBaseColor [get]
 
RectTransform Rt [get]
 
bool Locked [get]
 

Detailed Description

The Inspector widget, used to display information about generic IInspectable objects.

Member Function Documentation

◆ Awake()

override void FMAR.UI.Widgets.Inspector.Inspector.Awake ( )
inlineprotectedvirtual

Initializes the Inspector widget.

Reimplemented from FMAR.UI.Widgets.Widget.

◆ SetWidgetContainer()

override void FMAR.UI.Widgets.Inspector.Inspector.SetWidgetContainer ( WidgetContainer widgetContainer)
inlinevirtual

Sets the widget container and updates the UI activation based on the container's scale factor.

Parameters
widgetContainerThe widget container.

Reimplemented from FMAR.UI.Widgets.Widget.


The documentation for this class was generated from the following file: