Points of interest widget, manages the UI for the points of interest, including viewing and editing points of interest. More...

Inheritance diagram for FMAR.UI.Widgets.PointsOfInterest.PointsOfInterest:

Public Member Functions
override void	SetWidgetContainer (WidgetContainer widgetContainer)
	Sets the widget container for the points of interest widget.

void	ShowPoiList ()
	Shows the list of points of interest.

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 ()

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.

Properties
PointOfInterest	CurrentPoi `[get]`

Properties inherited from FMAR.UI.Widgets.Widget
WidgetContainer	WidgetContainer `[get]`

Vector2	PreferredFloatingDisplaySize `[get]`

Color	BackgroundBaseColor `[get]`

RectTransform	Rt `[get]`

bool	Locked `[get]`

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

Detailed Description

Points of interest widget, manages the UI for the points of interest, including viewing and editing points of interest.

Member Function Documentation

override void FMAR.UI.Widgets.PointsOfInterest.PointsOfInterest.Awake ( )

inlineprotectedvirtual

override void FMAR.UI.Widgets.PointsOfInterest.PointsOfInterest.SetWidgetContainer ( WidgetContainer widgetContainer )

inlinevirtual

Sets the widget container for the points of interest widget.

Parameters

widgetContainer The widget container to set.

void FMAR.UI.Widgets.PointsOfInterest.PointsOfInterest.ShowPoiList ( )

inline

Shows the list of points of interest.

PointOfInterest FMAR.UI.Widgets.PointsOfInterest.PointsOfInterest.CurrentPoi

get

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

/github/workspace/Packages/FMAR/UI/WidgetPointsOfInterest/Runtime/Scripts/PointsOfInterest.cs