class SFML::SoundCone

Directional-attenuation cone for a 3D sound source. Inside the inner_angle cone the sound plays at full volume; outside the outer_angle cone it’s attenuated by outer_gain; between the two it’s smoothly interpolated.

Angles are in degrees, measured from the source’s direction axis. outer_gain is a scalar in [0, 1] (0 = silent outside).

sound.direction = [0, 0, -1] sound.cone = SFML::SoundCone.new( inner_angle: 30, outer_angle: 90, outer_gain: 0.2, )

Attributes

inner_angle [R]

The inner angle, outer angle, outer gain components.

outer_angle [R]

The inner angle, outer angle, outer gain components.

outer_gain [R]

The inner angle, outer angle, outer gain components.

Public Class Methods

from_native (struct)

Source

# File lib/sfml/audio/sound_cone.rb, line 51
def self.from_native(struct)
  new(
    inner_angle: struct[:inner_angle],
    outer_angle: struct[:outer_angle],
    outer_gain:  struct[:outer_gain],
  )
end

@!visibility private

new (inner_angle:, outer_angle:, outer_gain:)

Source

# File lib/sfml/audio/sound_cone.rb, line 18
def initialize(inner_angle:, outer_angle:, outer_gain:)
  @inner_angle = inner_angle.to_f
  @outer_angle = outer_angle.to_f
  @outer_gain  = outer_gain.to_f
  freeze
end

Public Instance Methods

== (other)

Source

# File lib/sfml/audio/sound_cone.rb, line 25
def ==(other)
  other.is_a?(SoundCone) &&
    inner_angle == other.inner_angle &&
    outer_angle == other.outer_angle &&
    outer_gain  == other.outer_gain
end

Also aliased as: eql?

eql? (other)

Alias for: ==

hash (= [inner_angle, outer_angle, outer_gain].hash)

Source

# File lib/sfml/audio/sound_cone.rb, line 33
  def hash = [inner_angle, outer_angle, outer_gain].hash

  # Returns the to s.
  def to_s
    "SoundCone(inner=#{inner_angle}°, outer=#{outer_angle}°, outer_gain=#{outer_gain})"
  end
  alias inspect to_s

  # @!visibility private
  def to_native
    s = C::Audio::SoundSourceCone.new
    s[:inner_angle] = @inner_angle
    s[:outer_angle] = @outer_angle
    s[:outer_gain]  = @outer_gain
    s
  end

  # @!visibility private
  def self.from_native(struct)
    new(
      inner_angle: struct[:inner_angle],
      outer_angle: struct[:outer_angle],
      outer_gain:  struct[:outer_gain],
    )
  end
end

Returns the hash.

to_native ()

Source

# File lib/sfml/audio/sound_cone.rb, line 42
def to_native
  s = C::Audio::SoundSourceCone.new
  s[:inner_angle] = @inner_angle
  s[:outer_angle] = @outer_angle
  s[:outer_gain]  = @outer_gain
  s
end

@!visibility private

to_s ()

Source

# File lib/sfml/audio/sound_cone.rb, line 36
def to_s
  "SoundCone(inner=#{inner_angle}°, outer=#{outer_angle}°, outer_gain=#{outer_gain})"
end

Returns the to s.