Always snap to grid

Difference between revisions of "UE3:Canvas (UT3)"

From Unreal Wiki, The Unreal Engine Documentation Site
Jump to: navigation, search
(added a few descriptions)
(added function descriptions for texture drawing)
 
Line 160: Line 160:
 
{{code|native final function '''Draw2DLine''' ([[float]] '''X1''', [[float]] '''Y1''', [[float]] '''X2''', [[float]] '''Y2''', {{tl|Color|Object|structs}} '''LineColor''')}}
 
{{code|native final function '''Draw2DLine''' ([[float]] '''X1''', [[float]] '''Y1''', [[float]] '''X2''', [[float]] '''Y2''', {{tl|Color|Object|structs}} '''LineColor''')}}
  
−
Draws a line from (X1,Y1) to (X2,Y2).
+
Draws a line on the canvas from (X1,Y1) to (X2,Y2).
  
 
====DrawColorizedTile====
 
====DrawColorizedTile====
 
{{code|native final function '''DrawColorizedTile''' ({{cl|Texture2D}} '''Tex''', [[float]] '''XL''', [[float]] '''YL''', [[float]] '''U''', [[float]] '''V''', [[float]] '''UL''', [[float]] '''VL''', {{tl|LinearColor|Object|structs}} '''LColor''')}}
 
{{code|native final function '''DrawColorizedTile''' ({{cl|Texture2D}} '''Tex''', [[float]] '''XL''', [[float]] '''YL''', [[float]] '''U''', [[float]] '''V''', [[float]] '''UL''', [[float]] '''VL''', {{tl|LinearColor|Object|structs}} '''LColor''')}}
  
−
<!-- enter function description -->
+
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====
 
====DrawMaterialTile====
 
{{code|native final function '''DrawMaterialTile''' ({{cl|MaterialInterface}}&nbsp;'''Mat''', [[float]]&nbsp;'''XL''', [[float]]&nbsp;'''YL''', optional&nbsp;[[float]]&nbsp;'''U''', optional&nbsp;[[float]]&nbsp;'''V''', optional&nbsp;[[float]]&nbsp;'''UL''', optional&nbsp;[[float]]&nbsp;'''VL''')}}
 
{{code|native final function '''DrawMaterialTile''' ({{cl|MaterialInterface}}&nbsp;'''Mat''', [[float]]&nbsp;'''XL''', [[float]]&nbsp;'''YL''', optional&nbsp;[[float]]&nbsp;'''U''', optional&nbsp;[[float]]&nbsp;'''V''', optional&nbsp;[[float]]&nbsp;'''UL''', optional&nbsp;[[float]]&nbsp;'''VL''')}}
  
