Header menu logo Euclid

EuclidErrors Module

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

msg : string

fail1 msg a

Full Usage: fail1 msg a

Parameters:
    msg : string
    a : 'T

msg : string
a : 'T

fail2 msg a b

Full Usage: fail2 msg a b

Parameters:
    msg : string
    a : 'T
    b : 'U

msg : string
a : 'T
b : 'U

fail3 msg a b c

Full Usage: fail3 msg a b c

Parameters:
    msg : string
    a : 'T
    b : 'U
    c : 'V

msg : string
a : 'T
b : 'U
c : 'V

failColinear msg a b c

Full Usage: failColinear msg a b c

Parameters:
    msg : string
    a : 'T
    b : 'U
    c : 'V

msg : string
a : 'T
b : 'U
c : 'V

failDivide msg div obj

Full Usage: failDivide msg div obj

Parameters:
    msg : string
    div : float
    obj : 'T

msg : string
div : float
obj : 'T

failEmptySeq funcName arg

Full Usage: failEmptySeq funcName arg

Parameters:
    funcName : string
    arg : string

funcName : string
arg : string

failNaN2 msg x y

Full Usage: failNaN2 msg x y

Parameters:
    msg : string
    x : float
    y : float

msg : string
x : float
y : float

failNaN3 msg x y z

Full Usage: failNaN3 msg x y z

Parameters:
    msg : string
    x : float
    y : float
    z : float

msg : string
x : float
y : float
z : float

failNotOne2 msg x y

Full Usage: failNotOne2 msg x y

Parameters:
    msg : string
    x : float
    y : float

msg : string
x : float
y : float

failNotOne3 msg x y z

Full Usage: failNotOne3 msg x y z

Parameters:
    msg : string
    x : float
    y : float
    z : float

msg : string
x : float
y : float
z : float

failNull funcName arg

Full Usage: failNull funcName arg

Parameters:
    funcName : string
    arg : string

funcName : string
arg : string

failObsolete funName newFunName

Full Usage: failObsolete funName newFunName

Parameters:
    funName : string
    newFunName : string

funName : string
newFunName : string

failObsoleteV30 funName newFunName

Full Usage: failObsoleteV30 funName newFunName

Parameters:
    funName : string
    newFunName : string

funName : string
newFunName : string

failQuat w x y z

Full Usage: failQuat w x y z

Parameters:
    w : float
    x : float
    y : float
    z : float

w : float
x : float
y : float
z : float

failRarr msg xs

Full Usage: failRarr msg xs

Parameters:
    msg : string
    xs : ResizeArray<'T>

msg : string
xs : ResizeArray<'T>

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

Raises an EuclidException when offsetting a 2D rectangle edge fails due to insufficient size.

offStart : 'a
offEnd : 'b
len : 'c
edgeIdx : 'd
d : 'e

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

Raises an EuclidException when offsetting a 3D rectangle edge fails due to insufficient size.

offStart : 'a
offEnd : 'b
len : 'c
edgeIdx : 'd
d : 'e

failRot x y

Full Usage: failRot x y

Parameters:
    x : float
    y : float

x : float
y : float

failTooClose msg this other

Full Usage: failTooClose msg this other

Parameters:
    msg : string
    this : 'T
    other : 'U

msg : string
this : 'T
other : 'U

failTooFewPoly2D name minCount actual

Full Usage: failTooFewPoly2D name minCount actual

Parameters:
    name : string
    minCount : int
    actual : int

name : string
minCount : int
actual : int

failTooFewPoly3D name minCount actual

Full Usage: failTooFewPoly3D name minCount actual

Parameters:
    name : string
    minCount : int
    actual : int

name : string
minCount : int
actual : int

failTooSmall msg this

Full Usage: failTooSmall msg this

Parameters:
    msg : string
    this : 'T

msg : string
this : 'T

failTooSmall2 msg this other

Full Usage: failTooSmall2 msg this other

Parameters:
    msg : string
    this : 'T
    other : 'U

msg : string
this : 'T
other : 'U

failUnit2 msg x y

Full Usage: failUnit2 msg x y

Parameters:
    msg : string
    x : float
    y : float

msg : string
x : float
y : float

failUnit3 msg x y z

Full Usage: failUnit3 msg x y z

Parameters:
    msg : string
    x : float
    y : float
    z : float

msg : string
x : float
y : float
z : float

failVertical msg v

Full Usage: failVertical msg v

Parameters:
    msg : string
    v : 't

msg : string
v : 't

Type something to start searching.