GH_Format.FormatVectorValidity Method

GH_FormatFormatVectorValidity Method

If the point is invalid, return a string describing why.

Namespace:  Grasshopper.Kernel
Assembly:  Grasshopper (in Grasshopper.dll)
Syntax
Copy
public static string FormatVectorValidity(
	Vector3d val,
	string identifier = "Vector",
	bool testZero = false,
	bool testUnit = false
)
Public Shared Function FormatVectorValidity ( 
	val As Vector3d,
	Optional identifier As String = "Vector",
	Optional testZero As Boolean = false,
	Optional testUnit As Boolean = false
) As String

Parameters

val
Type: Vector3d
Value to format.
identifier (Optional)
Type: SystemString
Name used to refer to the value in the format.
testZero (Optional)
Type: SystemBoolean
If True, zero-length vectors are considered to be invalid.
testUnit (Optional)
Type: SystemBoolean
If True, non-unit-length vectors are considered to be invalid.

Return Value

Type: String
A string describing why the point is invalid or String.Empty if the value is not invalid.
See Also

M:Grasshopper.Kernel.GH_Format.FormatVectorValidity(Rhino.Geometry.Vector3d,System.String,System.Boolean,System.Boolean)