Difference between revisions of "API Panel.Graphics"

From Flowcode Help
Jump to navigationJump to search
(XML import API auto-gen)
(XML import)
 
(15 intermediate revisions by 2 users not shown)
Line 1: Line 1:
−
<sidebar>API contents</sidebar>
+
<sidebar>API Contents</sidebar>
 
Direct drawing routines for a single frame
 
Direct drawing routines for a single frame
  
−
===Functions provided for this class===
+
This class is contained within [[API Panel|Panel]].
−
{||-|[[API Panel.Graphics.Redraw|Redraw]]|Sends a redraw request to the given component|-|[[API Panel.Graphics.SetColor|SetColor]]|Sets the draw colour for and subsequent graphics objects|-|[[API Panel.Graphics.SetColorRGB|SetColorRGB]]|Sets the draw colour for and subsequent graphics objects|-|[[API Panel.Graphics.SetTextFont|SetTextFont]]|Sets the text font for subsequent text objects|-|[[API Panel.Graphics.SetTextScale|SetTextScale]]|Sets the text scale for subsequent text objects|-|[[API Panel.Graphics.DrawCreate|DrawCreate]]|Creates a drawing area on a shape|-|[[API Panel.Graphics.DrawBegin|DrawBegin]]|Begins drawing on a given shape|-|[[API Panel.Graphics.DrawEnd|DrawEnd]]|Ends drawing started with DrawBegin()|-|[[API Panel.Graphics.DrawDelete|DrawDelete]]|Deletes a drawing area for a shape|-|[[API Panel.Graphics.DrawText|DrawText]]|Draws a line of text texture|-|[[API Panel.Graphics.DrawPoint|DrawPoint]]|Draws a point on a texture|-|[[API Panel.Graphics.DrawLine|DrawLine]]|Draws a line on a texture|-|[[API Panel.Graphics.DrawRect|DrawRect]]|Draws a rectangle on a texture|-|[[API Panel.Graphics.DrawCircle|DrawCircle]]|Draws a circle on a texture|-|[[API Panel.Graphics.Shape|Shape]]|Routines to change the last drawn shape|}
 
  
−
===Constants provided for this class===
+
__TOC__
−
{| class="wikitable" |+width="20%"|Type|width="30%"|Name |width="40%"|Value|-LONG|Align_TopLeft|0
+
 
−
|-LONG|Align_TopCenter|1
+
==Sub-classes provided for this class==
−
|-LONG|Align_TopRight|2
+
{|
−
|-LONG|Align_CenterLeft|4
+
|-
−
|-LONG|Align_Center|5
+
|width="35%"|[[API Panel.Graphics.Shape|Shape]]
−
|-LONG|Align_CenterRight|6
+
|Routines to change the last drawn shape
−
|-LONG|Align_BottomLeft|8
 
−
|-LONG|Align_BottomCenter|9
 
−
|-LONG|Align_BottomRight|10
 
 
|}
 
|}
  
−
===Examples===
+
 
 +
==Functions provided for this class==
 +
{|
 +
|-
 +
|width="35%"|[[API Panel.Graphics.Redraw|Redraw]]
 +
|Sends a redraw request to the given component
 +
|-
 +
|width="35%"|[[API Panel.Graphics.SetColor|SetColor]]
 +
|Sets the draw colour for and subsequent graphics objects
 +
|-
 +
|width="35%"|[[API Panel.Graphics.SetColorRGB|SetColorRGB]]
 +
|Sets the draw colour for and subsequent graphics objects
 +
|-
 +
|width="35%"|[[API Panel.Graphics.SetTextFont|SetTextFont]]
 +
|Sets the text font for subsequent text objects
 +
|-
 +
|width="35%"|[[API Panel.Graphics.SetTextScale|SetTextScale]]
 +
|Sets the text scale for subsequent text objects
 +
|-
 +
|width="35%"|[[API Panel.Graphics.SetLineThickness|SetLineThickness]]
 +
|Sets the thinkness when drawing lines and points
 +
|-
 +
|width="35%"|[[API Panel.Graphics.DrawCreate|DrawCreate]]
 +
|Creates a drawing area on a shape
 +
|-
 +
|width="35%"|[[API Panel.Graphics.DrawBegin|DrawBegin]]
 +
|Begins drawing on a given shape
 +
|-
 +
|width="35%"|[[API Panel.Graphics.DrawEnd|DrawEnd]]
 +
|Ends drawing started with DrawBegin()
 +
|-
 +
|width="35%"|[[API Panel.Graphics.DrawDelete|DrawDelete]]
 +
|Deletes a drawing area for a shape
 +
|-
 +
|width="35%"|[[API Panel.Graphics.DrawText|DrawText]]
 +
|Draws a line of text texture
 +
|-
 +
|width="35%"|[[API Panel.Graphics.DrawPoint|DrawPoint]]
 +
|Draws a point on a texture
 +
|-
 +
|width="35%"|[[API Panel.Graphics.DrawLine|DrawLine]]
 +
|Draws a line on a texture
 +
|-
 +
|width="35%"|[[API Panel.Graphics.DrawLineA|DrawLineA]]
 +
|Draws a smooth line on a texture
 +
|-
 +
|width="35%"|[[API Panel.Graphics.DrawRect|DrawRect]]
 +
|Draws a rectangle on a texture
 +
|-
 +
|width="35%"|[[API Panel.Graphics.DrawCircle|DrawCircle]]
 +
|Draws a circle on a texture
 +
|}
 +
 
 +
 
 +
