OsDrawLine

From OpenSimulator

(Difference between revisions)
Jump to: navigation, search
Line 1: Line 1:
 
{{Template:Quicklinks}}
 
{{Template:Quicklinks}}
 +
{|  width="100%" style="border: thin solid black"
 +
| colspan="2" align="center" style=background:orange | '''{{SUBPAGENAME}}'''
 +
|- valign="top"
 +
|'''Threat Level''' || <Threat Level goes here>
  
LSL: '''[[string]] osDrawLine( [[string]] drawList, [[integer]] startX, [[integer]] startY, [[integer]] endX, [[integer]] endY )'''<br />
+
|- valign="top"
:'''[[string]] osDrawLine( [[string]] drawList, [[integer]] endX, [[integer]] endY )'''
+
|'''Function Syntax''' || <source lang="lsl">
C#: '''[[string]] osDrawLine( [[string]] drawList, [[int]] startX, [[int]] startY, [[int]] endX, [[int]] endY )'''<br />
+
LSL: string osDrawLine( string drawList, integer startX, integer startY, integer endX, integer endY )
:'''[[string]] osDrawLine( [[string]] drawList, [[int]] endX, [[int]] endY )'''
+
    string osDrawLine( string drawList, integer endX, integer endY )
 
+
C# : string osDrawLine( string drawList, int startX, int startY, int endX, int endY )
 
+
    string osDrawLine( string drawList, int endX, int endY )
Depending on the form, appends a [[Drawing_commands#LineTo|LineTo]] drawing command, or [[Drawing_commands#MoveTo|MoveTo]] and [[Drawing_commands#LineTo|LineTo]] commands, to the string provided in '''drawList''' and returns the result.
+
</source>
 
+
|- valign="top"
In the longer form, draws a line using the current pen size and color from to the coordinates indicated by '''startX''' and '''startY''' to the coordinates indicated by '''endX''' and '''endY'''.
+
|'''Example(s)||<source lang="lsl">
 
+
In the shorter form, draws a line using the current pen size and color from the pen's current position to the coordinates indicated by '''endX''' and '''endY'''.
+
 
+
After the line is drawn, the pen's X and Y coordinates are set to '''endX''' and '''endY''', respectively.
+
 
+
Example:
+
<source lang="lsl">
+
 
// Example of osDrawLine
 
// Example of osDrawLine
 
default
 
default
Line 35: Line 32:
 
}
 
}
 
</source>
 
</source>
 +
|}
 +
Depending on the form, appends a [[Drawing_commands#LineTo|LineTo]] drawing command, or [[Drawing_commands#MoveTo|MoveTo]] and [[Drawing_commands#LineTo|LineTo]] commands, to the string provided in '''drawList''' and returns the result.
 +
 +
In the longer form, draws a line using the current pen size and color from to the coordinates indicated by '''startX''' and '''startY''' to the coordinates indicated by '''endX''' and '''endY'''.
 +
 +
In the shorter form, draws a line using the current pen size and color from the pen's current position to the coordinates indicated by '''endX''' and '''endY'''.
 +
 +
After the line is drawn, the pen's X and Y coordinates are set to '''endX''' and '''endY''', respectively.
 +
  
 +
[[Category:OSSL Functions]]
 
[[Category:OSSL]]
 
[[Category:OSSL]]
 
[[Category:OSSL functions without threat level]]
 
[[Category:OSSL functions without threat level]]

Revision as of 16:00, 8 June 2011

OsDrawLine
Threat Level <Threat Level goes here>
Function Syntax
LSL: string osDrawLine( string drawList, integer startX, integer startY, integer endX, integer endY )
     string osDrawLine( string drawList, integer endX, integer endY )
C# : string osDrawLine( string drawList, int startX, int startY, int endX, int endY )
     string osDrawLine( string drawList, int endX, int endY )
Example(s)
// Example of osDrawLine
default
{
    state_entry()
    {
        string CommandList = ""; // Storage for our drawing commands
 
        CommandList = osSetPenSize( CommandList, 3 );              // Set the pen width to 3 pixels
        CommandList = osSetPenColour( CommandList, "Red" );        // Set the pen color to red
        CommandList = osDrawLine( CommandList, 10, 10, 128, 246 ); // Draw the first line (long form)
        CommandList = osSetPenColour( CommandList, "Green" );      // Set the pen color to green
        CommandList = osDrawLine( CommandList, 246, 10);           // Draw the second line (short form)
 
        // Now draw the lines
        osSetDynamicTextureData( "", "vector", CommandList, "width:256,height:256", 0 );
    }
}

Depending on the form, appends a LineTo drawing command, or MoveTo and LineTo commands, to the string provided in drawList and returns the result.

In the longer form, draws a line using the current pen size and color from to the coordinates indicated by startX and startY to the coordinates indicated by endX and endY.

In the shorter form, draws a line using the current pen size and color from the pen's current position to the coordinates indicated by endX and endY.

After the line is drawn, the pen's X and Y coordinates are set to endX and endY, respectively.

Personal tools
General
About This Wiki