Coherent UI for Unity3D  2.5.3
A modern user interface library for games
 All Classes Namespaces Functions Variables Enumerations Enumerator Properties Events Pages
Coherent.UI.ViewContext Class Reference

Encapsulates basic More...

Inherits IDisposable.

Public Member Functions

virtual bool Uninitialize ()
 Frees all resources used by the event system. the ViewContext object is unusable after this call More...
 
virtual void Update ()
 Communicates with the UI context process and performs all updates. Must be called in the thread that owns the context. All registered callbacks will be called in here More...
 
virtual void FetchSurfaces ()
 Check if new surfaces have been drawn and are available. This function can be called from a thread different than the main UI context thread in order to support client applications with multi-threaded rendering. Fetches only the surfaces of buffered views; on-demand views must be fetched manually per-view More...
 
virtual void CreateView (ViewInfo info, string path, ViewListenerBase listener)
 Creates a new UI Must be called after the context has signaled that it is ready via Coherent::UI::ContextListener::ContextReady More...
 
virtual void CreateView (ViewInfo info, string path, ViewListenerBase listener, string scriptToExecute)
 Creates a new UI Must be called after the context has signaled that it is ready via Coherent::UI::ContextListener::ContextReady More...
 
virtual void SaveCookies ()
 Saves the cookies to disk. Must be called after the context has signaled that it is ready via Coherent::UI::ContextListener::ContextReady More...
 
virtual void AddCrossOriginWhitelistEntry (string sourceOrigin, string targetProtocol, string targetDomain, bool allowTargetSubdomains)
 Add an entry to the cross-origin access whitelist. Must be called after the context has signaled that it is ready via Coherent::UI::ContextListener::ContextReady More...
 
virtual void RemoveCrossOriginWhitelistEntry (string sourceOrigin, string targetProtocol, string targetDomain, bool allowTargetSubdomains)
 Remove an entry from the cross-origin access whitelist. Must be called after the context has signaled that it is ready via Coherent::UI::ContextListener::ContextReady More...
 
virtual void ClearCrossOriginWhitelist ()
 Remove all entries from the cross-origin access whitelist. Must be called after the context has signaled that it is ready via Coherent::UI::ContextListener::ContextReady More...
 

Detailed Description

Encapsulates basic

Member Function Documentation

virtual void Coherent.UI.ViewContext.AddCrossOriginWhitelistEntry ( string  sourceOrigin,
string  targetProtocol,
string  targetDomain,
bool  allowTargetSubdomains 
)
inlinevirtual

Add an entry to the cross-origin access whitelist. Must be called after the context has signaled that it is ready via Coherent::UI::ContextListener::ContextReady

virtual void Coherent.UI.ViewContext.ClearCrossOriginWhitelist ( )
inlinevirtual

Remove all entries from the cross-origin access whitelist. Must be called after the context has signaled that it is ready via Coherent::UI::ContextListener::ContextReady

virtual void Coherent.UI.ViewContext.CreateView ( ViewInfo  info,
string  path,
ViewListenerBase  listener 
)
inlinevirtual

Creates a new UI Must be called after the context has signaled that it is ready via Coherent::UI::ContextListener::ContextReady

Parameters
infoan instance of the ViewInfo struct that describes all the parameters of the view
paththe page to load when the view is created
listeneran instance of the ViewListenerBase interface to allow listening to all the events raised for this view
virtual void Coherent.UI.ViewContext.CreateView ( ViewInfo  info,
string  path,
ViewListenerBase  listener,
string  scriptToExecute 
)
inlinevirtual

Creates a new UI Must be called after the context has signaled that it is ready via Coherent::UI::ContextListener::ContextReady

Parameters
infoan instance of the ViewInfo struct that describes all the parameters of the view
paththe page to load when the view is created
listeneran instance of the ViewListenerBase interface to allow listening to all the events raised for this view
virtual void Coherent.UI.ViewContext.FetchSurfaces ( )
inlinevirtual

Check if new surfaces have been drawn and are available. This function can be called from a thread different than the main UI context thread in order to support client applications with multi-threaded rendering. Fetches only the surfaces of buffered views; on-demand views must be fetched manually per-view

virtual void Coherent.UI.ViewContext.RemoveCrossOriginWhitelistEntry ( string  sourceOrigin,
string  targetProtocol,
string  targetDomain,
bool  allowTargetSubdomains 
)
inlinevirtual

Remove an entry from the cross-origin access whitelist. Must be called after the context has signaled that it is ready via Coherent::UI::ContextListener::ContextReady

virtual void Coherent.UI.ViewContext.SaveCookies ( )
inlinevirtual

Saves the cookies to disk. Must be called after the context has signaled that it is ready via Coherent::UI::ContextListener::ContextReady

virtual bool Coherent.UI.ViewContext.Uninitialize ( )
inlinevirtual

Frees all resources used by the event system. the ViewContext object is unusable after this call

Returns
true if the context has been properly uninitialized
virtual void Coherent.UI.ViewContext.Update ( )
inlinevirtual

Communicates with the UI context process and performs all updates. Must be called in the thread that owns the context. All registered callbacks will be called in here