Skip to main content

Cadquery object filtering framework

Project description

CadQuery object filtering framework

cq-filter adds a few new workplane methods that take a function argument of type f: Callable[[CQObject], bool]:

  • filter(f): filters Workplane objects
  • sort(f): orders Workplane objects
  • group(f): groups Workplane objects
  • last: selects newly created faces
  • toWires: select wires from selected faces

Additionally, it adds subscription support to the Workplane, allowing selection of objects quickly.

Rationale

Manipulating object selections in cadquery isn't currently possible without breaking out of the fluent API.

Using filter

Following example filters all faces with an Area of more than 100

wp = (
    wp
    .faces(">Z")
    .filter(lambda face: face.Area() > 100)
)

⚠️ values in cq/occt are often not as exact as you'd expect. For example you might expect a certain face to have an area of exactly 100 and be included when you filter the area against >= 100, but upon closer inspection it turns out the area is actually just slightly below 100 (99.999999997). Consider rounding to some sane precision, like round(face.Area(), 4)

Using sort and subscription

Following example sorts all faces by area and selects the three biggest ones

wp = (
    wp
    .faces(">Z")
    .sort(lambda face: face.Area())[-3:]
)

Using group and clustering

Select the smallest faces that are within 10 units of each other

wp = (
    wp
    .faces(">Z")
    .group(Cluster(lambda face: face.Area(), tol=10)[0])
)
  • ⚠️group() call will not yet select new objects, but it will create a new workplane object. Selection should be done immediatelly after the grouping. Grouping data will be erased by next manipulation of workplane.

  • selecting a range of groups ([0:2]) works as expected

  • Cluster() defaults to a tolerance of 1e-4

Using last to select newly created faces

A call to .last(everything=False) attempts to select newly created faces. When everything = False it will only select faces that share all their edges with other new faces. In other words: probably the face you'd want to focus on after some operation like extrude, cut or revolve will be selected.

Supplying everything = True will select all faces that are new.

from cq_filter import Workplane

wp = (
    Workplane()
    .rect(5, 5)
    .extrude(2)
    .last()
    .workplane()
)
  • ⚠️ last will not select faces that were modified

Usage

You may want to create your own workplane class if you have multiple mixins

from cq_filter import CQFilterMixin

class Workplane(CQFilterMixin, cq.Workplane):
   pass

If you don't have multiple mixins, then the above class can also be directly imported

from cq_filter import Workplane

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

cq-filter-0.0.3.tar.gz (13.0 kB view details)

Uploaded Source

Built Distribution

cq_filter-0.0.3-py3-none-any.whl (10.9 kB view details)

Uploaded Python 3

File details

Details for the file cq-filter-0.0.3.tar.gz.

File metadata

  • Download URL: cq-filter-0.0.3.tar.gz
  • Upload date:
  • Size: 13.0 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/4.0.1 CPython/3.11.3

File hashes

Hashes for cq-filter-0.0.3.tar.gz
Algorithm Hash digest
SHA256 1d7ee331b190fd1cf7b2ee5c4884105cf3908f76db083620b7d3d0b0a2b8f507
MD5 6bb8678b9dc399eb1d3ec16b2280882b
BLAKE2b-256 361ff99704b929a5464363f6f858d577ff45767ddda2df1ee1b60f49ffca2f17

See more details on using hashes here.

File details

Details for the file cq_filter-0.0.3-py3-none-any.whl.

File metadata

  • Download URL: cq_filter-0.0.3-py3-none-any.whl
  • Upload date:
  • Size: 10.9 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/4.0.1 CPython/3.11.3

File hashes

Hashes for cq_filter-0.0.3-py3-none-any.whl
Algorithm Hash digest
SHA256 27d6fcf188e0379f7dcd72570cac6565561ad78375b94c7195d57bb175f0933a
MD5 fb661a12817f8b4899ad41a3fbbc186f
BLAKE2b-256 c0ccb89b7e9328b13efe4785301b0088b596cd662e1c7a0b8fbb16924ed9e32c

See more details on using hashes here.

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page