My program doesn't have bugs. It just develops random features.
UE3:UIFrameBox (UT3)
From Unreal Wiki, The Unreal Engine Documentation Site
 |
Object >> UIRoot >> UIScreenObject >> UIObject >> UIContainer >> UIFrameBox |
Contents |
| This is an auto-generated page and may need human attention. Please remove this tag if the page seems reasonably complete or replace it with the {{expand}} tag if the page is not yet complete. |
More configurable image widget that allows the user to specify 9 image components to have a background box that scales properly while maintaining the aspect ratio of its corners.
Copyright 1998-2007 Epic Games, Inc. All Rights Reserved.
[edit] Properties
[edit] Property group 'Image'
[edit] BackgroundCornerSizes
Type: CornerSizes
Modifiers: editinline
Default value:
| Member | Value |
|---|---|
| BottomHeight | 16.0 |
| BottomLeft[0] | 16.0 |
| BottomLeft[1] | 16.0 |
| BottomRight[0] | 16.0 |
| BottomRight[1] | 16.0 |
| CenterLeftWidth | 16.0 |
| CenterRightWidth | 16.0 |
| TopHeight | 16.0 |
| TopLeft[0] | 16.0 |
| TopLeft[1] | 16.0 |
| TopRight[0] | 16.0 |
| TopRight[1] | 16.0 |
[edit] BackgroundImageComponent
Type: UIComp_DrawImage
Array size: 9
Modifiers: editinline, const, noclear
Component for rendering the background images
Default value, index 0: UIComp_DrawImage'TemplateTopLeft'
Default value, index 1: UIComp_DrawImage'TemplateTop'
Default value, index 2: UIComp_DrawImage'TemplateTopRight'
Default value, index 3: UIComp_DrawImage'TemplateCenterLeft'
Default value, index 4: UIComp_DrawImage'TemplateCenter'
Default value, index 5: UIComp_DrawImage'TemplateCenterRight'
Default value, index 6: UIComp_DrawImage'TemplateBottomLeft'
Default value, index 7: UIComp_DrawImage'TemplateBottom'
Default value, index 8: UIComp_DrawImage'TemplateBottomRight'
[edit] Default values
| Property | Value | ||||||
|---|---|---|---|---|---|---|---|
| bSupportsPrimaryStyle | False | ||||||
| PrimaryStyle |
|
[edit] Subobjects
[edit] TemplateBottom
Class: Engine.UIComp_DrawImage
| Property | Value | ||||
|---|---|---|---|---|---|
| ImageStyle |
|
||||
| StyleResolverTag | 'Bottom Style' |
[edit] TemplateBottomLeft
Class: Engine.UIComp_DrawImage
| Property | Value | ||||
|---|---|---|---|---|---|
| ImageStyle |
|
||||
| StyleResolverTag | 'Bottom Left Style' |
[edit] TemplateBottomRight
Class: Engine.UIComp_DrawImage
| Property | Value | ||||
|---|---|---|---|---|---|
| ImageStyle |
|
||||
| StyleResolverTag | 'Bottom Right Style' |
[edit] TemplateCenter
Class: Engine.UIComp_DrawImage
| Property | Value | ||||
|---|---|---|---|---|---|
| ImageStyle |
|
||||
| StyleResolverTag | 'Center Style' |
[edit] TemplateCenterLeft
Class: Engine.UIComp_DrawImage
| Property | Value | ||||
|---|---|---|---|---|---|
| ImageStyle |
|
||||
| StyleResolverTag | 'Center Left Style' |
[edit] TemplateCenterRight
Class: Engine.UIComp_DrawImage
| Property | Value | ||||
|---|---|---|---|---|---|
| ImageStyle |
|
||||
| StyleResolverTag | 'Center Right Style' |
[edit] TemplateTop
Class: Engine.UIComp_DrawImage
| Property | Value | ||||
|---|---|---|---|---|---|
| ImageStyle |
|
||||
| StyleResolverTag | 'Top Style' |
[edit] TemplateTopLeft
Class: Engine.UIComp_DrawImage
| Property | Value | ||||
|---|---|---|---|---|---|
| ImageStyle |
|
||||
| StyleResolverTag | 'Top Left Style' |
[edit] TemplateTopRight
Class: Engine.UIComp_DrawImage
| Property | Value | ||||
|---|---|---|---|---|---|
| ImageStyle |
|
||||
| StyleResolverTag | 'Top Right Style' |
[edit] WidgetEventComponent
Class: Engine.UIComp_Event
Inherits from: UIContainer.WidgetEventComponent
No new values.
[edit] Enums
[edit] EFrameBoxImage
Enum describing all of the image components used in this widget.
- FBI_TopLeft
- FBI_Top
- FBI_TopRight
- FBI_CenterLeft
- FBI_Center
- FBI_CenterRight
- FBI_BottomLeft
- FBI_Bottom
- FBI_BottomRight
[edit] Structs
[edit] CornerSizes
Modifiers: native
Sizes of the corners. The corner image components will always render at these sizes.
- float TopLeft[2]
- float TopRight[2]
- float BottomLeft[2]
- float BottomRight[2]
- float TopHeight
- float BottomHeight
- float CenterLeftWidth
- float CenterRightWidth
[edit] Instance functions
[edit] SetBackgroundImage
Changes the background image for this panel, creating the wrapper UITexture if necessary.
Parameters:
- NewImage - the new surface to use for this UIImage
