Documentation / Marblecore Imaging / Methods / DrawArrow
DrawArrow method
Draws a line with a begin and/or end cap on the image using the specified color, line width, line style and opacity.
Syntax
Boolean DrawArrow(nLeft As Number, nTop As Number, nRight As Number, nBottom As Number, nCapBegin As Cap, nCapEnd As Cap, nPenColor As Number, nPenOpacity As Number, nPenStyle As Pen, nPenWidth As Number, bPenAntiAliasing As State)
Return value
Returns true if the function succeeded.
Parameters
Parameter | Type | Required | Description |
nLeft | Number | Yes | Specifies the left coordinate for the line. |
nTop | Number | Yes | Specifies the top coordinate for the line. |
nRight | Number | Yes | Specifies the right coordinate for the line. |
nBottom | Number | Yes | Specifies the bottom coordinate for the line. |
nCapBegin | Cap (Enumeration) | No | Specifies the begin cap of the line. |
nCapEnd | Cap (Enumeration) | No | Specifies the end cap of the line. |
nPenColor | Number | No | Optional parameter containing a color value. If no color is specified, the current pen color will be used instead. |
nPenOpacity | Number | No | Optional parameter containing the opacity percentage (where 0% is completely transparent). If no opacity is specified, the current pen opacity will be used instead. |
nPenStyle | Pen (Enumeration) | No | Optional parameter containing the desired line style. If no style is specified, the current pen style will be used instead. |
nPenWidth | Number | No | Optional parameter containing the desired line width (thickness) in pixels (ranging from 1...100). If no width is specified, the current pen width will be used instead. |
bPenAntiAliasing | State (Enumeration) | No | Optional parameter enabling or disabling line anti-aliasing. If not specified the current pen anti-aliasing setting will be used instead. |
Example
The example below shows how to use the method. If you take a look at the example code, assume there is a reference to the Marblecore Imaging object with the name 'MarblecoreImaging'. Transparent parts of the image are displayed using a checkerboard pattern.
1
2 MarblecoreImaging.Create(150, 150, true);
3
4
5 MarblecoreImaging.DrawArrow(25, 25, 125, 125, "Arrow", "Circle");
6
7
8 MarblecoreImaging.SaveToFile("example-drawarrow.jpg");
Category
Drawing
See also
DrawArc |
DrawBackground |
DrawBezier |
DrawCheckerboard |
DrawCurve |
DrawCurveBorder |
DrawCurveFilled |
DrawCurveGradient |
DrawEllipse |
DrawEllipseBorder |
DrawEllipseFilled |
DrawEllipseGradient |
DrawFloodFill |
DrawLine |
DrawPie |
DrawPieBorder |
DrawPieFilled |
DrawPieGradient |
DrawPixel |
DrawPolygon |
DrawPolygonBorder |
DrawPolygonFilled |
DrawPolygonGradient |
DrawRectangle |
DrawRectangleBorder |
DrawRectangleFilled |
DrawRectangleGradient |
DrawRectangleTransparent |
DrawRhombus |
DrawRhombusBorder |
DrawRhombusFilled |
DrawRhombusGradient |
DrawRoundRectangle |
DrawRoundRectangleBorder |
DrawRoundRectangleFilled |
DrawRoundRectangleGradient |
DrawTriangle |
DrawTriangleBorder |
DrawTriangleFilled |
DrawTriangleGradient |
GetPixelColor |
LineTo |
MoveTo