View Source Scenic.Primitive.Rectangle (Scenic v0.11.2)
Draw a rectangle on the screen.
data
Data
{width, height}
The data for a line is a tuple containing two numbers.
width
- width of the rectangleheight
- height of the rectangle
styles
Styles
This primitive recognizes the following styles
hidden
- show or hide the primitivescissor
- "scissor rectangle" that drawing will be clipped to.fill
- fill in the area of the primitivestroke
- stroke the outline of the primitive. In this case, only the curvy part.join
- control how segments are joined.miter_limit
- control how segments are joined.
usage
Usage
You should add/modify primitives via the helper functions in
Scenic.Primitives
graph
|> rect( {100, 50}, stroke: {1, :yellow} )
|> rectangle( {100, 50}, stroke: {1, :yellow} )
Note: rect
is a shortcut for rectangle
and they can be used interchangeably.
Link to this section Summary
Functions
Returns the centroid of the rectangle. This is used as the default pin when applying rotate or scale transforms.
Compile the data for this primitive into a mini script. This can be combined with others to generate a larger script and is called when a graph is compiled.
Returns a list of styles recognized by this primitive.
Link to this section Types
@type styles_t() :: [
:hidden
| :scissor
| :fill
| :stroke_width
| :stroke_fill
| :join
| :miter_limit
]
Link to this section Functions
Returns the centroid of the rectangle. This is used as the default pin when applying rotate or scale transforms.
@spec compile(primitive :: Scenic.Primitive.t(), styles :: Scenic.Primitive.Style.t()) :: Scenic.Script.t()
Compile the data for this primitive into a mini script. This can be combined with others to generate a larger script and is called when a graph is compiled.
@spec valid_styles() :: styles_t()
Returns a list of styles recognized by this primitive.