Class: FrustumPoints

FrustumPoints(camera, group, canvas, settingsopt)

new FrustumPoints(camera, group, canvas, settingsopt)

Create a `FrustumPoints` instance.
Parameters:
Name Type Attributes Default Description
camera THREE.PerspectiveCamera PerspectiveCamera
group THREE.Group group of objects to which a new FrustumPoints will be added
canvas DOM The Graphics Canvas element to draw graphics and animations.
settings object <optional>
 {} the following settings are available
Properties
Name Type Attributes Default Description
options Options <optional>
 new Options() Options instance. The following options are available. See options parameter of MyThree class.
Properties
Name Type Attributes Default Description
orbitControls boolean | OrbitControls <optional>
 
false - do not add the OrbitControls. Allow the camera to orbit around a target.
Or OrbitControls instance.
dat object <optional>
 use dat-gui JavaScript Controller Library. dat.gui. See options.dat parameter of MyThree class.
scales object <optional>
 axes scales. See options.scales parameter of MyThree class.
guiSelectPoint boolean | GuiSelectPoint <optional>
 
false - do not displays the Select Point. dat.gui based graphical user interface for select a point from the mesh.
Or GuiSelectPoint instance.
raycaster object <optional>
 for Raycaster.
palette MyThree.ColorPicker.palette | boolean | number <optional>
 Points сolor. See options.palette parameter of MyThree class.
getLanguageCode function | string <optional>
 language code of your browser Your custom getLanguageCode() function or language code string. See options.getLanguageCode parameter of MyThree class.
axesHelper boolean | AxesHelper <optional>
 
false - do not add the AxesHelper.
Or AxesHelper instance.
frustumPoints object <optional>
 FrustumPoints options. undefined - do not create a FrustumPoints instance.
Properties
Name Type Attributes Default Description
point object <optional>
 {} points options.
Properties
Name Type Attributes Default Description
size number <optional>
 0 Size of each frustum point.
display boolean <optional>
 true true - display frustum points.
info boolean <optional>
 false true - display information about frustum point if user move mouse over or click this point.
stereo object <optional>
 stereo mode options
Properties
Name Type Attributes Default Description
hide number <optional>
 0 Hide the nearby to the camera points in percentage to all points for more comfortable visualisation.
opacity number <optional>
 0.3 Float in the range of 0.0 - 1.0 indicating how transparent the lines is. A value of 0.0 indicates fully transparent, 1.0 is fully opaque.
zCount number <optional>
 50 The count of layers of the frustum of the camera's field of view.
yCount number <optional>
 30 The count of vertical points for each z level of the frustum of the camera's field of view.
near number <optional>
 0 Shift of the frustum layer near to the camera in percents. 
0 percents - no shift.
100 percents - ближний к камере слой усеченной пирамиды приблизился к дальнему от камеры слою усеченной пирамиды.
far number <optional>
 0 Shift of the frustum layer far to the camera in percents. 
0 percents - no shift.
100 percents - дальний от камеры слоем усеченной пирамиды приблизился к ближнему к камере слою усеченной пирамиды.
base number <optional>
 100 Scale of the base of the frustum points in percents. 
0 base is null
100 no scale
square boolean <optional>
 false true - Square base of the frustum points.
Source:

Classes

guiSelectPoint

Methods

animate()

Called from animate loop for rendering.
Source:
See:

create(renderer)

create points
Parameters:
Name Type Description
renderer THREE.WebGLRenderer THREE.WebGLRenderer.
Source:

gui(folderopt)

Adds FrustumPoints folder into dat.GUI. See dat.GUI API.
Parameters:
Name Type Attributes Description
folder object <optional>
 parent folder
Source:

isDisplay()

Source:
Returns:
true - frustum points is created and visible.

false - frustum points have been removed.

pushArrayCloud(geometry)

Pushes to clouds array all points from geometry.attributes.position
Parameters:
Name Type Description
geometry THREE.BufferGeometry | THREE.Points THREE.BufferGeometry or THREE.Points
Source:
Returns:
index of the new array item

update()

Moves frustum points in front of the camera.
Source:

updateCloudPoint(mesh)

Parameters:
Name Type Description
mesh THREE.Mesh Mech
Source:

updateCloudPoints()

Updates the cloud's points according new position of the all points of the all meshes of the group of objects to which a new FrustumPoints has been added.
Source:

updateGuiSelectPoint()

update "frustum points" item in the GuiSelectPoint.
Source:

Events

onChangeControls

The user has moved the camera
Source:

updateCloudPointItem

The user has changed selected point.
Parameters:
Name Type Description
points THREE.Points Points
i number index of the point from points for udating
Source: