Changes between Version 4 and Version 5 of DrawingCommands

Timestamp:

Dec 18, 2011, 11:04:32 AM (12 years ago)

Author:

cinc

Comment:

Description about drawing rectangles

DrawingCommands

@@ -107 +107 @@
 === Set next line point ===
 
-{{{  
+{{{
 <line>toX toY</>
 
@@ -135 +135 @@
 
 It is possible to do several ''move'' and ''line'' commands on a surface. The actual drawing only takes place when performing the ''stroke'' command.
+
+
+== Drawing rectangles ==
+
+The engine supports the drawing of rectangles with or without borders.
+
+=== Defining the rectangle ===
+
+{{{
+<rect>Xpos yPos width height</>
+
+   Draw a rectangle at position 'Xpos/Ypos' with given 'height' and 'width'.
+}}}
+
+Note that nothing is actually painted yet. You need to issue a ''<fill></>'' or ''<stroke></>'' command.
+
+
+=== Fill rectangle ===
+
+{{{  
+<fill></>
+
+   Fill the rectangle with the set color.
+}}}
+
+The color used is the one previously set using the ''<color>'' or ''<colora>'' commands like in this example:
+
+{{{
+<colora> 0 0.3 0.65 0.8</><rect>0.13 0.345 0.7 0.3</><fill></>
+}}}
+
+=== Draw outline rectangle ===
+
+Similar to line drawing one has to issue the stroke command to actually draw the outline:
+
+{{{  
+<stroke></>
+
+   Do the actual drawing.
+}}}
+
+or
+
+{{{  
+<stroke>preserve</>
+
+   Do the actual drawing but keep all line information in the context.
+}}}
+
+Note that you have to define the line features prior to this command. You must at least specify the line width:
+
+{{{
+<colora> 0 0.3 0.65 0.8</><rect>0.13 0.345 0.7 0.3</><lwidth>0.05</><stroke></>
+}}}
+
+
+=== Draw a filled rectangle with border ===
+
+Combining the previous commands it is possible to draw rectangles with borders using any combination of color and line with.
+
+The following sequence of commands draws a rectangle with a blue semitransparent border filled with a solid grey color: 
+{{{
+<colora>0 0.3 0.65 0.8</><rect>0.13 0.345 0.7 0.3</><lwidth>0.05</><stroke>preserve</><color>0.5 0.5 0.5</><fill></>
+}}}
+
+Note the use of ''<stroke>preserve</>'' here. This way the information about the rectangle's shape is kept in the current drawing context after drawing the border and the fill command is applied to the same shape.
+
+When using ''<stroke></>'' here only the border is drawn because there is no definition for any shape when the ''<fill></>' command is encountered.