UIPanel Class Reference

Inheritance diagram for UIPanel:

Public Member Functions
delegate void	TransitionCompleteDelegate (UIPanelBase panel, EZTransition transition)
void	AddChild (GameObject go)
	Reference to the parent UIView.
void	RemoveChild (GameObject go)
	Removes an object as a child of the container.
void	MakeChild (GameObject go)
	Makes the specified GameObject a child of this panel, including making it a child of the panel's transform.
void	AddSubject (GameObject go)
	Adds a GameObject as a subject of this panel's transitions.
void	RemoveSubject (GameObject go)
	Removes a GameObject as a subjects of this panel's transitions.
EZTransition	GetTransition (int index)
	Returns a reference to the transition at the specified index.
EZTransition	GetTransition (UIPanelManager.SHOW_MODE transition)
	Returns a reference to the specified transition.
EZTransition	GetTransition (string transName)
	Returns a reference to the specified transition.
virtual void	StartTransition (UIPanelManager.SHOW_MODE mode)
	Starts one of the panel's "bring in" or "dismiss" transitions.
virtual void	StartTransition (string transName)
	Starts the transition matching the specified name (case-insensitive).
virtual void	BringIn ()
	Brings in the panel by playing its "Bring In Forward" transition.
virtual void	Dismiss ()
	Dismisses the panel by playing its "Dismiss Forward" transition.
void	AddTempTransitionDelegate (TransitionCompleteDelegate del)
	Temporarily adds a delegate to be called when the next transition completes. This will be unset after it is called.
virtual void	SetInputDelegate (EZInputDelegate del)
	Sets the method to be called when input occurs (input is forwarded from OnInput()). NOTE: This will replace any and all delegates which have been set or added previously. If you are unsure if any delegates are already registered, use AddInputDelegate() instead, or RemoveInputDelegate() to unset a previously registered delegate. Only use this when you are sure you want to replace all previously registered delegates.
virtual void	AddInputDelegate (EZInputDelegate del)
	Adds a method to be called when input occurs (input is forwarded from OnInput()).
virtual void	RemoveInputDelegate (EZInputDelegate del)
	Removes a method added with AddInputDelegate().
virtual void	SetValueChangedDelegate (EZValueChangedDelegate del)
	Sets the method to be called when the value of a control changes (such as a checkbox changing from false to true, or a slider being moved). NOTE: This will replace any and all delegates which have been set or added previously. If you are unsure if any delegates are already registered, use AddValueChangedDelegate() instead, or RemoveValueChangedDelegate() to unset a previously registered delegate. Only use this when you are sure you want to replace all previously registered delegates.
virtual void	AddValueChangedDelegate (EZValueChangedDelegate del)
	Adds a method to be called when the value of a control changes (such as a checkbox changing from false to true, or a slider being moved).
virtual void	RemoveValueChangedDelegate (EZValueChangedDelegate del)
	Removes a method added with AddValueChangedDelegate().
virtual void	OnInput (POINTER_INFO ptr)
	This is where input handling code should go in any derived class.
void	CancelDrag ()
	Cancels any pending drag and drop operation.
void	AddDragDropDelegate (EZDragDropDelegate del)
	Adds a delegate to be called with drag and drop notifications.
void	RemoveDragDropDelegate (EZDragDropDelegate del)
	Removes a delegate from the list of those to be called with drag and drop notifications.
void	SetDragDropDelegate (EZDragDropDelegate del)
	Sets the delegate to be called with drag and drop notifications. NOTE: This will replace any previously registered delegates.
Static Public Member Functions
static UIPanel	Create (string name, Vector3 pos)
	Creates a GameObject and attaches this component type to it.
static UIPanel	Create (string name, Vector3 pos, Quaternion rotation)
	Creates a GameObject and attaches this component type to it.
Public Attributes
int	index
	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.
bool	deactivateAllOnDismiss
	When true, will recursively set all child objects to inactive. Conversely, it will recursively set all child objects to active when brought in.
