Difference between revisions of "VEX2 Functions Display"

From ROBOTC API Guide
Jump to: navigation, search
 
(6 intermediate revisions by one user not shown)
Line 1: Line 1:
{| style="font-family:Verdana, Genega, sans-sarif; font-size:80%;color:gray;" width="100%" cellpadding="0%" cellspacing="0" border="0"
+
<yambe:breadcrumb self="Display">VEX2_Functions_and_Variables|Functions and Variables</yambe:breadcrumb>
|-
+
<br />
|
+
''[[Main_Page|Main]] >> [[VEX2_Main|CORTEX]] >> [[VEX2: Functions| Functions and Variables]] >> [[VEX2:_Functions_-_Display|Display]] ''
+
|-
+
|}
+
  
 
+
{|
{| class="wikiText"
+
 
|-
 
|-
|''For information about ROBOTC ''string'', please see the article: [[VEX2:_Functions_-_Strings|Strings]].''
+
|''For information about ROBOTC ''string'', please see the article: [[VEX2_Functions_Strings|Strings]].''
 
|-
 
|-
 
|
 
|
Line 26: Line 21:
 
   | style="border-style: solid; border-width: 0px 0px 1px 0px"|##
 
   | style="border-style: solid; border-width: 0px 0px 1px 0px"|##
 
   |-
 
   |-
   | style="border-style: solid; border-width: 0px 1px 1px 0px"|4
+
   | style="border-style: solid; border-width: 0px 1px 0px 0px"|4
   | style="text-align:left; border-style: solid; border-width: 0px 1px 1px 0px"|Pads the displayed number with spaces until the number of digits equals 4.  
+
   | style="text-align:left; border-style: solid; border-width: 0px 1px 0px 0px"|Pads the displayed number with spaces until the number of digits equals 4.  
   | style="border-style: solid; border-width: 0px 0px 1px 0px"|_ _ _# <br />_ _## <br />_### <br />####
+
   | style="border-style: solid; border-width: 0px 0px 0px 0px"|_ _ _# <br />_ _## <br />_### <br />####
 
   |-
 
   |-
 
   |}
 
   |}
Line 35: Line 30:
 
|-
 
|-
 
|}
 
|}
 +
<br />
  
 
+
{{tl|1|1}}
{|
+
|-
+
|style="vertical-align:top"| __TOC__
+
|style="vertical-align:top"|
+
{| width="100" cellpadding="2" cellspacing="0" style="border-collapse: collapse; border-width: 1px; border-style: solid; border-color: #000"
+
!colspan="2" class="wikiHeader"|Color Key
+
|-
+
|class="wikiText" width="75%" style="border-style: solid; border-width: 1px 0px 0px 0px"|Function:
+
|width="25%" style="border-style: solid; border-width: 1px 0px 0px 0px;" class="colorKeyFunc"|
+
|-
+
|class="wikiText" width="75%" style="border-style: solid; border-width: 0px 0px 0px 0px"|Variable:
+
|width="25%" style="border-style: solid; border-width: 0px 0px 0px 0px;" class="colorKeyVar"|
+
|}
+
|-
+
|}
+
 
<br />
 
<br />
  
Line 324: Line 305:
 
   |-
 
   |-
 
   |<syntaxhighlight lang="ROBOTC">displayNextLCDNumber(2365);  // displays the number '2365' onto the LCD screen</syntaxhighlight>
 
   |<syntaxhighlight lang="ROBOTC">displayNextLCDNumber(2365);  // displays the number '2365' onto the LCD screen</syntaxhighlight>
 +
  |-
 +
  |}
 +
|-
 +
|}
 +
<br />
 +
 +
