UE3:Canvas (UT3)

Object >> Canvas

Package: 

Engine

A drawing canvas for the HUD and for ScriptedTextures.

A canvas can define a clipping region through OrgX/Y and ClipX/Y, which is used as reference coordinate system for all drawing operations. The drawing position, CurX/Y, is relative to the origin of the clipping region. Drawing functions with "clipped" in their name will limit drawing to the clipping region, others only use the origin as offset and still draw to the entire canvas.

Properties

bCenter

Type: bool

Whether to center the text.

bNoSmooth

Type: bool

Don't bilinear filter.

Canvas

Type: pointer{FCanvas}

Modifiers: native, const

ClipX

Type: float

Width of the clipping region.

ClipY

Type: float

Height of the clipping region.

ColorModulate

Type: Object.Plane

Default value:

Member	Value
W	1.0
X	1.0
Y	1.0
Z	1.0

CurX

Type: float

Horizontal coordinate of current drawing position.

CurY

Type: float

Vertical coordinate of the current drawing position.

CurYL

Type: float

Height of the last DrawText output.

DefaultTexture

Type: Texture2D

Default value: Texture2D'EngineResources.WhiteSquareTexture'

DrawColor

Type: Object.Color

Color for drawing.

Default value:

Member	Value
A	255
B	127
G	127
R	127

Font

Type: Font

Font for DrawText.

Default value: Font'EngineFonts.SmallFont'

OrgX

Type: float

Offset of the clipping region from the left side of the screen.

OrgY

Type: float

Offset of the clipping region from the top side of the screen.

SceneView

Type: pointer{FSceneView}

Modifiers: native, const

SizeX

Type: int

Modifiers: const

Width of the screen in pixels.

SizeY

Type: int

Modifiers: const

Height of the screen in pixels.

Structs

CanvasIcon

Holds texture information with UV coordinates as well.

Texture2D Texture 

Source texture

float U 

Offset from the left side of the texture region.

float V 

Offset from the top side of the texture region.

float UL 

Texture region width.

float VL 

Texture region height.

Functions

Native functions

DeProject

native final function Object.Vector DeProject (Object.Vector location)

Converts local (screen) coordinates to global (world) coordinates.

Draw2DLine

native final function Draw2DLine (float X1, float Y1, float X2, float Y2, Object.Color LineColor)

Draws a line on the canvas from (X1,Y1) to (X2,Y2).

DrawColorizedTile

native final function DrawColorizedTile (Texture2D Tex, float XL, float YL, float U, float V, float UL, float VL, Object.LinearColor LColor)

Draws a part of a texture using the specified draw color. The current canvas position is used as upper left corner of the area to cover with the texture tile.

Parameters:

• Tex - The texture to draw.
• XL, YL - Width and height of the canvas area to draw the tile to. The tile is stretched to fit the area.
• U, V - Origin coordinates of the texture area. Bottom/right end of texture area for negative UL/VL values.
• UL, VL - Width and height of the texture area. Negative values mirror the tile in the corresponding direction.
• LColor - The color to use for drawing the tile.

DrawMaterialTile

native final function DrawMaterialTile (MaterialInterface Mat, float XL, float YL, optional float U, optional float V, optional float UL, optional float VL)

Draws a part of the emissive channel of a material. The current canvas position is used as upper left corner of the area to cover with the material tile.

Parameters:

• Mat - The material which contains the emissive expression to draw.
• XL, YL - Width and height of the canvas area to draw the tile to. The tile is stretched to fit the area.
• U, V - Origin coordinates of the material area. Bottom/right end of material area for negative UL/VL values.
• UL, VL - Width and height of the material area. Negative values mirror the tile in the corresponding direction.

DrawMaterialTileClipped

native final function DrawMaterialTileClipped (MaterialInterface Mat, float XL, float YL, optional float U, optional float V, optional float UL, optional float VL)

Same as DrawMaterialTile, but cuts off the drawing area at the edges of the canvas clipping region defined by OrgX/Y and ClipX/Y.

DrawRotatedMaterialTile

native final function DrawRotatedMaterialTile (MaterialInterface Mat, Object.Rotator Rotation, float XL, float YL, optional float U, optional float V, optional float UL, optional float VL, optional float AnchorX, optional float AnchorY)

Same as DrawMaterialTile, but additionally rotates the canvas draw area by the angle specified in Rotation.Yaw. The rotation anchor position on the drawing area is specified through AnchorX/Y and defaults to the center of the draw area. The anchor position is specified with relative values, so (0.0,0.0) is the top left corner, (0.5,0.5) is the center and (1.0,1.0) is the bottom right corner. Values outside the drawing area are also supported.

DrawRotatedTile

