Class: Alda::Marker

Inherits:

Event

• Object
• Event
• Alda::Marker

Defined in:

lib/alda-rb/event.rb

Overview

A marker event. An Alda::EventContainer containing an Alda::Marker can be created using event list sugar. See Alda::EventList#method_missing.

It should be used together with Alda::AtMarker.

Alda::Score.new do
  piano_ v1 c d _here e2 v2 __here c4 d e2
end

Instance Attribute Summary

• #name ⇒ Object

  The marker’s name.

Attributes inherited from Event

#container, #parent

Instance Method Summary

• #==(other) ⇒ Object

  :call-seq: marker == other -> true or false.

• #initialize(name) ⇒ Marker constructor

  :call-seq: new(name) -> Alda::Marker.

• #to_alda_code ⇒ Object

  :call-seq: to_alda_code() -> String.

Methods inherited from Event

#detach_from_parent, #is_event_of?, #on_contained

Constructor Details

#initialize(name) ⇒ Marker

:call-seq:

new(name) -> Alda::Marker

Creates an Alda::Marker.

Underlines in name is converted to hyphens.

# File 'lib/alda-rb/event.rb', line 1023

def initialize name
	super()
	@name = Alda::Utils.snake_to_slug name
end

Instance Attribute Details

#name ⇒ Object

The marker’s name

# File 'lib/alda-rb/event.rb', line 1014

def name
  @name
end

Instance Method Details

#==(other) ⇒ Object

:call-seq:

marker == other -> true or false

Overrides Alda::Event#==. Returns true if other is an Alda::Marker and has the same #name as marker (using ==).

# File 'lib/alda-rb/event.rb', line 1044

def == other
	super || other.is_a?(Alda::Marker) && @name == other.name
end

#to_alda_code ⇒ Object

:call-seq:

to_alda_code() -> String

Overrides Alda::Event#to_alda_code.

# File 'lib/alda-rb/event.rb', line 1033

def to_alda_code
	?% + @name
end