class Celestine::Mask
 
  - Celestine::Mask
 - Celestine::Drawable
 - Reference
 - Object
 
Overview
Class which acts like a group, but applies masking to another drawable.
Included Modules
- Celestine::Meta::Context::Methods
 - Celestine::Modules::Animate
 - Celestine::Modules::Animate::Motion
 - Celestine::Modules::Body
 - Celestine::Modules::Filter
 - Celestine::Modules::StrokeFill
 - Celestine::Modules::Transform
 
Defined in:
celestine.creffects/mask.cr
Constant Summary
- 
        TAG = 
"mask" 
Instance Method Summary
- 
        #anchor(&block : Celestine::Anchor -> Celestine::Anchor) : Celestine::Anchor
        
          
Allows a
Celestine::Anchorto be made using a DSL call, and added to this drawables items. - 
        #circle(&block : Celestine::Circle -> Celestine::Circle) : Celestine::Circle
        
          
Allows a
Celestine::Circleto be made using a DSL call, and added to this drawables items. - 
        #draw(io : IO) : Nil
        
          
Main draw method for a drawable.
 - 
        #ellipse(&block : Celestine::Ellipse -> Celestine::Ellipse) : Celestine::Ellipse
        
          
Allows a
Celestine::Ellipseto be made using a DSL call, and added to this drawables items. - 
        #group(&block : Celestine::Group -> Celestine::Group) : Celestine::Group
        
          
Allows a
Celestine::Groupto be made using a DSL call, and added to this drawables items. - 
        #image(&block : Celestine::Image -> Celestine::Image) : Celestine::Image
        
          
Allows a
Celestine::Imageto be made using a DSL call, and added to this drawables items. - 
        #path(&block : Celestine::Path -> Celestine::Path) : Celestine::Path
        
          
Allows a
Celestine::Pathto be made using a DSL call, and added to this drawables items. - 
        #rectangle(&block : Celestine::Rectangle -> Celestine::Rectangle) : Celestine::Rectangle
        
          
Allows a
Celestine::Rectangleto be made using a DSL call, and added to this drawables items. - 
        #svg(&block : Celestine::Svg -> Celestine::Svg) : Celestine::Svg
        
          
Allows a
Celestine::Svgto be made using a DSL call, and added to this drawables items. - 
        #text(&block : Celestine::Text -> Celestine::Text) : Celestine::Text
        
          
Allows a
Celestine::Textto be made using a DSL call, and added to this drawables items. 
Instance methods inherited from module Celestine::Meta::Context::Methods
  
  
    
      <<(drawable : Celestine::Drawable)
    <<, 
    
  
    
      use(id : String)use(drawable : Celestine::Drawable)
use(drawable : Celestine::Drawable, &block : Celestine::Use -> Celestine::Use)
use(id : String, &block : Celestine::Use -> Celestine::Use)
use(&block : Celestine::Use -> Celestine::Use) use
Instance methods inherited from module Celestine::Modules::Body
  
  
    
      body_attribute(io)
    body_attribute, 
    
  
    
      height : IFNumber | Nil
    height, 
    
  
    
      height=(height : IFNumber | Nil)
    height=, 
    
  
    
      height_units : String | Nil
    height_units, 
    
  
    
      height_units=(height_units : String | Nil)
    height_units=, 
    
  
    
      width : IFNumber | Nil
    width, 
    
  
    
      width=(width : IFNumber | Nil)
    width=, 
    
  
    
      width_units : String | Nil
    width_units, 
    
  
    
      width_units=(width_units : String | Nil)
    width_units=
    
  
    
    
  
    
  Instance methods inherited from module Celestine::Modules::Position
  
  
    
      position_attribute(io : IO)
    position_attribute, 
    
  
    
      x : IFNumber | Nil
    x, 
    
  
    
      x=(x : IFNumber | Nil)
    x=, 
    
  
    
      x_units : String | Nil
    x_units, 
    
  
    
      x_units=(x_units : String | Nil)
    x_units=, 
    
  
    
      y : IFNumber | Nil
    y, 
    
  
    
      y=(y : IFNumber | Nil)
    y=, 
    
  
    
      y_units : String | Nil
    y_units, 
    
  
    
      y_units=(y_units : String | Nil)
    y_units=
    
  
    
    
  
    
  Instance methods inherited from module Celestine::Modules::Filter
  
  
    
      filter_attribute(io : IO)
    filter_attribute, 
    
  
    
      set_filter(id : String)set_filter(filter : Celestine::Filter) set_filter