==Constants provided for this class==
 +
{| class="wikitable" width="85%"
 +
|+ Used by [[API Panel.Graphics.DrawText|DrawText]]()
 +
|-
 +
!width="10%"|Type
 +
!width="20%"|Name
 +
!width="20%"|Value
 +
!width="60%"|Description
 +
|-
 +
|LONG
 +
|Align_TopLeft
 +
|0
 +
|Text is left aligned and drawn below the Y coordinate
 +
|-
 +
|LONG
 +
|Align_TopCenter
 +
|1
 +
|Text is center aligned and drawn below the Y coordinate
 +
|-
 +
|LONG
 +
|Align_TopRight
 +
|2
 +
|Text is right aligned and drawn below the Y coordinate
 +
|-
 +
|LONG
 +
|Align_CenterLeft
 +
|4
 +
|Text is left aligned and vertically centered
 +
|-
 +
|LONG
 +
|Align_Center
 +
|5
 +
|Text is horizontally aligned and vertically centered
 +
|-
 +
|LONG
 +
|Align_CenterRight
 +
|6
 +
|Text is right aligned and vertically centered
 +
|-
 +
|LONG
 +
|Align_BottomLeft
 +
|8
 +
|Text is left aligned and drawn above the Y coordinate
 +
|-
 +
|LONG
 +
|Align_BottomCenter
 +
|9
 +
|Text is center aligned drawn above the Y coordinate
 +
|-
 +
|LONG
 +
|Align_BottomRight
 +
|10
 +
|Text is right aligned drawn above the Y coordinate
 +
|}
 +
 
 +
 
 +
==Examples==
 +
''<span style="color:red;">No additional examples</span>''
 +
 
 +
==See also==
 +
''<span style="color:red;">No additional information</span>''

Latest revision as of 15:57, 16 January 2014

<sidebar>API Contents</sidebar> Direct drawing routines for a single frame

This class is contained within Panel.

Sub-classes provided for this class

Shape Routines to change the last drawn shape


Functions provided for this class

Redraw Sends a redraw request to the given component
SetColor Sets the draw colour for and subsequent graphics objects
SetColorRGB Sets the draw colour for and subsequent graphics objects
SetTextFont Sets the text font for subsequent text objects
SetTextScale Sets the text scale for subsequent text objects
SetLineThickness Sets the thinkness when drawing lines and points
DrawCreate Creates a drawing area on a shape
DrawBegin Begins drawing on a given shape
DrawEnd Ends drawing started with DrawBegin()
DrawDelete Deletes a drawing area for a shape
DrawText Draws a line of text texture
DrawPoint Draws a point on a texture
DrawLine Draws a line on a texture
DrawLineA Draws a smooth line on a texture
DrawRect Draws a rectangle on a texture
DrawCircle Draws a circle on a texture


Constants provided for this class

Used by DrawText()
Type Name Value Description
LONG Align_TopLeft 0 Text is left aligned and drawn below the Y coordinate
LONG Align_TopCenter 1 Text is center aligned and drawn below the Y coordinate
LONG Align_TopRight 2 Text is right aligned and drawn below the Y coordinate
LONG Align_CenterLeft 4 Text is left aligned and vertically centered
LONG Align_Center 5 Text is horizontally aligned and vertically centered
LONG Align_CenterRight 6 Text is right aligned and vertically centered
LONG Align_BottomLeft 8 Text is left aligned and drawn above the Y coordinate
LONG Align_BottomCenter 9 Text is center aligned drawn above the Y coordinate
LONG Align_BottomRight 10 Text is right aligned drawn above the Y coordinate


Examples

No additional examples

See also

No additional information

Retrieved from "https://www.flowcode.co.uk/wiki/index.php?title=API_Panel.Graphics&oldid=13778"