Gets the minimum or maximum distance between this entity and the given face or edge entity (see
Remarks).
.NET Syntax
Visual Basic (Declaration) | |
---|
Function GetDistance( _
ByVal BaseEntity As System.Object, _
ByVal MinDistance As System.Boolean, _
ByVal Parameter As System.Object, _
ByRef Position1 As System.Object, _
ByRef Position2 As System.Object, _
ByRef Distance As System.Double _
) As System.Integer |
Visual Basic (Usage) | |
---|
Dim instance As IEntity
Dim BaseEntity As System.Object
Dim MinDistance As System.Boolean
Dim Parameter As System.Object
Dim Position1 As System.Object
Dim Position2 As System.Object
Dim Distance As System.Double
Dim value As System.Integer
value = instance.GetDistance(BaseEntity, MinDistance, Parameter, Position1, Position2, Distance) |
Parameters
- BaseEntity
- IEntity of another edge or face to get distance from this entity (see Remarks)
- MinDistance
- True to return minimum distance between entities; false to return maximum distance between entities
- Parameter
If MinDistance = False,
- and BaseEntity is an edge or curve, specify an array of two doubles (Min, Max), where Min and Max make up the U-parameter range of BaseEntity
- and BaseEntity is a face, specify an array of four doubles (UMin, VMin, UMax, VMax), where UMin, VMin, UMax, and VMax make up the UV-parameter range of the surface of BaseEntity
If MinDistance = True,
- and BaseEntity is an edge or curve, optionally specify an array of two doubles (Min, Max), where Min and Max make up the U-parameter range of BaseEntity
- and BaseEntity is a face, optionally specify an array of four doubles (UMin, VMin, UMax, VMax), where UMin, VMin, UMax, and VMax make up the UV-parameter range of the surface of BaseEntity
- Position1
- Array of doubles; coordinates of this entity that were used to measure the distance
- Position2
- Array of doubles; coordinates of BaseEntity that were used to measure the distance
- Distance
- Minimum or maximum distance between entities; if Parameter is not specified, minimum distance
Return Value
0 if success; -1 if failure
Example
Remarks
See Also
Availability
SOLIDWORKS 2009 SP5, Revision Number 17.5