Skip to main content

Shell

Kind: Class
Domain: Modeling and geometry
Canonical import: from cadflow import Shell

Signature

class Shell(shell: 'Any', cache: 'Optional[_TopologyEntityCache]' = None)

Description

OCP-native connected surface shell with face and edge topology.

Parameters

NameTypeRequiredDefaultSource description
shell'Any'yes-Not explicitly described in the source docstring.
cache'Optional[_TopologyEntityCache]'noNoneNot 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

MemberKindSignatureDescription
get_areamethod(self) -> 'float'Return the total area of every face in the shell.
get_edgesmethod(self, index: 'Optional[int]' = None) -> 'Union[List[Edge], Edge]'See the member signature.
get_facesmethod(self, index: 'Optional[int]' = None) -> 'Union[List[Face], Face]'See the member signature.
get_wiresmethod(self, index: 'Optional[int]' = None) -> 'Union[List[Wire], Wire]'Return the Shell's free boundary wires.
is_closedmethod(self) -> 'bool'Return whether the shell bounds a closed region.

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 Shell

See also