Skip to main content

create_box

Kind: Function
Domain: Modeling and geometry
Canonical import: from cadflow import create_box

Signature

def create_box(width: 'ScalarLike', height: 'ScalarLike', depth: 'ScalarLike', bottom_face_center: 'Tuple[float, float, float]' = (0, 0, 0), *, tag_prefix: 'Optional[str]' = None, result_tag: 'Optional[str]' = None, bottom_face_tag: 'Optional[str]' = None, top_face_tag: 'Optional[str]' = None, front_face_tag: 'Optional[str]' = None, back_face_tag: 'Optional[str]' = None, left_face_tag: 'Optional[str]' = None, right_face_tag: 'Optional[str]' = None) -> 'Solid'

Description

Create a box with native kernel-backed Face topology tags.

Other public imports

  • from cadflow import make_box_rsolid

Parameters

NameTypeRequiredDefaultSource description
width'ScalarLike'yes-Not explicitly described in the source docstring.
height'ScalarLike'yes-Not explicitly described in the source docstring.
depth'ScalarLike'yes-Not explicitly described in the source docstring.
bottom_face_center'Tuple[float, float, float]'no(0, 0, 0)Not explicitly described in the source docstring.
tag_prefix'Optional[str]'noNoneNot explicitly described in the source docstring.
result_tag'Optional[str]'noNoneNot explicitly described in the source docstring.
bottom_face_tag'Optional[str]'noNoneNot explicitly described in the source docstring.
top_face_tag'Optional[str]'noNoneNot explicitly described in the source docstring.
front_face_tag'Optional[str]'noNoneNot explicitly described in the source docstring.
back_face_tag'Optional[str]'noNoneNot explicitly described in the source docstring.
left_face_tag'Optional[str]'noNoneNot explicitly described in the source docstring.
right_face_tag'Optional[str]'noNoneNot explicitly described in the source docstring.

Returns

Type: 'Solid'

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.

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 create_box

See also