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

Component containing a Coherent UI view for surfaces on mobile platforms. More...

+ Inheritance diagram for MobileSurfaceView:

Public Member Functions

bool UpdateView ()
 Update the view. This method triggers the view to be rendered to the underlaying texture. More...
 
- Public Member Functions inherited from CoherentUIView
void SetMousePosition (int x, int y)
 Sets the mouse position. Note Coherent UI (0,0) is the upper left corner of the screen. More...
 
void DestroyView ()
 Destroy this view. Destroys the Coherent UI view and removes the CoherentUIView component from its game object. Any usage of the view after this method is undefined behaviour. More...
 
delegate void ViewDestroyedHandler ()
 Handler for ViewDestroyed event. More...
 
void Resize (int width, int height)
 Resize the view to the specified width and height. More...
 
void Reload (bool ignoreCache)
 Request reload of this view. More...
 
bool GetCamDimensions (out int x, out int y)
 Returns the camera dimensions of the current view. More...
 

Additional Inherited Members

- Properties inherited from CoherentUIView
string Page [get, set]
 Gets or sets the URL of the view More...
 
int Width [get, set]
 Gets or sets the width of the view. More...
 
int Height [get, set]
 Gets or sets the height of the view. More...
 
int XPos [get, set]
 Gets or sets the X position of the overlay view. More...
 
int YPos [get, set]
 Gets or sets the Y position of the overlay view. More...
 
bool ScaleToFit [get, set]
 Gets or sets if the view will scale it's content to fit it's size. More...
 
bool EnableWebGLSupport [get, set]
 If enabled, WebGL will be supported in the view. More...
 
string InitialScript [get, set]
 Gets or sets the initial JavaScript code to be executed when the view JavaScript engine is created. More...
 
CoherentViewInputState InputState [get, set]
 Gets or sets the inbput state of the overlay view. More...
 
bool IsTransparent [get, set]
 Gets or sets a value indicating whether the view is transparent. More...
 
bool SupportClickThrough [get, set]
 Gets or sets a value indicating whether this view CoherentUIView supports click through. More...
 
float ClickThroughAlphaThreshold [get, set]
 Gets or sets the alpha threshold for click through checks. More...
 
bool ClickToFocus [get, set]
 When enabled, allows a view to take input focus when clicked with the left mouse button. More...
 
DrawOrder DrawAfterPostEffects [get, set]
 Gets or sets a value indicating whether this view is drawn after post effects. More...
 
bool FlipY [get, set]
 Gets or sets a value indicating whether the Y axis of this view should be flipped. More...
 
virtual bool ReceivesInput [get, set]
 Gets or sets a value indicating whether this view receives input. All automatic processing and reading of this property is done in the LateUpdate() / OnGUI() callbacks in Unity, letting you do all your logic for View focus in Update(). More...
 
bool InterceptAllEvents [get, set]
 Gets or sets a value indicating whether this view intercepts all events and sends a message for each event. More...
 
bool EnableBindingAttribute [get, set]
 Gets or sets a value indicating whether this CoherentUIView enables usage of the CoherentMethod attribute in components in the host GameObject. When true, the all components in the host GameObject are inspected for the CoherentMethod attribute (in the Awake() function) and the decorated methods are automatically bound when the ReadyForBindings event is received. When false, the attribute does nothing. More...
 
bool IsIndependentOfZBuffer [get, set]
 Gets or sets a value indicating whether this view is z-buffer independent. If it is set to true, the view is rendered on top of everything. More...
 
bool ShowJavaScriptDialogs [get, set]
 Gets or sets a value indicating whether dialogs will be drawn when a JavaScript message is received (e.g. alert, prompt, auth credentials). More...
 
bool ForceSoftwareRendering [get, set]
 Forces the view to use software rendering. For GPU-bound applications software views might be a good choice. CSS 3D transforms, WebGL and accelerated Canvas don't work with software views. This option doesn't work with OnDemand. More...
 
bool IgnoreDisplayDensity [get, set]
 Defines whether the Android device's display density will affect the scale of the View. When set to true, the displayed content in the view will match its pixel size. For example, a device with 1.5 scale factor will display a div of 100px in a 200px View on about 75% of surface if IgnoreDisplayDensity is set to false. If IgnoreDisplayDensity is set to true, the same div of 100px displayed in a 200px View will occupy exactly 50% of the View. More...
 
bool UseCameraDimensions [get, set]
 If checked, the view will use the camera's width and height More...
 
bool CorrectGamma [get, set]
 Gets or sets a value indicating whether this view should have gamma corrected. More...
 
bool EnableIME [get, set]
 Gets or sets a value indicating whether the view should have IME enabled More...
 
View View [get]
 Gets the underlying Coherent.UI.View instance. More...
 
UnityViewListener.CoherentUI_OnViewCreated OnViewCreated
 Occurs when the underlying Coherent.UI.View is created More...
 
UnityViewListener.CoherentUI_OnReadyForBindings OnReadyForBindings
 Occurs when the view bindings should be registered. More...
 
UnityViewListener Listener [get]
 Gets the underlying UnityViewListener for this view. More...
 
virtual bool IsSurfaceView [get]
 whether this is a mobile surface view More...
 
- Events inherited from CoherentUIView
ViewDestroyedHandler OnViewDestroyed
 Occurs when the view has been destroyed and the CoherentUIView component is going to be removed from the game object. More...
 

Detailed Description

Component containing a Coherent UI view for surfaces on mobile platforms.

Member Function Documentation

bool MobileSurfaceView.UpdateView ( )
inline

Update the view. This method triggers the view to be rendered to the underlaying texture.

Returns
true if the view was actually updated