native final function DrawRotatedTile (Texture2D Tex, Object.Rotator Rotation, float XL, float YL, float U, float V, float UL, float VL, optional float AnchorX, optional float AnchorY)

Same as DrawTile, but additionally rotates the canvas draw area by the angle specified in Rotation.Yaw. The rotation anchor position on the drawing area is specified through AnchorX/Y and defaults to the center of the draw area. The anchor position is specified with relative values, so (0.0,0.0) is the top left corner, (0.5,0.5) is the center and (1.0,1.0) is the bottom right corner. Values outside the drawing area are also supported.

DrawText

native final function DrawText (coerce string Text, optional bool CR, optional float XScale, optional float YScale)

DrawTextClipped

native final function DrawTextClipped (coerce string Text, optional bool bCheckHotKey, optional float XScale, optional float YScale)

DrawTextureDoubleLine

native final function DrawTextureDoubleLine (Object.Vector StartPoint, Object.Vector EndPoint, float Perc, float Spacing, float Width, Object.Color LineColor, Object.Color AltLineColor, Texture2D Tex, float U, float V, float UL, float VL)

DrawTextureLine

native final function DrawTextureLine (Object.Vector StartPoint, Object.Vector EndPoint, float Perc, float Width, Object.Color LineColor, Texture2D LineTexture, float U, float V, float UL, float VL)

DrawTile

native final function DrawTile (Texture2D Tex, float XL, float YL, float U, float V, float UL, float VL)

Draws a part of a texture. The current canvas position is used as upper left corner of the area to cover with the texture tile.

Parameters:

• Tex - The texture to draw.
• XL, YL - Width and height of the canvas area to draw the tile to. The tile is stretched to fit the area.
• U, V - Origin coordinates of the texture area. Bottom/right end of texture area for negative UL/VL values.
• UL, VL - Width and height of the texture area. Negative values mirror the tile in the corresponding direction.

DrawTileClipped

native(468) final function DrawTileClipped (Texture2D Tex, float XL, float YL, float U, float V, float UL, float VL)

Same as DrawTile, but cuts off the drawing area at the edges of the canvas clipping region defined by OrgX/Y and ClipX/Y.

DrawTileNew

native final function DrawTileNew (Texture Tex, float XL, float YL, float U, float V, float UL, float VL)

Same as DrawTile, but also accepts other texture objects, such as TextureMovie or render targets, including ScriptedTextures.

DrawTileStretched

native final function DrawTileStretched (Texture2D Tex, float XL, float YL, float U, float V, float UL, float VL, Object.LinearColor LColor, optional bool bStretchHorizontally, optional bool bStretchVertically, optional float ScalingFactor)

PopTransform

native final function PopTransform ()

Pops the topmost matrix from the canvas transform stack.

Project

native final function Object.Vector Project (Object.Vector location)

Converts global (world) coordinates to local (screen) coordinates.

PushTranslationMatrix

native final function PushTranslationMatrix (Object.Vector TranslationVector)

Pushes a translation matrix onto the canvas.

Parameters:

• TranslationVector - Translation vector to use to create the translation matrix.

SetDrawColor

native final function SetDrawColor (byte R, byte G, byte B, optional byte A)

SetPos

native final function SetPos (float PosX, float PosY)

Sets CurX and CurY.

StrLen

native final function StrLen (coerce string String, out float XL, out float YL)

TextSize

native final function TextSize (coerce string String, out float XL, out float YL)

Events

Reset

event Reset (optional bool bKeepOrigin)

Other instance functions

DrawBox

final simulated function DrawBox (float width, float height)

DrawIcon

final function DrawIcon (CanvasIcon Icon, float X, float Y, optional float Scale)

Draw a CanvasIcon at the desired canvas position.

DrawIconSection

final function DrawIconSection (CanvasIcon Icon, float X, float Y, float UStartPct, float VStartPct, float UEndPct, float VEndPct, optional float Scale)

Draw a subsection of a CanvasIcon at the desired canvas position.

DrawRect

final function DrawRect (float RectX, float RectY, optional Texture2D Tex)

Draws a rectangle of the specified size in pixels at the current canvas position. If a texture is specified, it will be stretched to the rectangle size, otherwise the rectangle is drawn using the DefaultTexture, which is entirely white.

DrawTextRA

final function DrawTextRA (coerce string Text, optional bool CR)

Draws text right aligned from the current position.

DrawTexture

final function DrawTexture (Texture2D Tex, float Scale)

Draws the specified texture at the current canvas position.

MakeIcon

final function CanvasIcon MakeIcon (Texture2D Texture, optional float U, optional float V, optional float UL, optional float VL)

Fake CanvasIcon constructor.

SetClip

final function SetClip (float X, float Y)

Sets ClipXand ClipY.

SetOrigin

final function SetOrigin (float X, float Y)

Sets OrgX and OrgY.