new ViewGoPro(viewer, optionsnullable)
GoPro view class.
Parameters:
| Name | Type | Attributes | Description |
|---|---|---|---|
viewer |
FORGE.Viewer | FORGE.Viewer reference. | |
options |
ViewOptionsConfig |
<nullable> |
The view options. |
- Source:
Extends
Members
(readonly) alive :boolean
Get the alive flag value of the object.
Type:
- boolean
- Inherited From:
- Source:
(readonly) className :string
Get the class name of the object.
Type:
- string
- Inherited From:
- Source:
data :*
Get and set any custom data you want to associate to this object.
Type:
- *
- Inherited From:
- Source:
debug :boolean
Get and set the debug flag.
Type:
- boolean
- Inherited From:
- Source:
(readonly) fovMax :number
Get maximum fov for current view in radians.
Type:
- number
- Inherited From:
- Source:
(readonly) fovMin :number
Get minimum fov for current view in radians.
Type:
- number
- Inherited From:
- Source:
(readonly) onDestroy :FORGE.EventDispatcher
Get the onDestroy FORGE.EventDispatcher, this event is emitted at the end of the destroy sequence.
Type:
- Inherited From:
- Source:
(readonly) options :ViewOptionsConfig
Options getter
Type:
- ViewOptionsConfig
- Inherited From:
- Source:
pitchMax :number
Get the maximum pitch value in radians.
Type:
- number
- Inherited From:
- Source:
pitchMin :number
Get the minimum pitch value in radians.
Type:
- number
- Inherited From:
- Source:
rollMax :number
Get the maximum roll value in radians.
Type:
- number
- Inherited From:
- Source:
rollMin :number
Get the minimum roll value in radians.
Type:
- number
- Inherited From:
- Source:
(readonly) shaderSTW :ScreenToWorldProgram
Shader screen to world
Type:
- ScreenToWorldProgram
- Inherited From:
- Source:
(readonly) shaderWTS :WorldToScreenProgram
Shader world to screen
Type:
- WorldToScreenProgram
- Inherited From:
- Source:
(readonly) tags :Array
Get the tags associated to this object.
Type:
- Array
- Inherited From:
- Source:
(readonly) type :string
Get the view type.
Type:
- string
- Inherited From:
- Source:
(readonly) uid :string
Get the uid of the object.
Type:
- string
- Inherited From:
- Source:
warning :boolean
Get and set the warning flag.
Type:
- boolean
- Inherited From:
- Source:
yawMax :number
Get the maximum yaw value in radians.
Type:
- number
- Inherited From:
- Source:
yawMin :number
Get the minimum yaw value in radians.
Type:
- number
- Inherited From:
- Source:
Methods
destroy()
Destroy method.
- Overrides:
- Source:
getProjectionFov()
Get fov computed for projection.
- Overrides:
- Source:
log(value)
Basic log method, log a string in the console if debug is enabled.
Parameters:
| Name | Type | Description |
|---|---|---|
value |
* | The value you want to log in the console. |
- Inherited From:
- Source:
screenToWorld(screenPt) → (nullable) {THREE.Vector3}
Convert a point from screen space to world space.
Parameters:
| Name | Type | Description |
|---|---|---|
screenPt |
THREE.Vector2 | 2D point in screen space [0..w, 0..h] |
- Overrides:
- Source:
Returns:
world point
- Type
- THREE.Vector3
updateUniforms(uniforms)
Update uniforms.
Parameters:
| Name | Type | Description |
|---|---|---|
uniforms |
FORGEUniform |
- Overrides:
- Source:
warn(valuenullable)
Basic warn method, log a warn string in the console if warning is enabled.
Parameters:
| Name | Type | Attributes | Description |
|---|---|---|---|
value |
string | Object |
<nullable> |
The value you want to warn in the console. |
- Inherited From:
- Source:
worldToScreen(worldPt, parallaxFactor) → (nullable) {THREE.Vector2}
Convert a point from world space to screen space.
Parameters:
| Name | Type | Description |
|---|---|---|
worldPt |
THREE.Vector3 | 3D point in world space |
parallaxFactor |
number | parallax factor [0..1] |
- Overrides:
- Source:
Returns:
point in screen coordinates
- Type
- THREE.Vector2