Instance methods inherited from module Celestine::Modules::Animate::Motion
  
  
    
      animate_motion(&block : Celestine::Animate::Motion -> Celestine::Animate::Motion)
    animate_motion
    
  
    
    
  
    
  Instance methods inherited from module Celestine::Modules::Animate
  
  
    
      animate(&block : Proc(Celestine::Animate, Nil))
    animate
    
  
    
    
  
    
  Instance methods inherited from module Celestine::Modules::StrokeFill
  
  
    
      color : String | Nil
    color, 
    
  
    
      color=(color : String | Nil)
    color=, 
    
  
    
      color_interpolation : String | Nil
    color_interpolation, 
    
  
    
      color_interpolation=(color_interpolation : String | Nil)
    color_interpolation=, 
    
  
    
      color_interpolation_filters : String | Nil
    color_interpolation_filters, 
    
  
    
      color_interpolation_filters=(color_interpolation_filters : String | Nil)
    color_interpolation_filters=, 
    
  
    
      dash_array : Array(Float64)
    dash_array, 
    
  
    
      dash_array=(dash_array : Array(Float64))
    dash_array=, 
    
  
    
      dash_offset : IFNumber | Nil
    dash_offset, 
    
  
    
      dash_offset=(dash_offset : IFNumber | Nil)
    dash_offset=, 
    
  
    
      dash_offset_units : String | Nil
    dash_offset_units, 
    
  
    
      dash_offset_units=(dash_offset_units : String | Nil)
    dash_offset_units=, 
    
  
    
      fill : String | Nil
    fill, 
    
  
    
      fill=(fill : String | Nil)
    fill=, 
    
  
    
      fill_opacity : IFNumber | Nil
    fill_opacity, 
    
  
    
      fill_opacity=(fill_opacity : IFNumber | Nil)
    fill_opacity=, 
    
  
    
      fill_rule : Bool
    fill_rule, 
    
  
    
      fill_rule=(fill_rule : Bool)
    fill_rule=, 
    
  
    
      line_cap : String | Nil
    line_cap, 
    
  
    
      line_cap=(line_cap : String | Nil)
    line_cap=, 
    
  
    
      line_join : String | Nil
    line_join, 
    
  
    
      line_join=(line_join : String | Nil)
    line_join=, 
    
  
    
      miter_limit : IFNumber | Nil
    miter_limit, 
    
  
    
      miter_limit=(miter_limit : IFNumber | Nil)
    miter_limit=, 
    
  
    
      miter_limit_units : String | Nil
    miter_limit_units, 
    
  
    
      miter_limit_units=(miter_limit_units : String | Nil)
    miter_limit_units=, 
    
  
    
      opacity : IFNumber | Nil
    opacity, 
    
  
    
      opacity=(opacity : IFNumber | Nil)
    opacity=, 
    
  
    
      set_fill(pattern : Celestine::Pattern)set_fill(gradient : Celestine::Gradient) set_fill, set_stroke(pattern : Celestine::Pattern)
set_stroke(gradient : Celestine::Gradient) set_stroke, shape_rendering : String | Nil shape_rendering, shape_rendering=(shape_rendering : String | Nil) shape_rendering=, stroke : String | Nil stroke, stroke=(stroke : String | Nil) stroke=, stroke_fill_attribute(io : IO) stroke_fill_attribute, stroke_opacity : IFNumber | Nil stroke_opacity, stroke_opacity=(stroke_opacity : IFNumber | Nil) stroke_opacity=, stroke_width : IFNumber | Nil stroke_width, stroke_width=(stroke_width : IFNumber | Nil) stroke_width=, stroke_width_units : String | Nil stroke_width_units, stroke_width_units=(stroke_width_units : String | Nil) stroke_width_units=, vector_effect : String | Nil vector_effect, vector_effect=(vector_effect : String | Nil) vector_effect=
Instance methods inherited from module Celestine::Modules::Transform
  
  
    
      transform(&block : Celestine::Drawable::Transform -> Celestine::Drawable::Transform)
    transform, 
    
  
    
      transform_attribute(io : IO)
    transform_attribute
    
  
    
    
  
    
  Instance methods inherited from class Celestine::Drawable
  
  
    
      class_attribute(io : IO)
    class_attribute, 
    
  
    
      classes : Array(String)
    classes, 
    
  
    
      classes=(classes : Array(String))
    classes=, 
    
  
    
      custom_attribute(io : IO)
    custom_attribute, 
    
  
    
      custom_attrs : Hash(String, String)
    custom_attrs, 
    
  
    
      custom_attrs=(custom_attrs : Hash(String, String))
    custom_attrs=, 
    
  
    
      draw(io : IO) : Nil
    draw, 
    
  
    
      id : String | Nil
    id, 
    
  
    
      id=(id : String | Nil)
    id=, 
    
  
    
      id_attribute(io : IO)
    id_attribute, 
    
  
    
      inner_elements : IO::Memory
    inner_elements, 
    
  
    
      inner_elements=(inner_elements : IO::Memory)
    inner_elements=, 
    
  
    
      style : Hash(String, String)
    style, 
    
  
    
      style=(style : Hash(String, String))
    style=, 
    
  
    
      style_attribute(io : IO)
    style_attribute
    
  
    
    
  
    
    
    
  
    
    
    
  
Instance Method Detail
Main draw method for a drawable. Takes in and interacts with an io.