Click or drag to resize

ICoordinateExtensionsMagnitude Method

[This is preliminary documentation and is subject to change.]

Calculates the magnitude (size or length) of a coordinate (= vector), between origin (0,0,0) and the coordinate itself.

Namespace:  ModelExchanger.AnalysisDataModel.Extensions
Assembly:  ModelExchanger.AnalysisDataModel (in ModelExchanger.AnalysisDataModel.dll) Version: 1.13.0+Branch.master.Sha.d583fc64569355d188a9c0818d257b6d0d3e1339
Syntax
C#
public static Length Magnitude(
	this ICoordinate current
)

Parameters

current
Type: ModelExchanger.Shared.Models.InterfacesICoordinate
The current to calculate the size from

Return Value

Type: Length
The size of the coordinate as a Length unit, with the same unit in which the X,Y and Z values of the coordinate were expressed.

Usage Note

In Visual Basic and C#, you can call this method as an instance method on any object of type ICoordinate. When you use instance method syntax to call this method, omit the first parameter. For more information, see Extension Methods (Visual Basic) or Extension Methods (C# Programming Guide).
Remarks
All values used are expressed in meters
See Also