Engine.Canvas

//=============================================================================
// Canvas: A drawing canvas.
// This is a built-in Unreal class and it shouldn't be modified.
//
// Notes.
//   To determine size of a drawable object, set Style to STY_None,
//   remember CurX, draw the thing, then inspect CurX and CurYL.
//=============================================================================
class Canvas extends Object
		native
			noexport;

// Objects.
#exec Font Import File=Textures\SmallFont.bmp Name=SmallFont
#exec Font Import File=Textures\MedFont.pcx   Name=MedFont
#exec Font Import File=Textures\LargeFont.pcx Name=LargeFont
#exec Font Import File=Textures\BigFont.pcx   Name=BigFont

// Modifiable properties.
var font    Font;            // Font for DrawText.
var float   SpaceX, SpaceY;  // Spacing for after Draw*.
var float   OrgX, OrgY;      // Origin for drawing.
var float   ClipX, ClipY;    // Bottom right clipping region.
var float   CurX, CurY;      // Current position for drawing.
var float   Z;               // Z location. 1=no screenflash, 2=yes screenflash.
var byte    Style;           // Drawing style STY_None means don't draw.
var float   CurYL;           // Largest Y size since DrawText.
var color   DrawColor;       // Color for drawing.
var bool    bCenter;         // Whether to center the text.
var bool    bNoSmooth;       // Don't bilinear filter.
var const bool bUseOffset,bUseFlatZ; // Used by 3D tile offset.
var const int SizeX, SizeY;  // Zero-based actual dimensions.

// Stock fonts.
var font SmallFont;          // Small system font.
var font MedFont;            // Medium system font.
var font BigFont;            // Big system font.
var font LargeFont;          // Large system font.

// Internal.
var const viewport Viewport; // Viewport that owns the canvas.
var const int FramePtr;      // Scene frame pointer.
var const int RenderPtr;	 // Render device pointer, only valid during UGameEngine::Draw
var coords RenderCoords;     // Used by 3D tile offset.

// native functions.
native(464) final function StrLen( coerce string String, out float XL, out float YL );
native(465) final function DrawText( coerce string Text, optional bool CR );
native(466) final function DrawTile( texture Tex, float XL, float YL, float U, float V, float UL, float VL );
native(467) final function DrawActor( Actor A, bool WireFrame, optional bool ClearZ );
native(468) final function DrawTileClipped( texture Tex, float XL, float YL, float U, float V, float UL, float VL );
native(469) final function DrawTextClipped( coerce string Text, optional bool bCheckHotKey );
native(470) final function TextSize( coerce string String, out float XL, out float YL );
native(471) final function DrawClippedActor( Actor A, bool WireFrame, int X, int Y, int XB, int YB, optional bool ClearZ );
native(477) final function DrawTileStretched( Texture Tex, int X1, int Y1, int X2, int Y2 );
native(480) final function DrawPortal( int X, int Y, int Width, int Height, actor CamActor, vector CamLocation, rotator CamRotation, optional int FOV, optional bool ClearZ );

// New U227 functions:

/* Very fast:
Draw a clipped 2D line on the frame (vectors are given in screen space) */
native(1750) final function Draw2DLine( Color Col, vector Start, vector End );

/* Very fast:
Draw a 3D line (vectors are given in world space), rendering drivers notice:
-OpenGL/D3D8/D3D9 seems to render the line in world (meaning it can go behind objects and so). */
native(1751) final function Draw3DLine( Color Col, vector Start, vector End );

/* Very fast:
Convert a given world space location into screen location, note that coords should stand for camera rotation, example:
Pos = Canvas.WorldToScreen(ThePosition);
- The result: X = X screen location, Y = Y screen location, Z = 1, world location is in front of camera / -1, world location is behind the camera. */
native(1752) final function vector WorldToScreen( vector WorldPos, out float ZDistance );

/* Very fast:
Convert a given screen location into world space location, note that the result must be transformed with camera rotation then added with camera location:
Res = (Canvas.ScreenToWorld(ScreenPos) >> ViewRotation) + Location; */
native(1753) final function vector ScreenToWorld( vector ScreenPos );

/* Relative slow (debugging use only):
Draw the path network on HUD */
native(1754) final function DrawPathNetwork( bool bOnlyWalkable, optional float MaxDistance /*def 2000*/ );

/* enum ELineFlags
{
	LINE_None, = 0
	LINE_Transparent, = 1
	LINE_DepthCued = 2
};*/
// Render a circle
// Position is defined in world position.
native(1755) final function DrawCircle( Color Col, int LineFlags, vector Position, float Radius );

// Render a 3D box in world position.
native(1756) final function DrawBox( Color Col, int LineFlags, vector Start, vector End );

/* Very fast:
Get current camera location + rotation:
CamLocation = Origin
CamRotation = OrthoRotation(XAxis,YAxis,ZAxis) */
native(1757) final function coords GetCameraCoords();

// Set Tile drawing 3D offset.
// It is recommended you clear Z before using this (using Canvas.DrawActor(None,false,true);)
native(1758) final function SetTile3DOffset( bool bEnable, optional vector Offset, optional rotator RotOffset, optional bool bFlatZ, optional float Scale );


// UnrealScript functions.
event Reset()
{
	Font        = Default.Font;
	SpaceX      = Default.SpaceX;
	SpaceY      = Default.SpaceY;
	OrgX        = Default.OrgX;
	OrgY        = Default.OrgY;
	CurX        = Default.CurX;
	CurY        = Default.CurY;
	Style       = Default.Style;
	DrawColor   = Default.DrawColor;
	CurYL       = Default.CurYL;
	bCenter     = false;
	bNoSmooth   = false;
	Z           = 1.0;
	SetTile3DOffset(false);
}
final function SetPos( float X, float Y )
{
	CurX = X;
	CurY = Y;
}
final function SetOrigin( float X, float Y )
{
	OrgX = X;
	OrgY = Y;
}
final function SetClip( float X, float Y )
{
	ClipX = X;
	ClipY = Y;
}
final function DrawPattern( texture Tex, float XL, float YL, float Scale )
{
	DrawTile( Tex, XL, YL, (CurX-OrgX)*Scale, (CurY-OrgY)*Scale, XL*Scale, YL*Scale );
}
final function DrawIcon( texture Tex, float Scale )
{
	if ( Tex != None )
		DrawTile( Tex, Tex.USize*Scale, Tex.VSize*Scale, 0, 0, Tex.USize, Tex.VSize );
}
final function DrawRect( texture Tex, float RectX, float RectY )
{
	DrawTile( Tex, RectX, RectY, 0, 0, Tex.USize, Tex.VSize );
}

defaultproperties
{
				Z=1.000000
				Style=1
				DrawColor=(R=127,G=127,B=127)
				SmallFont=Font'Engine.SmallFont'
				MedFont=Font'Engine.MedFont'
				BigFont=Font'Engine.BigFont'
				LargeFont=Font'Engine.LargeFont'
}