−
Draws the emissive channel of a material to an axis-aligned quad at CurX,CurY.
+
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:'''
 
'''Parameters:'''
−
* ''Mat'' - The material which contains the emissive expression to render.
+
* ''Mat'' - The material which contains the emissive expression to draw.
−
* ''XL'' - The width of the quad in pixels.
+
* ''XL'', ''YL'' - Width and height of the canvas area to draw the tile to. The tile is stretched to fit the area.
−
* ''YL'' - The height of the quad in pixels.
+
* ''U'', ''V'' - Origin coordinates of the material area. Bottom/right end of material area for negative UL/VL values.
−
* ''U'' - The U coordinate of the quad's upper left corner, in normalized coordinates.
+
* ''UL'', ''VL'' - Width and height of the material area. Negative values mirror the tile in the corresponding direction.
−
* ''V'' - The V coordinate of the quad's upper left corner, in normalized coordinates.
+
−
* ''UL'' - The range of U coordinates which is mapped to the quad.
+
−
* ''VL'' - The range of V coordinates which is mapped to the quad.
+
  
 
====DrawMaterialTileClipped====
 
====DrawMaterialTileClipped====
 
{{code|native final function '''DrawMaterialTileClipped''' ({{cl|MaterialInterface}}&nbsp;'''Mat''', [[float]]&nbsp;'''XL''', [[float]]&nbsp;'''YL''', optional&nbsp;[[float]]&nbsp;'''U''', optional&nbsp;[[float]]&nbsp;'''V''', optional&nbsp;[[float]]&nbsp;'''UL''', optional&nbsp;[[float]]&nbsp;'''VL''')}}
 
{{code|native final function '''DrawMaterialTileClipped''' ({{cl|MaterialInterface}}&nbsp;'''Mat''', [[float]]&nbsp;'''XL''', [[float]]&nbsp;'''YL''', optional&nbsp;[[float]]&nbsp;'''U''', optional&nbsp;[[float]]&nbsp;'''V''', optional&nbsp;[[float]]&nbsp;'''UL''', optional&nbsp;[[float]]&nbsp;'''VL''')}}
  
−
<!-- enter function description -->
+
Same as {{tl|DrawMaterialTile}}, but cuts off the drawing area at the edges of the canvas clipping region defined by OrgX/Y and ClipX/Y.
  
 
====DrawRotatedMaterialTile====
 
====DrawRotatedMaterialTile====
 
{{code|native final function '''DrawRotatedMaterialTile''' ({{cl|MaterialInterface}}&nbsp;'''Mat''', {{tl|Rotator|Object|structs}}&nbsp;'''Rotation''', [[float]]&nbsp;'''XL''', [[float]]&nbsp;'''YL''', optional&nbsp;[[float]]&nbsp;'''U''', optional&nbsp;[[float]]&nbsp;'''V''', optional&nbsp;[[float]]&nbsp;'''UL''', optional&nbsp;[[float]]&nbsp;'''VL''', optional&nbsp;[[float]]&nbsp;'''AnchorX''', optional&nbsp;[[float]]&nbsp;'''AnchorY''')}}
 
{{code|native final function '''DrawRotatedMaterialTile''' ({{cl|MaterialInterface}}&nbsp;'''Mat''', {{tl|Rotator|Object|structs}}&nbsp;'''Rotation''', [[float]]&nbsp;'''XL''', [[float]]&nbsp;'''YL''', optional&nbsp;[[float]]&nbsp;'''U''', optional&nbsp;[[float]]&nbsp;'''V''', optional&nbsp;[[float]]&nbsp;'''UL''', optional&nbsp;[[float]]&nbsp;'''VL''', optional&nbsp;[[float]]&nbsp;'''AnchorX''', optional&nbsp;[[float]]&nbsp;'''AnchorY''')}}
  
−
<!-- enter function description -->
+
Same as {{tl|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====
 
====DrawRotatedTile====
 
{{code|native final function '''DrawRotatedTile''' ({{cl|Texture2D}}&nbsp;'''Tex''', {{tl|Rotator|Object|structs}}&nbsp;'''Rotation''', [[float]]&nbsp;'''XL''', [[float]]&nbsp;'''YL''', [[float]]&nbsp;'''U''', [[float]]&nbsp;'''V''', [[float]]&nbsp;'''UL''', [[float]]&nbsp;'''VL''', optional&nbsp;[[float]]&nbsp;'''AnchorX''', optional&nbsp;[[float]]&nbsp;'''AnchorY''')}}
 
{{code|native final function '''DrawRotatedTile''' ({{cl|Texture2D}}&nbsp;'''Tex''', {{tl|Rotator|Object|structs}}&nbsp;'''Rotation''', [[float]]&nbsp;'''XL''', [[float]]&nbsp;'''YL''', [[float]]&nbsp;'''U''', [[float]]&nbsp;'''V''', [[float]]&nbsp;'''UL''', [[float]]&nbsp;'''VL''', optional&nbsp;[[float]]&nbsp;'''AnchorX''', optional&nbsp;[[float]]&nbsp;'''AnchorY''')}}
  
−
<!-- enter function description -->
+
Same as {{tl|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====
 
====DrawText====
Line 219: Line 223:
 
{{code|native final function '''DrawTile''' ({{cl|Texture2D}}&nbsp;'''Tex''', [[float]]&nbsp;'''XL''', [[float]]&nbsp;'''YL''', [[float]]&nbsp;'''U''', [[float]]&nbsp;'''V''', [[float]]&nbsp;'''UL''', [[float]]&nbsp;'''VL''')}}
 
{{code|native final function '''DrawTile''' ({{cl|Texture2D}}&nbsp;'''Tex''', [[float]]&nbsp;'''XL''', [[float]]&nbsp;'''YL''', [[float]]&nbsp;'''U''', [[float]]&nbsp;'''V''', [[float]]&nbsp;'''UL''', [[float]]&nbsp;'''VL''')}}
  
−
<!-- enter function description -->
+
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====
 
====DrawTileClipped====
 
{{code|native(468) final function '''DrawTileClipped''' ({{cl|Texture2D}}&nbsp;'''Tex''', [[float]]&nbsp;'''XL''', [[float]]&nbsp;'''YL''', [[float]]&nbsp;'''U''', [[float]]&nbsp;'''V''', [[float]]&nbsp;'''UL''', [[float]]&nbsp;'''VL''')}}
 
{{code|native(468) final function '''DrawTileClipped''' ({{cl|Texture2D}}&nbsp;'''Tex''', [[float]]&nbsp;'''XL''', [[float]]&nbsp;'''YL''', [[float]]&nbsp;'''U''', [[float]]&nbsp;'''V''', [[float]]&nbsp;'''UL''', [[float]]&nbsp;'''VL''')}}
  
−
<!-- enter function description -->
+
Same as {{tl|DrawTile}}, but cuts off the drawing area at the edges of the canvas clipping region defined by OrgX/Y and ClipX/Y.
  
 
====DrawTileNew====
 
====DrawTileNew====
 
{{code|native final function '''DrawTileNew''' ({{cl|Texture}}&nbsp;'''Tex''', [[float]]&nbsp;'''XL''', [[float]]&nbsp;'''YL''', [[float]]&nbsp;'''U''', [[float]]&nbsp;'''V''', [[float]]&nbsp;'''UL''', [[float]]&nbsp;'''VL''')}}
 
{{code|native final function '''DrawTileNew''' ({{cl|Texture}}&nbsp;'''Tex''', [[float]]&nbsp;'''XL''', [[float]]&nbsp;'''YL''', [[float]]&nbsp;'''U''', [[float]]&nbsp;'''V''', [[float]]&nbsp;'''UL''', [[float]]&nbsp;'''VL''')}}
  
−
the only difference in this new version is you can pass in other types of textures (e.g. ScriptedTexture)
+
Same as {{tl|DrawTile}}, but also accepts other texture objects, such as {{cl|TextureMovie}} or render targets, including {{cl|ScriptedTexture}}s.
  
 
====DrawTileStretched====
 
====DrawTileStretched====
Line 299: Line 309:
 
{{code|final function '''DrawRect''' ([[float]]&nbsp;'''RectX''', [[float]]&nbsp;'''RectY''', optional&nbsp;{{cl|Texture2D}}&nbsp;'''Tex''')}}
 
{{code|final function '''DrawRect''' ([[float]]&nbsp;'''RectX''', [[float]]&nbsp;'''RectY''', optional&nbsp;{{cl|Texture2D}}&nbsp;'''Tex''')}}
  
−
<!-- enter function description -->
+
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 {{tl|DefaultTexture}}, which is entirely white.
  
 
====DrawTextRA====
 
====DrawTextRA====
Line 309: Line 319:
 
{{code|final function '''DrawTexture''' ({{cl|Texture2D}}&nbsp;'''Tex''', [[float]]&nbsp;'''Scale''')}}
 
{{code|final function '''DrawTexture''' ({{cl|Texture2D}}&nbsp;'''Tex''', [[float]]&nbsp;'''Scale''')}}
  
−
<!-- enter function description -->
+
Draws the specified texture at the current canvas position.
  
 
====MakeIcon====
 
====MakeIcon====

Latest revision as of 03:42, 4 October 2008

UT3 Object >> Canvas
Package: 
Engine
This class in other games:
RTNP, U1, UT, U2XMP, UE2Runtime, U2, UT2003, UT2004, UDK

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[edit]

bCenter[edit]

Type: bool

Whether to center the text.

bNoSmooth[edit]

Type: bool

Don't bilinear filter.

Canvas[edit]

Type: pointer{FCanvas}

Modifiers: native, const


ClipX[edit]

Type: float

Width of the clipping region.

ClipY[edit]

Type: float

Height of the clipping region.

ColorModulate[edit]

Type: Object.Plane


Default value:

Member Value
W 1.0
X 1.0
Y 1.0
Z 1.0

CurX[edit]

Type: float

Horizontal coordinate of current drawing position.

CurY[edit]

Type: float

Vertical coordinate of the current drawing position.

CurYL[edit]

Type: float

Height of the last DrawText output.

DefaultTexture[edit]

Type: Texture2D


Default value: Texture2D'EngineResources.WhiteSquareTexture'

DrawColor[edit]

Type: Object.Color

Color for drawing.

Default value:

Member Value
A 255
B 127
G 127
R 127

Font[edit]

Type: Font

Font for DrawText.

Default value: Font'EngineFonts.SmallFont'

OrgX[edit]

Type: float

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

OrgY[edit]

Type: float

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

SceneView[edit]

Type: pointer{FSceneView}

Modifiers: native, const


SizeX[edit]

Type: int

Modifiers: const

Width of the screen in pixels.

SizeY[edit]

Type: int

Modifiers: const

Height of the screen in pixels.

Structs[edit]

CanvasIcon[edit]

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[edit]

Native functions[edit]

DeProject[edit]

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

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

Draw2DLine[edit]

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[edit]

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[edit]

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[edit]

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[edit]

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[edit]

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[edit]

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


DrawTextClipped[edit]

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


DrawTextureDoubleLine[edit]

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[edit]

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[edit]

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[edit]

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[edit]

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[edit]

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[edit]

native final function PopTransform ()

Pops the topmost matrix from the canvas transform stack.

Project[edit]

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

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

PushTranslationMatrix[edit]

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[edit]

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


SetPos[edit]

native final function SetPos (float PosX, float PosY)

Sets CurX and CurY.

StrLen[edit]

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


TextSize[edit]

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


Events[edit]

Reset[edit]

event Reset (optional bool bKeepOrigin)


Other instance functions[edit]

DrawBox[edit]

final simulated function DrawBox (float width, float height)


DrawIcon[edit]

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

Draw a CanvasIcon at the desired canvas position.

DrawIconSection[edit]

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[edit]

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[edit]

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

Draws text right aligned from the current position.

DrawTexture[edit]

final function DrawTexture (Texture2D Tex, float Scale)

Draws the specified texture at the current canvas position.

MakeIcon[edit]

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

Fake CanvasIcon constructor.

SetClip[edit]

final function SetClip (float X, float Y)

Sets ClipXand ClipY.

SetOrigin[edit]

final function SetOrigin (float X, float Y)

Sets OrgX and OrgY.

Retrieved from "https://wiki.beyondunreal.com/UE3:Canvas_(UT3)?oldid=33094"