EuclidErrors (Euclid)

EuclidErrors Module

Namespace: Euclid
Assembly: Euclid.dll

An internal module for Euclid specific exceptions and failure functions.

Types

Type	Description
EuclidDivByZeroException	Exception for attempting to divide by a 0.0 or almost 0.0 value. Almost 0.0 is defined by UtilEuclid.zeroLengthTolerance as 1e-12.
EuclidEmptySeqException	Exception for empty sequences in inputs.
EuclidException	Exception in Euclid.
EuclidNanInfinityException	Exception for NaN or Infinity values in inputs.
EuclidNullException	Exception for null references in inputs.
EuclidObsoleteException	Exception for Obsolete features.
EuclidTooSmallException	Exception for too small input values that don't give a clear vector direction.
EuclidUnitizingException	Exception for attempting to divide by a 0.0 or almost 0.0 value during Unitizing Almost 0.0 is defined by UtilEuclid.zeroLengthTolerance as 1e-12.

Functions and values

Function or value	Description
`fail msg` Full Usage: `fail msg` Parameters: msg : `string` Returns: `'Failed`	msg : `string` Returns: `'Failed`
`fail1 msg a` Full Usage: `fail1 msg a` Parameters: msg : `string` a : `'T` Returns: `'Failed`	msg : `string` a : `'T` Returns: `'Failed`
`fail2 msg a b` Full Usage: `fail2 msg a b` Parameters: msg : `string` a : `'T` b : `'U` Returns: `'Failed`	msg : `string` a : `'T` b : `'U` Returns: `'Failed`
`fail3 msg a b c` Full Usage: `fail3 msg a b c` Parameters: msg : `string` a : `'T` b : `'U` c : `'V` Returns: `'Failed`	msg : `string` a : `'T` b : `'U` c : `'V` Returns: `'Failed`
`failColinear msg a b c` Full Usage: `failColinear msg a b c` Parameters: msg : `string` a : `'T` b : `'U` c : `'V` Returns: `'Failed`	msg : `string` a : `'T` b : `'U` c : `'V` Returns: `'Failed`
`failDivide msg div obj` Full Usage: `failDivide msg div obj` Parameters: msg : `string` div : `float` obj : `'T` Returns: `'Failed`	msg : `string` div : `float` obj : `'T` Returns: `'Failed`
`failEmptySeq funcName arg` Full Usage: `failEmptySeq funcName arg` Parameters: funcName : `string` arg : `string` Returns: `'Failed`	funcName : `string` arg : `string` Returns: `'Failed`
`failNaN2 msg x y` Full Usage: `failNaN2 msg x y` Parameters: msg : `string` x : `float` y : `float` Returns: `'Failed`	msg : `string` x : `float` y : `float` Returns: `'Failed`
`failNaN3 msg x y z` Full Usage: `failNaN3 msg x y z` Parameters: msg : `string` x : `float` y : `float` z : `float` Returns: `'Failed`	msg : `string` x : `float` y : `float` z : `float` Returns: `'Failed`
`failNotOne2 msg x y` Full Usage: `failNotOne2 msg x y` Parameters: msg : `string` x : `float` y : `float` Returns: `'Failed`	msg : `string` x : `float` y : `float` Returns: `'Failed`
`failNotOne3 msg x y z` Full Usage: `failNotOne3 msg x y z` Parameters: msg : `string` x : `float` y : `float` z : `float` Returns: `'Failed`	msg : `string` x : `float` y : `float` z : `float` Returns: `'Failed`
`failNull funcName arg` Full Usage: `failNull funcName arg` Parameters: funcName : `string` arg : `string` Returns: `'Failed`	funcName : `string` arg : `string` Returns: `'Failed`
`failObsolete funName newFunName` Full Usage: `failObsolete funName newFunName` Parameters: funName : `string` newFunName : `string` Returns: `'Failed`	funName : `string` newFunName : `string` Returns: `'Failed`
`failObsoleteV30 funName newFunName` Full Usage: `failObsoleteV30 funName newFunName` Parameters: funName : `string` newFunName : `string` Returns: `'Failed`	funName : `string` newFunName : `string` Returns: `'Failed`
`failQuat w x y z` Full Usage: `failQuat w x y z` Parameters: w : `float` x : `float` y : `float` z : `float` Returns: `'Failed`	w : `float` x : `float` y : `float` z : `float` Returns: `'Failed`
`failRarr msg xs` Full Usage: `failRarr msg xs` Parameters: msg : `string` xs : `ResizeArray<'T>` Returns: `'Failed`	msg : `string` xs : `ResizeArray<'T>` Returns: `'Failed`
`failRect2DOffsetEdge (offStart, offEnd, len, edgeIdx, d)` Full Usage: `failRect2DOffsetEdge (offStart, offEnd, len, edgeIdx, d)` Parameters: offStart : `'a` offEnd : `'b` len : `'c` edgeIdx : `'d` d : `'e` Returns: `'Failed`	Raises an EuclidException when offsetting a 2D rectangle edge fails due to insufficient size. offStart : `'a` offEnd : `'b` len : `'c` edgeIdx : `'d` d : `'e` Returns: `'Failed`
`failRect3DOffsetEdge (offStart, offEnd, len, edgeIdx, d)` Full Usage: `failRect3DOffsetEdge (offStart, offEnd, len, edgeIdx, d)` Parameters: offStart : `'a` offEnd : `'b` len : `'c` edgeIdx : `'d` d : `'e` Returns: `'Failed`	Raises an EuclidException when offsetting a 3D rectangle edge fails due to insufficient size. offStart : `'a` offEnd : `'b` len : `'c` edgeIdx : `'d` d : `'e` Returns: `'Failed`
`failRot x y` Full Usage: `failRot x y` Parameters: x : `float` y : `float` Returns: `'Failed`	x : `float` y : `float` Returns: `'Failed`
`failTooClose msg this other` Full Usage: `failTooClose msg this other` Parameters: msg : `string` this : `'T` other : `'U` Returns: `'Failed`	msg : `string` this : `'T` other : `'U` Returns: `'Failed`
`failTooFewPoly2D name minCount actual` Full Usage: `failTooFewPoly2D name minCount actual` Parameters: name : `string` minCount : `int` actual : `int` Returns: `'Failed`	name : `string` minCount : `int` actual : `int` Returns: `'Failed`
`failTooFewPoly3D name minCount actual` Full Usage: `failTooFewPoly3D name minCount actual` Parameters: name : `string` minCount : `int` actual : `int` Returns: `'Failed`	name : `string` minCount : `int` actual : `int` Returns: `'Failed`
`failTooSmall msg this` Full Usage: `failTooSmall msg this` Parameters: msg : `string` this : `'T` Returns: `'Failed`	msg : `string` this : `'T` Returns: `'Failed`
`failTooSmall2 msg this other` Full Usage: `failTooSmall2 msg this other` Parameters: msg : `string` this : `'T` other : `'U` Returns: `'Failed`	msg : `string` this : `'T` other : `'U` Returns: `'Failed`
`failUnit2 msg x y` Full Usage: `failUnit2 msg x y` Parameters: msg : `string` x : `float` y : `float` Returns: `'Failed`	msg : `string` x : `float` y : `float` Returns: `'Failed`
`failUnit3 msg x y z` Full Usage: `failUnit3 msg x y z` Parameters: msg : `string` x : `float` y : `float` z : `float` Returns: `'Failed`	msg : `string` x : `float` y : `float` z : `float` Returns: `'Failed`
`failVertical msg v` Full Usage: `failVertical msg v` Parameters: msg : `string` v : `'t` Returns: `'Failed`	msg : `string` v : `'t` Returns: `'Failed`