Interactions

Contact

compas_model.interactions.contact

Classes

Contact

Contact(
    points: list[Point] | None = None,
    region: PlanarRegion | None = None,
    frame: Frame | None = None,
    size: float | None = None,
    mesh: Mesh | None = None,
    holes: list[Polygon] | None = None,
    name: str | None = None,
)

Class representing a planar contact between two elements.

Parameters:

• points (list[Point] | None, default: None ) –

  The points defining the exterior contact polygon. Required only when region is omitted.

• region (PlanarRegion | None, default: None ) –

  The authoritative planar contact region.

• frame (Frame | None, default: None ) –

  The local coordinate system of the contact.

• size (float | None, default: None ) –

  Deprecated compatibility parameter. Contact size is derived from the net area of region.

• mesh (Mesh | None, default: None ) –

  The mesh representation of the contact surface.

• holes (list[Polygon] | None, default: None ) –

  Holes in the contact polygon.

• name (str | None, default: None ) –

  A human-readable name.

Warnings

The definition of contact surfaces is under active development and may change frequently.

Attributes

geometry property

geometry: PlanarRegion

PlanarRegion: The complete contact region, including holes.

holes property

holes: list[Polygon]

list[Polygon]: The interior boundaries of the contact region.

polygon property

polygon: Polygon

Polygon: The exterior boundary of the contact region.

region property

region: PlanarRegion

PlanarRegion: The authoritative planar contact geometry.