Overview Package Class Source Class tree Glossary
previous class      next class frames      no frames

Engine.UIFrameBox

Extends
UIContainer
Modifiers
placeable native ( UIPrivate )

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-2008 Epic Games, Inc. All Rights Reserved. 

Core.Object
|   
+-- Engine.UIRoot
   |   
   +-- Engine.UIScreenObject
      |   
      +-- Engine.UIObject
         |   
         +-- Engine.UIContainer
            |   
            +-- Engine.UIFrameBox
Constants Summary
Inherited Contants from Engine.UIObject
CONTEXTMENU_BINDING_INDEX, FIRST_DEFAULT_DATABINDING_INDEX, TOOLTIP_BINDING_INDEX

Variables Summary
Image
CornerSizesBackgroundCornerSizes
UIComp_DrawImageBackgroundImageComponent[9]
Inherited Variables from Engine.UIContainer
AutoAlignment
Inherited Variables from Engine.UIObject
AnimationParent, AnimationPosition, AnimStack, bDebugShowBounds, bEnableActiveCursorUpdates, bSupportsPrimaryStyle, ContextMenuData, DebugBoundsColor, DockTargets, NavigationTargets, Owner, OwnerScene, PrimaryStyle, PrivateFlags, RenderBoundsVertices[EUIWidgetFace.UIFACE_MAX], RenderBounds[EUIWidgetFace.UIFACE_MAX], RenderOffset, Rotation, StyleSubscribers, TabIndex, ToolTip, WidgetID, WidgetTag

Enumerations Summary
EFrameBoxImage
FBI_TopLeft, FBI_Top, FBI_TopRight, FBI_CenterLeft, FBI_Center, FBI_CenterRight, FBI_BottomLeft, FBI_Bottom, FBI_BottomRight

Structures Summary
CornerSizes
TopLeft[2], TopRight[2], BottomLeft[2], BottomRight[2], TopHeight, BottomHeight, CenterLeftWidth, CenterRightWidth

Functions Summary
function SetBackgroundImage (EFrameBoxImage ImageToSet, Surface NewImage ))
Inherited Functions from Engine.UIObject
AddStyleSubscriber, AnimSetBottom, AnimSetColor, AnimSetLeft, AnimSetOpacity, AnimSetPosition, AnimSetRelPosition, AnimSetRight, AnimSetRotation, AnimSetScale, AnimSetTop, AnimSetVisibility, CanAcceptFocus, ClearDefaultDataBinding, ClearUIAnimation, FindStyleSubscriberIndex, FindStyleSubscriberIndexById, GenerateSceneDataStoreMarkup, GenerateTransformMatrix, GetAnchorPosition, GetDefaultDataBinding, GetDefaultDataStores, GetOwner, GetParent, GetPositionExtent, GetPositionExtents, GetRotationMatrix, GetScene, GetToolTipValue, HasTransform, IsContainedBy, IsDockedTo, IsPrivateBehaviorSet, LogRenderBounds, NeedsActiveCursorUpdates, NotifyValueChanged, OnSetDatastoreBinding, PlayUIAnimation, RemoveStyleSubscriber, ResolveDefaultDataBinding, ResolveStyles, RotateWidget, SetActiveCursorUpdate, SetAnchorPosition, SetDefaultDataBinding, SetDockPadding, SetDockParameters, SetDockTarget, SetForcedNavigationTarget, SetNavigationTarget, SetPrivateBehavior, SetWidgetStyleByName, StopUIAnimation, TickAnim, UIAnimEnd, UpdateRotationMatrix

Variables Detail

Image

BackgroundCornerSizes Source code

var(Image) editinline CornerSizes BackgroundCornerSizes;

BackgroundImageComponent[9] Source code

var(Image) editinline const noclear UIComp_DrawImage BackgroundImageComponent[9];
Component for rendering the background images

Enumerations Detail

EFrameBoxImage Source code

enum EFrameBoxImage
{
FBI_TopLeft, FBI_Top, FBI_TopRight, FBI_CenterLeft, FBI_Center, FBI_CenterRight, FBI_BottomLeft, FBI_Bottom, FBI_BottomRight
};
Enum describing all of the image components used in this widget.

Structures Detail

CornerSizes Source code

struct CornerSizes
{
var(UIFrameBox) float BottomHeight;
var(UIFrameBox) float BottomLeft[2];
var(UIFrameBox) float BottomRight[2];
var(UIFrameBox) float CenterLeftWidth;
var(UIFrameBox) float CenterRightWidth;
var(UIFrameBox) float TopHeight;
var(UIFrameBox) float TopLeft[2];
var(UIFrameBox) float TopRight[2];
};
Sizes of the corners. The corner image components will always render at these sizes.

Functions Detail

SetBackgroundImage Source code

final function SetBackgroundImage ( EFrameBoxImage ImageToSet, Surface NewImage ) )
Changes the background image for this panel, creating the wrapper UITexture if necessary.
@param NewImage the new surface to use for this UIImage

Defaultproperties 

