2D noise generator

Introduced properties

abstract fun [](x: Float, y: Float): Float

noise :: Noise :: []

Get the noise value at x, y
fun amplitude: Float

noise :: Noise :: amplitude

Amplitude of the values returned by []
fun amplitude=(value: Float)

noise :: Noise :: amplitude=

Set the desired amplitude of the values returned by []
fun frequency: Float

noise :: Noise :: frequency

Frequency of this noise
fun frequency=(value: Float)

noise :: Noise :: frequency=

Set the frequency if this noise
fun max: Float

noise :: Noise :: max

Highest possible value returned by []
fun max=(max: Float)

noise :: Noise :: max=

Highest possible value returned by []
fun min: Float

noise :: Noise :: min

Lowest possible value returned by []
fun min=(min: Float)

noise :: Noise :: min=

Lowest possible value returned by []
fun period: Float

noise :: Noise :: period

Distance between reference points of the noise
fun period=(period: Float)

noise :: Noise :: period=

Distance between reference points of the noise
fun seed: Int

noise :: Noise :: seed

Seed to the random number generator gradient_vector
fun seed=(seed: Int)

noise :: Noise :: seed=

Seed to the random number generator gradient_vector

Redefined properties

redef type SELF: Noise

noise $ Noise :: SELF

Type of this instance, automatically specialized in every class
redef fun core_serialize_to(v: Serializer)

noise $ Noise :: core_serialize_to

Actual serialization of self to serializer
redef init from_deserializer(v: Deserializer)

noise $ Noise :: from_deserializer

Create an instance of this class from the deserializer

All properties

fun !=(other: nullable Object): Bool

core :: Object :: !=

Have self and other different values?
fun ==(other: nullable Object): Bool

core :: Object :: ==

Have self and other the same value?
type CLASS: Class[SELF]

core :: Object :: CLASS

The type of the class of self.
type SELF: Object

core :: Object :: SELF

Type of this instance, automatically specialized in every class
abstract fun [](x: Float, y: Float): Float

noise :: Noise :: []

Get the noise value at x, y
protected fun accept_json_serializer(v: JsonSerializer)

serialization :: Serializable :: accept_json_serializer

Refinable service to customize the serialization of this class to JSON
protected fun accept_msgpack_attribute_counter(v: AttributeCounter)

serialization :: Serializable :: accept_msgpack_attribute_counter

Hook to customize the behavior of the AttributeCounter
protected fun accept_msgpack_serializer(v: MsgPackSerializer)

serialization :: Serializable :: accept_msgpack_serializer

Hook to customize the serialization of this class to MessagePack
protected fun add_to_bundle(bundle: NativeBundle, key: JavaString)

serialization :: Serializable :: add_to_bundle

Called by []= to dynamically choose the appropriate method according
fun amplitude: Float

noise :: Noise :: amplitude

Amplitude of the values returned by []
fun amplitude=(value: Float)

noise :: Noise :: amplitude=

Set the desired amplitude of the values returned by []
protected fun class_factory(name: String): CLASS

core :: Object :: class_factory

Implementation used by get_class to create the specific class.
fun class_name: String

core :: Object :: class_name

The class name of the object.
fun core_serialize_to(serializer: Serializer)

serialization :: Serializable :: core_serialize_to

Actual serialization of self to serializer
fun frequency: Float

noise :: Noise :: frequency

Frequency of this noise
fun frequency=(value: Float)

noise :: Noise :: frequency=

Set the frequency if this noise
init from_deserializer(deserializer: Deserializer)

serialization :: Serializable :: from_deserializer

Create an instance of this class from the deserializer
fun get_class: CLASS

core :: Object :: get_class

The meta-object representing the dynamic type of self.
fun hash: Int

core :: Object :: hash

The hash code of the object.
init init

core :: Object :: init

fun inspect: String

core :: Object :: inspect

Developer readable representation of self.
protected fun inspect_head: String

core :: Object :: inspect_head

Return "CLASSNAME:#OBJECTID".
intern fun is_same_instance(other: nullable Object): Bool

core :: Object :: is_same_instance

Return true if self and other are the same instance (i.e. same identity).
fun is_same_serialized(other: nullable Object): Bool

core :: Object :: is_same_serialized

Is self the same as other in a serialization context?
intern fun is_same_type(other: Object): Bool

