Class ClashResult

Namespace: GeometryHelper.Clash

Assembly: GeometryHelper.dll

One pair of parts a clash check found, and what they do to each other.

public sealed class ClashResult

Inheritance: object

ClashResult

Inherited Members: object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.ReferenceEquals(object, object)

Properties

Contact: Gets where the two lie against each other, face to face, for a Touch; empty where they meet only along an edge or at a corner, and for every other kind.

ContactArea: Gets the area of Contact.

Depth: Gets how deep the two run into each other, for a Hard clash; nought otherwise.

Distance: Gets how far apart the two are: the gap for Clearance, nought otherwise.

Error: Gets what went wrong checking the pair, for Unresolved; null otherwise.

First: Gets the index of the first part of the pair: in the one list checked, the lower index; with two lists, the index in the first.

Gap: Gets the shortest segment across the gap for Clearance; null otherwise.

Kind: Gets what the two do to each other.

LengthInside: Gets how much of a bar's centre line runs inside the part, for a bar checked by its centre line (ClashBar); nought where the centre line stays outside, and for two bodies.

Location: Gets where the clash is: the centre of the volume shared, the centre of the contact, the middle of the gap left, or for a pair that could not be checked, the middle of the space the two boxes share.

Overlaps: Gets the regions the two share, one body per region, for a Hard clash; empty otherwise, and for a bar checked by its centre line, whose clashes are measured and not built. A clash reported as touching for being shallower than MinimumDepth or smaller than MinimumVolume keeps them.

Second: Gets the index of the second part of the pair: in the one list checked, the higher index; with two lists, the index in the second.

Volume: Gets how much volume the two share; nought unless the clash is Hard, and for a bar checked by its centre line. A clash reported as touching for being too shallow or too small keeps it.

Methods

ToString()

Edit this page