Class StackPanel
Hierarchy
- Container
- StackPanel
Index
Constructors
Properties
- animations
- fixed
Ratio - hover
Cursor - ignore
Layout Warnings - is
Focus Invisible - is
Hit Test Visible - is
Pointer Blocker - log
Layout Cycle Errors - max
Layout Cycle - metadata
- name
- on
Accessibility Tag Changed Observable - on
After Draw Observable - on
Before Draw Observable - on
Control Added Observable - on
Control Removed Observable - on
Dirty Observable - on
Dispose Observable - on
Is Visible Changed Observable - on
Pointer Click Observable - on
Pointer Down Observable - on
Pointer Enter Observable - on
Pointer Move Observable - on
Pointer Out Observable - on
Pointer Up Observable - on
Wheel Observable - overlap
Delta Multiplier - overlap
Group - parent
- unique
Id - use
Bitmap Cache - Add
Header - Allow
Alpha Inheritance
Accessors
- accessibility
Tag - adapt
Height To Children - adapt
Width To Children - alpha
- background
- background
Gradient - centerX
- centerY
- children
- clip
Children - clip
Content - color
- descendants
Only Padding - disabled
Color - disabled
Color Item - font
Family - font
Offset - font
Size - font
Size In Pixels - font
Style - font
Weight - gradient
- height
- height
In Pixels - highlight
Color - highlight
Line Width - horizontal
Alignment - host
- is
Dirty - is
Enabled - is
Highlighted - is
Read Only - is
Vertical - is
Visible - left
- left
In Pixels - link
OffsetX - link
OffsetXIn Pixels - link
OffsetY - link
OffsetYIn Pixels - linked
Mesh - not
Renderable - padding
Bottom - padding
Bottom In Pixels - padding
Left - padding
Left In Pixels - padding
Right - padding
Right In Pixels - padding
Top - padding
Top In Pixels - render
To Intermediate Texture - rotation
- scaleX
- scaleY
- shadow
Blur - shadow
Color - shadow
OffsetX - shadow
OffsetY - spacing
- style
- top
- top
In Pixels - transform
CenterX - transform
CenterY - transformed
Measure - type
Name - vertical
Alignment - width
- width
In Pixels - z
Index - HORIZONTAL_
ALIGNMENT_ CENTER - HORIZONTAL_
ALIGNMENT_ LEFT - HORIZONTAL_
ALIGNMENT_ RIGHT - VERTICAL_
ALIGNMENT_ BOTTOM - VERTICAL_
ALIGNMENT_ CENTER - VERTICAL_
ALIGNMENT_ TOP
Methods
- _flag
Descendants As Matrix Dirty - add
Control - clear
Controls - clone
- contains
- contains
Control - dispose
- get
Ascendant Of Class - get
Child By Name - get
Child By Type - get
Class Name - get
Descendants - get
Descendants To Ref - get
Local Coordinates - get
Local Coordinates To Ref - get
Parent Local Coordinates - is
Ascendant - is
Ready - link
With Mesh - mark
All As Dirty - mark
As Dirty - move
To Vector3 - parse
- remove
Control - serialize
- set
Padding - set
Padding In Pixels - Parse
Constructors
constructor
Creates a new StackPanel
Parameters
Optional name: string
defines control name
Returns StackPanel
Properties
animationsSearch playground for animations
Array of animations
fixed
Gets or sets a fixed ratio for this control. When different from 0, the ratio is used to compute the "second" dimension. The first dimension used in the computation is the last one set (by setting width / widthInPixels or height / heightInPixels), and the second dimension is computed as first dimension * fixedRatio
hover
Gets or sets the cursor to use when the control is hovered
ignore
Gets or sets a boolean indicating that layout warnings should be ignored
is
Gets or sets a boolean indicating if the control can be focusable
is
Gets or sets a boolean indicating if the control can be hit with pointer events
is
Gets or sets a boolean indicating if the control can block pointer events. False by default except on the following controls:
- Button controls (Button, RadioButton, ToggleButton)
- Checkbox
- ColorPicker
- InputText
- Slider
log
Gets or sets a boolean indicating that layout cycle errors should be displayed on the console
max
Gets or sets the number of layout cycles (a change involved by a control while evaluating the layout) allowed
metadataSearch playground for metadata
Gets or sets an object used to store user defined information for the node
Optional nameSearch playground for name
defines the name of the control
on
on
An event triggered after the control was drawn
on
An event triggered before drawing the control
on
An event triggered when any control is added to this container.
on
An event triggered when any control is removed from this container.
on
An event triggered when the control is marked as dirty
on
An event triggered when the control has been disposed
on
An event triggered when the control isVisible is changed
on
An event triggered when a control is clicked on
on
An event triggered when the pointer taps the control
on
An event triggered when pointer enters the control
on
An event triggered when the pointer moves over the control.
on
An event triggered when the pointer moves out of the control.
on
An event triggered when pointer up
on
An event triggered when pointer wheel is scrolled
Optional overlap
Gets/sets the deoverlap movement multiplier
Optional overlap
Gets/sets the overlap group of the control. Controls with overlapGroup set to a number can be deoverlapped. Controls with overlapGroup set to undefined are not deoverlapped.
parentSearch playground for parent
Gets or sets the control parent
unique
Gets or sets the unique id of the node. Please note that this number will be updated when the control is added to a container
use
Gets or sets a boolean indicating that the current control should cache its rendering (useful when the control does not change often)
Static Add
Type declaration
Parameters
control: Control
text: string
size: string | number
options: { controlFirst: boolean; isHorizontal: boolean }
control
First: boolean is
Horizontal: boolean
Returns any
Static Allow
Gets or sets a boolean indicating if alpha must be an inherited value (false by default)
Accessors
accessibility
Gets or sets the accessibility tag to describe the control for accessibility purpose. By default, GUI controls already indicate accessibility info, but one can override the info using this tag.
Returns Nullable<IAccessibilityTag>
Gets or sets the accessibility tag to describe the control for accessibility purpose. By default, GUI controls already indicate accessibility info, but one can override the info using this tag.
Parameters
value: Nullable<IAccessibilityTag>
Returns void
adapt
Gets or sets a boolean indicating if the container should try to adapt to its children height
Returns boolean
Gets or sets a boolean indicating if the container should try to adapt to its children height
Parameters
value: boolean
Returns void
adapt
Gets or sets a boolean indicating if the container should try to adapt to its children width
Returns boolean
Gets or sets a boolean indicating if the container should try to adapt to its children width
Parameters
value: boolean
Returns void
alpha
Gets or sets alpha value for the control (1 means opaque and 0 means entirely transparent)
Returns number
Gets or sets alpha value for the control (1 means opaque and 0 means entirely transparent)
Parameters
value: number
Returns void
background
Gets or sets background color
Returns string
Gets or sets background color
Parameters
value: string
Returns void
background
Gets or sets background gradient color. Takes precedence over background
Returns Nullable<BaseGradient>
Gets or sets background gradient color. Takes precedence over background
Parameters
value: Nullable<BaseGradient>
Returns void
centerX
Gets the center coordinate on X axis
Returns number
centerY
Gets the center coordinate on Y axis
Returns number
children
Gets the list of children
Returns Control[]
clip
Sets/Gets a boolean indicating if the children are clipped to the current control bounds. Please note that not clipping children may generate issues with adt.useInvalidateRectOptimization so it is recommended to turn this optimization off if you want to use unclipped children
Returns boolean
Sets/Gets a boolean indicating if the children are clipped to the current control bounds. Please note that not clipping children may generate issues with adt.useInvalidateRectOptimization so it is recommended to turn this optimization off if you want to use unclipped children
Parameters
value: boolean
Returns void
clip
Sets/Gets a boolean indicating that control content must be clipped Please note that not clipping content may generate issues with adt.useInvalidateRectOptimization so it is recommended to turn this optimization off if you want to use unclipped children
Returns boolean
Sets/Gets a boolean indicating that control content must be clipped Please note that not clipping content may generate issues with adt.useInvalidateRectOptimization so it is recommended to turn this optimization off if you want to use unclipped children
Parameters
value: boolean
Returns void
color
Gets or sets foreground color
Returns string
Gets or sets foreground color
Parameters
value: string
Returns void
descendants
Gets or sets a value indicating the padding should work like in CSS. Basically, it will add the padding amount on each side of the parent control for its children.
Returns boolean
Gets or sets a value indicating the padding should work like in CSS. Basically, it will add the padding amount on each side of the parent control for its children.
Parameters
value: boolean
Returns void
disabled
Gets or sets background color of control if it's disabled. Only applies to Button class.
Returns string
Gets or sets background color of control if it's disabled. Only applies to Button class.
Parameters
value: string
Returns void
disabled
Gets or sets front color of control if it's disabled. Only applies to Checkbox class.
Returns string
Gets or sets front color of control if it's disabled. Only applies to Checkbox class.
Parameters
value: string
Returns void
font
Gets or set font family
Returns string
Gets or set font family
Parameters
value: string
Returns void
font
Gets or set information about font offsets (used to render and align text)
Returns { ascent: number; descent: number; height: number }
ascent: number
descent: number
height: number
Gets or set information about font offsets (used to render and align text)
Parameters
offset: { ascent: number; descent: number; height: number }
ascent: number
descent: number
height: number
Returns void
font
Gets or sets font size
Returns string | number
Gets or sets font size
Parameters
value: string | number
Returns void
font
Gets or sets font size in pixels
Returns number
Gets or sets font size in pixels
Parameters
value: number
Returns void
font
Gets or sets font style
Returns string
Gets or sets font style
Parameters
value: string
Returns void
font
Gets or sets font weight
Returns string
Gets or sets font weight
Parameters
value: string
Returns void
gradient
Gets or sets gradient. Setting a gradient will override the color
Returns Nullable<BaseGradient>
Gets or sets gradient. Setting a gradient will override the color
Parameters
value: Nullable<BaseGradient>
Returns void
height
Gets or sets panel height. This value should not be set when in vertical mode as it will be computed automatically
Returns string | number
Gets or sets panel height. This value should not be set when in vertical mode as it will be computed automatically
Parameters
value: string | number
Returns void
height
Gets or sets control height in pixel
Returns number
Gets or sets control height in pixel
Parameters
value: number
Returns void
highlight
Gets or sets a string defining the color to use for highlighting this control
Returns string
Gets or sets a string defining the color to use for highlighting this control
Parameters
value: string
Returns void
highlight
Gets or sets a number indicating size of stroke we want to highlight the control with (mostly for debugging purpose)
Returns number
Gets or sets a number indicating size of stroke we want to highlight the control with (mostly for debugging purpose)
Parameters
value: number
Returns void
horizontal
Gets or sets the horizontal alignment
Returns number
Gets or sets the horizontal alignment
Parameters
value: number
Returns void
host
Get the hosting AdvancedDynamicTexture
Returns AdvancedDynamicTexture
is
Gets a boolean indicating that the control needs to update its rendering
Returns boolean
is
Gets or sets if control is Enabled
Returns boolean
Gets or sets if control is Enabled
Parameters
value: boolean
Returns void
is
Gets or sets a boolean indicating that we want to highlight the control (mostly for debugging purpose)
Returns boolean
Gets or sets a boolean indicating that we want to highlight the control (mostly for debugging purpose)
Parameters
value: boolean
Returns void
is
Gets or sets a boolean indicating if the control is readonly (default: false). A readonly control will still raise pointer events but will not react to them
Returns boolean
Gets or sets a boolean indicating if the control is readonly (default: false). A readonly control will still raise pointer events but will not react to them
Parameters
value: boolean
Returns void
is
Gets or sets a boolean indicating if the stack panel is vertical or horizontal
Returns boolean
Gets or sets a boolean indicating if the stack panel is vertical or horizontal
Parameters
value: boolean
Returns void
is
Gets or sets a boolean indicating if the control is visible
Returns boolean
Gets or sets a boolean indicating if the control is visible
Parameters
value: boolean
Returns void
left
Gets or sets a value indicating the left coordinate of the control
Returns string | number
Gets or sets a value indicating the left coordinate of the control
Parameters
value: string | number
Returns void
left
Gets or sets a value indicating the left coordinate in pixels of the control
Returns number
Gets or sets a value indicating the left coordinate in pixels of the control
Parameters
value: number
Returns void
link
Gets or sets a value indicating the offset on X axis to the linked mesh
Returns string | number
Gets or sets a value indicating the offset on X axis to the linked mesh
Parameters
value: string | number
Returns void
link
Gets or sets a value indicating the offset in pixels on X axis to the linked mesh
Returns number
Gets or sets a value indicating the offset in pixels on X axis to the linked mesh
Parameters
value: number
Returns void
link
Gets or sets a value indicating the offset on Y axis to the linked mesh
Returns string | number
Gets or sets a value indicating the offset on Y axis to the linked mesh
Parameters
value: string | number
Returns void
link
Gets or sets a value indicating the offset in pixels on Y axis to the linked mesh
Returns number
Gets or sets a value indicating the offset in pixels on Y axis to the linked mesh
Parameters
value: number
Returns void
linked
Gets the current linked mesh (or null if none)
Returns Nullable<TransformNode>
not
Gets or sets a boolean indicating if the control can be rendered
Returns boolean
Gets or sets a boolean indicating if the control can be rendered
Parameters
value: boolean
Returns void
padding
Gets or sets a value indicating the padding to use on the bottom of the control
Returns string | number
Gets or sets a value indicating the padding to use on the bottom of the control
Parameters
value: string | number
Returns void
padding
Gets or sets a value indicating the padding in pixels to use on the bottom of the control
Returns number
Gets or sets a value indicating the padding in pixels to use on the bottom of the control
Parameters
value: number
Returns void
padding
Gets or sets a value indicating the padding to use on the left of the control
Returns string | number
Gets or sets a value indicating the padding to use on the left of the control
Parameters
value: string | number
Returns void
padding
Gets or sets a value indicating the padding in pixels to use on the left of the control
Returns number
Gets or sets a value indicating the padding in pixels to use on the left of the control
Parameters
value: number
Returns void
padding
Gets or sets a value indicating the padding to use on the right of the control
Returns string | number
Gets or sets a value indicating the padding to use on the right of the control
Parameters
value: string | number
Returns void
padding
Gets or sets a value indicating the padding in pixels to use on the right of the control
Returns number
Gets or sets a value indicating the padding in pixels to use on the right of the control
Parameters
value: number
Returns void
padding
Gets or sets a value indicating the padding to use on the top of the control
Returns string | number
Gets or sets a value indicating the padding to use on the top of the control
Parameters
value: string | number
Returns void
padding
Gets or sets a value indicating the padding in pixels to use on the top of the control
Returns number
Gets or sets a value indicating the padding in pixels to use on the top of the control
Parameters
value: number
Returns void
render
Gets or sets boolean indicating if children should be rendered to an intermediate texture rather than directly to host, useful for alpha blending
Returns boolean
Gets or sets boolean indicating if children should be rendered to an intermediate texture rather than directly to host, useful for alpha blending
Parameters
value: boolean
Returns void
rotation
Gets or sets the rotation angle (0 by default)
Returns number
Gets or sets the rotation angle (0 by default)
Parameters
value: number
Returns void
scaleX
Gets or sets a value indicating the scale factor on X axis (1 by default)
Returns number
Gets or sets a value indicating the scale factor on X axis (1 by default)
Parameters
value: number
Returns void
scaleY
Gets or sets a value indicating the scale factor on Y axis (1 by default)
Returns number
Gets or sets a value indicating the scale factor on Y axis (1 by default)
Parameters
value: number
Returns void
shadow
Gets or sets a value indicating the amount of blur to use to render the shadow
Returns number
Gets or sets a value indicating the amount of blur to use to render the shadow
Parameters
value: number
Returns void
shadow
Gets or sets a value indicating the color of the shadow (black by default ie. "#000")
Returns string
Gets or sets a value indicating the color of the shadow (black by default ie. "#000")
Parameters
value: string
Returns void
shadow
Gets or sets a value indicating the offset to apply on X axis to render the shadow
Returns number
Gets or sets a value indicating the offset to apply on X axis to render the shadow
Parameters
value: number
Returns void
shadow
Gets or sets a value indicating the offset to apply on Y axis to render the shadow
Returns number
Gets or sets a value indicating the offset to apply on Y axis to render the shadow
Parameters
value: number
Returns void
spacing
Gets or sets the spacing (in pixels) between each child.
Returns number
Gets or sets the spacing (in pixels) between each child.
Parameters
value: number
Returns void
style
top
Gets or sets a value indicating the top coordinate of the control
Returns string | number
Gets or sets a value indicating the top coordinate of the control
Parameters
value: string | number
Returns void
top
Gets or sets a value indicating the top coordinate in pixels of the control
Returns number
Gets or sets a value indicating the top coordinate in pixels of the control
Parameters
value: number
Returns void
transform
Gets or sets the transformation center on X axis (0 by default)
Returns number
Gets or sets the transformation center on X axis (0 by default)
Parameters
value: number
Returns void
transform
Gets or sets the transformation center on Y axis (0 by default)
Returns number
Gets or sets the transformation center on Y axis (0 by default)
Parameters
value: number
Returns void
transformed
Gets the transformed measure, that is the bounding box of the control after applying all transformations
Returns Measure
type
Gets the control type name
Returns string
vertical
Gets or sets the vertical alignment
Returns number
Gets or sets the vertical alignment
Parameters
value: number
Returns void
width
Gets or sets panel width. This value should not be set when in horizontal mode as it will be computed automatically
Returns string | number
Gets or sets panel width. This value should not be set when in horizontal mode as it will be computed automatically
Parameters
value: string | number
Returns void
width
Gets or sets the control width in pixel
Returns number
Gets or sets the control width in pixel
Parameters
value: number
Returns void
z
Gets or sets z index which is used to reorder controls on the z axis
Returns number
Gets or sets z index which is used to reorder controls on the z axis
Parameters
value: number
Returns void
Static HORIZONTAL_
HORIZONTAL_ALIGNMENT_CENTER
Returns number
Static HORIZONTAL_
HORIZONTAL_ALIGNMENT_LEFT
Returns number
Static HORIZONTAL_
HORIZONTAL_ALIGNMENT_RIGHT
Returns number
Static VERTICAL_
VERTICAL_ALIGNMENT_BOTTOM
Returns number
Static VERTICAL_
VERTICAL_ALIGNMENT_CENTER
Returns number
Static VERTICAL_
VERTICAL_ALIGNMENT_TOP
Returns number
Methods
_flag
Returns void
add
clear
Removes all controls from the current container
Returns Container
the current container
cloneSearch playground for clone
Clones a control and its descendants
Parameters
Optional host: AdvancedDynamicTexture
the texture where the control will be instantiated. Can be empty, in which case the control will be created on the same texture
Returns Control
the cloned control
containsSearch playground for contains
Tests if a given coordinates belong to the current control
Parameters
x: number
defines x coordinate to test
y: number
defines y coordinate to test
Returns boolean
true if the coordinates are inside the control
contains
Search for a specific control in children
Parameters
control: Control
defines the control to look for
Returns boolean
true if the control is in child list
disposeSearch playground for dispose
Releases associated resources
Returns void
get
get
get
get
Get the current class name of the control.
Returns string
current class name
get
Will return all controls that have this control as ascendant
Parameters
Optional directDescendantsOnly: boolean
defines if true only direct descendants of 'this' will be considered, if false direct and also indirect (children of children, an so on in a recursive manner) descendants of 'this' will be considered
Optional predicate: ((control: Control) => boolean)
defines an optional predicate that will be called on every evaluated child, the predicate must return true for a given child to be part of the result, otherwise it will be ignored
Parameters
control: Control
Returns boolean
Returns Control[]
all child controls
get
get
get
get
is
Determines if a container is an ascendant of the current control
Parameters
container: Control
defines the container to look for
Returns boolean
true if the container is one of the ascendant of the control
is
Returns true if the control is ready to be used
Returns boolean
link
Link current control with a target mesh
Parameters
mesh: Nullable<TransformNode>
defines the mesh to link with
Returns void
mark
Mark the element and its children as dirty
Returns void
mark
Mark control element as dirty
Parameters
Optional force: boolean
force non visible elements to be marked too
Returns void
move
parseSearch playground for parse
Parses a serialized object into this control
Parameters
serializedObject: any
the object with the serialized properties
Optional host: AdvancedDynamicTexture
the texture where the control will be instantiated. Can be empty, in which case the control will be created on the same texture
Returns Control
this control
remove
serializeSearch playground for serialize
Serializes the current control
Parameters
serializationObject: any
defined the JSON serialized object
Returns void
set
Shorthand function to set the top, right, bottom, and left padding values on the control.
Parameters
paddingTop: string | number
The value of the top padding.
Optional paddingRight: string | number
The value of the right padding. If omitted, top is used.
Optional paddingBottom: string | number
The value of the bottom padding. If omitted, top is used.
Optional paddingLeft: string | number
The value of the left padding. If omitted, right is used.
Returns void
set
Shorthand funtion to set the top, right, bottom, and left padding values in pixels on the control.
Parameters
paddingTop: number
The value in pixels of the top padding.
Optional paddingRight: number
The value in pixels of the right padding. If omitted, top is used.
Optional paddingBottom: number
The value in pixels of the bottom padding. If omitted, top is used.
Optional paddingLeft: number
The value in pixels of the left padding. If omitted, right is used.
Returns void
Static ParseSearch playground for Parse
Creates a Control from parsed data
Parameters
serializedObject: any
defines parsed data
host: AdvancedDynamicTexture
defines the hosting AdvancedDynamicTexture
Returns Control
a new Control
Class used to create a 2D stack panel container