Class: AxesHelper

AxesHelper~AxesHelper(group, optionsopt)

new AxesHelper(group, optionsopt)

An axis object to visualize the 1, 2 or 3 axes.
Parameters:
Name Type Attributes Default Description
group THREE.Group | THREE.Scene THREE.Group or THREE.Scene.
options object <optional>
 new Options() the following options are available. See the options parameter of the MyThree class.
Properties
Name Type Attributes Default Description
axesHelper boolean <optional>
 false - do not create a AxesHelper instance.
scales object <optional>
 {} axes scales.
scales[axis] object <optional>
 axes options. axis is "x" or "y" or "z".
scales[axis].name string <optional>
 "X" or "Y" or "Z" or "W" axis name.
scales[axis].min number <optional>
 -1 Minimum range of the axis.
scales[axis].max number <optional>
 1 Maximum range of the axis.
scales[axis].marks number <optional>
 3 Number of scale marks.
scales[axis].zoomMultiplier number <optional>
 1.1 zoom multiplier.
scales[axis].offset number <optional>
 0.1 position offset.
scales.posAxesIntersection THREE.Vector3 <optional>
 new THREE.Vector3() Position of the axes intersection.
scales.display boolean <optional>
 true true - displays the label and scale of the axes.
scales.color object <optional>
 'rgba(255, 255, 255, 0.5)' axes color. Available color names see THREE.Color.NAMES.
scales.text object <optional>
 {} followed options of the text of the marks is available
Properties
Name Type Attributes Default Description
precision boolean <optional>
 4 Formats a scale marks into a specified length.
textHeight number <optional>
 0.04 The height of the text.
rect object <optional>
 {} rectangle around the text.
Properties
Name Type Attributes Default Description
displayRect boolean <optional>
 true true - the rectangle around the text is visible.
borderRadius number <optional>
 15
camera THREE.PerspectiveCamera <optional>
 PerspectiveCamera. Use the camera key if you want control cameras focus. Set the camera if you want to see text size is independent from camera.fov. The text height will be calculated as textHeight = camera.fov * textHeight / 50 See https://threejs.org/docs/index.html#api/en/cameras/PerspectiveCamera.fov about camera.fov. Default is undefined. Default camera.fov is 50.
Source:

Members

options

See the options parameter of the MyThree class.
Source:

Methods

createAxis(axisName)

create axis
Parameters:
Name Type Description
axisName string axis name
Source:

exposePosition(intersection)

Expose position on axes.
Parameters:
Name Type Description
intersection THREE.Vector3 | object position or intersection. See Raycaster for detail.
Source:

getGroup()

get group
Source:
Returns:
Group

movePosition()

move exposed position on axes.
Source:

updateAxes()

update axes
Source: