FMAR.UI.Widgets.Map.Map Class Reference

Map widget, which displays points of interest, barriers, breadcrumbs, etc and allows interactions such as zooming and panning. More...

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

Public Types
enum	UpMode { FacingDirection , North }
	Enum representing the up mode for the map. More...

Public Member Functions
void	OnScroll (PointerEventData eventData)
	Handles the scroll event by zooming in or out based on the scroll delta.
override void	SetWidgetContainer (WidgetContainer widgetContainer)
	Sets the widget container and updates the game object parent, size, and scale factor.
void	ZoomStep (int direction)
	Zooms in or out based on the direction parameter.
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 ()
override void	Start ()
Protected Member Functions inherited from FMAR.UI.Widgets.Widget
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

Map widget, which displays points of interest, barriers, breadcrumbs, etc and allows interactions such as zooming and panning.

Member Enumeration Documentation

UpMode

enum FMAR.UI.Widgets.Map.Map.UpMode

Enum representing the up mode for the map.

Enumerator
FacingDirection
North

Member Function Documentation

Awake()

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

inlineprotectedvirtual

Reimplemented from FMAR.UI.Widgets.Widget.

OnScroll()

void FMAR.UI.Widgets.Map.Map.OnScroll ( PointerEventData eventData )

inline

Handles the scroll event by zooming in or out based on the scroll delta.

Parameters

eventData

Pointer event data.

SetWidgetContainer()

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

inlinevirtual

Sets the widget container and updates the game object parent, size, and scale factor.

Parameters

widgetContainer

The widget container.

Reimplemented from FMAR.UI.Widgets.Widget.

Start()

override void FMAR.UI.Widgets.Map.Map.Start ( )

inlineprotectedvirtual

Reimplemented from FMAR.UI.Widgets.Widget.

ZoomStep()

void FMAR.UI.Widgets.Map.Map.ZoomStep ( int direction )

inline

Zooms in or out based on the direction parameter.

Parameters

direction

The direction to zoom.

---

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

• /github/workspace/Packages/FMAR/UI/WidgetMap/Runtime/Scripts/Map.cs