model Namespace Reference

Classes
class	ModelWindow

Functions
np.ndarray	identity_matrix ()
np.ndarray	look_at_matrix (tuple[float, float, float] eye, tuple[float, float, float] center, tuple[float, float, float] up)
int	main ()
list[float]	matrix_values (np.ndarray matrix)
np.ndarray	normalize_vector (np.ndarray vector)
	parse_args ()
tuple[int, int]	parse_resolution (str value)
np.ndarray	perspective_matrix (float fov_radians, float aspect, float near_plane, float far_plane)
np.ndarray	rotation_y_matrix (float angle)
np.ndarray	scale_matrix (float x, float y, float z)
np.ndarray	translation_matrix (float x, float y, float z)

Variables
	EXAMPLE_DIR = Path(__file__).resolve().parent

Function Documentation

identity_matrix()

np.ndarray identity_matrix

(

)

Definition at line 36 of file model.py.

def identity_matrix() -> np.ndarray:
    return np.eye(4, dtype=np.float32)
 

look_at_matrix()

np.ndarray look_at_matrix	(	tuple[float, float, float]	eye,
		tuple[float, float, float]	center,
		tuple[float, float, float]	up )

Definition at line 57 of file model.py.

def look_at_matrix(eye: tuple[float, float, float], center: tuple[float, float, float], up: tuple[float, float, float]) -> np.ndarray:
    eye_vector = np.array(eye, dtype=np.float32)
    center_vector = np.array(center, dtype=np.float32)
    up_vector = np.array(up, dtype=np.float32)
    forward = normalize_vector(center_vector - eye_vector)
    side = normalize_vector(np.cross(forward, up_vector))
    camera_up = np.cross(side, forward)
    matrix = identity_matrix()
    matrix[0, 0] = side[0]
    matrix[0, 1] = side[1]
    matrix[0, 2] = side[2]
    matrix[0, 3] = -float(np.dot(side, eye_vector))
    matrix[1, 0] = camera_up[0]
    matrix[1, 1] = camera_up[1]
    matrix[1, 2] = camera_up[2]
    matrix[1, 3] = -float(np.dot(camera_up, eye_vector))
    matrix[2, 0] = -forward[0]
    matrix[2, 1] = -forward[1]
    matrix[2, 2] = -forward[2]
    matrix[2, 3] = float(np.dot(forward, eye_vector))
    return matrix
 

main()

int main

(

void

)

Definition at line 281 of file model.py.

def main() -> int:
    args = parse_args()
    width, height = args.resolution
    if (args.input_filename):
        filename = args.input_filename
    else:
        filename = args.filename
    window = None
    try:
        window = ModelWindow(filename, args.path, "MXVK Model Test", width, height, args.fullscreen, args.enable_vsync)
        window.loop()
 
    except mxvk.MXVKError as exception:
        print(f"mxvk: Exception: {exception}", file=sys.stderr)
        return 1
    finally:
        if (window is not None):
            window.close()
    return 0
 

matrix_values()

list[float] matrix_values

(

np.ndarray

matrix

)

Definition at line 33 of file model.py.

def matrix_values(matrix: np.ndarray) -> list[float]:
    return matrix.astype(np.float32, copy=False).reshape(16).tolist()
 

normalize_vector()

np.ndarray normalize_vector

(

np.ndarray

vector

)

Definition at line 50 of file model.py.

def normalize_vector(vector: np.ndarray) -> np.ndarray:
    length = float(np.linalg.norm(vector))
    if (length <= 0.0):
        return vector
 
    return vector / length
 

parse_args()

parse_args

(

)

Definition at line 271 of file model.py.

def parse_args():
    parser = argparse.ArgumentParser(description="MXVK textured Penguin Python example")
    parser.add_argument("filename", nargs="?", default="", help="optional OBJ or MXMOD model path")
    parser.add_argument("-i", "--input", dest="input_filename", default="", help="optional OBJ or MXMOD model path")
    parser.add_argument("-p", "--path", default=str(EXAMPLE_DIR), help="resource root containing the data directory")
    parser.add_argument("-r", "--resolution", type=parse_resolution, default=(1280, 720), metavar="WIDTHxHEIGHT", help="window resolution (default: 1280x720)")
    parser.add_argument("-f", "--fullscreen", action="store_true", help="start fullscreen")
    parser.add_argument("--enable-vsync", action="store_true", help="enable vertical synchronization")
    return parser.parse_args()
 

parse_resolution()

tuple[int, int] parse_resolution

(

str

value

)

Definition at line 258 of file model.py.

def parse_resolution(value: str) -> tuple[int, int]:
    try:
        width_text, height_text = value.lower().split("x", 1)
        width = int(width_text)
        height = int(height_text)
 
    except ValueError as exception:
        raise argparse.ArgumentTypeError("resolution must use WIDTHxHEIGHT, for example 1280x720") from exception
 
    if (width <= 0 or height <= 0):
        raise argparse.ArgumentTypeError("resolution width and height must be greater than zero")
    return width, height
 

perspective_matrix()

np.ndarray perspective_matrix	(	float	fov_radians,
		float	aspect,
		float	near_plane,
		float	far_plane )

Definition at line 79 of file model.py.

def perspective_matrix(fov_radians: float, aspect: float, near_plane: float, far_plane: float) -> np.ndarray:
    tangent = math.tan(fov_radians * 0.5)
    matrix = np.zeros((4, 4), dtype=np.float32)
    matrix[0, 0] = 1.0 / (aspect * tangent)
    matrix[1, 1] = 1.0 / tangent
    matrix[2, 2] = far_plane / (near_plane - far_plane)
    matrix[2, 3] = (far_plane * near_plane) / (near_plane - far_plane)
    matrix[3, 2] = -1.0
    matrix[1, 1] *= -1.0
    return matrix
 

rotation_y_matrix()

np.ndarray rotation_y_matrix

(

float

angle

)

Definition at line 39 of file model.py.

def rotation_y_matrix(angle: float) -> np.ndarray:
    cosine = math.cos(angle)
    sine = math.sin(angle)
    return np.array([[cosine, 0.0, sine, 0.0], [0.0, 1.0, 0.0, 0.0], [-sine, 0.0, cosine, 0.0], [0.0, 0.0, 0.0, 1.0]], dtype=np.float32)
 

scale_matrix()

np.ndarray scale_matrix	(	float	x,
		float	y,
		float	z )

Definition at line 44 of file model.py.

def scale_matrix(x: float, y: float, z: float) -> np.ndarray:
    return np.array([[x, 0.0, 0.0, 0.0], [0.0, y, 0.0, 0.0], [0.0, 0.0, z, 0.0], [0.0, 0.0, 0.0, 1.0]], dtype=np.float32)
 

translation_matrix()

np.ndarray translation_matrix	(	float	x,
		float	y,
		float	z )

Definition at line 47 of file model.py.

def translation_matrix(x: float, y: float, z: float) -> np.ndarray:
    return np.array([[1.0, 0.0, 0.0, x], [0.0, 1.0, 0.0, y], [0.0, 0.0, 1.0, z], [0.0, 0.0, 0.0, 1.0]], dtype=np.float32)
 

Variable Documentation

EXAMPLE_DIR

model.EXAMPLE_DIR = Path(__file__).resolve().parent

Definition at line 31 of file model.py.