deformable 0.1.0__py3-none-win_amd64.whl

deformable/native.py

@@ -0,0 +1,401 @@
+"""The C structs of deformable.h as ctypes structures, field for field and in the header's order.
+
+Handles are opaque, so they cross as plain void pointers. tests/test_native.py checks every structure here against the
+header, so neither side can change alone.
+"""
+
+from __future__ import annotations
+
+import ctypes
+
+Status = ctypes.c_int32
+Enumeration = ctypes.c_int32
+Boolean = ctypes.c_uint8
+Handle = ctypes.c_void_p
+Index = ctypes.c_uint32
+Count = ctypes.c_size_t
+
+TetrahedronIndices = Index * 4
+TriangleIndices = Index * 3
+EdgeIndices = Index * 2
+Colour = ctypes.c_double * 4
+Weights = ctypes.c_double * 4
+Pixel = ctypes.c_uint8 * 3
+FloatVector = ctypes.c_float * 3
+
+
+class Vector2(ctypes.Structure):
+    """DeformableVector2."""
+
+    _fields_ = [("x", ctypes.c_double), ("y", ctypes.c_double)]
+
+
+class Vector3(ctypes.Structure):
+    """DeformableVector3."""
+
+    _fields_ = [("x", ctypes.c_double), ("y", ctypes.c_double), ("z", ctypes.c_double)]
+
+
+class Matrix3(ctypes.Structure):
+    """DeformableMatrix3."""
+
+    _fields_ = [("rows", Vector3 * 3)]
+
+
+class AffineTransform(ctypes.Structure):
+    """DeformableAffineTransform."""
+
+    _fields_ = [("linear", Matrix3), ("translation", Vector3)]
+
+
+class ErrorDetails(ctypes.Structure):
+    """DeformableErrorDetails."""
+
+    _fields_ = [("status", Status), ("first_index", Index), ("second_index", Index)]
+
+
+class LicenseStatus(ctypes.Structure):
+    """DeformableLicenseStatus."""
+
+    _fields_ = [
+        ("state", Enumeration),
+        ("days_left", ctypes.c_uint32),
+        ("tetrahedron_limit", ctypes.c_uint32),
+        ("usable", Boolean),
+        ("needs_online", Boolean),
+        ("has_license_key", Boolean),
+        ("message", ctypes.c_char * 64),
+    ]
+
+
+class TetrahedralMeshView(ctypes.Structure):
+    """DeformableTetrahedralMeshView."""
+
+    _fields_ = [
+        ("positions", ctypes.POINTER(Vector3)),
+        ("position_count", Count),
+        ("tetrahedrons", ctypes.POINTER(TetrahedronIndices)),
+        ("tetrahedron_count", Count),
+    ]
+
+
+class PolygonMeshView(ctypes.Structure):
+    """DeformablePolygonMeshView."""
+
+    _fields_ = [
+        ("positions", ctypes.POINTER(Vector3)),
+        ("position_count", Count),
+        ("polygon_sizes", ctypes.POINTER(Index)),
+        ("polygon_count", Count),
+        ("polygon_vertices", ctypes.POINTER(Index)),
+        ("corner_count", Count),
+    ]
+
+
+class TriangleSurfaceView(ctypes.Structure):
+    """DeformableTriangleSurfaceView."""
+
+    _fields_ = [
+        ("positions", ctypes.POINTER(Vector3)),
+        ("position_count", Count),
+        ("triangles", ctypes.POINTER(TriangleIndices)),
+        ("triangle_count", Count),
+    ]
+
+
+class SurfaceMeshView(ctypes.Structure):
+    """DeformableSurfaceMeshView."""
+
+    _fields_ = [
+        ("mesh", PolygonMeshView),
+        ("normals", ctypes.POINTER(Vector3)),
+        ("normal_count", Count),
+        ("uvs", ctypes.POINTER(Vector2)),
+        ("uv_set_count", Count),
+        ("colours", ctypes.POINTER(Colour)),
+        ("colour_count", Count),
+    ]
+
+
+class Anisotropy(ctypes.Structure):
+    """DeformableAnisotropy."""
+
+    _fields_ = [("scale", ctypes.c_double), ("direction", Vector3)]
+
+
+class AutocageParameters(ctypes.Structure):
+    """DeformableAutocageParameters."""
+
+    _fields_ = [
+        ("scale_gap", ctypes.c_double),
+        ("target_face_count", ctypes.c_int32),
+        ("target_tetrahedron_count", ctypes.c_int32),
+    ]
+
+
+class FaceHole(ctypes.Structure):
+    """DeformableFaceHole."""
+
+    _fields_ = [("face", Index), ("first_corner", Index), ("corner_count", Index)]
+
+
+class TriangulateParameters(ctypes.Structure):
+    """DeformableTriangulateParameters."""
+
+    _fields_ = [
+        ("maximum_area", ctypes.c_double),
+        ("quality", ctypes.c_double),
+        ("anisotropy", Anisotropy * 2),
+        ("watertight", Boolean),
+    ]
+
+
+class TriangulationView(ctypes.Structure):
+    """DeformableTriangulationView."""
+
+    _fields_ = [
+        ("surface", TriangleSurfaceView),
+        ("source_polygons", ctypes.POINTER(Index)),
+        ("source_polygon_count", Count),
+    ]
+
+
+class DensityRegion(ctypes.Structure):
+    """DeformableDensityRegion."""
+
+    _fields_ = [("points", ctypes.POINTER(Vector3)), ("point_count", Count), ("scale", ctypes.c_double)]
+
+
+class TetrahedralizeParameters(ctypes.Structure):
+    """DeformableTetrahedralizeParameters."""
+
+    _fields_ = [
+        ("maximum_edge_length", ctypes.c_double),
+        ("anisotropy", Anisotropy * 2),
+        ("density_regions", ctypes.POINTER(DensityRegion)),
+        ("density_region_count", Count),
+    ]
+
+
+class TetrahedralizationView(ctypes.Structure):
+    """DeformableTetrahedralizationView."""
+
+    _fields_ = [
+        ("mesh", TetrahedralMeshView),
+        ("skipped_density_regions", ctypes.POINTER(Count)),
+        ("skipped_density_region_count", Count),
+    ]
+
+
+class MeshChecks(ctypes.Structure):
+    """DeformableMeshChecks."""
+
+    _fields_ = [
+        ("angle_threshold_degrees", ctypes.c_double),
+        ("gap_threshold", ctypes.c_double),
+        ("planar_threshold", ctypes.c_double),
+        ("check_uv_consistency", Boolean),
+        ("uv_threshold", ctypes.c_double),
+        ("same_uv", Boolean),
+        ("convex", Boolean),
+        ("watertight", Boolean),
+        ("self_intersection", Enumeration),
+    ]
+
+
+class MeshIssue(ctypes.Structure):
+    """DeformableMeshIssue."""
+
+    _fields_ = [
+        ("kind", Enumeration),
+        ("vertex", Index),
+        ("face", Index),
+        ("hole", Index),
+        ("corner", Index),
+        ("uv_set", Index),
+        ("island", Index),
+        ("container", Index),
+        ("use_count", Index),
+        ("hole_count", Index),
+        ("island_count", Index),
+        ("edge", EdgeIndices),
+        ("corners", EdgeIndices),
+        ("inward", Boolean),
+        ("distance", ctypes.c_double),
+        ("relative_distance", ctypes.c_double),
+        ("degrees", ctypes.c_double),
+        ("relative_deviation", ctypes.c_double),
+        ("interior_angle_degrees", ctypes.c_double),
+        ("vertices", ctypes.POINTER(Index)),
+        ("vertex_count", Count),
+        ("edges", ctypes.POINTER(EdgeIndices)),
+        ("edge_count", Count),
+        ("uncontained", ctypes.POINTER(Index)),
+        ("uncontained_count", Count),
+    ]
+
+
+class PixelGrid(ctypes.Structure):
+    """DeformablePixelGrid."""
+
+    _fields_ = [
+        ("width", ctypes.c_uint32),
+        ("height", ctypes.c_uint32),
+        ("pixels", ctypes.POINTER(Pixel)),
+        ("pixel_count", Count),
+    ]
+
+
+class SplinterImageParameters(ctypes.Structure):
+    """DeformableSplinterImageParameters."""
+
+    _fields_ = [("size", Vector3), ("origin", Vector3), ("allow_nonconvex", Boolean)]
+
+
+class MaterialParameters(ctypes.Structure):
+    """DeformableMaterialParameters."""
+
+    _fields_ = [
+        ("youngs_modulus", ctypes.c_double),
+        ("poissons_ratio", ctypes.c_double),
+        ("density", ctypes.c_double),
+        ("toughness", ctypes.c_double),
+        ("youngs_damping", ctypes.c_double),
+        ("yield_strain", ctypes.c_double),
+        ("maximum_yield", ctypes.c_double),
+        ("creep_fraction", ctypes.c_double),
+        ("wake_up_radius", ctypes.c_double),
+        ("friction", ctypes.c_double),
+    ]
+
+
+class TetrahedronMaterials(ctypes.Structure):
+    """DeformableTetrahedronMaterials."""
+
+    _fields_ = [
+        ("assignment", Enumeration),
+        ("material", Index),
+        ("materials", ctypes.POINTER(Index)),
+        ("material_count", Count),
+    ]
+
+
+class ObjectOptions(ctypes.Structure):
+    """DeformableObjectOptions."""
+
+    _fields_ = [("self_collision", Boolean), ("disabled", Boolean)]
+
+
+class GlueParameters(ctypes.Structure):
+    """DeformableGlueParameters."""
+
+    _fields_ = [("spring_constant", ctypes.c_double), ("damping_coefficient", ctypes.c_double)]
+
+
+class Plane(ctypes.Structure):
+    """DeformablePlane."""
+
+    _fields_ = [("normal", Vector3), ("offset", ctypes.c_double)]
+
+
+class ConvexRegion(ctypes.Structure):
+    """DeformableConvexRegion."""
+
+    _fields_ = [("planes", ctypes.POINTER(Plane)), ("plane_count", Count)]
+
+
+class MaterialRegion(ctypes.Structure):
+    """DeformableMaterialRegion."""
+
+    _fields_ = [("mesh", PolygonMeshView), ("to_mesh_space", AffineTransform)]
+
+
+class DrivenVertex(ctypes.Structure):
+    """DeformableDrivenVertex."""
+
+    _fields_ = [("vertex", Index), ("target", Vector3)]
+
+
+class StepReport(ctypes.Structure):
+    """DeformableStepReport."""
+
+    _fields_ = [("substeps_run", ctypes.c_uint32), ("outcome", Enumeration)]
+
+
+class TetrahedronState(ctypes.Structure):
+    """DeformableTetrahedronState."""
+
+    _fields_ = [
+        ("corners", Vector3 * 4),
+        ("island", ctypes.c_uint32),
+        ("strain_measure", ctypes.c_double),
+        ("flags", ctypes.c_uint32),
+    ]
+
+
+class FaceEvent(ctypes.Structure):
+    """DeformableFaceEvent."""
+
+    _fields_ = [("tetrahedron", Index), ("exposed_faces", ctypes.c_uint8)]
+
+
+class SimulationStatistics(ctypes.Structure):
+    """DeformableSimulationStatistics."""
+
+    _fields_ = [
+        ("systems", ctypes.c_uint64),
+        ("conjugate_gradient_updates", ctypes.c_uint64),
+        ("contacts", Count),
+        ("islands", Count),
+    ]
+
+
+class PreparationParameters(ctypes.Structure):
+    """DeformablePreparationParameters."""
+
+    _fields_ = [
+        ("clip_mode", Enumeration),
+        ("uv_scale", ctypes.c_double),
+        ("splinter_cage", ctypes.POINTER(PolygonMeshView)),
+    ]
+
+
+class SkinningOptions(ctypes.Structure):
+    """DeformableSkinningOptions."""
+
+    _fields_ = [("show_inner_faces", Boolean), ("start_splintered", Boolean)]
+
+
+class SurfaceEmbeddingView(ctypes.Structure):
+    """DeformableSurfaceEmbeddingView."""
+
+    _fields_ = [
+        ("surface", SurfaceMeshView),
+        ("corner_flags", ctypes.POINTER(ctypes.c_uint32)),
+        ("corner_flag_count", Count),
+        ("source_faces", ctypes.POINTER(ctypes.c_int32)),
+        ("source_face_count", Count),
+        ("vertex_tetrahedrons", ctypes.POINTER(Index)),
+        ("vertex_tetrahedron_count", Count),
+        ("vertex_weights", ctypes.POINTER(Weights)),
+        ("vertex_weight_count", Count),
+        ("normal_weights", ctypes.POINTER(Weights)),
+        ("normal_weight_count", Count),
+        ("brick_tetrahedrons", ctypes.POINTER(Index)),
+        ("brick_tetrahedron_count", Count),
+        ("vertex_cell_tetrahedrons", ctypes.POINTER(Index)),
+        ("vertex_cell_tetrahedron_count", Count),
+    ]
+
+
+class DeformedSurfaceView(ctypes.Structure):
+    """DeformableDeformedSurfaceView."""
+
+    _fields_ = [
+        ("positions", ctypes.POINTER(FloatVector)),
+        ("position_count", Count),
+        ("normals", ctypes.POINTER(FloatVector)),
+        ("normal_count", Count),
+        ("hidden_faces", ctypes.POINTER(ctypes.c_uint8)),
+        ("face_count", Count),
+    ]