core :: Object :: is_same_type

Return true if self and other have the same dynamic type.
fun max: Float

noise :: Noise :: max

Highest possible value returned by []
fun max=(max: Float)

noise :: Noise :: max=

Highest possible value returned by []
fun min: Float

noise :: Noise :: min

Lowest possible value returned by []
fun min=(min: Float)

noise :: Noise :: min=

Lowest possible value returned by []
protected fun msgpack_extra_array_items: Int

serialization :: Serializable :: msgpack_extra_array_items

Hook to request a larger than usual metadata array
intern fun object_id: Int

core :: Object :: object_id

An internal hash code for the object based on its identity.
fun output

core :: Object :: output

Display self on stdout (debug only).
intern fun output_class_name

core :: Object :: output_class_name

Display class name on stdout (debug only).
fun period: Float

noise :: Noise :: period

Distance between reference points of the noise
fun period=(period: Float)

noise :: Noise :: period=

Distance between reference points of the noise
fun seed: Int

noise :: Noise :: seed

Seed to the random number generator gradient_vector
fun seed=(seed: Int)

noise :: Noise :: seed=

Seed to the random number generator gradient_vector
fun serialization_hash: Int

core :: Object :: serialization_hash

Hash value use for serialization
fun serialize_msgpack(plain: nullable Bool): Bytes

serialization :: Serializable :: serialize_msgpack

Serialize self to MessagePack bytes
fun serialize_to(serializer: Serializer)

serialization :: Serializable :: serialize_to

Serialize self to serializer
fun serialize_to_json(plain: nullable Bool, pretty: nullable Bool): String

serialization :: Serializable :: serialize_to_json

Serialize self to JSON
intern fun sys: Sys

core :: Object :: sys

Return the global sys object, the only instance of the Sys class.
fun to_json: String

serialization :: Serializable :: to_json

Serialize self to plain JSON
abstract fun to_jvalue(env: JniEnv): JValue

core :: Object :: to_jvalue

fun to_pretty_json: String

serialization :: Serializable :: to_pretty_json

Serialize self to plain pretty JSON
fun to_s: String

core :: Object :: to_s

User readable representation of self.
package_diagram noise::Noise Noise serialization::Serializable Serializable noise::Noise->serialization::Serializable core::Object Object serialization::Serializable->core::Object ...core::Object ... ...core::Object->core::Object noise::PerlinNoise PerlinNoise noise::PerlinNoise->noise::Noise noise::InterpolatedNoise InterpolatedNoise noise::InterpolatedNoise->noise::Noise

Ancestors

interface Object

core :: Object

The root of the class hierarchy.

Parents

interface Serializable

serialization :: Serializable

Instances of this class can be passed to Serializer::serialize

Children

class InterpolatedNoise

noise :: InterpolatedNoise

Simple interpolated noise
class PerlinNoise

noise :: PerlinNoise

2D Perlin noise generator using layered InterpolatedNoise

Class definitions

noise $ Noise
# 2D noise generator
abstract class Noise

	# Get the noise value at `x`, `y`
	#
	# The coordinates `x`, `y` can be floats of any size.
	#
	# Returns a value between or equal to `min` and `max`.
	fun [](x, y: Float): Float is abstract

	# Lowest possible value returned by `[]`
	#
	# Default at `0.0`.
	#
	# Require: `min < max`
	var min = 0.0 is writable

	# Highest possible value returned by `[]`
	#
	# Default at `1.0`.
	#
	# Require: `min < max`
	var max = 1.0 is writable

	# Distance between reference points of the noise
	#
	# Higher values will result in smoother noise and
	# lower values will result in steeper curves.
	#
	# Default at `1.0`.
	var period = 1.0 is writable

	# Amplitude of the values returned by `[]`
	fun amplitude: Float do return max - min

	# Set the desired amplitude of the values returned by `[]`
	#
	# Will only modify `max`, `min` stays the same.
	fun amplitude=(value: Float) do max = min + value

	# Frequency of this noise
	fun frequency: Float do return 1.0/period

	# Set the frequency if this noise
	fun frequency=(value: Float) do period = 1.0/value

	# Seed to the random number generator `gradient_vector`
	#
	# By default, `seed` has a random value created with `Int::rand`.
	var seed: Int = 19511359.rand is lazy, writable
end
lib/noise/noise.nit:20,1--70,3