bool	detargetOnDisable = false
	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.
Properties
override EZTransitionList	Transitions `[get]`
bool	IsTransitioning `[get]`
	Indicates whether the panel is currently transitioning.
virtual bool	controlIsEnabled `[get, set]`
	Controls whether this control is in an enabled state or not. If it is not, input is not processed. This can also be used to cause a control to take on a "grayed out" appearance when disabled.
virtual bool	DetargetOnDisable `[get, set]`
	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.
object	Data `[get, set]`
	Holds "boxed" data for the control. This can be used to associate any object or value with the control for later reference and use.
bool	IsDraggable `[get, set]`
	Indicates whether the object can be dragged as part of a drag & drop operation.
LayerMask	DropMask `[get, set]`
	A mask which can be used to make the object only be "droppable" on objects in a certain layer. NOTE: This mask is combined with the camera's mask.
float	DragOffset `[get, set]`
	The distance an object being dragged and dropped should be offset toward the camera to ensure it hovers above other objects and controls in the scene.
EZAnimation.EASING_TYPE	CancelDragEasing `[get, set]`
	The type of easing to use to animate the object back to its starting position when a drag operation is cancelled.
float	CancelDragDuration `[get, set]`
	The duration of the easing animation when a drag and drop operation is cancelled.
bool	IsDragging `[get, set]`
	Indicates whether the object is being dragged as part of a drag & drop operation. Setting this value to false while the object is being dragged will cause the drag and drop operation to be cancelled.
GameObject	DropTarget `[get, set]`
	The GameObject over which the object being dragged is hovering and will attempt to be dropped if it let go.
bool	DropHandled `[get, set]`
	In the context of a drag & drop operation, this indicates whether the drop action was handled. If this is not set to true in response to a Dropped message sent to OnEZDragDrop(), the drop will be considered to be unhandled and will result in a cancelled drop, causing the dragged object to return to its original position.

Detailed Description

UIPanel provides functionality as a container for controls. Controls can be organized into panels and manipulated as a group.

To organize controls into a panel, simply make them children of a GameObject containing a UIPanel component.

Member Function Documentation

void UIPanelBase.AddChild ( GameObject go ) [inherited]

Reference to the parent UIView.

Adds a child to the container.

Parameters:

go

GameObject to be added as a child of the container.

Implements IUIContainer.

void UIPanelBase.AddDragDropDelegate ( EZDragDropDelegate del ) [inherited]

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

Parameters:

del

The delegate to add.

Implements IEZDragDrop.

virtual void UIPanelBase.AddInputDelegate ( EZInputDelegate del ) [virtual, inherited]

Adds a method to be called when input occurs (input is forwarded from OnInput()).

Parameters:

del

A method that conforms to the EZInputDelegate pattern.

Implements IUIObject.

void UIPanelBase.AddSubject ( GameObject go ) [inherited]

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

Parameters:

go

GameObject to be added as a subject.

Implements IUIContainer.

void UIPanelBase.AddTempTransitionDelegate ( TransitionCompleteDelegate del ) [inherited]

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

Parameters:

del

Delegate to be called.

virtual void UIPanelBase.AddValueChangedDelegate ( EZValueChangedDelegate del ) [virtual, inherited]

Adds a method to be called when the value of a control changes (such as a checkbox changing from false to true, or a slider being moved).

Parameters:

del

A method that conforms to the EZValueChangedDelegate pattern.

Implements IUIObject.

virtual void UIPanelBase.BringIn ( ) [virtual, inherited]

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

void UIPanelBase.CancelDrag ( ) [inherited]

Cancels any pending drag and drop operation.

Implements IEZDragDrop.

static UIPanel UIPanel.Create	(	string	name,
		Vector3	pos,
		Quaternion	rotation
	)			`[static]`

Creates a GameObject and attaches this component type to it.

Parameters:

	name	Name to give to the new GameObject.
	pos	Position, in world space, where the new object should be created.
	rotation	Rotation of the object.

