uPano  v3.1
InfinityCode.uPano.InteractiveElements.InteractiveElement Class Referenceabstract

The base class for interactive elements like HotSpot, Direction, etc. More...

Inheritance diagram for InfinityCode.uPano.InteractiveElements.InteractiveElement:
InfinityCode.uPano.HotAreas.HotArea InfinityCode.uPano.InteractiveElements.PrefabElement InfinityCode.uPano.Directions.Direction InfinityCode.uPano.HotSpots.HotSpot

Public Member Functions

virtual void Destroy ()
 Destroy an interactive element More...
 
virtual void InitQuickActions (GameObject target)
 Initiates quick actions More...
 
abstract void GetPanTilt (out float pan, out float tilt)
 Gets the pan and tilt of an interactive element More...
 
GetRuntimeField< T > (string key)
 Gets user value for the key and cast to the specified type More...
 
abstract void Reinit ()
 Reinitializes an interactive element More...
 
abstract void SetPanTilt (float pan, float tilt)
 Sets pan and tilt for an interactive element More...
 

Public Attributes

InteractiveElementEvent OnClick = new InteractiveElementEvent()
 Event that occurs when click Interactive Element More...
 
InteractiveElementEvent OnPointerDown = new InteractiveElementEvent()
 Event that occurs when press Interactive Element More...
 
InteractiveElementEvent OnPointerUp = new InteractiveElementEvent()
 Event that occurs when release Interactive Element More...
 
InteractiveElementEvent OnPointerEnter = new InteractiveElementEvent()
 Event that occurs when cursor enter on Interactive Element More...
 
InteractiveElementEvent OnPointerExit = new InteractiveElementEvent()
 Event that occurs when cursor exit from Interactive Element More...
 
bool ignoreGlobalActions = false
 Should the element ignore global actions? More...
 
GameObject loadPanoramaPrefab
 Prefab of panorama that should be instantiated and opened when you click on an element More...
 
GameObject switchToPanorama
 Panorama that should be opened when you click on an element More...
 
bool copyPanTilt = true
 Copy pan and tilt from source to target panorama More...
 
GameObject beforeTransitionPrefab
 Prefab which contains the transition that is played before the panorama is closed More...
 
GameObject afterTransitionPrefab
 Prefab which contains the transition that is played after the panorama is closed More...
 

Properties

Pano pano [get, set]
 Reference to instance of a panorama More...
 
object this[string key] [get, set]
 Gets and sets the user value to be stored in an element More...
 
virtual string title [get, set]
 Title More...
 
virtual bool visible [get, set]
 Visible More...
 

Detailed Description

The base class for interactive elements like HotSpot, Direction, etc.

Member Function Documentation

◆ Destroy()

virtual void InfinityCode.uPano.InteractiveElements.InteractiveElement.Destroy ( )
virtual

Destroy an interactive element

Reimplemented in InfinityCode.uPano.HotSpots.HotSpot.

◆ GetPanTilt()

abstract void InfinityCode.uPano.InteractiveElements.InteractiveElement.GetPanTilt ( out float  pan,
out float  tilt 
)
pure virtual

Gets the pan and tilt of an interactive element

Parameters
panPan
tiltTilt

Implemented in InfinityCode.uPano.HotSpots.HotSpot, InfinityCode.uPano.HotAreas.HotArea, and InfinityCode.uPano.Directions.Direction.

◆ GetRuntimeField< T >()

T InfinityCode.uPano.InteractiveElements.InteractiveElement.GetRuntimeField< T > ( string  key)

Gets user value for the key and cast to the specified type

Template Parameters
TType of value
Parameters
keyKey
Returns
Value

◆ InitQuickActions()

virtual void InfinityCode.uPano.InteractiveElements.InteractiveElement.InitQuickActions ( GameObject  target)
virtual

Initiates quick actions

Parameters
targetThe container that will contain the Quick Actions components

Reimplemented in InfinityCode.uPano.HotSpots.HotSpot.

◆ Reinit()

abstract void InfinityCode.uPano.InteractiveElements.InteractiveElement.Reinit ( )
pure virtual

◆ SetPanTilt()

abstract void InfinityCode.uPano.InteractiveElements.InteractiveElement.SetPanTilt ( float  pan,
float  tilt 
)
pure virtual

Sets pan and tilt for an interactive element

Parameters
panNew pan
tiltNew tilt

Implemented in InfinityCode.uPano.HotSpots.HotSpot, InfinityCode.uPano.HotAreas.HotArea, and InfinityCode.uPano.Directions.Direction.

Member Data Documentation

◆ afterTransitionPrefab

GameObject InfinityCode.uPano.InteractiveElements.InteractiveElement.afterTransitionPrefab

Prefab which contains the transition that is played after the panorama is closed

◆ beforeTransitionPrefab

GameObject InfinityCode.uPano.InteractiveElements.InteractiveElement.beforeTransitionPrefab

Prefab which contains the transition that is played before the panorama is closed

◆ copyPanTilt

bool InfinityCode.uPano.InteractiveElements.InteractiveElement.copyPanTilt = true

Copy pan and tilt from source to target panorama

◆ ignoreGlobalActions

bool InfinityCode.uPano.InteractiveElements.InteractiveElement.ignoreGlobalActions = false

Should the element ignore global actions?

◆ loadPanoramaPrefab

GameObject InfinityCode.uPano.InteractiveElements.InteractiveElement.loadPanoramaPrefab

Prefab of panorama that should be instantiated and opened when you click on an element

◆ OnClick

InteractiveElementEvent InfinityCode.uPano.InteractiveElements.InteractiveElement.OnClick = new InteractiveElementEvent()

Event that occurs when click Interactive Element

◆ OnPointerDown

InteractiveElementEvent InfinityCode.uPano.InteractiveElements.InteractiveElement.OnPointerDown = new InteractiveElementEvent()

Event that occurs when press Interactive Element

◆ OnPointerEnter

InteractiveElementEvent InfinityCode.uPano.InteractiveElements.InteractiveElement.OnPointerEnter = new InteractiveElementEvent()

Event that occurs when cursor enter on Interactive Element

◆ OnPointerExit

InteractiveElementEvent InfinityCode.uPano.InteractiveElements.InteractiveElement.OnPointerExit = new InteractiveElementEvent()

Event that occurs when cursor exit from Interactive Element

◆ OnPointerUp

InteractiveElementEvent InfinityCode.uPano.InteractiveElements.InteractiveElement.OnPointerUp = new InteractiveElementEvent()

Event that occurs when release Interactive Element

◆ switchToPanorama

GameObject InfinityCode.uPano.InteractiveElements.InteractiveElement.switchToPanorama

Panorama that should be opened when you click on an element

Property Documentation

◆ pano

Pano InfinityCode.uPano.InteractiveElements.InteractiveElement.pano
getset

Reference to instance of a panorama

◆ this[string key]

object InfinityCode.uPano.InteractiveElements.InteractiveElement.this[string key]
getset

Gets and sets the user value to be stored in an element

Parameters
keyKey
Returns
Value

◆ title

virtual string InfinityCode.uPano.InteractiveElements.InteractiveElement.title
getset

Title

◆ visible

virtual bool InfinityCode.uPano.InteractiveElements.InteractiveElement.visible
getset

Visible