Difference between revisions of "Component: Display Manager (Graphical Library)"

Revision as of 12:02, 3 February 2023

Author	MatrixTSL
Version	1.0
Category	Graphical Library

Display Manager component

A component designed to simplify the process of drawing primitives and text onto a graphical display. Keeps track of coordinates so you don't have to. Also works great as a base layer for gLCD based games as it will check for collisions and perform movement.

Component Source Code

Please click here to download the component source project: FC_Comp_Source_temp/Lib_DisplayManager.fcfx

Please click here to view the component source code (Beta): FC_Comp_Source_temp/Lib_DisplayManager.fcfx

Detailed description

The component can create the follow objects.

Type_Line - 2 - A simple straight line.
Type_Rectangle - 1 - A simple rectangular box.
Type_RectangeFilled - 5 - A filled rectangular box.
Type_Ellipse - 3 - A simple ellipse or circle.
Type_EllipseFilled - 4 - A filled ellipse or circle.
Type_TextBox - 0 - A text area allowing a line of text to be displayed.

The type can be entered by using the component's public constants. Begin with the Display Manager handle name followed by :: and the list of the public variables will be displayed.

For example... DisplayManager1::Type_TextBox

Examples

An example showing the creation of some text areas inside formatted shapes.

Display Manager Example

Macro reference

CreateObject

	CreateObject
Define an object on the graphical LCD. Returns the Object ID.
- UINT	ObjectType
0=TextBox, 1=Rect, 2=Line, 3=Ellipse, 4=FilledEllipse, 5=FilledRect
- UINT	X
X Pixel Coordinate
- UINT	Y
Y Pixel Coordinate
- UINT	Width
Pixel Width or X Radius
- UINT	Height
Pixel Height or Y Radius
- UINT	Return

DrawObject

	DrawObject
Draws a single object onto the display without clearing the display. Doesn't draw a textfield component, this is done using the SetObjectText macro.
- UINT	ObjectID

- VOID	Return

MoveObject

	MoveObject
Moves an existing object to absolute coordinates on the screen.
- UINT	ObjectID

- UINT	X

- UINT	Y

- VOID	Return

RedrawAll

	RedrawAll
Redraws all the content from the display manager objects. Doesn't draw textfield components, this is done using the SetObjectText macro.
- VOID	Return

ScaleObject

	ScaleObject
Changes the width and height of the selected Object
- UINT	ObjectID

- UINT	Width

- UINT	Height

- VOID	Return

SetObjectText

	SetObjectText
Assigns text to a single line text object and draws directly to the display. Blanks the selected area first to ensure nothing from previous text is left behind.
- UINT	ObjectID

- STRING	Text

- BYTE	Font

- VOID	Return

ShiftObject

	ShiftObject
Shifts an existing object coordinates on the screen relative to the previous coordinates.
- UINT	ObjectID

- INT	X

- INT	Y

- VOID	Return

Property reference

	Properties
	LinkTo

	Max Objects
The total number of objects allowed on the screen. Sets the size of the RAM buffers used to track the various screen elements.

@@ Line 17: / Line 17: @@
 ==Component Source Code==
