# utilities – Helper functions¶

The utilities package is the standard home for shared functions which many modules may use. The spirit of utilities is also to isolate sections of critical code so that unit tests can be used to ensure a minimum of bugginess.

## Chat Formatting¶

Colorizers.

bravo.utilities.chat.sanitize_chat(s)[source]

Verify that the given chat string is safe to send to Notchian recepients.

Permute a username through several common alternative-finding algorithms.

## Coordinate Handling¶

Utilities for coordinate handling and munging.

Adjust a set of coords according to a face.

The face is a standard string descriptor, such as “+x”.

The “noop” face is supported.

bravo.utilities.coords.split_coords(x, z)[source]

Split a pair of coordinates into chunk and subchunk coordinates.

Parameters: x (int) – the X coordinate z (int) – the Z coordinate a tuple of the X chunk, X subchunk, Z chunk, and Z subchunk
bravo.utilities.coords.taxicab2(x1, y1, x2, y2)[source]

Return the taxicab distance between two blocks.

bravo.utilities.coords.taxicab3(x1, y1, z1, x2, y2, z2)[source]

Return the taxicab distance between two blocks, in three dimensions.

## Data Packing¶

More affectionately known as “bit-twiddling.”

## Decorators¶

General decorators for a variety of purposes.

## Geometry¶

bravo.utilities.geometry.gen_line_covered(point1, point2)[source]

This is Bresenham’s algorithm with a little twist: all the blocks that intersect with the line are yielded.

bravo.utilities.geometry.gen_line_simple(point1, point2)[source]

Generalization of Bresenham’s line algorithm in 3d.

It yields blocks coordinates along a line that is at all times only one block in width.

It is a simplified version that does nothing fancy with integers or such: all computation is done on float (maybe it should be changed?)

## Spatial Hashes¶

class bravo.utilities.spatial.Block2DSpatialDict[source]

Class for tracking blocks in the XZ-plane.

key_for_bucket(key)[source]

Partition keys into chunk-sized buckets.

Get all bucket keys “near” this key.

This method may return a generator.

class bravo.utilities.spatial.Block3DSpatialDict[source]

Class for tracking blocks in the XZ-plane.

key_for_bucket(key)[source]

Partition keys into chunk-sized buckets.

Get all bucket keys “near” this key.

This method may return a generator.

class bravo.utilities.spatial.SpatialDict[source]

Bases: object, UserDict.DictMixin

A spatial dictionary, for accelerating spatial lookups.

This particular class is a template for specific spatial dictionaries; in order to make it work, subclass it and add key_for_bucket().

A version of iteritems() that filters based on the distance from a given key.

The key does not need to actually be in the dictionary.

iterkeys()[source]

Yield all the keys.

Yield all of the keys within a certain radius of this key.

Yield all of the values within a certain radius of this key.

keys()[source]

Get a list of all keys in the dictionary.

## Trigonometry¶

bravo.utilities.maths.morton2(x, y)[source]

Create a Morton number by interleaving the bits of two numbers.

This can be used to map 2D coordinates into the integers.

Inputs will be masked off to 16 bits, unsigned.

bravo.utilities.maths.rotated_cosine(x, y, theta, lambd)[source]

Evaluate a rotated 3D sinusoidal wave at a given point, angle, and wavelength.

The function used is:

This function has a handful of useful properties; it has a local minimum at f(0, 0) and oscillates infinitely betwen 0 and 1.

Parameters: x (float) – X coordinate y (float) – Y coordinate theta (float) – angle of rotation lambda (float) – wavelength float of f(x, y)