Returns:: Returns a reference to the component.

static UIPanel UIPanel.Create	(	string	name,
		Vector3	pos
	)			`[static]`

Creates a GameObject and attaches this component type to it.

Parameters:

	name	Name to give to the new GameObject.
	pos	Position, in world space, where the new object should be created.

Returns:: Returns a reference to the component.

virtual void UIPanelBase.Dismiss ( ) [virtual, inherited]

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

EZTransition UIPanelBase.GetTransition ( string transName ) [inherited]

Returns a reference to the specified transition.

Parameters:

transName

The name of the transition to retrieve.

Returns:: Returns a reference to the specified transition. Null if none is found.

EZTransition UIPanelBase.GetTransition ( UIPanelManager.SHOW_MODE transition ) [inherited]

Returns a reference to the specified transition.

Parameters:

transition

The enum identifying the transition to retrieve.

Returns:: Returns a reference to the specified transition. Null if none is found.

EZTransition UIPanelBase.GetTransition ( int index ) [inherited]

Returns a reference to the transition at the specified index.

Parameters:

index

The zero-based index of the transition to retrieve.

Returns:: Returns a reference to the transition at the specified index. Null if none is found at the specified index.

void UIPanelBase.MakeChild ( GameObject go ) [inherited]

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

Parameters:

go

GameObject to make a child of the panel.

virtual void UIPanelBase.OnInput ( POINTER_INFO ptr ) [virtual, inherited]

This is where input handling code should go in any derived class.

Parameters:

ptr

POINTER_INFO struct that contains information on the pointer that caused the event, as well as the event that occurred.

Implements IUIObject.

Reimplemented in UIBistateInteractivePanel, and UIInteractivePanel.

void UIPanelBase.RemoveChild ( GameObject go ) [inherited]

Removes an object as a child of the container.

Parameters:

go

Object to be removed.

Implements IUIContainer.

void UIPanelBase.RemoveDragDropDelegate ( EZDragDropDelegate del ) [inherited]

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

Parameters:

del

The delegate to add.

Implements IEZDragDrop.

virtual void UIPanelBase.RemoveInputDelegate ( EZInputDelegate del ) [virtual, inherited]

Removes a method added with AddInputDelegate().

Parameters:

del

A method that conforms to the EZInputDelegate pattern.

Implements IUIObject.

void UIPanelBase.RemoveSubject ( GameObject go ) [inherited]

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

Parameters:

go

GameObject to be removed as a subject.

Implements IUIContainer.

virtual void UIPanelBase.RemoveValueChangedDelegate ( EZValueChangedDelegate del ) [virtual, inherited]

Removes a method added with AddValueChangedDelegate().

Parameters:

del

A method that conforms to the EZValueChangedDelegate pattern.

Implements IUIObject.

void UIPanelBase.SetDragDropDelegate ( EZDragDropDelegate del ) [inherited]

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

Parameters:

del

The delegate to add.

Implements IEZDragDrop.

virtual void UIPanelBase.SetInputDelegate ( EZInputDelegate del ) [virtual, inherited]

Sets the method to be called when input occurs (input is forwarded from OnInput()). NOTE: This will replace any and all delegates which have been set or added previously. If you are unsure if any delegates are already registered, use AddInputDelegate() instead, or RemoveInputDelegate() to unset a previously registered delegate. Only use this when you are sure you want to replace all previously registered delegates.

Parameters:

del

A method that conforms to the EZInputDelegate pattern.

Implements IUIObject.

virtual void UIPanelBase.SetValueChangedDelegate ( EZValueChangedDelegate del ) [virtual, inherited]

Sets the method to be called when the value of a control changes (such as a checkbox changing from false to true, or a slider being moved). NOTE: This will replace any and all delegates which have been set or added previously. If you are unsure if any delegates are already registered, use AddValueChangedDelegate() instead, or RemoveValueChangedDelegate() to unset a previously registered delegate. Only use this when you are sure you want to replace all previously registered delegates.

