Fundamental Constants

The fundamental information of Minim are stored in constant.py.

Display Configuration

Display is the output of the scene. The existing available configuration of display are: Display ConfigurationPixel HeightPixel WidthFrame RateRemarks PRODUCTION_QUALITY_CAMERA_CONFIG1440256060Default HIGH_QUALITY_CAMERA_CONFIG1080192060-h, --high_quality switch MEDIUM_QUALITY_CAMERA_CONFIG720128030-m, --medium_quality switch LOW_QUALITY_CAMERA_CONFIG48085415-l, --low_quality switch By default, the pixel height is 1440, the pixel width is 2560, and the frame rate is 60. And values in constants.py are

PRODUCTION_QUALITY_CAMERA_CONFIG = {
    "pixel_height": 1440,
    "pixel_width": 2560,
    "frame_rate": 60,
}

HIGH_QUALITY_CAMERA_CONFIG = {
    "pixel_height": 1080,
    "pixel_width": 1920,
    "frame_rate": 60,
}

MEDIUM_QUALITY_CAMERA_CONFIG = {
    "pixel_height": 720,
    "pixel_width": 1280,
    "frame_rate": 30,
}

LOW_QUALITY_CAMERA_CONFIG = {
    "pixel_height": 480,
    "pixel_width": 854,
    "frame_rate": 15,
}

DEFAULT_PIXEL_HEIGHT = PRODUCTION_QUALITY_CAMERA_CONFIG["pixel_height"]
DEFAULT_PIXEL_WIDTH = PRODUCTION_QUALITY_CAMERA_CONFIG["pixel_width"]
DEFAULT_FRAME_RATE = 60

Frame Configuration

Frame is the coordinate system of the display. By default, the point of reference, called origin, for the display is located at the center of display. Constants FRAME_Y_RADIUS and FRAME_X_RADIUS are used to control to the position of origin in the display. The maximum and minimum limit of frame height is controlled by constant FRAME_HEIGHT. The default magnetude of frame height is 8. Therefore the maximum frame height scale limit is 4 and the minimum frame height scale limit is -4. The data aspect ratio, or relative length of data unit between height and weight, is equal to [1, 1]. And therefore the default magnetude of frame width is expressed in terms of constant FRAME_HEIGHT and is equal to FRAME_HEIGHT * DEFAULT_PIXEL_WIDTH / DEFAULT_PIXEL_HEIGHT. The default calculated frame weight is approximated equal 14.22. In other words, the default maximum frame width scale limit is 7 and the minimum frame width scale limit is -7. An example of default NumberPlane display is

The default values related to frame configuration in constants.py are

FRAME_HEIGHT = 8.0
FRAME_WIDTH = FRAME_HEIGHT * DEFAULT_PIXEL_WIDTH / DEFAULT_PIXEL_HEIGHT
FRAME_Y_RADIUS = FRAME_HEIGHT / 2
FRAME_X_RADIUS = FRAME_WIDTH / 2

Coordinate Array Shortcut

Some coordinate array shortcut aliases are defined in constants.py for the most common coordinate arrays. The elements of the array, (x, y, z) are values in x-, y-, and z- dimension. These array shortcut aliases can be used as absolute coordinates or relative coordinates. Aliases>Coordinate ArrayRemarks ORIGINnp.array((0., 0., 0.)) UPnp.array((0., 1., 0.)) DOWNnp.array((0., -1., 0.)) RIGHTnp.array((1., 0., 0.)) LEFTnp.array((-1., 0., 0.)) INnp.array((0., 0., -1.)) OUTnp.array((0., 0., 1.)) X_AXISnp.array((1., 0., 0.)) Y_AXISnp.array((0., 1., 0.)) Z_AXISnp.array((0., 0., 1.)) ULUP + LEFTnp.array((-1., 1., 0.)) URUP + RIGHTnp.array((1., 1., 0.)) DLDOWN + LEFTnp.array((-1., -1., 0.)) DRDOWN + RIGHTnp.array((1., -1., 0.)) TOPFRAME_Y_RADIUS * UPmaximum y scalar limit BOTTOMFRAME_Y_RADIUS * DOWNminimum y scalar limit LEFT_SIDEFRAME_X_RADIUS * LEFTminimum x scalar limit RIGHT_SIDEFRAME_X_RADIUS * RIGHTmaximum x scalar limit And values in constants.py are

ORIGIN = np.array((0., 0., 0.))
UP = np.array((0., 1., 0.))
DOWN = np.array((0., -1., 0.))
RIGHT = np.array((1., 0., 0.))
LEFT = np.array((-1., 0., 0.))
IN = np.array((0., 0., -1.))
OUT = np.array((0., 0., 1.))
X_AXIS = np.array((1., 0., 0.))
Y_AXIS = np.array((0., 1., 0.))
Z_AXIS = np.array((0., 0., 1.))

# Useful abbreviations for diagonals
UL = UP + LEFT
UR = UP + RIGHT
DL = DOWN + LEFT
DR = DOWN + RIGHT

TOP = FRAME_Y_RADIUS * UP
BOTTOM = FRAME_Y_RADIUS * DOWN
LEFT_SIDE = FRAME_X_RADIUS * LEFT
RIGHT_SIDE = FRAME_X_RADIUS * RIGHT

Source and Reference

https://github.com/3b1b/manim19Dec2019