ThreePipe
Preparing search index...
HDRiGroundPlugin
Class HDRiGroundPlugin
Base Class for Sync Viewer Plugins
Hierarchy (
View Summary
)
AViewerPluginSync
HDRiGroundPlugin
Index
Constructors
constructor
Properties
_
dirty
_
viewer?
_
viewer
Listeners
constructor
enabled
origin
Position
prompt
On
Background
Mismatch
tripod
Height
ui
Config?
world
Radius
Old
Plugin
Type?
Plugin
Type
Accessors
dirty
Methods
_
on
Viewer
Event
_
store
Key
disable
dispose
enable
export
State
from
JSON
import
State
is
Disabled
on
Added
on
Remove
set
Dirty
to
JSON
Constructors
constructor
new
HDRiGroundPlugin
(
enabled
?:
boolean
,
promptOnBackgroundMismatch
?:
boolean
,
)
:
HDRiGroundPlugin
Parameters
enabled
:
boolean
= false
promptOnBackgroundMismatch
:
boolean
= true
Returns
HDRiGroundPlugin
Properties
Protected
_
dirty
_dirty
:
boolean
= false
Protected
Optional
_
viewer
_viewer
?:
ThreeViewer
Protected
_
viewer
Listeners
_viewerListeners
:
PartialRecord
<
IViewerEventTypes
,
(
e
:
IViewerEvent
)
=>
void
>
= {}
constructor
constructor
:
typeof
AViewerPluginSync
&
typeof
AViewerPlugin
enabled
enabled
:
boolean
= false
origin
Position
originPosition
:
Vector3
= ...
prompt
On
Background
Mismatch
promptOnBackgroundMismatch
:
boolean
= true
tripod
Height
tripodHeight
:
number
= 10
Optional
ui
Config
uiConfig
?:
UiObjectConfig
<
any
,
string
,
any
>
= undefined
world
Radius
worldRadius
:
number
= 100
Static
Optional
Readonly
Old
Plugin
Type
OldPluginType
?:
string
Static
Readonly
Plugin
Type
PluginType
:
"HDRiGroundPlugin"
= 'HDRiGroundPlugin'
Accessors
dirty
get
dirty
()
:
boolean
Returns
boolean
set
dirty
(
value
:
boolean
)
:
void
Parameters
value
:
boolean
Returns
void
Methods
Protected
_
on
Viewer
Event
_onViewerEvent
(
e
:
IViewerEvent
)
:
IViewerEvent
Parameters
e
:
IViewerEvent
Returns
IViewerEvent
Protected
_
store
Key
_storeKey
(
prefix
?:
string
)
:
string
Parameters
Optional
prefix
:
string
Returns
string
disable
disable
(
key
:
any
,
setDirty
?:
boolean
)
:
void
Parameters
key
:
any
setDirty
:
boolean
= true
Returns
void
dispose
dispose
()
:
void
Returns
void
enable
enable
(
key
:
any
,
setDirty
?:
boolean
)
:
void
Parameters
key
:
any
setDirty
:
boolean
= true
Returns
void
export
State
exportState
()
:
ISerializedConfig
|
Record
<
string
,
never
>
Returns
ISerializedConfig
|
Record
<
string
,
never
>
from
JSON
fromJSON
(
data
:
ISerializedConfig
,
meta
?:
SerializationMetaType
,
)
:
null
|
HDRiGroundPlugin
|
Promise
<
null
|
HDRiGroundPlugin
>
Parameters
data
:
ISerializedConfig
Optional
meta
:
SerializationMetaType
Returns
null
|
HDRiGroundPlugin
|
Promise
<
null
|
HDRiGroundPlugin
>
import
State
importState
(
state
:
any
)
:
Promise
<
void
>
Parameters
state
:
any
Returns
Promise
<
void
>
is
Disabled
isDisabled
()
:
boolean
Returns
boolean
on
Added
onAdded
(
viewer
:
ThreeViewer
)
:
void
Parameters
viewer
:
ThreeViewer
Returns
void
on
Remove
onRemove
(
viewer
:
ThreeViewer
)
:
void
Parameters
viewer
:
ThreeViewer
Returns
void
set
Dirty
setDirty
()
:
void
Returns
void
to
JSON
toJSON
(
meta
?:
SerializationMetaType
)
:
ISerializedConfig
Parameters
Optional
meta
:
SerializationMetaType
Returns
ISerializedConfig
Settings
Member Visibility
Protected
Inherited
Theme
OS
Light
Dark
On This Page
Constructors
constructor
Properties
_
dirty
_
viewer
_
viewer
Listeners
constructor
enabled
origin
Position
prompt
On
Background
Mismatch
tripod
Height
ui
Config
world
Radius
Old
Plugin
Type
Plugin
Type
Accessors
dirty
Methods
_
on
Viewer
Event
_
store
Key
disable
dispose
enable
export
State
from
JSON
import
State
is
Disabled
on
Added
on
Remove
set
Dirty
to
JSON
ThreePipe
Loading...
Base Class for Sync Viewer Plugins