luminarycloud.params.geometry¶

Classes¶

`AnnularCylinder`	Abstract base class for generic types.
`Cone`	Abstract base class for generic types.
`Cube`	Abstract base class for generic types.
`Cylinder`	Abstract base class for generic types.
`GeometryEntity`	A generic entity in the geometry.
`HalfSphere`	Abstract base class for generic types.
`OrientedCube`	Abstract base class for generic types.
`Shape`	Abstract base class for generic types.
`Sphere`	Abstract base class for generic types.
`SphereShell`	Abstract base class for generic types.
`Surface`	A surface in the geometry. This class should never be instantiated directly.
`Torus`	Abstract base class for generic types.
`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)¶

Abstract base class for generic types.

A generic type is typically declared by inheriting from this class parameterized with one or more type variables. For example, a generic mapping type might be defined as:

class Mapping(Generic[KT, VT]):
    def __getitem__(self, key: KT) -> VT:
        ...
    # Etc.

This class can then be used as follows:

def lookup_name(mapping: Mapping[KT, VT], key: KT, default: VT) -> VT:
    try:
        return mapping[key]
    except KeyError:
        return default

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)¶

Abstract base class for generic types.

A generic type is typically declared by inheriting from this class parameterized with one or more type variables. For example, a generic mapping type might be defined as:

class Mapping(Generic[KT, VT]):
    def __getitem__(self, key: KT) -> VT:
        ...
    # Etc.

This class can then be used as follows:

def lookup_name(mapping: Mapping[KT, VT], key: KT, default: VT) -> VT:
    try:
        return mapping[key]
    except KeyError:
        return default

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)¶

Abstract base class for generic types.

A generic type is typically declared by inheriting from this class parameterized with one or more type variables. For example, a generic mapping type might be defined as:

class Mapping(Generic[KT, VT]):
    def __getitem__(self, key: KT) -> VT:
        ...
    # Etc.

This class can then be used as follows:

def lookup_name(mapping: Mapping[KT, VT], key: KT, default: VT) -> VT:
    try:
        return mapping[key]
    except KeyError:
        return default

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)¶

Abstract base class for generic types.

A generic type is typically declared by inheriting from this class parameterized with one or more type variables. For example, a generic mapping type might be defined as:

class Mapping(Generic[KT, VT]):
    def __getitem__(self, key: KT) -> VT:
        ...
    # Etc.

This class can then be used as follows:

def lookup_name(mapping: Mapping[KT, VT], key: KT, default: VT) -> VT:
    try:
        return mapping[key]
    except KeyError:
        return default

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 HalfSphere(*, center: luminarycloud.types.vector3.Vector3Like | None = None, radius: float = 0.0, normal: luminarycloud.types.vector3.Vector3Like | None = None)¶

Abstract base class for generic types.

A generic type is typically declared by inheriting from this class parameterized with one or more type variables. For example, a generic mapping type might be defined as:

class Mapping(Generic[KT, VT]):
    def __getitem__(self, key: KT) -> VT:
        ...
    # Etc.

This class can then be used as follows:

def lookup_name(mapping: Mapping[KT, VT], key: KT, default: VT) -> VT:
    try:
        return mapping[key]
    except KeyError:
        return default

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)¶

Abstract base class for generic types.

A generic type is typically declared by inheriting from this class parameterized with one or more type variables. For example, a generic mapping type might be defined as:

class Mapping(Generic[KT, VT]):
    def __getitem__(self, key: KT) -> VT:
        ...
    # Etc.

This class can then be used as follows:

def lookup_name(mapping: Mapping[KT, VT], key: KT, default: VT) -> VT:
    try:
        return mapping[key]
    except KeyError:
        return default

max: luminarycloud.types.Vector3¶

min: luminarycloud.types.Vector3¶

origin: luminarycloud.types.Vector3¶

x_axis: luminarycloud.types.Vector3¶

y_axis: luminarycloud.types.Vector3¶

class Shape¶

Abstract base class for generic types.

A generic type is typically declared by inheriting from this class parameterized with one or more type variables. For example, a generic mapping type might be defined as:

class Mapping(Generic[KT, VT]):
    def __getitem__(self, key: KT) -> VT:
        ...
    # Etc.

This class can then be used as follows:

def lookup_name(mapping: Mapping[KT, VT], key: KT, default: VT) -> VT:
    try:
        return mapping[key]
    except KeyError:
        return default

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

Abstract base class for generic types.

A generic type is typically declared by inheriting from this class parameterized with one or more type variables. For example, a generic mapping type might be defined as:

class Mapping(Generic[KT, VT]):
    def __getitem__(self, key: KT) -> VT:
        ...
    # Etc.

This class can then be used as follows:

def lookup_name(mapping: Mapping[KT, VT], key: KT, default: VT) -> VT:
    try:
        return mapping[key]
    except KeyError:
        return default

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)¶

Abstract base class for generic types.

A generic type is typically declared by inheriting from this class parameterized with one or more type variables. For example, a generic mapping type might be defined as:

class Mapping(Generic[KT, VT]):
    def __getitem__(self, key: KT) -> VT:
        ...
    # Etc.

This class can then be used as follows:

def lookup_name(mapping: Mapping[KT, VT], key: KT, default: VT) -> VT:
    try:
        return mapping[key]
    except KeyError:
        return default

center: luminarycloud.types.Vector3¶

radius: float¶

radius_inner: float¶

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 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)¶

Abstract base class for generic types.

A generic type is typically declared by inheriting from this class parameterized with one or more type variables. For example, a generic mapping type might be defined as:

class Mapping(Generic[KT, VT]):
    def __getitem__(self, key: KT) -> VT:
        ...
    # Etc.

This class can then be used as follows:

def lookup_name(mapping: Mapping[KT, VT], key: KT, default: VT) -> VT:
    try:
        return mapping[key]
    except KeyError:
        return default

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¶