-Please click here to download the component source project: [https://www.flowcode.co.uk/wiki/componentsource/FC_Comp_Source_Lib_DisplayManager.fcfx FC_Comp_Source_Lib_DisplayManager.fcfx]
+Please click here to download the component source project: [https://www.flowcode.co.uk/wiki/componentsource/FC_Comp_Source_temp/Lib_DisplayManager.fcfx FC_Comp_Source_temp/Lib_DisplayManager.fcfx]
-Please click here to view the component source code (Beta): [https://www.flowcode.co.uk/FlowchartView/?wfile=componentsource/FC_Comp_Source_Lib_DisplayManager.fcfx FC_Comp_Source_Lib_DisplayManager.fcfx]
+Please click here to view the component source code (Beta): [https://www.flowcode.co.uk/FlowchartView/?wfile=componentsource/FC_Comp_Source_temp/Lib_DisplayManager.fcfx FC_Comp_Source_temp/Lib_DisplayManager.fcfx]
 ==Detailed description==
@@ Line 66: / Line 66: @@
 {{Fcfile|DisplayManagerExample.fcfx|Display Manager Example}}
@@ Line 73: / Line 75: @@
 ==Macro reference==
-===MoveObject===
+===CreateObject===
 {| class="wikitable" style="width:60%; background-color:#FFFFFF;"
 |-
 | width="10%" align="center" style="background-color:#D8C9D8;" align="center" | [[File:Fc9-comp-macro.png]]
-| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''MoveObject'''
+| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''CreateObject'''
 |-
-| colspan="2" | Moves an existing object to absolute coordinates on the screen.&nbsp;
+| colspan="2" | Define an object on the graphical LCD. Returns the Object ID.&nbsp;
 |-
 |-
 | width="10%" align="center" | [[File:Fc9-u16-icon.png]] - UINT
-| width="90%" | ObjectID
+| width="90%" | ObjectType
 |-
-| colspan="2" | &nbsp;
+| colspan="2" | 0=TextBox, 1=Rect, 2=Line, 3=Ellipse, 4=FilledEllipse, 5=FilledRect&nbsp;
 |-
 | width="10%" align="center" | [[File:Fc9-u16-icon.png]] - UINT
 | width="90%" | X
 |-
-| colspan="2" | &nbsp;
+| colspan="2" | X Pixel Coordinate&nbsp;
 |-
 | width="10%" align="center" | [[File:Fc9-u16-icon.png]] - UINT
 | width="90%" | Y
+|-
+| colspan="2" | Y Pixel Coordinate&nbsp;
+|-
+| width="10%" align="center" | [[File:Fc9-u16-icon.png]] - UINT
+| width="90%" | Width
+|-
+| colspan="2" | Pixel Width or X Radius&nbsp;
+|-
+| width="10%" align="center" | [[File:Fc9-u16-icon.png]] - UINT
+| width="90%" | Height
+|-
+| colspan="2" | Pixel Height or Y Radius&nbsp;
+|-
+| width="10%" align="center" style="border-top: 2px solid #000;" | [[File:Fc9-u16-icon.png]] - UINT
+| width="90%" style="border-top: 2px solid #000;" | ''Return''
+|}
+===DrawObject===
+{| class="wikitable" style="width:60%; background-color:#FFFFFF;"
+|-
+| width="10%" align="center" style="background-color:#D8C9D8;" align="center" | [[File:Fc9-comp-macro.png]]
+| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''DrawObject'''
+|-
+| colspan="2" | Draws a single object onto the display without clearing the display. Doesn't draw a textfield component, this is done using the SetObjectText macro.&nbsp;
+|-
+|-
+| width="10%" align="center" | [[File:Fc9-u16-icon.png]] - UINT
+| width="90%" | ObjectID
 |-
 | colspan="2" | &nbsp;
@@ Line 102: / Line 133: @@
-===ShiftObject===
+===MoveObject===
 {| class="wikitable" style="width:60%; background-color:#FFFFFF;"
 |-
 | width="10%" align="center" style="background-color:#D8C9D8;" align="center" | [[File:Fc9-comp-macro.png]]
-| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''ShiftObject'''
+| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''MoveObject'''
 |-
-| colspan="2" | Shifts an existing object coordinates on the screen relative to the previous coordinates.&nbsp;
+| colspan="2" | Moves an existing object to absolute coordinates on the screen.&nbsp;
 |-
 |-
@@ Line 116: / Line 147: @@
 | colspan="2" | &nbsp;
 |-
-| width="10%" align="center" | [[File:Fc9-s16-icon.png]] - INT
+| width="10%" align="center" | [[File:Fc9-u16-icon.png]] - UINT
 | width="90%" | X
 |-
 | colspan="2" | &nbsp;
 |-
-| width="10%" align="center" | [[File:Fc9-s16-icon.png]] - INT
+| width="10%" align="center" | [[File:Fc9-u16-icon.png]] - UINT
 | width="90%" | Y
 |-
@@ Line 131: / Line 162: @@
-===DrawObject===
+===RedrawAll===
 {| class="wikitable" style="width:60%; background-color:#FFFFFF;"
 |-
 | width="10%" align="center" style="background-color:#D8C9D8;" align="center" | [[File:Fc9-comp-macro.png]]
-| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''DrawObject'''
+| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''RedrawAll'''
 |-
-| colspan="2" | Draws a single object onto the display without clearing the display. Doesn't draw a textfield component, this is done using the SetObjectText macro.&nbsp;
+| colspan="2" | Redraws all the content from the display manager objects. Doesn't draw textfield components, this is done using the SetObjectText macro.&nbsp;
-|-
-|-
-| width="10%" align="center" | [[File:Fc9-u16-icon.png]] - UINT
-| width="90%" | ObjectID
 |-
-| colspan="2" | &nbsp;
 |-
 | width="10%" align="center" style="border-top: 2px solid #000;" | [[File:Fc9-void-icon.png]] - VOID
@@ Line 173: / Line 199: @@
 |-
 | colspan="2" | &nbsp;
-|-
-| width="10%" align="center" style="border-top: 2px solid #000;" | [[File:Fc9-void-icon.png]] - VOID
-| width="90%" style="border-top: 2px solid #000;" | ''Return''
-|}
-===RedrawAll===
-{| class="wikitable" style="width:60%; background-color:#FFFFFF;"
-|-
-| width="10%" align="center" style="background-color:#D8C9D8;" align="center" | [[File:Fc9-comp-macro.png]]
-| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''RedrawAll'''
-|-
-| colspan="2" | Redraws all the content from the display manager objects. Doesn't draw textfield components, this is done using the SetObjectText macro.&nbsp;
-|-
 |-
 | width="10%" align="center" style="border-top: 2px solid #000;" | [[File:Fc9-void-icon.png]] - VOID
@@ Line 222: / Line 234: @@
-===CreateObject===
+===ShiftObject===
 {| class="wikitable" style="width:60%; background-color:#FFFFFF;"
 |-
 | width="10%" align="center" style="background-color:#D8C9D8;" align="center" | [[File:Fc9-comp-macro.png]]
-| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''CreateObject'''
+| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''ShiftObject'''
 |-
-| colspan="2" | Define an object on the graphical LCD. Returns the Object ID.&nbsp;
+| colspan="2" | Shifts an existing object coordinates on the screen relative to the previous coordinates.&nbsp;
 |-
 |-
 | width="10%" align="center" | [[File:Fc9-u16-icon.png]] - UINT
-| width="90%" | ObjectType
+| width="90%" | ObjectID
 |-
-| colspan="2" | 0=TextBox, 1=Rect, 2=Line, 3=Ellipse, 4=FilledEllipse, 5=FilledRect&nbsp;
+| colspan="2" | &nbsp;
 |-
-| width="10%" align="center" | [[File:Fc9-u16-icon.png]] - UINT
+| width="10%" align="center" | [[File:Fc9-s16-icon.png]] - INT
 | width="90%" | X
 |-
-| colspan="2" | X Pixel Coordinate&nbsp;
+| colspan="2" | &nbsp;
 |-
-| width="10%" align="center" | [[File:Fc9-u16-icon.png]] - UINT
+| width="10%" align="center" | [[File:Fc9-s16-icon.png]] - INT
 | width="90%" | Y
 |-
-| colspan="2" | Y Pixel Coordinate&nbsp;
+| colspan="2" | &nbsp;
 |-
-| width="10%" align="center" | [[File:Fc9-u16-icon.png]] - UINT
+| width="10%" align="center" style="border-top: 2px solid #000;" | [[File:Fc9-void-icon.png]] - VOID
-| width="90%" | Width
-|-
-| colspan="2" | Pixel Width or X Radius&nbsp;
-|-
-| width="10%" align="center" | [[File:Fc9-u16-icon.png]] - UINT
-| width="90%" | Height
-|-
-| colspan="2" | Pixel Height or Y Radius&nbsp;
-|-
-| width="10%" align="center" style="border-top: 2px solid #000;" | [[File:Fc9-u16-icon.png]] - UINT
 | width="90%" style="border-top: 2px solid #000;" | ''Return''
 |}

Difference between revisions of "Component: Display Manager (Graphical Library)"

Revision as of 12:02, 3 February 2023

Contents