Kerbal Space Program  1.12.4
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Properties Events Macros
Public Types | Public Member Functions | Public Attributes | Protected Member Functions | Protected Attributes | Properties | List of all members
Expansions.Missions.Editor.MEGUIPanel Class Reference

This class defines the behaviour of an Mission Editor panel, panels are subwindows of the ME that can be resized, hided or maximized in the screen More...

Inheritance diagram for Expansions.Missions.Editor.MEGUIPanel:

Public Types

enum  PanelAnchor {
  PanelAnchor.Left, PanelAnchor.Right, PanelAnchor.Top, PanelAnchor.Bottom,
  PanelAnchor.None
}
 Defines where is the window moving from More...
 
enum  PanelSizeStyle { PanelSizeStyle.Absolute, PanelSizeStyle.Normalized }
 Defines the panel size values style, absoulte screen pixels or normalized values More...
 
enum  PanelState { PanelState.Normal, PanelState.Hidden, PanelState.Maximized }
 Defines the panel state More...
 

Public Member Functions

void Hide (bool enableUI=false)
 Hides this panel More...
 
void Maximize ()
 Maximize this panel More...
 
void RebuildPanelLayout ()
 Rebuild the layout and child layout elements afected by calculations More...
 
void Reset ()
 Reset the panels to the default state More...
 
void Restore ()
 Restore this panel to it's previous size More...
 
void Show (bool enableUI=false)
 Shows this panel More...
 

Public Attributes

PanelAnchor Anchor
 Specifies the panel anchor position within the ME More...
 
RectTransform ContentRoot
 Root transform where this panel content is located More...
 
MEGUIPanel[] HideOnMaximize
 Array of panels that should hide in order for this panel to be maximized More...
 
float maxHeight
 
RectTransform MaximizeParent
 Transform of the parent where the panel should move on maximize More...
 
Toggle MaximizeToggle
 
float maxWidth
 
float minHeight
 
float minWidth
 
float preferredHeight
 
float preferredWidth
 
PanelSizeStyle SizeStyle
 Specifies the style of the size values stored in the panel min, preferred, max values. More...
 
Toggle VisibilityToggle
 

Protected Member Functions

void OnMaximizeValueChange (bool value)
 
void OnVisibilityValueChange (bool value)
 
IEnumerator VisibilityHideAnimation ()
 Slide animation coroutine that changes the panel visibility to hidden More...
 
IEnumerator VisibilityShowAnimation ()
 Slide animation coroutine that changes the panel visibility to normal More...
 

Protected Attributes

List< MEGUIPanelchildPanels
 List of child panels of this panel More...
 
List< MEGUIPanelhiddenPanels
 List of panels references that were hidden during the maximize More...
 
bool isMoving = false
 Specifies wherever the panel is moving to a show <-> hide state More...
 
LayoutElement layoutElement
 
RectTransform parent
 

Properties

float CurrentHeight [get, set]
 Gets the current height of this panel, or zero if this axis is auto adjusted More...
 
float CurrentWidth [get, set]
 Gets the current width of this panel, or zero if this axis is auto adjusted More...
 
PanelState State [get, set]
 Current panel state More...
 

Detailed Description

This class defines the behaviour of an Mission Editor panel, panels are subwindows of the ME that can be resized, hided or maximized in the screen

Member Enumeration Documentation

Defines where is the window moving from

Enumerator
Left 
Right 
Top 
Bottom 
None 

Defines the panel size values style, absoulte screen pixels or normalized values

Enumerator
Absolute 
Normalized 

Defines the panel state

Enumerator
Normal 
Hidden 
Maximized 

Member Function Documentation

void Expansions.Missions.Editor.MEGUIPanel.Hide ( bool  enableUI = false)
inline

Hides this panel

Parameters
enableUISpecifies whatever or not the UI Buttons should be activaded
void Expansions.Missions.Editor.MEGUIPanel.Maximize ( )
inline

Maximize this panel

void Expansions.Missions.Editor.MEGUIPanel.OnMaximizeValueChange ( bool  value)
inlineprotected
void Expansions.Missions.Editor.MEGUIPanel.OnVisibilityValueChange ( bool  value)
inlineprotected
void Expansions.Missions.Editor.MEGUIPanel.RebuildPanelLayout ( )
inline

Rebuild the layout and child layout elements afected by calculations

void Expansions.Missions.Editor.MEGUIPanel.Reset ( )
inline

Reset the panels to the default state

void Expansions.Missions.Editor.MEGUIPanel.Restore ( )
inline

Restore this panel to it's previous size

void Expansions.Missions.Editor.MEGUIPanel.Show ( bool  enableUI = false)
inline

Shows this panel

Parameters
enableUISpecifies whatever or not the UI Buttons should be activaded
IEnumerator Expansions.Missions.Editor.MEGUIPanel.VisibilityHideAnimation ( )
inlineprotected

Slide animation coroutine that changes the panel visibility to hidden

Returns
IEnumerator Expansions.Missions.Editor.MEGUIPanel.VisibilityShowAnimation ( )
inlineprotected

Slide animation coroutine that changes the panel visibility to normal

Returns

Member Data Documentation

PanelAnchor Expansions.Missions.Editor.MEGUIPanel.Anchor

Specifies the panel anchor position within the ME

List<MEGUIPanel> Expansions.Missions.Editor.MEGUIPanel.childPanels
protected

List of child panels of this panel

RectTransform Expansions.Missions.Editor.MEGUIPanel.ContentRoot

Root transform where this panel content is located

List<MEGUIPanel> Expansions.Missions.Editor.MEGUIPanel.hiddenPanels
protected

List of panels references that were hidden during the maximize

MEGUIPanel [] Expansions.Missions.Editor.MEGUIPanel.HideOnMaximize

Array of panels that should hide in order for this panel to be maximized

bool Expansions.Missions.Editor.MEGUIPanel.isMoving = false
protected

Specifies wherever the panel is moving to a show <-> hide state

LayoutElement Expansions.Missions.Editor.MEGUIPanel.layoutElement
protected
float Expansions.Missions.Editor.MEGUIPanel.maxHeight
RectTransform Expansions.Missions.Editor.MEGUIPanel.MaximizeParent

Transform of the parent where the panel should move on maximize

Toggle Expansions.Missions.Editor.MEGUIPanel.MaximizeToggle
float Expansions.Missions.Editor.MEGUIPanel.maxWidth
float Expansions.Missions.Editor.MEGUIPanel.minHeight
float Expansions.Missions.Editor.MEGUIPanel.minWidth
RectTransform Expansions.Missions.Editor.MEGUIPanel.parent
protected
float Expansions.Missions.Editor.MEGUIPanel.preferredHeight
float Expansions.Missions.Editor.MEGUIPanel.preferredWidth
PanelSizeStyle Expansions.Missions.Editor.MEGUIPanel.SizeStyle

Specifies the style of the size values stored in the panel min, preferred, max values.

Toggle Expansions.Missions.Editor.MEGUIPanel.VisibilityToggle

Property Documentation

float Expansions.Missions.Editor.MEGUIPanel.CurrentHeight
getset

Gets the current height of this panel, or zero if this axis is auto adjusted

float Expansions.Missions.Editor.MEGUIPanel.CurrentWidth
getset

Gets the current width of this panel, or zero if this axis is auto adjusted

PanelState Expansions.Missions.Editor.MEGUIPanel.State
getset

Current panel state


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