Parameters:

del

A method that conforms to the EZValueChangedDelegate pattern.

Implements IUIObject.

virtual void UIPanelBase.StartTransition ( string transName ) [virtual, inherited]

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

Parameters:

transName

The name of the transition to start. Ex: "Bring In Forward"

virtual void UIPanelBase.StartTransition ( UIPanelManager.SHOW_MODE mode ) [virtual, inherited]

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

Parameters:

mode

The mode corresponding to the transition that should be played.

Reimplemented in UIBistateInteractivePanel.

delegate void UIPanelBase.TransitionCompleteDelegate	(	UIPanelBase	panel,
		EZTransition	transition
	)			`[inherited]`

Delegate definition for receiving notification of when a UIPanel has finished transitioning.

Parameters:

	panel	Reference to the panel itself.
	transition	Reference to the transition which has just completed.

Member Data Documentation

bool UIPanelBase.deactivateAllOnDismiss [inherited]

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

bool UIPanelBase.detargetOnDisable = false [inherited]

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.

int UIPanelBase.index [inherited]

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.

Property Documentation

float UIPanelBase.CancelDragDuration [get, set, inherited]

The duration of the easing animation when a drag and drop operation is cancelled.

Implements IEZDragDrop.

EZAnimation.EASING_TYPE UIPanelBase.CancelDragEasing [get, set, inherited]

The type of easing to use to animate the object back to its starting position when a drag operation is cancelled.

Implements IEZDragDrop.

virtual bool UIPanelBase.controlIsEnabled [get, set, inherited]

Controls whether this control is in an enabled state or not. If it is not, input is not processed. This can also be used to cause a control to take on a "grayed out" appearance when disabled.

Implements IUIObject.

object UIPanelBase.Data [get, set, inherited]

Holds "boxed" data for the control. This can be used to associate any object or value with the control for later reference and use.

Implements IEZDragDrop.

virtual bool UIPanelBase.DetargetOnDisable [get, set, inherited]

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.

Implements IUIObject.

float UIPanelBase.DragOffset [get, set, inherited]

The distance an object being dragged and dropped should be offset toward the camera to ensure it hovers above other objects and controls in the scene.

Implements IEZDragDrop.

bool UIPanelBase.DropHandled [get, set, inherited]

In the context of a drag & drop operation, this indicates whether the drop action was handled. If this is not set to true in response to a Dropped message sent to OnEZDragDrop(), the drop will be considered to be unhandled and will result in a cancelled drop, causing the dragged object to return to its original position.

Implements IEZDragDrop.

LayerMask UIPanelBase.DropMask [get, set, inherited]

A mask which can be used to make the object only be "droppable" on objects in a certain layer. NOTE: This mask is combined with the camera's mask.

Implements IEZDragDrop.

GameObject UIPanelBase.DropTarget [get, set, inherited]

The GameObject over which the object being dragged is hovering and will attempt to be dropped if it let go.

Implements IEZDragDrop.

bool UIPanelBase.IsDraggable [get, set, inherited]

Indicates whether the object can be dragged as part of a drag & drop operation.

Implements IEZDragDrop.

bool UIPanelBase.IsDragging [get, set, inherited]

Indicates whether the object is being dragged as part of a drag & drop operation. Setting this value to false while the object is being dragged will cause the drag and drop operation to be cancelled.

Implements IEZDragDrop.

bool UIPanelBase.IsTransitioning [get, inherited]

Indicates whether the panel is currently transitioning.

override EZTransitionList UIPanel.Transitions [get]

UIPanel provides functionality as a container for controls. Controls can be organized into panels and manipulated as a group.

To organize controls into a panel, simply make them children of a GameObject containing a UIPanel component.

Reimplemented from UIPanelBase.

The documentation for this class was generated from the following file:

UIPanel.cs

UIPanel Class Reference

Public Member Functions

Static Public Member Functions

Public Attributes

Properties

Detailed Description

Member Function Documentation

Member Data Documentation

Property Documentation