MUSHclient documentation: function WindowBezier

Log on

WindowBezier

WindowBezier
Script function world.WindowBezier Read about scripting Type Method Summary Draws a Bézier curve in a miniwindow Prototype `long WindowBezier(BSTR WindowName, BSTR Points, long PenColour, long PenStyle, long PenWidth);` View list of data type meanings Description Draws one or more Bézier splines. This function draws cubic Bézier splines by using the endpoints and control points specified by the Points parameter. The first spline is drawn from the first point to the fourth point by using the second and third points as control points. Each subsequent spline in the sequence needs exactly three more points: the end point of the previous spline is used as the starting point, the next two points in the sequence are control points, and the third is the end point. Note that changes to miniwindows will not become visible until the output window is redrawn. This happens when new (visible) lines arrive from the MUD, or if you call WindowShow, or Redraw. Parameters: WindowName - the name of an existing miniwindow. Points - a string consisting of pairs of numbers, one for each point, in the format x1,y1,x2,y2 ... For example: "20,50,180,50" would specify two points, one at 20,50 and one at 180,50. You must have at least 4 points (the start, and 3 points per spline), which is 8 numbers. The number of numbers in the string must be even (divisible by two), as it takes a pair of numbers to specify one point. Also, since you need 3 points per spline, the number of numbers in the Points string must have a remainder of 2 when divided by 6 (3 points per spline, plus the start point). PenColour - the RGB colour for this pen PenStyle - what style of pen to use: 0 - solid (an unbroken pen) 1 - dash: ------- 2 - dot: ....... 3 - dashdot: _._._._ 4 - dashdotdot: _.._.._ 5 - null (no pen) 6 - insideframe - a solid pen, drawn inside the shape Also you can add into the style: 0x0000 - round ends (0 = the default) 0x0100 - square ends (256) 0x0200 - flat ends (512) 0x0000 - round joins (0 = the default) 0x1000 - bevel joins (4096) 0x2000 - miter joins (8192) PenWidth - the width of the pen in pixels. For styles 1 to 4 only a width of 1 is valid. For a particular shape, specify style 5 (no pen) if you only want to fill the shape, and not stroke it as well. For more information, see: http://www.gammon.com.au/mushclient/mw_shapes.htm Available in MUSHclient version 4.34 onwards. Lua example `WindowBezier (win, "30, 20, 5, 90, 50, 90, 80, 30", ColourNameToRGB("blue"), 0, 2)` Lua notes `You can use the following constants for the pen style: miniwin.pen_solid = 0 miniwin.pen_dash = 1 miniwin.pen_dot = 2 miniwin.pen_dash_dot = 3 miniwin.pen_dash_dot_dot = 4 miniwin.pen_null = 5 miniwin.pen_inside_frame = 6 -- how lines join (eg. in polygons) (add this to the style) miniwin.pen_join_round = 0 miniwin.pen_join_bevel = 4096 miniwin.pen_join_miter = 8192 -- how lines end (add this to the style) miniwin.pen_endcap_round = 0 miniwin.pen_endcap_square = 256 miniwin.pen_endcap_flat = 512` Return value `eNoSuchWindow - no such miniwindow ePenStyleNotValid - invalid pen style eInvalidNumberOfPoints - number of numbers supplied does not give a remainder of 2 after dividing by 6, or is less than 8. eOK - completed OK` View list of return code meanings See Also ... Topic MiniWindows Functions (GetDeviceCaps) Gets screen device capabilities (SetCursor) Changes the shape of the mouse cursor (TextRectangle) Specifies the size of the rectangle in which text is displayed in the output window. (WindowAddHotspot) Adds a hotspot to a miniwindow (WindowArc) Draws an arc in a miniwindow (WindowBlendImage) Blends an image into a miniwindow, using a specified blending mode (WindowCircleOp) Draws ellipses, filled rectangles, round rectangles, chords, pies in a miniwindow (WindowCreate) Creates a miniwindow (WindowCreateImage) Creates an image in a miniwindow (WindowDelete) Deletes a miniwindow (WindowDeleteAllHotspots) Deletes all hotspots from a miniwindow (WindowDeleteHotspot) Deletes a hotspot from a miniwindow (WindowDragHandler) Adds a drag handler to a miniwindow hotspot (WindowDrawImage) Draws an image into a miniwindow (WindowDrawImageAlpha) Draws an image into a miniwindow respecting the alpha channel (WindowFilter) Performs a filtering operation over part of the miniwindow. (WindowFont) Loads a font into a miniwindow (WindowFontInfo) Returns information about a font (WindowFontList) Lists all fonts loaded into a miniwindow (WindowGetImageAlpha) Draws the alpha channel of an image into a miniwindow (WindowGetPixel) Gets the colour of a single pixel in a miniwindow (WindowGradient) Draws a gradient in a rectangle (WindowHotspotInfo) Returns information about a hotspot (WindowHotspotList) Lists all hotspots installed into a miniwindow (WindowHotspotTooltip) Changes the tooltip text for a hotspot in a miniwindow (WindowImageFromWindow) Creates an image from another miniwindow (WindowImageInfo) Returns information about an image (WindowImageList) Lists all images installed into a miniwindow (WindowImageOp) Draws an ellipse, rectangle or round rectangle, filled with an image (WindowInfo) Returns information about a miniwindow (WindowLine) Draws a line in a miniwindow (WindowList) Lists all miniwindows (WindowLoadImage) Loads an image into a miniwindow from a disk file (WindowMenu) Creates a pop-up menu inside a miniwindow (WindowMergeImageAlpha) Merges an image into a miniwindow based on an alpha mask (WindowMoveHotspot) Moves a hotspot in a miniwindow (WindowPolygon) Draws a polygon in a miniwindow (WindowPosition) Moves a miniwindow (WindowRectOp) Draws a rectangle in a miniwindow (WindowResize) Resizes a miniwindow (WindowScrollwheelHandler) Adds a scroll-wheel handler to a miniwindow hotspot (WindowSetPixel) Sets a single pixel in a miniwindow to the specified colour (WindowSetZOrder) Sets the Z-Order for a miniwindow (WindowShow) Shows or hides a miniwindow (WindowText) Draws text into a miniwindow (WindowTextWidth) Calculates the width of text in a miniwindow (WindowTransformImage) Draws an image into a miniwindow with optional rotation, scaling, reflection and shearing (WindowWrite) Writes the contents of a miniwindow to disk as a graphics file (Help topic: function=WindowBezier)

