|
|
# ShapeCorona
|
|
|
The ShapeCorona is the most simple form of a corona, however, given its extensive customization capabilities, this corona is very versatile.
|
|
|
|
|
|
## shape
|
|
|
The **mandatory** `<shape>` tag groups all properties related the shape of the corona. The `<shape>` group accepts the following children
|
|
|
|
|
|
### state
|
|
|
`<state>`: specifies the coordinate system that the subsequent shape dimensions are expressed in. Possible values are:
|
|
|
* *ScreenCoordinates*: dimensions are expressed in pixels.
|
|
|
* *CameraCoordinates*: dimensions are expressed in normalized camera coordinates, i.e. value in the range 0 <= offset <= 1. **Default**
|
|
|
* *TableCoordinates*: dimensions are is expressed in millimeters.
|
|
|
|
|
|
### type
|
|
|
The **mandatory** `<type>` tag specifies the geometry of the shape. Possible values are:
|
|
|
* *circle*: corona is drawn as a circular shape. Dimensions of circle are specified as follows:
|
|
|
* *circleSize*: specifies the diameter of the circle.
|
|
|
* *square*: corona is drawn as a plain square. Dimensions of square are specified as follows:
|
|
|
* *squareSize*: specifies the length of the squares' sides.
|
|
|
* *triangle*: corona is drawn as a equilateral triangle. Dimensions of triangle are specified as follows:
|
|
|
* *triangleSize*: specifies the length of the triangles' sides.
|
|
|
* *rectangle*: corona is drawn as a plain rectangular shape. Dimensions of the rectangle are specified as follows:
|
|
|
* *width*: specifies the width of the rectangle.
|
|
|
* *height*: specifies the height of the rectangle.
|
|
|
* *roundedSquare*: corona is drawn as a square with rounded corners. Dimensions of square are specified as follows:
|
|
|
* *squareSize*: specifies the length of the squares' sides.
|
|
|
* *cornerRadius*: specifies the radius of the rounded corners.
|
|
|
* *roundedRectangle*: corona is drawn as a rectangle with rounded corners. Dimensions of the rectangle are specified as follows:
|
|
|
* *width*: specifies the width of the rectangle.
|
|
|
* *height*: specifies the height of the rectangle.
|
|
|
* *cornerRadius*: specifies the radius of the rounded corners.
|
|
|
|
|
|
### fillColour
|
|
|
The **optional** `<fillColour>` tag specifies the [colour](bootstrapping/colour) to be used to fill the shape. If omitted, the fill colour will be set to gray.
|
|
|
|
|
|
### strokeColour
|
|
|
The **optional** `<strokeColour>` tag specifies the [colour](bootstrapping/colour) to be used to fill the shape. If omitted, the fill colour will be set to gray.
|
|
|
|
|
|
### strokeWidth
|
|
|
The **optional** `<strokeWidth>` tag specifies the width of the stroke used to draw the outline of the shape using the colour specified by the `<strokeColour>` tag |
|
|
\ No newline at end of file |