DocumentClash.TryCalculateMinimumClearance Method

Calculates the minimum clearance between two object selections, using object center- lines (if requested and if the center-line geometry is available).

Namespace: Autodesk.Navisworks.Api.Clash
Assembly: Autodesk.Navisworks.Clash (in Autodesk.Navisworks.Clash.dll)

Syntax

Visual Basic
Public Function TryCalculateMinimumClearance ( _
	selection1 As ModelItemCollection, _
	selection2 As ModelItemCollection, _
	useCenterlines As Boolean, _
	<OutAttribute> ByRef clearanceResult As MinimumClearanceResult _
) As Boolean
C#
public bool TryCalculateMinimumClearance(
	ModelItemCollection selection1,
	ModelItemCollection selection2,
	bool useCenterlines,
	out MinimumClearanceResult clearanceResult
)
Visual C++
public:
bool TryCalculateMinimumClearance(
	ModelItemCollection^ selection1, 
	ModelItemCollection^ selection2, 
	bool useCenterlines, 
	[OutAttribute] MinimumClearanceResult^% clearanceResult
)

Parameters

selection1
Type: Autodesk.Navisworks.Api..::..ModelItemCollection
The first collection of model objects.
selection2
Type: Autodesk.Navisworks.Api..::..ModelItemCollection
The second collection of model objects.
useCenterlines
Type: System..::..Boolean
True if center-line geometry should be used in the calculation, otherwise false.
clearanceResult
Type: Autodesk.Navisworks.Api.Clash..::..MinimumClearanceResult%
Output object defining the shortest distance between the two object collections.

Return Value

True if the minimum clearance can be determined, otherwise false.

Exceptions

ExceptionCondition
System..::..ArgumentExceptionif either selection1 or selection2 is null or empty.

See Also

M:Autodesk.Navisworks.Api.Clash.DocumentClash.TryCalculateMinimumClearance(Autodesk.Navisworks.Api.ModelItemCollection,Autodesk.Navisworks.Api.ModelItemCollection,System.Boolean,Autodesk.Navisworks.Api.Clash.MinimumClearanceResult@)