Script function

world.WindowBezier

Read about scripting

Type

Method

Summary

Draws a Bézier curve in a miniwindow

Prototype

long WindowBezier(BSTR WindowName, BSTR Points, long PenColour, long PenStyle, long PenWidth);

View list of data type meanings

Description

Draws one or more Bézier splines. This function draws cubic Bézier splines by using the endpoints and control points specified by the Points parameter. The first spline is drawn from the first point to the fourth point by using the second and third points as control points. Each subsequent spline in the sequence needs exactly three more points: the end point of the previous spline is used as the starting point, the next two points in the sequence are control points, and the third is the end point. Note that changes to miniwindows will not become visible until the output window is redrawn. This happens when new (visible) lines arrive from the MUD, or if you call WindowShow, or Redraw. Parameters: WindowName - the name of an existing miniwindow. Points - a string consisting of pairs of numbers, one for each point, in the format x1,y1,x2,y2 ... For example: "20,50,180,50" would specify two points, one at 20,50 and one at 180,50. You must have at least 4 points (the start, and 3 points per spline), which is 8 numbers. The number of numbers in the string must be even (divisible by two), as it takes a pair of numbers to specify one point. Also, since you need 3 points per spline, the number of numbers in the Points string must have a remainder of 2 when divided by 6 (3 points per spline, plus the start point). PenColour - the RGB colour for this pen PenStyle - what style of pen to use: 0 - solid (an unbroken pen) 1 - dash: ------- 2 - dot: ....... 3 - dashdot: _._._._ 4 - dashdotdot: _.._.._ 5 - null (no pen) 6 - insideframe - a solid pen, drawn inside the shape Also you can add into the style: 0x0000 - round ends (0 = the default) 0x0100 - square ends (256) 0x0200 - flat ends (512) 0x0000 - round joins (0 = the default) 0x1000 - bevel joins (4096) 0x2000 - miter joins (8192) PenWidth - the width of the pen in pixels. For styles 1 to 4 only a width of 1 is valid. For a particular shape, specify style 5 (no pen) if you only want to fill the shape, and not stroke it as well. For more information, see: http://www.gammon.com.au/mushclient/mw_shapes.htm

Available in MUSHclient version 4.34 onwards.

Lua example

WindowBezier (win, "30, 20, 5, 90, 50, 90, 80, 30", 
              ColourNameToRGB("blue"), 0, 2)

Lua notes

You can use the following constants for the pen style:

miniwin.pen_solid = 0
miniwin.pen_dash = 1
miniwin.pen_dot = 2
miniwin.pen_dash_dot = 3
miniwin.pen_dash_dot_dot = 4
miniwin.pen_null = 5
miniwin.pen_inside_frame = 6

-- how lines join (eg. in polygons) (add this to the style)
   
miniwin.pen_join_round = 0
miniwin.pen_join_bevel = 4096
miniwin.pen_join_miter = 8192

-- how lines end (add this to the style)
   
miniwin.pen_endcap_round = 0
miniwin.pen_endcap_square = 256
miniwin.pen_endcap_flat = 512

Return value

eNoSuchWindow - no such miniwindow ePenStyleNotValid - invalid pen style eInvalidNumberOfPoints - number of numbers supplied does not give a remainder of 2 after dividing by 6, or is less than 8. eOK - completed OK

View list of return code meanings

See Also ...

Topic

MiniWindows

Functions

(Help topic: function=WindowBezier)

Documentation contents page

Search ...

Enter a search string to find matching documentation.

Information and images on this site are licensed under the Creative Commons Attribution 3.0 Australia License unless stated otherwise.