defaultproperties
{
   Begin Object Class=UIComp_DrawImage Name=TemplateTopLeft ObjName=TemplateTopLeft Archetype=UIComp_DrawImage'Engine.Default__UIComp_DrawImage'
      StyleResolverTag="Top Left Style"
      ImageStyle=(DefaultStyleTag="PanelBackground")
      Name="TemplateTopLeft"
      ObjectArchetype=UIComp_DrawImage'Engine.Default__UIComp_DrawImage'
   End Object
   BackgroundImageComponent(0)=TemplateTopLeft
   Begin Object Class=UIComp_DrawImage Name=TemplateTop ObjName=TemplateTop Archetype=UIComp_DrawImage'Engine.Default__UIComp_DrawImage'
      StyleResolverTag="Top Style"
      ImageStyle=(DefaultStyleTag="PanelBackground")
      Name="TemplateTop"
      ObjectArchetype=UIComp_DrawImage'Engine.Default__UIComp_DrawImage'
   End Object
   BackgroundImageComponent(1)=TemplateTop
   Begin Object Class=UIComp_DrawImage Name=TemplateTopRight ObjName=TemplateTopRight Archetype=UIComp_DrawImage'Engine.Default__UIComp_DrawImage'
      StyleResolverTag="Top Right Style"
      ImageStyle=(DefaultStyleTag="PanelBackground")
      Name="TemplateTopRight"
      ObjectArchetype=UIComp_DrawImage'Engine.Default__UIComp_DrawImage'
   End Object
   BackgroundImageComponent(2)=TemplateTopRight
   Begin Object Class=UIComp_DrawImage Name=TemplateCenterLeft ObjName=TemplateCenterLeft Archetype=UIComp_DrawImage'Engine.Default__UIComp_DrawImage'
      StyleResolverTag="Center Left Style"
      ImageStyle=(DefaultStyleTag="PanelBackground")
      Name="TemplateCenterLeft"
      ObjectArchetype=UIComp_DrawImage'Engine.Default__UIComp_DrawImage'
   End Object
   BackgroundImageComponent(3)=TemplateCenterLeft
   Begin Object Class=UIComp_DrawImage Name=TemplateCenter ObjName=TemplateCenter Archetype=UIComp_DrawImage'Engine.Default__UIComp_DrawImage'
      StyleResolverTag="Center Style"
      ImageStyle=(DefaultStyleTag="PanelBackground")
      Name="TemplateCenter"
      ObjectArchetype=UIComp_DrawImage'Engine.Default__UIComp_DrawImage'
   End Object
   BackgroundImageComponent(4)=TemplateCenter
   Begin Object Class=UIComp_DrawImage Name=TemplateCenterRight ObjName=TemplateCenterRight Archetype=UIComp_DrawImage'Engine.Default__UIComp_DrawImage'
      StyleResolverTag="Center Right Style"
      ImageStyle=(DefaultStyleTag="PanelBackground")
      Name="TemplateCenterRight"
      ObjectArchetype=UIComp_DrawImage'Engine.Default__UIComp_DrawImage'
   End Object
   BackgroundImageComponent(5)=TemplateCenterRight
   Begin Object Class=UIComp_DrawImage Name=TemplateBottomLeft ObjName=TemplateBottomLeft Archetype=UIComp_DrawImage'Engine.Default__UIComp_DrawImage'
      StyleResolverTag="Bottom Left Style"
      ImageStyle=(DefaultStyleTag="PanelBackground")
      Name="TemplateBottomLeft"
      ObjectArchetype=UIComp_DrawImage'Engine.Default__UIComp_DrawImage'
   End Object
   BackgroundImageComponent(6)=TemplateBottomLeft
   Begin Object Class=UIComp_DrawImage Name=TemplateBottom ObjName=TemplateBottom Archetype=UIComp_DrawImage'Engine.Default__UIComp_DrawImage'
      StyleResolverTag="Bottom Style"
      ImageStyle=(DefaultStyleTag="PanelBackground")
      Name="TemplateBottom"
      ObjectArchetype=UIComp_DrawImage'Engine.Default__UIComp_DrawImage'
   End Object
   BackgroundImageComponent(7)=TemplateBottom
   Begin Object Class=UIComp_DrawImage Name=TemplateBottomRight ObjName=TemplateBottomRight Archetype=UIComp_DrawImage'Engine.Default__UIComp_DrawImage'
      StyleResolverTag="Bottom Right Style"
      ImageStyle=(DefaultStyleTag="PanelBackground")
      Name="TemplateBottomRight"
      ObjectArchetype=UIComp_DrawImage'Engine.Default__UIComp_DrawImage'
   End Object
   BackgroundImageComponent(8)=TemplateBottomRight
   BackgroundCornerSizes=(TopLeft[0]=16.000000,TopLeft[1]=16.000000,TopRight[0]=16.000000,TopRight[1]=16.000000,BottomLeft[0]=16.000000,BottomLeft[1]=16.000000,BottomRight[0]=16.000000,BottomRight[1]=16.000000,TopHeight=16.000000,BottomHeight=16.000000,CenterLeftWidth=16.000000,CenterRightWidth=16.000000)
   PrimaryStyle=(DefaultStyleTag="PanelBackground",RequiredStyleClass=Class'Engine.UIStyle_Image')
   bSupportsPrimaryStyle=False
   Begin Object Class=UIComp_Event Name=WidgetEventComponent ObjName=WidgetEventComponent Archetype=UIComp_Event'Engine.Default__UIContainer:WidgetEventComponent'
      ObjectArchetype=UIComp_Event'Engine.Default__UIContainer:WidgetEventComponent'
   End Object
   EventProvider=WidgetEventComponent
   Name="Default__UIFrameBox"
   ObjectArchetype=UIContainer'Engine.Default__UIContainer'
}
Overview Package Class Source Class tree Glossary
previous class      next class frames      no frames
Creation time: sk 18-3-2018 10:00:47.269 - Created with UnCodeX