Class: Vizcore::DSL::LayerGroupBuilder

Inherits:
Object
  • Object
show all
Includes:
ColorHelpers
Defined in:
lib/vizcore/dsl/layer_group_builder.rb

Overview

Collects related layers and applies shared layer parameters.

Instance Method Summary collapse

Methods included from ColorHelpers

#gradient, #hsl, #hsv

Constructor Details

#initialize(name:, styles: {}, defaults: {}, mapping_presets: {}, strict: false) ⇒ LayerGroupBuilder

Returns a new instance of LayerGroupBuilder.

Parameters:

  • name (Symbol, String) —

    group identifier stored on nested layer params

  • styles (Hash) (defaults to: {}) —

    reusable layer parameter styles

  • mapping_presets (Hash) (defaults to: {}) —

    reusable layer mapping presets

  • defaults (Hash) (defaults to: {}) —

    scene defaults already applied before group params

  • strict (Boolean) (defaults to: false) —

    true when unknown layer params should fail



17
18
19
20
21
22
23
24
 
# File 'lib/vizcore/dsl/layer_group_builder.rb', line 17

def initialize(name:, styles: {}, defaults: {}, mapping_presets: {}, strict: false)
  @name = name.to_sym
  @styles = styles
  @mapping_presets = mapping_presets
  @strict = !!strict
  @params = deep_dup(defaults)
  @layers = []
end

Dynamic Method Handling

This class handles dynamic methods through the method_missing method

#method_missing(method_name, *args, &block) ⇒ Object

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.

Stores dynamic one-argument setters into shared group params.



79
80
81
82
83
84
85
86
 
# File 'lib/vizcore/dsl/layer_group_builder.rb', line 79

def method_missing(method_name, *args, &block)
  if block.nil? && args.length == 1
    @params[method_name.to_sym] = args.first
    return args.first
  end

  super
end

Instance Method Details

#blend(value) ⇒ Symbol

Parameters:

  • value (Symbol, String) —

    layer compositing mode shared by nested layers

Returns:

  • (Symbol) 


48
49
50
 
# File 'lib/vizcore/dsl/layer_group_builder.rb', line 48

def blend(value)
  @params[:blend] = value.to_sym
end

#evaluate { ... } ⇒ Vizcore::DSL::LayerGroupBuilder

Evaluate a group block.

Yields:

  • Layer group DSL methods

Returns:



30
31
32
33
 
# File 'lib/vizcore/dsl/layer_group_builder.rb', line 30

def evaluate(&block)
  instance_eval(&block) if block
  self
end

#layer(name) { ... } ⇒ void

This method returns an undefined value.

Define one layer in this group.

Parameters:

  • name (Symbol, String) —

    layer identifier

Yields:

  • Layer definition block



40
41
42
43
44
 
# File 'lib/vizcore/dsl/layer_group_builder.rb', line 40

def layer(name, &block)
  builder = LayerBuilder.new(name: name, styles: @styles, mapping_presets: @mapping_presets, defaults: layer_defaults, strict: @strict)
  builder.evaluate(&block)
  @layers << builder.to_h
end

#palette(*colors) ⇒ Array<String>

Store an ordered color palette shared by nested layers.

Parameters:

  • colors (Array<String, Array<String>>) —

    color values such as “#00ffff”

Returns:

  • (Array<String>)

Raises:

  • (ArgumentError) —

    when no non-blank colors are supplied



57
58
59
 
# File 'lib/vizcore/dsl/layer_group_builder.rb', line 57

def palette(*colors)
  @params[:palette] = normalize_palette(colors)
end

#respond_to_missing?(method_name, include_private = false) ⇒ Boolean

Returns:

  • (Boolean) 


88
89
90
 
# File 'lib/vizcore/dsl/layer_group_builder.rb', line 88

def respond_to_missing?(method_name, include_private = false)
  @params.key?(method_name.to_sym) || super
end

#to_a ⇒ Array<Hash>

Returns serialized nested layers.

Returns:

  • (Array<Hash>) —

    serialized nested layers



73
74
75
 
# File 'lib/vizcore/dsl/layer_group_builder.rb', line 73

def to_a
  @layers.map { |layer| deep_dup(layer) }
end

#use_style(name) ⇒ Hash

Merge a named style into this group’s shared params.

Parameters:

  • name (Symbol, String) —

    style identifier

Returns:

  • (Hash) —

    applied style params

Raises:

  • (ArgumentError) —

    when the style is unknown



66
67
68
69
70
 
# File 'lib/vizcore/dsl/layer_group_builder.rb', line 66

def use_style(name)
  style_name = name.to_sym
  style_params = @styles.fetch(style_name) { raise ArgumentError, "unknown style: #{style_name}" }
  @params.merge!(deep_dup(style_params))
end