C# Class UIPanelBase, marblemadness

Inheritance: MonoBehaviour, IUIContainer, IUIObject

Afficher le fichier Open project: MtvnGames/marblemadness Class Usage Examples

Méthodes publiques

Свойство	Type	Description
deactivateAllOnDismiss	bool
detargetOnDisable	bool
index	int

Protected Properties

Свойство	Type	Description
changeDelegate	EZValueChangedDelegate
childPanels	EZLinkedList>
container	IUIContainer
dragDropDelegate	EZDragDropDelegate
inputDelegate	EZInputDelegate
m_controlIsEnabled	bool
m_started	bool
prevTransIndex	int
prevTransition	EZTransition
tempTransCompleteDel	TransitionCompleteDelegate
uiObjs	EZLinkedList>

Méthodes publiques

Méthode	Description
AddChild ( GameObject go ) : void
AddDragDropDelegate ( EZDragDropDelegate del ) : void	Adds a delegate to be called with drag and drop notifications.
AddInputDelegate ( EZInputDelegate del ) : void
AddSubject ( GameObject go ) : void	Adds a GameObject as a subject of this panel's transitions.
AddTempTransitionDelegate ( TransitionCompleteDelegate del ) : void	Temporarily adds a delegate to be called when the next transition completes. This will be unset after it is called.
AddValueChangedDelegate ( EZValueChangedDelegate del ) : void
BringIn ( ) : void	Brings in the panel by playing its "Bring In Forward" transition.
CancelDrag ( ) : void
CompareIndices ( UIPanelBase, a, UIPanelBase, b ) : int
Dismiss ( ) : void	Dismisses the panel by playing its "Dismiss Forward" transition.
DragUpdatePosition ( POINTER_INFO, ptr ) : void
GetControl ( POINTER_INFO, &ptr ) : IUIObject
GetTransition ( UIPanelManager, transition ) : EZTransition	Returns a reference to the specified transition.
GetTransition ( int index ) : EZTransition	Returns a reference to the transition at the specified index.
GetTransition ( string transName ) : EZTransition	Returns a reference to the specified transition.
GetTransitionNames ( ) : string[]
GotFocus ( ) : bool
MakeChild ( GameObject go ) : void	Makes the specified GameObject a child of this panel, including making it a child of the panel's transform.
OnEZDragDrop_Internal ( EZDragDropParams, parms ) : void	Receives regular notification of drag & drop events pertaining to this object when an object is being dragged. This is called on potential drop targets when an object is dragged over them. It is also called on the object(s) being dragged/dropped.
OnInput ( POINTER_INFO, ptr ) : void
RemoveChild ( GameObject go ) : void
RemoveDragDropDelegate ( EZDragDropDelegate del ) : void	Removes a delegate from the list of those to be called with drag and drop notifications.
RemoveInputDelegate ( EZInputDelegate del ) : void
RemoveSubject ( GameObject go ) : void	Removes a GameObject as a subjects of this panel's transitions.
RemoveValueChangedDelegate ( EZValueChangedDelegate del ) : void
RequestContainership ( IUIContainer cont ) : bool
ScanChildren ( ) : void
SetDragDropDelegate ( EZDragDropDelegate del ) : void	Sets the delegate to be called with drag and drop notifications. NOTE: This will replace any previously registered delegates.
SetInputDelegate ( EZInputDelegate del ) : void
SetValueChangedDelegate ( EZValueChangedDelegate del ) : void
Start ( ) : void
StartTransition ( UIPanelManager, mode ) : void	Starts one of the panel's "bring in" or "dismiss" transitions.
StartTransition ( string transName ) : void	Starts the transition matching the specified name (case-insensitive).
TransitionCompleted ( EZTransition transition ) : void

Méthodes protégées

Méthode	Description
OnDisable ( ) : void
SetupTransitionSubjects ( ) : void

Method Details

AddChild() public méthode

public AddChild ( GameObject go ) : void
go	GameObject
Résultat	void

AddDragDropDelegate() public méthode

