Difference between revisions of "gc:drawArc"

From Inspired-Lua Wiki
Jump to navigation Jump to search
m (Made sure this looks the same as gc:fillArc, which had some places with more enters. And added a See Also to gc:fillArc)
 
(2 intermediate revisions by 2 users not shown)
Line 4: Line 4:
 
    
 
    
  
Draws an arc in the rectangle with upper left corner (x,y) and pixel ''width'' and ''height''. The arc is drawn beginning at ''startAngle'' degrees and ending at ''endAngle''.
+
Draws an arc in the rectangle with upper left corner (x,y) and pixel ''width'' and ''height''. The arc is drawn beginning at ''startAngle'' degrees and turns over ''turnAngle'' degrees.<br />
 
Zero degrees points to the right and 90 degrees points up (standard mathematical practice but worth mentioning since the y axis is inverted).     
 
Zero degrees points to the right and 90 degrees points up (standard mathematical practice but worth mentioning since the y axis is inverted).     
 +
  
 
{{Since|3.0}}
 
{{Since|3.0}}
  
 
== Syntax  ==
 
== Syntax  ==
gc:'''drawArc'''(x, y, width, height, start angle, finish angle)  
+
gc:'''drawArc'''(x, y, width, height, start angle, turn angle)  
  
 
{| class="wikitable"
 
{| class="wikitable"
Line 25: Line 26:
  
 
|-
 
|-
| <u><center>start angle</center></u> || number || start angle
+
| <u><center>start angle</center></u> || number || The starting angle of the arc
  
 
|-
 
|-
| <u><center>finish angle</center></u> || number || finish angle
+
| <u><center>turning angle</center></u> || number || The angle over which the arc turns
 
|}
 
|}
  
== Example ==
+
In this syntax ''turnAngle'' can be negative. This means the arc will be drawn clockwise, whereas a positive number results in an arc turning counterclockwise. (Standard mathematical practice as well.)
 +
 
 +
== Examples ==
 
<syntaxhighlight>gc:drawArc(10, 10, 20, 30, 0, 120)</syntaxhighlight>
 
<syntaxhighlight>gc:drawArc(10, 10, 20, 30, 0, 120)</syntaxhighlight>
 +
The syntax above draws an arc from the right to the point turned 120 degrees.
 +
<br /><br />
 +
<syntaxhighlight>gc:drawArc(50, 50, 25, 25, 90, 180)</syntaxhighlight>
 +
The syntax above draws a semicircle from the top to the bottom, turning counterclockwise while doing so. Resulting in the semicircle being on the left side.
 +
<syntaxhighlight>gc:drawArc(50, 50, 25, 25, 90, -180)</syntaxhighlight>
 +
The syntax above draws a semicircle as well. Again from the top to the bottom. This time however, the routine will turn the arc clockwise, resulting in the semicircle being on the right side.
  
 
== Good to know ==
 
== Good to know ==
  
To draw a circle, the width and height must be equal length and the start and end angles must be 0 and 360. If width and height are different lengths, this routine will draw an oval.
+
To draw a circle, the width and height must be equal length and the turning angle must be 360. If width and height are different lengths, this routine will draw an oval. It is standard procedure to set the starting angle at 0 degrees. However, this is not necessary.
 +
 
 +
 
 +
Any number over 360 set for ''startAngle'' will roll back to be within the domain of [0,360].
 +
 
 +
Any number over 360 set for ''turnAngle'' will have no influence. All numbers higher than 360 will result in a circle.
 +
 
 +
== See Also ==
 +
[[gc:fillArc]]
  
 
<br /><br />
 
<br /><br />
  
 
[[Category:gc]]
 
[[Category:gc]]

Latest revision as of 10:36, 13 February 2019


gc:drawArc is a function that is part of gc (Graphics Context).


Draws an arc in the rectangle with upper left corner (x,y) and pixel width and height. The arc is drawn beginning at startAngle degrees and turns over turnAngle degrees.
Zero degrees points to the right and 90 degrees points up (standard mathematical practice but worth mentioning since the y axis is inverted).


This has been introduced in TI-Nspire OS 3.0 (Changes).


Syntax

gc:drawArc(x, y, width, height, start angle, turn angle)

Parameter Type Description
x
number The x-coordinate of the upper-left point
y
number The x-coordinate of the upper-left point
width
number Width of the rectangle containing the arc
height
number Height of the rectangle containing the arc
start angle
number The starting angle of the arc
turning angle
number The angle over which the arc turns

In this syntax turnAngle can be negative. This means the arc will be drawn clockwise, whereas a positive number results in an arc turning counterclockwise. (Standard mathematical practice as well.)

Examples

gc:drawArc(10, 10, 20, 30, 0, 120)

The syntax above draws an arc from the right to the point turned 120 degrees.

gc:drawArc(50, 50, 25, 25, 90, 180)

The syntax above draws a semicircle from the top to the bottom, turning counterclockwise while doing so. Resulting in the semicircle being on the left side.

gc:drawArc(50, 50, 25, 25, 90, -180)

The syntax above draws a semicircle as well. Again from the top to the bottom. This time however, the routine will turn the arc clockwise, resulting in the semicircle being on the right side.

Good to know

To draw a circle, the width and height must be equal length and the turning angle must be 360. If width and height are different lengths, this routine will draw an oval. It is standard procedure to set the starting angle at 0 degrees. However, this is not necessary.


Any number over 360 set for startAngle will roll back to be within the domain of [0,360].

Any number over 360 set for turnAngle will have no influence. All numbers higher than 360 will result in a circle.

See Also

gc:fillArc