|
|
@@ -4,14 +4,28 @@ using System.Runtime.CompilerServices;
|
|
|
|
|
|
namespace BansheeEngine
|
|
|
{
|
|
|
+ /// <summary>
|
|
|
+ /// Base class for GUI layout implementations. GUI layouts serve as containers
|
|
|
+ /// for GUI elements that position and resize the elements automatically with
|
|
|
+ /// respect to layout rules set on the elements.
|
|
|
+ /// </summary>
|
|
|
public abstract class GUILayout : GUIElement
|
|
|
{
|
|
|
+ /// <summary>
|
|
|
+ /// Adds a new element to the layout after all existing elements.
|
|
|
+ /// </summary>
|
|
|
+ /// <param name="element">GUI element to add.</param>
|
|
|
public void AddElement(GUIElement element)
|
|
|
{
|
|
|
if(element != null)
|
|
|
Internal_AddElement(mCachedPtr, element.mCachedPtr);
|
|
|
}
|
|
|
|
|
|
+ /// <summary>
|
|
|
+ /// Inserts a GUI element before the element at the specified index.
|
|
|
+ /// </summary>
|
|
|
+ /// <param name="index">Index to insert the GUI element at. This must be in range [0, GetNumChildren()).</param>
|
|
|
+ /// <param name="element">GUI element to insert.</param>
|
|
|
public void InsertElement(int index, GUIElement element)
|
|
|
{
|
|
|
if(index < 0 || index > GetNumChildren())
|
|
|
@@ -21,16 +35,30 @@ namespace BansheeEngine
|
|
|
Internal_InsertElement(mCachedPtr, index, element.mCachedPtr);
|
|
|
}
|
|
|
|
|
|
+ /// <summary>
|
|
|
+ /// Returns number of child elements in the layout.
|
|
|
+ /// </summary>
|
|
|
+ /// <returns>Number of child elements in the layout.</returns>
|
|
|
public int GetNumChildren()
|
|
|
{
|
|
|
return Internal_GetChildCount(mCachedPtr);
|
|
|
}
|
|
|
|
|
|
+ /// <summary>
|
|
|
+ /// Gets a child elements at the specified index in the layout.
|
|
|
+ /// </summary>
|
|
|
+ /// <param name="index">Index of the element to retrieve. This must be in range [0, GetNumChildren()).</param>
|
|
|
+ /// <returns>GUI element at the specified index, or null if the index is invalid.</returns>
|
|
|
public GUIElement GetChild(int index)
|
|
|
{
|
|
|
return Internal_GetChild(mCachedPtr, index);
|
|
|
}
|
|
|
|
|
|
+ /// <summary>
|
|
|
+ /// Adds a new horizontal layout as a child of this layout. Layout is inserted after all existing elements.
|
|
|
+ /// </summary>
|
|
|
+ /// <param name="options">Options that allow you to control how is the layout positioned and sized.</param>
|
|
|
+ /// <returns>Newly created horizontal layout.</returns>
|
|
|
public GUILayoutX AddLayoutX(params GUIOption[] options)
|
|
|
{
|
|
|
GUILayoutX layout = new GUILayoutX(options);
|
|
|
@@ -38,6 +66,11 @@ namespace BansheeEngine
|
|
|
return layout;
|
|
|
}
|
|
|
|
|
|
+ /// <summary>
|
|
|
+ /// Adds a new vertical layout as a child of this layout. Layout is inserted after all existing elements.
|
|
|
+ /// </summary>
|
|
|
+ /// <param name="options">Options that allow you to control how is the layout positioned and sized.</param>
|
|
|
+ /// <returns>Newly created vertical layout.</returns>
|
|
|
public GUILayoutY AddLayoutY(params GUIOption[] options)
|
|
|
{
|
|
|
GUILayoutY layout = new GUILayoutY(options);
|
|
|
@@ -45,6 +78,11 @@ namespace BansheeEngine
|
|
|
return layout;
|
|
|
}
|
|
|
|
|
|
+ /// <summary>
|
|
|
+ /// Adds a new GUI panel as a child of this layout. Panel is inserted after all existing elements.
|
|
|
+ /// </summary>
|
|
|
+ /// <param name="options">Options that allow you to control how is the panel positioned and sized.</param>
|
|
|
+ /// <returns>Newly created GUI panel.</returns>
|
|
|
public GUIPanel AddPanel(params GUIOption[] options)
|
|
|
{
|
|
|
GUIPanel layout = new GUIPanel(options);
|
|
|
@@ -52,13 +90,35 @@ namespace BansheeEngine
|
|
|
return layout;
|
|
|
}
|
|
|
|
|
|
- public GUIPanel AddPanel(Int16 depth = 0, ushort depthRangeMin = ushort.MaxValue, ushort depthRangeMax = ushort.MaxValue, params GUIOption[] options)
|
|
|
+ /// <summary>
|
|
|
+ /// Adds a new GUI panel as a child of this layout. Panel is inserted after all existing elements.
|
|
|
+ /// </summary>
|
|
|
+ /// <param name="depth">Depth at which to position the panel. Panels with lower depth will be displayed in front of
|
|
|
+ /// panels with higher depth. Provided depth is relative to the depth of the parent GUI panel. The depth value will
|
|
|
+ /// be clamped if outside of the depth range of the parent GUI panel.
|
|
|
+ /// </param>
|
|
|
+ /// <param name="depthRangeMin">Smallest depth offset allowed by any child GUI panels. If a child panel has a depth
|
|
|
+ /// offset lower than this value it will be clamped.
|
|
|
+ /// </param>
|
|
|
+ /// <param name="depthRangeMax">Largest depth offset allowed by any child GUI panels. If a child panel has a depth
|
|
|
+ /// offset higher than this value it will be clamped.
|
|
|
+ /// </param>
|
|
|
+ /// <param name="options">Options that allow you to control how is the panel positioned and sized.
|
|
|
+ /// </param>
|
|
|
+ /// <returns>Newly created GUI panel.</returns>
|
|
|
+ public GUIPanel AddPanel(Int16 depth = 0, ushort depthRangeMin = ushort.MaxValue,
|
|
|
+ ushort depthRangeMax = ushort.MaxValue, params GUIOption[] options)
|
|
|
{
|
|
|
GUIPanel layout = new GUIPanel(depth, depthRangeMin, depthRangeMax, options);
|
|
|
AddElement(layout);
|
|
|
return layout;
|
|
|
}
|
|
|
|
|
|
+ /// <summary>
|
|
|
+ /// Adds a new flexible space as a child of this layout. Flexible space expands
|
|
|
+ /// to fill all available space in the layout. Space is inserted after all existing elements.
|
|
|
+ /// </summary>
|
|
|
+ /// <returns>Newly created flexible space.</returns>
|
|
|
public GUIFlexibleSpace AddFlexibleSpace()
|
|
|
{
|
|
|
GUIFlexibleSpace space = new GUIFlexibleSpace();
|
|
|
@@ -66,6 +126,14 @@ namespace BansheeEngine
|
|
|
return space;
|
|
|
}
|
|
|
|
|
|
+ /// <summary>
|
|
|
+ /// Adds a new fixed space object. Fixed space inserts a blank space with specific
|
|
|
+ /// width or height (depending on layout type) in the layout. Space is inserted after all existing elements.
|
|
|
+ /// </summary>
|
|
|
+ /// <param name="size">Size of the space in pixels. This will represent either width or height depending whether the
|
|
|
+ /// layout is vertical or horizontal.
|
|
|
+ /// </param>
|
|
|
+ /// <returns>Newly created fixed space.</returns>
|
|
|
public GUIFixedSpace AddSpace(int size)
|
|
|
{
|
|
|
GUIFixedSpace space = new GUIFixedSpace(size);
|
|
|
@@ -73,6 +141,13 @@ namespace BansheeEngine
|
|
|
return space;
|
|
|
}
|
|
|
|
|
|
+ /// <summary>
|
|
|
+ /// Adds a new horizontal layout as a child of this layout. Layout is inserted
|
|
|
+ /// before the element at the specified index.
|
|
|
+ /// </summary>
|
|
|
+ /// <param name="idx">Index to insert the layout at. This must be in range [0, GetNumChildren()) </param>
|
|
|
+ /// <param name="options">Options that allow you to control how is the layout positioned and sized.</param>
|
|
|
+ /// <returns>Newly created horizontal layout.</returns>
|
|
|
public GUILayoutX InsertLayoutX(int idx, params GUIOption[] options)
|
|
|
{
|
|
|
GUILayoutX layout = new GUILayoutX(options);
|
|
|
@@ -80,6 +155,13 @@ namespace BansheeEngine
|
|
|
return layout;
|
|
|
}
|
|
|
|
|
|
+ /// <summary>
|
|
|
+ /// Adds a new vertical layout as a child of this layout. Layout is inserted
|
|
|
+ /// before the element at the specified index.
|
|
|
+ /// </summary>
|
|
|
+ /// <param name="idx">Index to insert the layout at. This must be in range [0, GetNumChildren()).</param>
|
|
|
+ /// <param name="options">Options that allow you to control how is the layout positioned and sized.</param>
|
|
|
+ /// <returns>Newly created vertical layout.</returns>
|
|
|
public GUILayoutY InsertLayoutY(int idx, params GUIOption[] options)
|
|
|
{
|
|
|
GUILayoutY layout = new GUILayoutY(options);
|
|
|
@@ -87,6 +169,12 @@ namespace BansheeEngine
|
|
|
return layout;
|
|
|
}
|
|
|
|
|
|
+ /// <summary>
|
|
|
+ /// Adds a new GUI panel as a child of this layout. Panel is inserted before the element at the specified index.
|
|
|
+ /// </summary>
|
|
|
+ /// <param name="idx">Index to insert the panel at. This must be in range [0, GetNumChildren()).</param>
|
|
|
+ /// <param name="options">Options that allow you to control how is the panel positioned and sized.</param>
|
|
|
+ /// <returns>Newly created GUI panel.</returns>
|
|
|
public GUIPanel InsertPanel(int idx, params GUIOption[] options)
|
|
|
{
|
|
|
GUIPanel layout = new GUIPanel(options);
|
|
|
@@ -94,6 +182,22 @@ namespace BansheeEngine
|
|
|
return layout;
|
|
|
}
|
|
|
|
|
|
+ /// <summary>
|
|
|
+ /// Adds a new GUI panel as a child of this layout. Panel is inserted before the element at the specified index.
|
|
|
+ /// </summary>
|
|
|
+ /// <param name="depth">Depth at which to position the panel. Panels with lower depth will be displayed in front of
|
|
|
+ /// panels with higher depth. Provided depth is relative to the depth of the parent GUI panel. The depth value will
|
|
|
+ /// be clamped if outside of the depth range of the parent GUI panel.
|
|
|
+ /// </param>
|
|
|
+ /// <param name="depthRangeMin">Smallest depth offset allowed by any child GUI panels. If a child panel has a depth
|
|
|
+ /// offset lower than this value it will be clamped.
|
|
|
+ /// </param>
|
|
|
+ /// <param name="depthRangeMax">Largest depth offset allowed by any child GUI panels. If a child panel has a depth
|
|
|
+ /// offset higher than this value it will be clamped.
|
|
|
+ /// </param>
|
|
|
+ /// <param name="options">Options that allow you to control how is the panel positioned and sized.
|
|
|
+ /// </param>
|
|
|
+ /// <returns>Newly created GUI panel.</returns>
|
|
|
public GUIPanel InsertPanel(int idx, Int16 depth = 0, ushort depthRangeMin = ushort.MaxValue,
|
|
|
ushort depthRangeMax = ushort.MaxValue, params GUIOption[] options)
|
|
|
{
|
|
|
@@ -102,6 +206,11 @@ namespace BansheeEngine
|
|
|
return layout;
|
|
|
}
|
|
|
|
|
|
+ /// <summary>
|
|
|
+ /// Adds a new flexible space as a child of this layout. Flexible space expands to fill all available space in the
|
|
|
+ /// layout. is inserted before the element at the specified index.
|
|
|
+ /// </summary>
|
|
|
+ /// <returns>Newly created flexible space.</returns>
|
|
|
public GUIFlexibleSpace InsertFlexibleSpace(int idx)
|
|
|
{
|
|
|
GUIFlexibleSpace space = new GUIFlexibleSpace();
|
|
|
@@ -109,6 +218,13 @@ namespace BansheeEngine
|
|
|
return space;
|
|
|
}
|
|
|
|
|
|
+ /// <summary>
|
|
|
+ /// Adds a new fixed space object. Fixed space inserts a blank space with specific width or height (depending on
|
|
|
+ /// layout type) in the layout. Space is inserted after all existing elements.
|
|
|
+ /// </summary>
|
|
|
+ /// <param name="size">Size of the space in pixels. This will represent either width or height depending whether the
|
|
|
+ /// layout is vertical or horizontal.</param>
|
|
|
+ /// <returns>Newly created fixed space.</returns>
|
|
|
public GUIFixedSpace InsertSpace(int idx, int size)
|
|
|
{
|
|
|
GUIFixedSpace space = new GUIFixedSpace(size);
|
|
|
@@ -126,7 +242,8 @@ namespace BansheeEngine
|
|
|
protected static extern void Internal_CreateInstanceY(GUILayout instance, GUIOption[] options);
|
|
|
|
|
|
[MethodImpl(MethodImplOptions.InternalCall)]
|
|
|
- protected static extern void Internal_CreateInstancePanel(GUILayout instance, Int16 depth, ushort depthRangeMin, ushort depthRangeMax, GUIOption[] options);
|
|
|
+ protected static extern void Internal_CreateInstancePanel(GUILayout instance, Int16 depth, ushort depthRangeMin,
|
|
|
+ ushort depthRangeMax, GUIOption[] options);
|
|
|
|
|
|
[MethodImpl(MethodImplOptions.InternalCall)]
|
|
|
protected static extern void Internal_AddElement(IntPtr instance, IntPtr element);
|
Marko Pintera