Class NwcClashRule

Namespace

NwcIO.Model.Clash

Assembly

NwcIO.dll

A rule that excludes specific pairs of elements from clash reporting.

public sealed class NwcClashRule

Inheritance

object

NwcClashRule

Inherited Members

object.Equals(object?)

object.Equals(object?, object?)

object.GetHashCode()

object.GetType()

object.ReferenceEquals(object?, object?)

object.ToString()

Constructors

NwcClashRule()

public NwcClashRule()

NwcClashRule(string, NwcClashRuleType, bool)

public NwcClashRule(string name, NwcClashRuleType ruleType, bool enabled = true)

Parameters

name string

ruleType NwcClashRuleType

enabled bool

Properties

CustomPredicate

public Func<NwcClashResult, bool>? CustomPredicate { get; set; }

Property Value

Func<NwcClashResult, bool>?

Enabled

public bool Enabled { get; set; }

Property Value

bool

Name

public string Name { get; set; }

Property Value

string

PropertyName

public string? PropertyName { get; set; }

Property Value

string?

PropertyValue

public string? PropertyValue { get; set; }

Property Value

string?

RuleType

public NwcClashRuleType RuleType { get; set; }

Property Value

NwcClashRuleType

SetA

public string? SetA { get; set; }

Property Value

string?

SetB

public string? SetB { get; set; }

Property Value

string?

Threshold

public double Threshold { get; set; }

Property Value

double

Methods

MinPenetration(double, bool)

Creates a rule that ignores clashes with penetration depth below a threshold.

public static NwcClashRule MinPenetration(double minPenetration, bool enabled = true)

Parameters

minPenetration double

enabled bool

Returns

NwcClashRule

SameFile(bool)

Creates a rule that ignores clashes between elements in the same file/model.

public static NwcClashRule SameFile(bool enabled = true)

Parameters

enabled bool

Returns

NwcClashRule

SameGroup(bool)

Creates a rule that ignores clashes between elements in the same group or parent composite node.

public static NwcClashRule SameGroup(bool enabled = true)

Parameters

enabled bool

Returns

NwcClashRule

SameLayer(bool)

Creates a rule that ignores clashes between elements on the same layer.

public static NwcClashRule SameLayer(bool enabled = true)

Parameters

enabled bool

Returns

NwcClashRule

ShouldIgnore(NwcClashResult)

Evaluates whether a detected clash should be ignored according to this rule.

public bool ShouldIgnore(NwcClashResult clash)

Parameters

clash NwcClashResult

Returns

bool