Grasshopper API
Grasshopper.Kernel
GH_Format Class
GH_Format Methods
DefaultCulture Method
FormatAngularDimension Method
FormatAnnotationValidity Method
FormatArc Method
FormatArcValidity Method
FormatBoolean Method
FormatBoundingBoxValidity Method
FormatBox Method
FormatBoxValidity Method
FormatBrep Method
FormatBrepValidity Method
FormatCentermark Method
FormatCircle Method
FormatCircleValidity Method
FormatColour Method
FormatComplexNumber Method
FormatComplexValidity Method
FormatCurve Method
FormatCurveValidity Method
FormatDate Method
FormatDetailView Method
FormatDetailViewValidity Method
FormatDimension Method
FormatDouble Method
FormatDoubleValidity Method
FormatExtrusion Method
FormatExtrusionValidity Method
FormatFilePath Method
FormatGeometry Method
FormatHatch Method
FormatHatchValidity Method
FormatInstanceReference Method
FormatInstanceReferenceValidity Method
FormatInteger Method
FormatInterval Method
FormatIntervalValidity Method
FormatKeys Method
FormatLeader Method
FormatLightValidity Method
FormatLine Method
FormatLinearDimension Method
FormatLineValidity Method
FormatMatrix Method
FormatMesh Method
FormatMeshFace Method
FormatMeshFaceValidity Method
FormatMeshValidity Method
FormatOrdinateDimension Method
FormatPlane Method
FormatPlaneValidity Method
FormatPoint Method
FormatPointCloud Method
FormatPointCloudValidity Method
FormatPointValidity Method
FormatRadialDimension Method
FormatRectangleValidity Method
FormatSingle Method
FormatSubD Method
FormatSubDValidity Method
FormatSurface Method
FormatSurfaceValidity Method
FormatTextDot Method
FormatTextDotValidity Method
FormatTextEntity Method
FormatTransformValidity Method
FormatVector Method
FormatVectorValidity Method
RhinoUnitName Method
RhinoUnitSymbol Method
TreatAsCollection Method
Click or drag to resize

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
)

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