luminarycloud.params.geometry¶

Classes¶

`AnnularCylinder`
`Cone`
`Cube`
`Cylinder`
`GeometryEntity`	A generic entity in the geometry.
`GeometryExportParams`	Parameters defining the geometry export format and options.
`GeometryExportTarget`	One target in a batch geometry export request.
`HalfSphere`
`OrientedCube`
`Shape`
`Sphere`
`SphereShell`
`StlExportOptions`	Options for exporting geometry as STL.
`Surface`	A surface in the geometry. This class should never be instantiated directly.
`TessellationParams`	Tessellation parameters for STL export.
`Torus`
`Volume`	A volume in the geometry. This class should never be instantiated directly.

Package Contents¶

class AnnularCylinder(*, start: luminarycloud.types.vector3.Vector3Like | None = None, end: luminarycloud.types.vector3.Vector3Like | None = None, radius: float = 0.0, radius_inner: float = 0.0)¶

end: luminarycloud.types.Vector3¶

radius: float¶

radius_inner: float¶

start: luminarycloud.types.Vector3¶

class Cone(*, apex: luminarycloud.types.vector3.Vector3Like | None = None, base_center: luminarycloud.types.vector3.Vector3Like | None = None, base_radius: float = 0.0)¶

apex: luminarycloud.types.Vector3¶

base_center: luminarycloud.types.Vector3¶

base_radius: float¶

class Cube(*, min: luminarycloud.types.vector3.Vector3Like | None = None, max: luminarycloud.types.vector3.Vector3Like | None = None)¶

max: luminarycloud.types.Vector3¶

min: luminarycloud.types.Vector3¶

class Cylinder(*, start: luminarycloud.types.vector3.Vector3Like | None = None, end: luminarycloud.types.vector3.Vector3Like | None = None, radius: float = 0.0)¶

end: luminarycloud.types.Vector3¶

radius: luminarycloud.types.adfloat.LcFloat¶

start: luminarycloud.types.Vector3¶

class GeometryEntity¶

A generic entity in the geometry.

bbox_max: luminarycloud.types.Vector3¶

bbox_min: luminarycloud.types.Vector3¶

geometry_id: str¶

id: str¶

class GeometryExportParams¶

Parameters defining the geometry export format and options. Only STL supported for now.

stl: StlExportOptions | None = None¶

tags: list[str] | None = None¶

class GeometryExportTarget¶

One target in a batch geometry export request.

export_type: luminarycloud.enum.GeometryExportType¶

geometry_version_id: str¶

params: GeometryExportParams | None = None¶

tags: list[str] | None = None¶

class HalfSphere(*, center: luminarycloud.types.vector3.Vector3Like | None = None, radius: float = 0.0, normal: luminarycloud.types.vector3.Vector3Like | None = None)¶

center: luminarycloud.types.Vector3¶

normal: luminarycloud.types.Vector3¶

radius: luminarycloud.types.adfloat.LcFloat¶

class OrientedCube(*, min: luminarycloud.types.vector3.Vector3Like | None = None, max: luminarycloud.types.vector3.Vector3Like | None = None, origin: luminarycloud.types.vector3.Vector3Like | None = None, x_axis: luminarycloud.types.vector3.Vector3Like | None = None, y_axis: luminarycloud.types.vector3.Vector3Like | None = None)¶

max: luminarycloud.types.Vector3¶

min: luminarycloud.types.Vector3¶

origin: luminarycloud.types.Vector3¶

x_axis: luminarycloud.types.Vector3¶

y_axis: luminarycloud.types.Vector3¶

class Shape¶

class Sphere(*, center: luminarycloud.types.vector3.Vector3Like | None = None, radius: float = 0.0)¶

center: luminarycloud.types.Vector3¶

radius: luminarycloud.types.adfloat.LcFloat¶

class SphereShell(*, center: luminarycloud.types.vector3.Vector3Like | None = None, radius: float = 0.0, radius_inner: float = 0.0)¶

center: luminarycloud.types.Vector3¶

radius: float¶

radius_inner: float¶

class StlExportOptions¶

Options for exporting geometry as STL.

ascii: bool = False¶

tessellation: TessellationParams | None = None¶

class Surface¶

A surface in the geometry. This class should never be instantiated directly.

bbox_max: luminarycloud.types.Vector3¶

bbox_min: luminarycloud.types.Vector3¶

geometry_id: str¶

id: str¶

class TessellationParams¶

Tessellation parameters for STL export.

With target_triangle_count set, the exporter holds the triangle count near the target and uses max_aspect_ratio to control triangle shape:

max_aspect_ratio=1: near-equilateral triangles (isotropic).
Larger values: triangles may be stretched up to that long/short edge ratio in directions of low curvature (e.g. the axial direction of a cylinder, planar regions).

Triangle distribution is not uniform; refinement concentrates where curvature changes fastest. On nearly-flat geometries the achieved count may undershoot the target because curvature is what drives subdivision; a safety-net edge-length budget keeps subdivision going but may not reach the requested target on pure planar surfaces. If you need a specific count on a mostly-flat geometry, file a request with your use case.

max_aspect_ratio: float | None = None¶

non_conforming: bool = False¶

target_triangle_count: int | None = None¶

triangle_count_tolerance: float | None = None¶

class Torus(*, center: luminarycloud.types.vector3.Vector3Like | None = None, normal: luminarycloud.types.vector3.Vector3Like | None = None, major_radius: float = 0.0, minor_radius: float = 0.0)¶

center: luminarycloud.types.Vector3¶

major_radius: float¶

minor_radius: float¶

normal: luminarycloud.types.Vector3¶

class Volume¶

A volume in the geometry. This class should never be instantiated directly.

bbox_max: luminarycloud.types.Vector3¶

bbox_min: luminarycloud.types.Vector3¶

geometry_id: str¶

id: str¶