Search
Preparing search index...
The search index is not available
XStream HDVR WebSDK Getting Started
Options
All
Public
Inherited
Only exported
Menu
Globals
Fovia
Util
Module Util
Index
Classes
Color
Matrix
Plane
Point
Presets
Rect
Size
Vector
Variables
X_
NEG
X_
POS
Y_
NEG
Y_
POS
Z_
NEG
Z_
POS
rescale
Intercept
rescale
Slope
Functions
Intersects
Matrix
Multiply
angle
cross
cut
Plane
Affects
Volume
display
ToStored
Unit
dot
encode
ToBase64
euclidean
Distance
get
Converted
View
Angle
get
Pixels
Per
Millimeter
get
Plane
EquationT
getURLParam
getURLParam
AsNumber
get
Volume
Box
Points
getsigned
Distance
Pointand
Plane
is
Number
length
localize
Event
normalize
render
Image
Loc2
Volume
Coordinates
rotate
Matrix
stored
ToDisplay
Units
vector
Difference
volume2
Projection
Plane
Perspective
Variables
X_
NEG
X_
NEG
:
number
= 1
X_
POS
X_
POS
:
number
= 0
Y_
NEG
Y_
NEG
:
number
= 3
Y_
POS
Y_
POS
:
number
= 2
Z_
NEG
Z_
NEG
:
number
= 5
Z_
POS
Z_
POS
:
number
= 4
rescale
Intercept
rescale
Intercept
:
number
= 0
rescale
Slope
rescale
Slope
:
number
= 1
Functions
Intersects
Intersects
(
box
:
Vector
[]
, plane
:
Plane
)
:
string
Parameters
box:
Vector
[]
plane:
Plane
Returns
string
Matrix
Multiply
Matrix
Multiply
(
A
:
any
, B
:
any
)
:
Matrix
Parameters
A:
any
B:
any
Returns
Matrix
angle
angle
(
vec1
:
any
, vec2
:
any
)
:
number
Parameters
vec1:
any
vec2:
any
Returns
number
cross
cross
(
vec1
:
Vector
, vec2
:
Vector
)
:
Vector
cross
(
vec1
:
Vector
, vec2
:
Vector
)
:
Vector
Parameters
vec1:
Vector
vec2:
Vector
Returns
Vector
Parameters
vec1:
Vector
vec2:
Vector
Returns
Vector
cut
Plane
Affects
Volume
cut
Plane
Affects
Volume
(
plane
:
Plane
, vbp
:
Vector
[]
, vbpArrayLen
:
number
, fudgeFactor
:
number
)
:
boolean
Parameters
plane:
Plane
vbp:
Vector
[]
vbpArrayLen:
number
fudgeFactor:
number
Returns
boolean
display
ToStored
Unit
display
ToStored
Unit
(
du
:
number
, slope
?:
number
, intercept
?:
number
)
:
number
Parameters
du:
number
Default value
slope:
number
= rescaleSlope
Default value
intercept:
number
= rescaleIntercept
Returns
number
dot
dot
(
vec1
:
Vector
, vec2
:
Vector
)
:
number
dot
(
vec1
:
Vector
, vec2
:
Vector
)
:
number
Parameters
vec1:
Vector
vec2:
Vector
Returns
number
Parameters
vec1:
Vector
vec2:
Vector
Returns
number
encode
ToBase64
encode
ToBase64
(
input
:
any
)
:
string
Parameters
input:
any
Returns
string
euclidean
Distance
euclidean
Distance
(
pos1
:
Vector
, pos2
:
Vector
)
:
number
euclidean
Distance
(
pos1
:
Vector
, pos2
:
Vector
)
:
number
Parameters
pos1:
Vector
pos2:
Vector
Returns
number
Parameters
pos1:
Vector
pos2:
Vector
Returns
number
get
Converted
View
Angle
get
Converted
View
Angle
(
imgSize
:
Size
, viewAngle
:
number
)
:
number
Parameters
imgSize:
Size
viewAngle:
number
Returns
number
get
Pixels
Per
Millimeter
get
Pixels
Per
Millimeter
(
spacingX
:
number
, zoom
:
number
)
:
number
Parameters
spacingX:
number
zoom:
number
Returns
number
get
Plane
EquationT
get
Plane
EquationT
(
transform
:
Matrix
)
:
Plane
Parameters
transform:
Matrix
Returns
Plane
getURLParam
getURLParam
(
name
:
any
, w
?:
any
)
:
any
Parameters
name:
any
Optional
w:
any
Returns
any
getURLParam
AsNumber
getURLParam
AsNumber
(
name
:
any
, w
?:
any
)
:
number
Parameters
name:
any
Optional
w:
any
Returns
number
get
Volume
Box
Points
get
Volume
Box
Points
(
vdp
:
VolumeDataContext
)
:
Vector
[]
Parameters
vdp:
VolumeDataContext
Returns
Vector
[]
getsigned
Distance
Pointand
Plane
getsigned
Distance
Pointand
Plane
(
point
:
Vector
, plane
:
Plane
)
:
number
Parameters
point:
Vector
plane:
Plane
Returns
number
is
Number
is
Number
(
obj
:
any
)
:
boolean
Parameters
obj:
any
Returns
boolean
length
length
(
vector
:
Vector
)
:
number
length
(
vector
:
Vector
)
:
number
Parameters
vector:
Vector
Returns
number
Parameters
vector:
Vector
Returns
number
localize
Event
localize
Event
(
event
:
any
, offsetX
:
number
, offsetY
:
number
)
:
MouseEvent
Parameters
event:
any
offsetX:
number
offsetY:
number
Returns
MouseEvent
normalize
normalize
(
vector
:
Vector
)
:
Vector
Parameters
vector:
Vector
Returns
Vector
render
Image
Loc2
Volume
Coordinates
render
Image
Loc2
Volume
Coordinates
(
x
:
number
, y
:
number
, transform
:
Matrix
, imgSize
:
Size
, zoom
:
number
, vdp
:
VolumeDataContext
)
:
Vector
Parameters
x:
number
y:
number
transform:
Matrix
imgSize:
Size
zoom:
number
vdp:
VolumeDataContext
Returns
Vector
rotate
Matrix
rotate
Matrix
(
angle
:
number
, vector
:
Vector
)
:
Matrix
Parameters
angle:
number
vector:
Vector
Returns
Matrix
stored
ToDisplay
Units
stored
ToDisplay
Units
(
su
:
number
, slope
?:
number
, intercept
?:
number
)
:
number
Parameters
su:
number
Default value
slope:
number
= rescaleSlope
Default value
intercept:
number
= rescaleIntercept
Returns
number
vector
Difference
vector
Difference
(
vec1
:
any
, vec2
:
any
)
:
Vector
Parameters
vec1:
any
vec2:
any
Returns
Vector
volume2
Projection
Plane
Perspective
volume2
Projection
Plane
Perspective
(
x
:
number
, y
:
number
, z
:
number
, transform
:
Matrix
, imgSize
:
Size
, convertedViewAngle
:
number
)
:
Vector
Parameters
x:
number
y:
number
z:
number
transform:
Matrix
imgSize:
Size
convertedViewAngle:
number
Returns
Vector
Globals
Fovia
Fovia.UI
Fovia.
Util
Fovia
Private
Generated using
TypeDoc