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

UTGame.UTSimpleImageList

Extends
UTDrawPanel
Modifiers
native ( UI )

Copyright 1998-2008 Epic Games, Inc. All Rights Reserved. - This is a simple Horz. List that uses graphics.

Core.Object
|   
+-- Engine.UIRoot
   |   
   +-- Engine.UIScreenObject
      |   
      +-- Engine.UIObject
         |   
         +-- UTGame.UTUI_Widget
            |   
            +-- UTGame.UTDrawPanel
               |   
               +-- UTGame.UTSimpleImageList

Variables Summary
boolbInvalidated
boolbTransitioning
intItemCount
floatLastMouseUpdate
floatLastRenderTime
array<SimpleImageListData>List
floatListWidthInPixel
floatListWidthInPixels
intOldSelection
floatPaddingThisFrame
floatResScale
intSelection
floatSelectionAlpha
floatSelectionModifier
floatStartSelectionTime
floatTransitionTime
floatWindowLeft
floatWindowScaling
floatWindowWidth
UTSimpleImageList
intBubbleRadius
floatDefaultCellHeight
floatDefaultCellWidth
array<Texture2D>ImageList
floatPadding
Inherited Variables from UTGame.UTDrawPanel
bUseFullViewport, Canvas, pHeight, pLeft, pTop, pWidth, ResolutionScale
Inherited Variables from UTGame.UTUI_Widget
bRequiresTick, UTSceneOwner

Structures Summary
SimpleImageListData
Tag, Count, ImageIndex, UVs, CurMultiplier, Multipliers[2], TransitionTime, TransitionAlpha, Bounds[4], bWasRendered

Delegates Summary
delegatebool OnDrawItem (UTSimpleImageList SimpleList, int ItemIndex, float XPos, out float YPos))
delegate OnItemChosen (UTSimpleImageList SourceList, int SelectedIndex, int PlayerIndex)
delegate OnSelectionChange (UTSimpleImageList SourceList, int NewSelectedIndex)
Inherited Delegates from UTGame.UTDrawPanel
DrawDelegate

Functions Summary
event AddItem (name NewTag, int Count, int NewImageIndex, TextureCoordinates NewUVs))
functionbool CursorCheck (float X1, float Y1, float X2, float Y2))
function DrawItem (int ItemIndex, float XPos, out float YPos))
event DrawPanel ()))
event Empty ()))
eventfloat GetItemScale (int ItemIdx, float SelectionPos))
functionfloat GetItemWidthInPixels (float ItemScale))
functionVector GetMousePosition ()))
functionname GetSelectedTag ()))
event GetSupportedUIActionKeyNames (out array out_KeyNames ))
function ItemChosen (int PlayerIndex))
functionbool MouseInBounds ()))
event PostInitialize ()))
functionbool ProcessInputKey (const out SubscribedInputEventParameters EventParms ))
event RemoveItem (int IndexToRemove))
event SelectItem (int NewSelection))
function SelectUnderCursor ()))
function SetTransition (int ItemIndex, float NewDestinationTransition))
event SizeList ()))
function UpdateAnimation (FLOAT DeltaTime)
Inherited Functions from UTGame.UTDrawPanel
Draw2DLine, DrawPanel
Inherited Functions from UTGame.UTUI_Widget
FindDataStore, GetPlayerControllerId, NotifyGameSessionEnded


Variables Detail

bInvalidated Source code

var transient bool bInvalidated;
If true, the positions have been invalidated so recalculate the sizes/etc.

bTransitioning Source code

var transient bool bTransitioning;

ItemCount Source code

var transient int ItemCount;

LastMouseUpdate Source code

var transient float LastMouseUpdate;

LastRenderTime Source code

var transient float LastRenderTime;

List Source code

var transient array<SimpleImageListData> List;

ListWidthInPixel Source code

var transient float ListWidthInPixel;

ListWidthInPixels Source code

var transient float ListWidthInPixels;

OldSelection Source code

var transient int OldSelection;

PaddingThisFrame Source code

var transient float PaddingThisFrame;

ResScale Source code

var transient float ResScale;

Selection Source code

var transient int Selection;

SelectionAlpha Source code

var transient float SelectionAlpha;

SelectionModifier Source code

var transient float SelectionModifier;

StartSelectionTime Source code

var transient float StartSelectionTime;

TransitionTime Source code

var transient float TransitionTime;

WindowLeft Source code

var transient float WindowLeft;

WindowScaling Source code

var transient float WindowScaling;

WindowWidth Source code

var transient float WindowWidth;

UTSimpleImageList

BubbleRadius Source code

