ThreeScalaJS
0.0.7
DocsAPI
Generated with
Copyright (c) 2022-2025, Olivier NOUGUIER
Copyright (c) 2022-2025, Olivier NOUGUIER
ThreeScalaJS/THREE/BoxHelper

BoxHelper

THREE.BoxHelper
See theBoxHelper companion object
class BoxHelper(var obj: Object3D, var color: Double | Color | String) extends LineSegments

Helper object to graphically show the world-axis-aligned bounding box around an object. The actual bounding box is handled with [[Box3]], this is just a visual helper for debugging. It can be automatically resized with [[BoxHelper#update]] when the object it's created from is transformed. Note that the object must have a geometry for this to work, so it won't work with sprites.

Attributes

Example 
 val sphere = new SphereGeometry()
 val obj    = new Mesh(sphere, new MeshBasicMaterial(0xff0000))
 val box    = new BoxHelper(obj, 0xffff00)
 scene.add(box)
Companion
object
Graph
Supertypes
class LineSegments
class Line
class Object3D
class Object
trait Any
class Object
trait Matchable
class Any
Show all

Members list

Value members

Concrete methods

def dispose(): Unit

Frees the GPU-related resources allocated by this instance. Call this method whenever this instance is no longer used in your app.

Frees the GPU-related resources allocated by this instance. Call this method whenever this instance is no longer used in your app.

Attributes

def setFromObject(obj: Object3D): BoxHelper

Updates the wireframe box for the passed object.

Updates the wireframe box for the passed object.

Value parameters

obj

The 3D object to create the helper for.

Attributes

Returns

A reference to this instance.

def update(): Unit

Updates the helper's geometry to match the dimensions of the object, including any children.

Updates the helper's geometry to match the dimensions of the object, including any children.

Attributes

Inherited methods

def add(obj: Object3D*): this.type

Attributes

Inherited from:
Object3D
def applyMatrix4(matrix: Matrix4): Unit

Attributes

Inherited from:
Object3D
def applyQuaternion(q: Quaternion): this.type

Attributes

Inherited from:
Object3D
def attach(obj: Object3D): this.type

Attributes

Inherited from:
Object3D
def clear(): this.type

Attributes

Inherited from:
Object3D
def computeLineDistances(): this.type

Computes an array of distance values which are necessary for LineDashedMaterial. For each vertex in the geometry, the method calculates the cumulative length from the current point to the very beginning of the line.

Computes an array of distance values which are necessary for LineDashedMaterial. For each vertex in the geometry, the method calculates the cumulative length from the current point to the very beginning of the line.

Attributes

Inherited from:
Line
def copy(source: Object3D, recursive: Boolean): this.type

Attributes

Inherited from:
Object3D
def getObjectById(id: Int): UndefOr[Object3D]

Attributes

Inherited from:
Object3D
def getObjectByName(name: String): UndefOr[Object3D]

Attributes

Inherited from:
Object3D
def getObjectByProperty(name: String, value: Any): UndefOr[Object3D]

Attributes

Inherited from:
Object3D
def getWorldDirection(target: Vector3): Vector3

Attributes

Inherited from:
Object3D
def getWorldPosition(target: Vector3): Vector3

Attributes

Inherited from:
Object3D
def getWorldQuaternion(target: Quaternion): Quaternion

Attributes

Inherited from:
Object3D
def getWorldScale(target: Vector3): Vector3

Attributes

Inherited from:
Object3D
def hasOwnProperty(v: String): Boolean

Attributes

Inherited from:
Object
def isPrototypeOf(v: Object): Boolean

Attributes

Inherited from:
Object
def jsClone(recursive: Boolean): this.type

Attributes

Inherited from:
Object3D
def localToWorld(vector: Vector3): Vector3

Attributes

Inherited from:
Object3D
def lookAt(x: Any, y: UndefOr[Double], z: UndefOr[Double]): Unit

Attributes

Inherited from:
Object3D
def propertyIsEnumerable(v: String): Boolean

Attributes

Inherited from:
Object
def raycast(raycaster: Object, intersects: Array[Object]): Unit

Attributes

Inherited from:
Object3D
def remove(ob: Object3D*): this.type

Attributes

Inherited from:
Object3D
def rotateOnAxis(axis: Vector3, angle: Double): this.type

Attributes

Inherited from:
Object3D
def rotateOnWorldAxis(axis: Vector3, angle: Double): this.type

Attributes

Inherited from:
Object3D
def rotateX(angle: Double): this.type

Attributes

Inherited from:
Object3D
def rotateY(angle: Double): this.type

Attributes

Inherited from:
Object3D
def rotateZ(angle: Double): this.type

Attributes

Inherited from:
Object3D
def setRotationFromAxisAngle(axis: Vector3, angle: Double): Unit

Attributes

Inherited from:
Object3D
def setRotationFromEuler(euler: Euler): Unit

Attributes

Inherited from:
Object3D
def setRotationFromMatrix(m: Matrix4): Unit

Attributes

Inherited from:
Object3D
def setRotationFromQuaternion(q: Quaternion): Unit

Attributes

Inherited from:
Object3D
def toLocaleString(): String

Attributes

Inherited from:
Object
def translateOnAxis(axis: Vector3, distance: Double): this.type

Attributes

Inherited from:
Object3D
def translateX(distance: Double): this.type

Attributes

Inherited from:
Object3D
def translateY(distance: Double): this.type

Attributes

Inherited from:
Object3D
def translateZ(distance: Double): this.type

Attributes

Inherited from:
Object3D
def traverse(callback: Function1[Object3D, Unit]): Unit

Attributes

Inherited from:
Object3D
def traverseAncestors(callback: Function1[Object3D, Unit]): Unit

Attributes

Inherited from:
Object3D
def traverseVisible(callback: Function1[Object3D, Unit]): Unit

Attributes

Inherited from:
Object3D
def updateMatrix(): Unit

Attributes

Inherited from:
Object3D
def updateMatrixWorld(force: Boolean): Unit

Attributes

Inherited from:
Object3D
def updateMorphTargets(): Unit

Updates the morphTargets to have no influence on the object. Resets the morphTargetInfluences and morphTargetDictionary properties.

Updates the morphTargets to have no influence on the object. Resets the morphTargetInfluences and morphTargetDictionary properties.

Attributes

Inherited from:
Line
def updateWorldMatrix(updateParent: Boolean, updateChildren: Boolean): Unit

Attributes

Inherited from:
Object3D
def valueOf(): Any

Attributes

Inherited from:
Object
def worldToLocal(vector: Vector3): Vector3

Attributes

Inherited from:
Object3D

Concrete fields

override val `type`: String

The type property of the helper.

The type property of the helper.

Attributes

var color: Double | Color | String
val isBoxHelper: Boolean

This flag can be used for type testing.

This flag can be used for type testing.

Attributes

var obj: Object3D

Inherited fields

var castShadow: Boolean

Attributes

Inherited from:
Object3D
val children: Array[Object3D]

Attributes

Inherited from:
Object3D
var frustumCulled: Boolean

Attributes

Inherited from:
Object3D
var geometry: BufferGeometry

Attributes

Inherited from:
Line
val id: Int

Attributes

Inherited from:
Object3D
val isLine: Boolean

This flag can be used for type testing.

This flag can be used for type testing.

Attributes

Inherited from:
Line
val isLineSegments: Boolean

This flag can be used for type testing.

This flag can be used for type testing.

Attributes

Inherited from:
LineSegments
var layers: Object

Attributes

Inherited from:
Object3D
var material: Any

Attributes

Inherited from:
Line
var matrix: Matrix4

Attributes

Inherited from:
Object3D
var matrixAutoUpdate: Boolean

Attributes

Inherited from:
Object3D
var matrixWorld: Matrix4

Attributes

Inherited from:
Object3D
var matrixWorldNeedsUpdate: Boolean

Attributes

Inherited from:
Object3D
var morphTargetDictionary: UndefOr[Dictionary[Double]]

A dictionary of morphTargets based on the morphTarget.name property.

A dictionary of morphTargets based on the morphTarget.name property.

Attributes

Inherited from:
Line
var morphTargetInfluences: UndefOr[Array[Double]]

An array of weights typically from 0-1 that specify how much of the morph is applied.

An array of weights typically from 0-1 that specify how much of the morph is applied.

Attributes

Inherited from:
Line
var name: String

Attributes

Inherited from:
Object3D
var parent: UndefOr[Object3D]

Attributes

Inherited from:
Object3D
var position: Vector3

Attributes

Inherited from:
Object3D
var quaternion: Quaternion

Attributes

Inherited from:
Object3D
var receiveShadow: Boolean

Attributes

Inherited from:
Object3D
var renderOrder: Double

Attributes

Inherited from:
Object3D
var rotation: Euler

Attributes

Inherited from:
Object3D
var scale: Vector3

Attributes

Inherited from:
Object3D
var userData: Object

Attributes

Inherited from:
Object3D
val uuid: String

Attributes

Inherited from:
Object3D
var visible: Boolean

Attributes

Inherited from:
Object3D
Generated with
Copyright (c) 2022-2025, Olivier NOUGUIER
Copyright (c) 2022-2025, Olivier NOUGUIER