OsDrawRectangle

From OpenSimulator

(Difference between revisions)
Jump to: navigation, search
m (Fixed a link)
 
(15 intermediate revisions by 5 users not shown)
Line 1: Line 1:
{{Template:Quicklinks}}
+
{{osslfunc
[[Technical Reference | Technical Reference]] -> [[Technical Reference/terms | Terms]] -> [[Status | Status Page]] -> [[OSSL_Implemented| OSSL Implemented Functions]] -> [[Dynamic textures]] -> [[OsDrawRectangle | osDrawRectangle]]
+
|threat_level=ignored
 
+
|permissions=true
 
+
|delay=0
LSL: '''[[string]] osDrawRectangle( [[string]] drawList, [[integer]] width, [[integer]] height )'''<br />
+
|function_syntax=string osDrawRectangle(string drawList, integer width, integer height)
C#: '''[[string]] osDrawRectangle( [[string]] drawList, [[int]] width, [[int]] height )'''
+
|ossl_example=<source lang="lsl">
 
+
 
+
Appends a [[Drawing_commands#Rectangle|Rectangle]] drawing command to the string provided in '''drawList''' and returns the result.
+
 
+
The outline of a rectangle is drawn with the current pen size and color, at the specified width and height (in pixels), with the upper left corner of the rectangle placed at the pen's current position. After the rectangle is drawn, the width and height values are added to the pen's X and Y position, respectively (that is, the pen is positioned at the lower right corner of the rectangle.
+
 
+
Example:
+
<source lang="lsl">
+
 
// Example of osDrawRectangle
 
// Example of osDrawRectangle
 
default
 
default
Line 20: Line 12:
 
         string CommandList = ""; // Storage for our drawing commands
 
         string CommandList = ""; // Storage for our drawing commands
  
         CommandList += osSetPenSize( CommandList, 3 );          // Set the pen width to 3 pixels
+
         CommandList = osSetPenSize( CommandList, 3 );          // Set the pen width to 3 pixels
         CommandList += osSetPenColour( CommandList, "Green" );  // Set the pen color to green
+
         CommandList = osSetPenColor( CommandList, "Green" );  // Set the pen color to green
         CommandList += osMovePen( CommandList, 28, 78 );        // Upper left corner at <28,78>
+
         CommandList = osMovePen( CommandList, 28, 78 );        // Upper left corner at <28,78>
         CommandList += osDrawRectangle( CommandList, 200, 100 ); // 200 pixels by 100 pixels
+
         CommandList = osDrawRectangle( CommandList, 200, 100 ); // 200 pixels by 100 pixels
  
 
         // Now draw the rectangle
 
         // Now draw the rectangle
Line 30: Line 22:
 
}
 
}
 
</source>
 
</source>
 +
|description=Appends a [[Drawing commands#Rectangle|Rectangle]] drawing command to the string provided in '''drawList''' and returns the result.
 +
 +
The outline of a rectangle is drawn with the current pen size and color, at the specified width and height (in pixels), with the upper left corner of the rectangle placed at the pen's current position. After the rectangle is drawn, the width and height values are added to the pen's X and Y position, respectively (that is, the pen is positioned at the lower right corner of the rectangle.
 +
|
 +
}}

Latest revision as of 12:36, 14 November 2018

string osDrawRectangle(string drawList, integer width, integer height)
Appends a Rectangle drawing command to the string provided in drawList and returns the result.

The outline of a rectangle is drawn with the current pen size and color, at the specified width and height (in pixels), with the upper left corner of the rectangle placed at the pen's current position. After the rectangle is drawn, the width and height values are added to the pen's X and Y position, respectively (that is, the pen is positioned at the lower right corner of the rectangle.

Threat Level This function does not do a threat level check
Permissions Use of this function is always allowed by default
Extra Delay 0 seconds
Example(s)
// Example of osDrawRectangle
default
{
    state_entry()
    {
        string CommandList = ""; // Storage for our drawing commands
 
        CommandList = osSetPenSize( CommandList, 3 );           // Set the pen width to 3 pixels
        CommandList = osSetPenColor( CommandList, "Green" );   // Set the pen color to green
        CommandList = osMovePen( CommandList, 28, 78 );         // Upper left corner at <28,78>
        CommandList = osDrawRectangle( CommandList, 200, 100 ); // 200 pixels by 100 pixels
 
        // Now draw the rectangle
        osSetDynamicTextureData( "", "vector", CommandList, "width:256,height:256", 0 );
    }
}


Personal tools
General
About This Wiki