Scenic
v0.11.2

View Source Scenic.Primitive.Quad (Scenic v0.11.2)

Draw a quad on the screen.

data

 Data

{point_a, point_b, point_c, point_d}

The data for a line is a tuple containing four points.

  • point_a - position to start drawing from
  • point_b - position to draw to
  • point_c - position to draw to
  • point_d - position to draw to

styles

 Styles

This primitive recognizes the following styles

  • hidden - show or hide the primitive
  • scissor - "scissor rectangle" that drawing will be clipped to.
  • fill - fill in the area of the primitive
  • stroke - 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
  |> quad(
    {{10, 0}, {20, 40}, {17, 50}, {0, 10}},
    stroke: {1, :yellow}
  )

Link to this section Summary

Types

styles_t()
t()

Functions

compile(primitive, styles)

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.

valid_styles()

Returns a list of styles recognized by this primitive.

Link to this section Types

Link to this type

styles_t()

View Source 
@type styles_t() :: [
  :hidden
  | :scissor
  | :fill
  | :stroke_width
  | :stroke_fill
  | :join
  | :miter_limit
]
Link to this type

t()

View Source 
@type t() ::
  {{x0 :: number(), y0 :: number()}, {x1 :: number(), y1 :: number()},
   {x2 :: number(), y2 :: number()}, {x3 :: number(), y3 :: number()}}

Link to this section Functions

Link to this function

compile(primitive, styles)

View Source 
@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.

Link to this function

valid_styles()

View Source 
@spec valid_styles() :: styles_t()

Returns a list of styles recognized by this primitive.