var(UTSimpleImageList) int BubbleRadius;
Size of the selection bubble, used to calculate alpha for items around the selected item.

DefaultCellHeight Source code

var(UTSimpleImageList) float DefaultCellHeight;

DefaultCellWidth Source code

var(UTSimpleImageList) float DefaultCellWidth;

ImageList Source code

var(UTSimpleImageList) editinlineuse array<Texture2D> ImageList;

Padding Source code

var(UTSimpleImageList) float Padding;


Structures Detail

SimpleImageListData Source code

struct SimpleImageListData
{
var float Bounds[4];
var bool bWasRendered;
var int Count;
var float CurMultiplier;
var int ImageIndex;
var float Multipliers[2];
var name Tag;
var float TransitionAlpha;
var float TransitionTime;
var TextureCoordinates UVs;
};



Delegates Detail

OnDrawItem Source code

delegate bool OnDrawItem ( UTSimpleImageList SimpleList, int ItemIndex, float XPos, out float YPos) )
This delegate allows anyone to alter the drawing code of the list. @Returns true to skip the default drawing

OnItemChosen Source code

delegate OnItemChosen ( UTSimpleImageList SourceList, int SelectedIndex, int PlayerIndex )
This delegate is called when an item in the list is chosen.

OnSelectionChange Source code

delegate OnSelectionChange ( UTSimpleImageList SourceList, int NewSelectedIndex )
This delegate is called when the selection index changes


Functions Detail

AddItem Source code

event AddItem ( name NewTag, int Count, int NewImageIndex, TextureCoordinates NewUVs) )

CursorCheck Source code

function bool CursorCheck ( float X1, float Y1, float X2, float Y2) )
All are in pixels @Param X1 Left @Param Y1 Top @Param X2 Right @Param Y2 Bottom @Returns true if the mouse is within the bounds given

DrawItem Source code

function DrawItem ( int ItemIndex, float XPos, out float YPos) )
Draws an item to the screen.

DrawPanel Source code

event DrawPanel ( ) )
Render the list. At this point each cell should be sized, etc.

Empty Source code

event Empty ( ) )
Empties the list

GetItemScale Source code

event float GetItemScale ( int ItemIdx, float SelectionPos) )

@return Returns an item's height given the current position of the selection bar.

GetItemWidthInPixels Source code

function float GetItemWidthInPixels ( float ItemScale) )

@return Converts an item's scale width to pixels.

GetMousePosition Source code

function Vector GetMousePosition ( ) )
@Returns the mouse position in widget space

GetSelectedTag Source code

function name GetSelectedTag ( ) )

GetSupportedUIActionKeyNames Source code

event GetSupportedUIActionKeyNames ( out array<Name> out_KeyNames ) )

ItemChosen Source code

function ItemChosen ( int PlayerIndex) )

MouseInBounds Source code

function bool MouseInBounds ( ) )

PostInitialize Source code

event PostInitialize ( ) )
Setup the input system

ProcessInputKey Source code

function bool ProcessInputKey ( const out SubscribedInputEventParameters EventParms ) )

RemoveItem Source code

event RemoveItem ( int IndexToRemove) )
Removes an item from the list

SelectItem Source code

event SelectItem ( int NewSelection) )
Selects an item

SelectUnderCursor Source code

function SelectUnderCursor ( ) )
Select whichever widget happens to be under the cursor

SetTransition Source code

function SetTransition ( int ItemIndex, float NewDestinationTransition) )
Starts an item down the road to transition

SizeList Source code

event SizeList ( ) )
SizeList is called directly before rendering anything in the list.

UpdateAnimation Source code

native function UpdateAnimation ( FLOAT DeltaTime )


Defaultproperties

defaultproperties
{
   DefaultCellWidth=96.000000
   DefaultCellHeight=128.000000
   BubbleRadius=2
   DefaultStates(3)=Class'Engine.UIState_Active'
   Begin Object Class=UIComp_Event Name=WidgetEventComponent ObjName=WidgetEventComponent Archetype=UIComp_Event'UTGame.Default__UTDrawPanel:WidgetEventComponent'
      ObjectArchetype=UIComp_Event'UTGame.Default__UTDrawPanel:WidgetEventComponent'
   End Object
   EventProvider=WidgetEventComponent
   Name="Default__UTSimpleImageList"
   ObjectArchetype=UTDrawPanel'UTGame.Default__UTDrawPanel'
}

Overview Package Class Source Class tree Glossary
previous class      next class frames      no frames
Creation time: sk 18-3-2018 10:00:56.900 - Created with UnCodeX