Skip to main content
Ctrl+K
Logo image

COMPAS Timber

  • Introduction
  • Installation
  • API Reference
    • compas_timber.model
    • compas_timber.elements
    • compas_timber.connections
    • compas_timber.fabrication
    • compas_timber.design
    • compas_timber.planning
    • compas_timber.errors
    • compas_timber.ghpython
    • compas_timber.rhino
  • Grasshopper plugin
    • Installation Guide
    • Workflow
    • Attributes
    • Beams
    • Design
    • Fabrication
    • Features
    • Joint Rules
    • Model
    • Show
    • Utils
    • Examples
  • Developer Guide
    • Class Diagrams
    • BTLx Contribution Guide
    • Joints Contribution Guide
  • License
  • Citing
COMPAS.dev
  • API Reference
  • Pocket
  • Pocket.apply

Pocket.apply

Pocket.apply(geometry, element)[source]

Apply the feature to the element geometry.

Parameters:
geometryBrep

The geometry of the elements to be processed.

elementcompas_timber.elements.Beam or compas_timber.elements.Plate

The element that is processed by this instance.

Returns:
Brep

The resulting geometry after processing

Raises:
FeatureApplicationError

If the cutting plane does not intersect with element geometry.

On this page
  • Pocket.apply()

© Copyright COMPAS Association.

Created using Sphinx 6.2.1.

Built with the PyData Sphinx Theme 0.13.3.