如视 Five SDK
Preparing search index...
plugins
Object3DHelperPluginType
BaseHelper
Interface BaseHelper<OriginObject3D>
Abstract
interface
BaseHelper
<
OriginObject3D
extends
Object3D
=
Object3D
>
{
get
helperObject
()
:
Object3D
;
add
(
...
objects
:
Object3D
[]
)
:
BaseHelper
<
OriginObject3D
>
;
addIfNotExists
(
...
objects
:
Object3D
[]
)
:
BaseHelper
<
OriginObject3D
>
;
applyHelperQuaternion
(
quaternion
:
Quaternion
,
origin
?:
Vector3
)
:
void
;
applyHelperScaleMatrix4
(
matrix
:
Matrix4
,
origin
?:
Vector3
)
:
void
;
disable
()
:
void
;
dispose
()
:
void
;
enable
()
:
void
;
hide
()
:
void
;
initialPosition
(
offset
?:
Vector3
)
:
void
;
initQuaternion
(
config
?:
{
xAxis
?:
Vector3
|
(
()
=>
Vector3
)
;
yAxis
?:
Vector3
|
(
()
=>
Vector3
)
;
zAxis
?:
Vector3
|
(
()
=>
Vector3
)
;
}
,
)
:
void
;
raycasterIntersectObject
(
raycaster
:
Raycaster
,
intersection
?:
Intersection
[]
,
)
:
Intersection
[]
;
remove
(
...
objects
:
Object3D
[]
)
:
BaseHelper
<
OriginObject3D
>
;
removeChildren
()
:
BaseHelper
<
OriginObject3D
>
;
removeFromParent
()
:
BaseHelper
<
OriginObject3D
>
;
render
()
:
void
;
setHelperQuaternion
(
quaternion
:
Quaternion
,
origin
?:
Vector3
)
:
void
;
setScaleByCamera
(
camera
:
PerspectiveCamera
|
OrthographicCamera
)
:
void
;
show
()
:
void
;
}
Type Parameters
OriginObject3D
extends
Object3D
=
Object3D
Hierarchy (
View Summary
)
Object3D
BaseHelper
MoveHelperAbstract
RotateHelperAbstract
Index
Accessors
helper
Object
Methods
add
add
If
Not
Exists
apply
Helper
Quaternion
apply
Helper
Scale
Matrix4
disable
dispose
enable
hide
initial
Position
init
Quaternion
raycaster
Intersect
Object
remove
remove
Children
remove
From
Parent
render
set
Helper
Quaternion
set
Scale
By
Camera
show
Accessors
helper
Object
get
helperObject
()
:
Object3D
Returns
Object3D
Methods
add
add
(
...
objects
:
Object3D
[]
)
:
BaseHelper
<
OriginObject3D
>
Adds object as child of this object.
Parameters
...
objects
:
Object3D
[]
Returns
BaseHelper
<
OriginObject3D
>
add
If
Not
Exists
addIfNotExists
(
...
objects
:
Object3D
[]
)
:
BaseHelper
<
OriginObject3D
>
Parameters
...
objects
:
Object3D
[]
Returns
BaseHelper
<
OriginObject3D
>
apply
Helper
Quaternion
applyHelperQuaternion
(
quaternion
:
Quaternion
,
origin
?:
Vector3
)
:
void
Parameters
quaternion
:
Quaternion
Optional
origin
:
Vector3
Returns
void
apply
Helper
Scale
Matrix4
applyHelperScaleMatrix4
(
matrix
:
Matrix4
,
origin
?:
Vector3
)
:
void
Parameters
matrix
:
Matrix4
Optional
origin
:
Vector3
Returns
void
disable
disable
()
:
void
Returns
void
dispose
dispose
()
:
void
Returns
void
enable
enable
()
:
void
Returns
void
hide
hide
()
:
void
Returns
void
initial
Position
initialPosition
(
offset
?:
Vector3
)
:
void
Parameters
Optional
offset
:
Vector3
Returns
void
init
Quaternion
initQuaternion
(
config
?:
{
xAxis
?:
Vector3
|
(
()
=>
Vector3
)
;
yAxis
?:
Vector3
|
(
()
=>
Vector3
)
;
zAxis
?:
Vector3
|
(
()
=>
Vector3
)
;
}
,
)
:
void
Parameters
Optional
config
:
{
xAxis
?:
Vector3
|
(
()
=>
Vector3
)
;
yAxis
?:
Vector3
|
(
()
=>
Vector3
)
;
zAxis
?:
Vector3
|
(
()
=>
Vector3
)
;
}
Returns
void
raycaster
Intersect
Object
raycasterIntersectObject
(
raycaster
:
Raycaster
,
intersection
?:
Intersection
[]
,
)
:
Intersection
[]
Parameters
raycaster
:
Raycaster
intersection
:
Intersection
[]
= []
Returns
Intersection
[]
remove
remove
(
...
objects
:
Object3D
[]
)
:
BaseHelper
<
OriginObject3D
>
Removes object as child of this object.
Parameters
...
objects
:
Object3D
[]
Returns
BaseHelper
<
OriginObject3D
>
remove
Children
removeChildren
()
:
BaseHelper
<
OriginObject3D
>
Returns
BaseHelper
<
OriginObject3D
>
remove
From
Parent
removeFromParent
()
:
BaseHelper
<
OriginObject3D
>
Returns
BaseHelper
<
OriginObject3D
>
render
render
()
:
void
Returns
void
set
Helper
Quaternion
setHelperQuaternion
(
quaternion
:
Quaternion
,
origin
?:
Vector3
)
:
void
Parameters
quaternion
:
Quaternion
Optional
origin
:
Vector3
Returns
void
set
Scale
By
Camera
setScaleByCamera
(
camera
:
PerspectiveCamera
|
OrthographicCamera
)
:
void
Parameters
camera
:
PerspectiveCamera
|
OrthographicCamera
Returns
void
show
show
()
:
void
Returns
void
Settings
Member Visibility
Inherited
Theme
OS
Light
Dark
On This Page
Accessors
helper
Object
Methods
add
add
If
Not
Exists
apply
Helper
Quaternion
apply
Helper
Scale
Matrix4
disable
dispose
enable
hide
initial
Position
init
Quaternion
raycaster
Intersect
Object
remove
remove
Children
remove
From
Parent
render
set
Helper
Quaternion
set
Scale
By
Camera
show
如视 Five SDK
Loading...
Adds object as child of this object.