Adds a delegate to be called with drag and drop notifications.

public AddDragDropDelegate ( EZDragDropDelegate del ) : void
del	EZDragDropDelegate	The delegate to add.
Résultat	void

AddInputDelegate() public méthode

public AddInputDelegate ( EZInputDelegate del ) : void
del	EZInputDelegate
Résultat	void

AddSubject() public méthode

Adds a GameObject as a subject of this panel's transitions.

public AddSubject ( GameObject go ) : void
go	GameObject	GameObject to be added as a subject.
Résultat	void

AddTempTransitionDelegate() public méthode

Temporarily adds a delegate to be called when the next transition completes. This will be unset after it is called.

public AddTempTransitionDelegate ( TransitionCompleteDelegate del ) : void
del	TransitionCompleteDelegate	Delegate to be called.
Résultat	void

AddValueChangedDelegate() public méthode

public AddValueChangedDelegate ( EZValueChangedDelegate del ) : void
del	EZValueChangedDelegate
Résultat	void

BringIn() public méthode

Brings in the panel by playing its "Bring In Forward" transition.

public BringIn ( ) : void
Résultat	void

CancelDrag() public méthode

public CancelDrag ( ) : void
Résultat	void

CompareIndices() public static méthode

public static CompareIndices ( UIPanelBase, a, UIPanelBase, b ) : int
a	UIPanelBase,
b	UIPanelBase,
Résultat	int

Dismiss() public méthode

Dismisses the panel by playing its "Dismiss Forward" transition.

public Dismiss ( ) : void
Résultat	void

DragUpdatePosition() public méthode

public DragUpdatePosition ( POINTER_INFO, ptr ) : void
ptr	POINTER_INFO,
Résultat	void

GetControl() public méthode

public GetControl ( POINTER_INFO, &ptr ) : IUIObject
ptr	POINTER_INFO,
Résultat	IUIObject

GetTransition() public méthode

Returns a reference to the specified transition.

public GetTransition ( UIPanelManager, transition ) : EZTransition
transition	UIPanelManager,	The enum identifying the transition to retrieve.
Résultat	EZTransition

GetTransition() public méthode

Returns a reference to the transition at the specified index.

public GetTransition ( int index ) : EZTransition
index	int	The zero-based index of the transition to retrieve.
Résultat	EZTransition

GetTransition() public méthode

Returns a reference to the specified transition.

public GetTransition ( string transName ) : EZTransition
transName	string	The name of the transition to retrieve.
Résultat	EZTransition

GetTransitionNames() public méthode

public GetTransitionNames ( ) : string[]
Résultat	string[]

GotFocus() public méthode

public GotFocus ( ) : bool
Résultat	bool

MakeChild() public méthode

Makes the specified GameObject a child of this panel, including making it a child of the panel's transform.

public MakeChild ( GameObject go ) : void
go	GameObject	GameObject to make a child of the panel.
Résultat	void

OnDisable() protected méthode

protected OnDisable ( ) : void
Résultat	void

OnEZDragDrop_Internal() public méthode

Receives regular notification of drag & drop events pertaining to this object when an object is being dragged. This is called on potential drop targets when an object is dragged over them. It is also called on the object(s) being dragged/dropped.

public OnEZDragDrop_Internal ( EZDragDropParams, parms ) : void
parms	EZDragDropParams,	The EZDragDropParams structure which holds information about the event.
Résultat	void

OnInput() public méthode

public OnInput ( POINTER_INFO, ptr ) : void
ptr	POINTER_INFO,
Résultat	void

RemoveChild() public méthode

public RemoveChild ( GameObject go ) : void
go	GameObject
Résultat	void

RemoveDragDropDelegate() public méthode

Removes a delegate from the list of those to be called with drag and drop notifications.

public RemoveDragDropDelegate ( EZDragDropDelegate del ) : void
del	EZDragDropDelegate	The delegate to add.
Résultat	void

RemoveInputDelegate() public méthode

public RemoveInputDelegate ( EZInputDelegate del ) : void
del	EZInputDelegate
Résultat	void

