Data Structures

class phoxi_instant_meshing.Mesh

Bases: object

3D mesh with vertices, normals, colors, and triangular faces.

Non-organized collection of vertices with optional normals and colors, along with triangular face indices. Corresponds to phoim_Mesh in the C API.

export(file_path: str) → bool

Export the mesh to a file.

Supported formats: .stl, .fbx, .ply

Parameters:

file_path – Full path including filename and extension

Returns:

True if export was successful, False otherwise

class phoxi_instant_meshing.PointCloud

Bases: object

Non-organized point cloud.

Unordered collection of 3D points with optional normals and colors. Corresponds to phoim_PointCloud in the C API.

export(file_path: str) → bool

Export the point cloud to a file.

Supported formats: .ply

Parameters:

file_path – Full path including filename and extension

Returns:

True if export was successful, False otherwise

class phoxi_instant_meshing.Scan

Bases: object

Organized point cloud with defined resolution (3D scan).

Points are ordered in row-major format with defined width and height. Corresponds to phoim_Scan in the C API.

class phoxi_instant_meshing.Frame

Bases: object

Frame data for scan processing.

Contains timestamp, camera parameters, point cloud, and optional texture data. Corresponds to phoim_Frame in the C API.

class phoxi_instant_meshing.InputScan(frame, device_id: str, transformation: object | None = None)

Bases: object

Input scan for processing.

Contains frame data with timestamp, camera parameters, point cloud, and device transformation for scan processing. Corresponds to phoim_InputScan in the C API.

class phoxi_instant_meshing.VirtualCamera

Bases: object

Virtual camera parameters.

Contains camera resolution, projection mode, position, orientation, intrinsics, distortion coefficients, and orthogonal projection parameters. Corresponds to phoim_VirtualCamera in the C API.

class phoxi_instant_meshing.MessageType(*values)

Bases: IntEnum

class phoxi_instant_meshing.RasterizationEngine(*values)

Bases: IntEnum

Rasterization engine selection.

OPENGL: Default engine, requires display CUDA: Use for servers without display (may impact performance) VULKAN: Best performance but still in beta testing