Compound
Kind: Class
Domain: Modeling and geometry
Canonical import: from cadflow import Compound
Signature
class Compound(compound: 'Any', cache: 'Optional[_TopologyEntityCache]' = None)
Description
OCP-native compound wrapper for explicit multi-shape projections.
Parameters
| Name | Type | Required | Default | Source description |
|---|---|---|---|---|
compound | 'Any' | yes | - | Not explicitly described in the source docstring. |
cache | 'Optional[_TopologyEntityCache]' | no | None | Not explicitly described in the source docstring. |
Returns
Type: Any
The source docstring does not declare additional return semantics.
Errors
The source docstring does not declare a narrower exception contract. Invalid types, values, ownership, paths, or backend state may still raise the corresponding public error.
Public members
| Member | Kind | Signature | Description |
|---|---|---|---|
get_edges | method | (self, index: 'Optional[int]' = None) -> 'Union[List[Edge], Edge]' | See the member signature. |
get_faces | method | (self, index: 'Optional[int]' = None) -> 'Union[List[Face], Face]' | See the member signature. |
get_solids | method | (self, index: 'Optional[int]' = None) -> 'Union[List[Solid], Solid]' | See the member signature. |
get_volume | method | (self) -> 'float' | See the member signature. |
Behavior and constraints
- The contract below is generated from the current public runtime signature. Check domain notes for ownership and workflow constraints.
Import check
from cadflow import Compound