RemoveSubject() public méthode

Removes a GameObject as a subjects of this panel's transitions.

public RemoveSubject ( GameObject go ) : void
go	GameObject	GameObject to be removed as a subject.
Résultat	void

RemoveValueChangedDelegate() public méthode

public RemoveValueChangedDelegate ( EZValueChangedDelegate del ) : void
del	EZValueChangedDelegate
Résultat	void

RequestContainership() public méthode

public RequestContainership ( IUIContainer cont ) : bool
cont	IUIContainer
Résultat	bool

ScanChildren() public méthode

public ScanChildren ( ) : void
Résultat	void

SetDragDropDelegate() public méthode

Sets the delegate to be called with drag and drop notifications. NOTE: This will replace any previously registered delegates.

public SetDragDropDelegate ( EZDragDropDelegate del ) : void
del	EZDragDropDelegate	The delegate to add.
Résultat	void

SetInputDelegate() public méthode

public SetInputDelegate ( EZInputDelegate del ) : void
del	EZInputDelegate
Résultat	void

SetValueChangedDelegate() public méthode

public SetValueChangedDelegate ( EZValueChangedDelegate del ) : void
del	EZValueChangedDelegate
Résultat	void

SetupTransitionSubjects() protected méthode

protected SetupTransitionSubjects ( ) : void
Résultat	void

Start() public méthode

public Start ( ) : void
Résultat	void

StartTransition() public méthode

Starts one of the panel's "bring in" or "dismiss" transitions.

public StartTransition ( UIPanelManager, mode ) : void
mode	UIPanelManager,	The mode corresponding to the transition that should be played.
Résultat	void

StartTransition() public méthode

Starts the transition matching the specified name (case-insensitive).

public StartTransition ( string transName ) : void
transName	string	The name of the transition to start. Ex: "Bring In Forward"
Résultat	void

TransitionCompleted() public méthode

public TransitionCompleted ( EZTransition transition ) : void
transition	EZTransition
Résultat	void

Property Details

changeDelegate protected_oe property

protected EZValueChangedDelegate changeDelegate
Résultat	EZValueChangedDelegate

childPanels protected_oe property

protected EZLinkedList> childPanels
Résultat	EZLinkedList>

container protected_oe property

protected IUIContainer container
Résultat	IUIContainer

deactivateAllOnDismiss public_oe property

When true, will recursively set all child objects to inactive. Conversely, it will recursively set all child objects to active when brought in.

public bool deactivateAllOnDismiss
Résultat	bool

detargetOnDisable public_oe property

When set to true, the control will instruct any pointers which have it as their target to de-target them. Use this if you are deactivating a control and want no input to go to it. It is strongly recommended NOT to use this feature on any control that appears in a scroll list, or else you may be unable to scroll past the edge of the list's viewable area.

public bool detargetOnDisable
Résultat	bool

dragDropDelegate protected_oe property

protected EZDragDropDelegate dragDropDelegate
Résultat	EZDragDropDelegate

index public_oe property

The index of the panel in the optional UIPanelManager which manages it. This is an optional value that allows you to determine the order in which this panel will appear in a menu that is navigated without specifying the specific panels to go to, but rather moves to each panel based upon its index. If no default panel is specified in the UIPanelManager, the panel with the lowest index value will be the first panel shown.

public int index
Résultat	int

inputDelegate protected_oe property

protected EZInputDelegate inputDelegate
Résultat	EZInputDelegate

m_controlIsEnabled protected_oe property

protected bool m_controlIsEnabled
Résultat	bool

m_started protected_oe property

protected bool m_started
Résultat	bool

prevTransIndex protected_oe property

protected int prevTransIndex
Résultat	int

prevTransition protected_oe property

protected EZTransition prevTransition
Résultat	EZTransition

tempTransCompleteDel protected_oe property

protected TransitionCompleteDelegate tempTransCompleteDel
Résultat	TransitionCompleteDelegate

uiObjs protected_oe property

protected EZLinkedList> uiObjs
Résultat	EZLinkedList>