luminarycloud.geometry¶
Classes¶
Represents a Geometry object. |
Functions¶
|
Get a specific geometry with the given ID. |
Module Contents¶
- class luminarycloud.geometry.Geometry(proto_type: google.protobuf.message.Message | None = None)¶
Represents a Geometry object.
- id: str¶
Geometry ID.
- name: str¶
Geometry name.
- property create_time: datetime.datetime¶
The time the geometry was created.
- modify(modification: luminarycloud._proto.geometry.geometry_pb2.Modification) tuple[list[luminarycloud._proto.geometry.geometry_pb2.Volume], list[luminarycloud._proto.geometry.geometry_pb2.Feature], list[luminarycloud._proto.geometry.geometry_pb2.FeatureIssues]]¶
Apply a modification to the geometry.
- Parameters:
- modificationModification
The modification to apply to the geometry.
- Returns:
- volumeslist[Volume]
A list of the volumes in the geometry, after the requested modification was applied.
- featureslist[Feature]
A list of currently active features in the geometry, after the requested modification was applied.
- feature_issueslist[FeatureIssues]
A list of issues that may affect the feature.
- check() tuple[bool, list[str]]¶
Check the geometry for any issues that may prevent meshing.
- Returns:
- okboolean
If true, the geometry is ready for meshing.
If false, the geometry contains errors. Inspect issues and resolve any errors.
- issuestuple[str]
A list of issues with the geometry.
When ok=True, issues may be empty or non-empty but contain only warning or informational messages. When ok=False, issues will contain at least one error message and possibly additional warning or informational messages.