Engine.UIComp_DrawImage

Extends

UIComp_DrawComponents

Modifiers

native ( UIPrivate ) HideCategories ( Object ) implements ( UIStyleResolver , CustomPropertyItemHandler ) editinlinenew

This component encapsulates rendering a UITexture for widgets. It is responsible for managing any image formatting data that is required for a particular widget (thus inappropriate for storage in UIStyles). The style used for rendering the ImageRef is defined by whichever widget owns this component. It is the widget's responsibility to call ApplyImageStyle when the widget receives a call to OnStyleResolved for the UIStyleReference which is intended to be used as the style for this image. Copyright 1998-2008 Epic Games, Inc. All Rights Reserved.

Core.Object
|   
+-- Core.Component
   |   
   +-- Engine.UIComponent
      |   
      +-- Engine.UIComp_DrawComponents
         |   
         +-- Engine.UIComp_DrawImage

Direct Known Subclasses:

UIComp_DrawTeamColoredImage, UIComp_UTDrawStateImage

Functions Summary
		DisableCustomColor ()
		DisableCustomCoordinates ()
		DisableCustomFormatting ()
		DisableCustomOpacity ()
		DisableCustomPadding ()
	UIStyle_Image	GetAppliedImageStyle (optional UIState DesiredMenuState)
	Surface	GetImage () con)
	name	GetStyleResolverTag ()
	bool	NotifyResolveStyle (UISkin ActiveSkin, bool bClearExistingValue, optional UIState CurrentMenuState, const optional name StylePropertyName)
		SetColor (LinearColor NewColor)
		SetCoordinates (TextureCoordinates NewCoordinates)
		SetFormatting (EUIOrientation Orientation, UIImageAdjustmentData NewFormattingData)
		SetImage (Surface NewImage)
		SetOpacity (float NewOpacity)
		SetPadding (float HorizontalPadding, float VerticalPadding)
	bool	SetStyleResolverTag (name NewResolverTag)

ImageStyle Source code

The style to use for rendering this component's image. If the style is invalid, the component will use the owning widget's PrimaryStyle, if possible.

StyleResolverTag Source code

The tag used to fulfill the UIStyleResolver interface's GetStyleResolverTag method. Value should be set by the owning widget.

StyleOverride

ImageRef Source code

The utility wrapper for the image that this component should render. Automatically created by the component when given an material/texture to render.

StyleCustomization Source code

Contains values for customizing and overriding rendering and formatting values designated by this component's style.

DisableCustomColor Source code

Disables image color customization allowing the image to use the values from the applied style.

DisableCustomCoordinates Source code

Disables image coordinate customization allowing the image to use the values from the applied style.

DisableCustomFormatting Source code

Disables image formatting customization allowing the image to use the values from the applied style.

DisableCustomOpacity Source code

Disables the custom opacity level for this comp

DisableCustomPadding Source code

Disables the custom padding for this component.

GetAppliedImageStyle Source code

Returns the image style data being used by this image rendering component. If the component's ImageStyle is not set, the style data will be pulled from the owning widget's primary style.
@param DesiredMenuState the menu state for the style data to retrieve; if not speicified, uses the owning widget's current menu state.
@return the image style data used to render this component's image for the specified menu state.
@note: noexport because we the native version is also handles optionally resolving the image style data from the active skin, so it takes a few more parameters.

GetImage Source code

Returns the texture or material assigned to this component.

GetStyleResolverTag Source code

Returns the tag assigned to this UIStyleResolver by the owning widget

NotifyResolveStyle Source code

Resolves the image style for this image rendering component.
@param ActiveSkin the skin the use for resolving the style reference.
@param bClearExistingValue if TRUE, style references will be invalidated first.
@param CurrentMenuState the menu state to use for resolving the style data; if not specified, uses the current menu state of the owning widget.
@param StyleProperty if specified, only the style reference corresponding to the specified property will be resolved; otherwise, all style references will be resolved.

SetColor Source code

Enables image color customization and changes the component's override color to the value specified.
@param NewColor the color to use for rendering this component's image

SetCoordinates Source code

Enables image coordinate customization and changes the component's override coordinates to the value specified.
@param NewCoordinates the UV coordinates to use for rendering this component's image

SetFormatting Source code

Enables image formatting customization and changes the component's formatting override data to the value specified.
@param Orientation indicates which orientation to modify
@param NewFormattingData the new value to use for rendering this component's image.

SetImage Source code

Changes the image for this component, creating the wrapper UITexture if necessary.
@param NewImage the new texture or material to use in this component

SetOpacity Source code

Enables a custom opacity and changes the component's override opacity to the value specified.
@param NewOpacity the alpha to use for rendering this component's string

SetPadding Source code

Enables custom padding and changes the component's override padding to the value specified.
@param HorizontalPadding new horizontal padding value to use (assuming a screen height of DEFAULT_SIZE_Y); will be scaled based on actual resolution. Specify -1 to indicate that HorizontalPadding should not be changed (useful when changing only the vertical padding)
@param HorizontalPadding new vertical padding value to use (assuming a screen height of DEFAULT_SIZE_Y); will be scaled based on actual resolution. Specify -1 to indicate that VerticalPadding should not be changed (useful when changing only the horizontal padding)

SetStyleResolverTag Source code

Changes the tag assigned to the UIStyleResolver to the specified value.
@return TRUE if the name was changed successfully; FALSE otherwise.

defaultproperties
{
   StyleResolverTag="Image Style"
   StyleCustomization=(Formatting[0]=(AdjustmentType=ADJUST_Normal),Formatting[1]=(AdjustmentType=ADJUST_Normal),DrawColor=(R=1.000000,G=1.000000,B=1.000000,A=1.000000),Opacity=1.000000)
   ImageStyle=(DefaultStyleTag="DefaultImageStyle",RequiredStyleClass=Class'Engine.UIStyle_Image')
   Name="Default__UIComp_DrawImage"
   ObjectArchetype=UIComp_DrawComponents'Engine.Default__UIComp_DrawComponents'
}