Young, strong and crazy!
Public Member Functions | Public Attributes | List of all members
UnityEngine.UI.Windows.WindowComponent Class Reference
Inheritance diagram for UnityEngine.UI.Windows.WindowComponent:
Inheritance graph
[legend]
Collaboration diagram for UnityEngine.UI.Windows.WindowComponent:
Collaboration graph
[legend]

Public Member Functions

List< WindowComponentGetSubComponents ()
 Gets the sub components. More...
 
WindowLayoutBase GetLayoutRoot ()
 Gets the layout root. More...
 
void RegisterSubComponent (WindowComponent subComponent)
 Registers the sub component. More...
 
void UnregisterSubComponent (WindowComponent subComponent)
 Unregisters the sub component. More...
 
override void OnInit ()
 Raises the init event. More...
 
override void OnDeinit ()
 Raises the deinit event. More...
 
override void OnShowEnd ()
 Raises the show end event. More...
 
override void OnHideEnd ()
 Raises the hide end event. More...
 
override void OnShowBegin (System.Action callback)
 Raises the show begin event. More...
 
override void OnHideBegin (System.Action callback)
 Raises the hide begin event. More...
 
- Public Member Functions inherited from UnityEngine.UI.Windows.WindowComponentBase
WindowObjectState GetComponentState ()
 Gets the state of the component. More...
 
void Show (bool resetAnimation=true)
 Show component. More...
 
virtual void Show (System.Action callback, bool resetAnimation)
 Show component with callback after end. More...
 
void Hide ()
 Hide this instance. More...
 
void Hide (bool immediately)
 Hide the specified immediately. More...
 
virtual void Hide (System.Action callback, bool immediately)
 Hide the specified callback and immediately. More...
 
void SetResetState ()
 Set up reset state to animation. More...
 
void SetInState ()
 Set up in state to animation. More...
 
void SetOutState ()
 Set up out state to animation. More...
 
virtual float GetAnimationDuration (bool forward)
 Gets the duration of the animation. More...
 
- Public Member Functions inherited from UnityEngine.UI.Windows.WindowObject
WindowBase GetWindow ()
 
void HideCurrentWindow ()
 

Public Attributes

bool autoRegisterSubComponents = true
 
- Public Attributes inherited from UnityEngine.UI.Windows.WindowComponentBase
new WindowAnimationBase animation
 
List< TransitionInputParametersanimationInputParams = new List<TransitionInputParameters>()
 
CanvasGroup canvas
 
bool animationRefresh = false
 

Member Function Documentation

WindowLayoutBase UnityEngine.UI.Windows.WindowComponent.GetLayoutRoot ( )

Gets the layout root.

Basicaly it's the parent transform from current. But it's not always so. Sometimes you need to get layout element where this component (or it's parent) stored to play animation (for example).

Returns
The layout root.
List<WindowComponent> UnityEngine.UI.Windows.WindowComponent.GetSubComponents ( )

Gets the sub components.

Returns
The sub components.
override void UnityEngine.UI.Windows.WindowComponent.OnDeinit ( )
virtual
override void UnityEngine.UI.Windows.WindowComponent.OnHideBegin ( System.Action  callback)
virtual

Raises the hide begin event.

Wait while all sub components return the callback. You can override this method but call it's base.

Parameters
callbackCallback.

Reimplemented from UnityEngine.UI.Windows.WindowComponentBase.

Reimplemented in UnityEngine.UI.Windows.Components.List, UnityEngine.UI.Windows.Components.LinkerComponent, UnityEngine.UI.Windows.Components.ProgressWithParticlesComponent, UnityEngine.UI.Windows.Components.ProgressComponent, and UnityEngine.UI.Windows.Components.ButtonHoverComponent.

Here is the call graph for this function:

Here is the caller graph for this function:

override void UnityEngine.UI.Windows.WindowComponent.OnHideEnd ( )
virtual

Raises the hide end event.

You can override this method but call it's base.

Reimplemented from UnityEngine.UI.Windows.WindowComponentBase.

Reimplemented in UnityEngine.UI.Windows.Components.LinkerComponent.

Here is the caller graph for this function:

override void UnityEngine.UI.Windows.WindowComponent.OnInit ( )
virtual
override void UnityEngine.UI.Windows.WindowComponent.OnShowBegin ( System.Action  callback)
virtual

Raises the show begin event.

Wait while all sub components return the callback. You can override this method but call it's base.

Parameters
callbackCallback.

Reimplemented from UnityEngine.UI.Windows.WindowComponentBase.

Reimplemented in UnityEngine.UI.Windows.Components.PopupComponent, and UnityEngine.UI.Windows.Components.LinkerComponent.

Here is the call graph for this function:

Here is the caller graph for this function:

override void UnityEngine.UI.Windows.WindowComponent.OnShowEnd ( )
virtual

Raises the show end event.

You can override this method but call it's base.

Reimplemented from UnityEngine.UI.Windows.WindowComponentBase.

Reimplemented in UnityEngine.UI.Windows.Components.LinkerComponent, and UnityEngine.UI.Windows.Components.ProgressWithParticlesComponent.

Here is the caller graph for this function:

void UnityEngine.UI.Windows.WindowComponent.RegisterSubComponent ( WindowComponent  subComponent)

Registers the sub component.

If you want to instantiate new component manualy but wants the window events - register this component here.

Parameters
subComponentSub component.

Here is the call graph for this function:

void UnityEngine.UI.Windows.WindowComponent.UnregisterSubComponent ( WindowComponent  subComponent)

Unregisters the sub component.

Parameters
subComponentSub component.

Here is the call graph for this function:

Member Data Documentation

bool UnityEngine.UI.Windows.WindowComponent.autoRegisterSubComponents = true

Fri Apr 3 2015 14:05:26   Generated by   doxygen   Content copyrighted to Alex