== displayNextLCDString ==
 +
{| style="color:black;" width="100%" cellpadding="5%" cellspacing="0" border="0"
 +
|-
 +
| class="functionType"| <span class="bigKeywordBI">void </span><span class="bigKeywordB">displayNextLCDString</span><span class="bigCodePunc">(</span><span class="bigKeywordBI">string </span><span class="bigCodeBasic">sString</span><span class="bigCodePunc">)</span>
 +
|-
 +
| style="font-family:Verdana, Geneva, sans-serif; color:black; background-color:#FFFFFF; text-align:left; font-size:100%;"|([[Data_Types#dataType_void|void]]) Displays a integer number on the VEX LCD.
 +
|-
 +
|
 +
  {| class="parameterTable" cellpadding="5%" width="100%"
 +
  ! width="20%" style="border-style: solid; border-width: 0px 0px 1px 0px"|Parameter
 +
  ! width="60%" style="border-style: solid; border-width: 0px 0px 1px 0px"|Explanation
 +
  ! width="20%" style="border-style: solid; border-width: 0px 0px 1px 0px"|Data Type
 +
  |-
 +
  | style="border-style: solid; border-width: 1px 0px 0px 0px"|''sString''
 +
  | style="border-style: solid; border-width: 1px 0px 0px 0px"|The string to display.
 +
  | style="border-style: solid; border-width: 1px 0px 0px 0px"|[[Data_Types#dataType_string|string]]
 +
  |-
 +
  |}
 +
|-
 +
|
 +
  {|
 +
  |-
 +
  |<syntaxhighlight lang="ROBOTC">displayNextLCDString("ROBOT123");  // displays the string of text ROBOTC123 onto the LCD</syntaxhighlight>
 +
  |-
 +
  |}
 +
|-
 +
|}
 +
<br />
 +
 +
== setLCDPosition ==
 +
{| style="color:black;" width="100%" cellpadding="5%" cellspacing="0" border="0"
 +
|-
 +
| class="functionType"| <span class="bigKeywordBI">void </span><span class="bigKeywordB">setLCDPosition</span><span class="bigCodePunc">(</span><span class="bigKeywordBI">const int </span><span class="bigCodeBasic">nLine</span><span class="bigCodePunc">, </span><span class="bigKeywordBI">const int </span><span class="bigCodeBasic">nPos</span><span class="bigCodePunc">)</span>
 +
|-
 +
| style="font-family:Verdana, Geneva, sans-serif; color:black; background-color:#FFFFFF; text-align:left; font-size:100%;"|([[Data_Types#dataType_void|void]]) Sets the next display position on the VEX LCD.
 +
|-
 +
|
 +
  {| class="parameterTable" cellpadding="5%" width="100%"
 +
  ! width="20%" style="border-style: solid; border-width: 0px 0px 1px 0px"|Parameter
 +
  ! width="60%" style="border-style: solid; border-width: 0px 0px 1px 0px"|Explanation
 +
  ! width="20%" style="border-style: solid; border-width: 0px 0px 1px 0px"|Data Type
 +
  |-
 +
  | style="border-style: solid; border-width: 1px 0px 0px 0px"|''nLine''
 +
  | style="border-style: solid; border-width: 1px 0px 0px 0px"|The line to display on.  0 is the top, 1 is the bottom.
 +
  | style="border-style: solid; border-width: 1px 0px 0px 0px"|[[Data_Types#dataType_int|int]]
 +
  |-
 +
  | style="border-style: solid; border-width: 1px 0px 0px 0px"|''nPos''
 +
  | style="border-style: solid; border-width: 1px 0px 0px 0px"|The position on 'nLine' to display from.
 +
  | style="border-style: solid; border-width: 1px 0px 0px 0px"|[[Data_Types#dataType_int|int]]
 +
  |-
 +
  |}
 +
|-
 +
|
 +
  {|
 +
  |-
 +
  |<syntaxhighlight lang="ROBOTC">displayLCDPos(0,0);  //Sets the next character position to the first character on line 1</syntaxhighlight>
 
   |-
 
   |-
 
   |}
 
   |}

Latest revision as of 16:07, 30 April 2012


For information about ROBOTC string, please see the article: Strings.

Some display functions offer a precision parameter, which pads the displayed number with either zeros or spaces, until the number of digits is equal to the precision value:

Precision value Description Example Output
-4 Pads the displayed number with zeros until the number of digits equals 4. 000#
00##
0###
####
0 No padding. ##
4 Pads the displayed number with spaces until the number of digits equals 4. _ _ _#
_ _##
_###
####

Note: Underscore ( _ ) character denotes a space.


Color Key
Function:
Variable:


clearLCDLine

void clearLCDLine(const int nLine)
(void) Clears the indicated line of the VEX LCD to blanks.
Parameter Explanation Data Type
nLine The line to clear. 0 is the top, 1 is the bottom. int
clearLCDLine(1);  //Clears the second line of the LCD Screen (0 would be the first line)


displayLCDCenteredString

void displayLCDCenteredString(const int nLine, string sString)
(void) Clears the indicated line of the VEX LCD to blanks.
Parameter Explanation Data Type
nLine The line to display on. 0 is the top, 1 is the bottom. int
sString The string to display. string
displayLCDCenteredString(0,"ROBOT123");  //Displays the string "ROBOTC123" to the center of line 0


displayLCDChar

void displayLCDChar(const int nLine, const int nPos, const int cChar)
(void) Clears the indicated line of the VEX LCD to blanks.
Parameter Explanation Data Type
nLine The line to display on. 0 is the top, 1 is the bottom. int
nPos The position on 'nLine' to display from. int
cChar The char to display. Can be an int or char. int
displayLCDChar(0,0,'C');  //Displays the character 'C' at the first position on the first line.


displayLCDNumber

void displayLCDNumber(const int nLine, const int nPos, const int nValue, const int nPrecision = -1)
(void) Displays a number nValue on line nLine at position nPos.
Parameter Explanation Data Type
nLine The line to display on. 0 is the top, 1 is the bottom. int
nPos The position on 'nLine' to display from. int
nValue The number to display. int
nPrecision The precision of the number. -1 by default. int
displayLCDNumber(0,0,331);  // displays the number 331 at the first position on the first line


displayLCDPos

void displayLCDPos(const int nLine, const int nPos)
(void) Sets the next display position on the VEX LCD.
Parameter Explanation Data Type
nLine The line to display on. 0 is the top, 1 is the bottom. int
nPos The position on 'nLine' to display from. int
displayLCDPos(0,0);  // sets the next character position to the first character on line 1


displayLCDString

void displayLCDString(const int nLine, const int nPos, string sString)
(void) Displays a string sString on line nLine at position nPos.
Parameter Explanation Data Type
nLine The line to display on. 0 is the top, 1 is the bottom. int
nPos The position on 'nLine' to display from. int
sString The string to display. string
displayLCDString(0,0,"ROBOTC");  // displays the string "ROBOTC" starting from the first position 
                                 // on the first line


displayNextLCDChar

void displayNextLCDChar(const int cChar)
(void) Displays a specific character on the VEX LCD.
Parameter Explanation Data Type
cChar The char to display. Can be an int or char. int
displayLCDPos(1,5);       // sets the current LCD position to line 2, character 6
displayNextLCdChar('A');  // displays the character 'A' on line 2, character 6


displayNextLCDNumber

void displayNextLCDNumber(const int nValue, const int nPrecision = 0x40)
(void) Displays a integer number on the VEX LCD.
Parameter Explanation Data Type
nValue The number to display. int
nPrecision The precision of the number. 64 by default. int
displayNextLCDNumber(2365);  // displays the number '2365' onto the LCD screen


displayNextLCDString

void displayNextLCDString(string sString)
(void) Displays a integer number on the VEX LCD.
Parameter Explanation Data Type
sString The string to display. string
displayNextLCDString("ROBOT123");  // displays the string of text ROBOTC123 onto the LCD


setLCDPosition

void setLCDPosition(const int nLine, const int nPos)
(void) Sets the next display position on the VEX LCD.
Parameter Explanation Data Type
nLine The line to display on. 0 is the top, 1 is the bottom. int
nPos The position on 'nLine' to display from. int
displayLCDPos(0,0);  //Sets the next character position to the first character on line 1