Class BoxOutline

Defines the thin outline on the edges of the section box.

Hierarchy

  • LineSegments
    • BoxOutline

Constructors

constructor

Properties

animations castShadow children customDepthMaterial customDistanceMaterial frustumCulled geometry id isLine isLineSegments isObject3D layers material matrix matrixAutoUpdate matrixWorld matrixWorldNeedsUpdate modelViewMatrix morphTargetDictionary? morphTargetInfluences? name normalMatrix onAfterRender onBeforeRender parent position quaternion receiveShadow renderOrder rotation scale type up userData uuid visible DefaultMatrixAutoUpdate DefaultUp

Methods

add addEventListener applyMatrix4 applyQuaternion attach clear clone computeLineDistances copy dispatchEvent dispose fitBox getObjectById getObjectByName getObjectByProperty getWorldDirection getWorldPosition getWorldQuaternion getWorldScale hasEventListener localToWorld lookAt raycast remove removeEventListener removeFromParent rotateOnAxis rotateOnWorldAxis rotateX rotateY rotateZ setRotationFromAxisAngle setRotationFromEuler setRotationFromMatrix setRotationFromQuaternion toJSON translateOnAxis translateX translateY translateZ traverse traverseAncestors traverseVisible updateMatrix updateMatrixWorld updateMorphTargets updateWorldMatrix worldToLocal

Constructors

constructor

Properties

animations

animations: AnimationClip[]

Array with animation clips.

Default

[]

castShadow

castShadow: boolean

Gets rendered into shadow map.

Default

false

children

children: Object3D<Event>[]

Array with object's children.

Default

[]

customDepthMaterial

customDepthMaterial: Material

Custom depth material to be used when rendering to the depth map. Can only be used in context of meshes. When shadow-casting with a DirectionalLight or SpotLight, if you are (a) modifying vertex positions in the vertex shader, (b) using a displacement map, (c) using an alpha map with alphaTest, or (d) using a transparent texture with alphaTest, you must specify a customDepthMaterial for proper shadows.

customDistanceMaterial

customDistanceMaterial: Material

Same as customDepthMaterial, but used with PointLight.

frustumCulled

frustumCulled: boolean

When this is set, it checks every frame if the object is in the frustum of the camera before rendering the object. If set to false the object gets rendered every frame even if it is not in the frustum of the camera.

Default

true

geometry

geometry: BufferGeometry

id

id: number

Unique number of this object instance.

Readonly isLine

isLine: true

Readonly isLineSegments

isLineSegments: true

Readonly isObject3D

isObject3D: true

Used to check whether this or derived classes are Object3Ds. Default is true. You should not change this, as it is used internally for optimisation.

layers

layers: Layers

Default

new THREE.Layers()

material

material: Material | Material[]

matrix

matrix: Matrix4

Local transform.

Default

new THREE.Matrix4()

matrixAutoUpdate

matrixAutoUpdate: boolean

When this is set, it calculates the matrix of position, (rotation or quaternion) and scale every frame and also recalculates the matrixWorld property.

Default

THREE.Object3D.DefaultMatrixAutoUpdate

matrixWorld

matrixWorld: Matrix4

The global transform of the object. If the Object3d has no parent, then it's identical to the local transform.

Default

new THREE.Matrix4()

matrixWorldNeedsUpdate

matrixWorldNeedsUpdate: boolean

When this is set, it calculates the matrixWorld in that frame and resets this property to false.

Default

false

Readonly modelViewMatrix

modelViewMatrix: Matrix4

Default

new THREE.Matrix4()

Optional morphTargetDictionary

morphTargetDictionary?: {
    [key: string]: number;
}

Type declaration

  • [key: string]: number

Optional morphTargetInfluences

morphTargetInfluences?: number[]

name

name: string

Optional name of the object (doesn't need to be unique).

Default

''

Readonly normalMatrix

normalMatrix: Matrix3

Default

new THREE.Matrix3()

onAfterRender

onAfterRender: ((renderer: WebGLRenderer, scene: Scene, camera: Camera, geometry: BufferGeometry, material: Material, group: Group) => void)

Type declaration

    • (renderer: WebGLRenderer, scene: Scene, camera: Camera, geometry: BufferGeometry, material: Material, group: Group): void

    • Calls after rendering object

      Parameters

      • renderer: WebGLRenderer
      • scene: Scene
      • camera: Camera
      • geometry: BufferGeometry
      • material: Material
      • group: Group

      Returns void

onBeforeRender

onBeforeRender: ((renderer: WebGLRenderer, scene: Scene, camera: Camera, geometry: BufferGeometry, material: Material, group: Group) => void)

Type declaration

    • (renderer: WebGLRenderer, scene: Scene, camera: Camera, geometry: BufferGeometry, material: Material, group: Group): void

    • Calls before rendering object

      Parameters

      • renderer: WebGLRenderer
      • scene: Scene
      • camera: Camera
      • geometry: BufferGeometry
      • material: Material
      • group: Group

      Returns void

parent

parent: Object3D<Event>

Object's parent in the scene graph.

Default

null

Readonly position

position: Vector3

Object's local position.

Default

new THREE.Vector3()

Readonly quaternion

quaternion: Quaternion

Object's local rotation as a Quaternion.

Default

new THREE.Quaternion()

receiveShadow

receiveShadow: boolean

Material gets baked in shadow receiving.

Default

false

renderOrder

renderOrder: number

Overrides the default rendering order of scene graph objects, from lowest to highest renderOrder. Opaque and transparent objects remain sorted independently though. When this property is set for an instance of Group, all descendants objects will be sorted and rendered together.

Default

0

Readonly rotation

rotation: Euler

Object's local rotation (Euler angles), in radians.

Default

new THREE.Euler()

Readonly scale

scale: Vector3

Object's local scale.

Default

new THREE.Vector3()

type

type: string

Default

'LineSegments'

up

up: Vector3

Up direction.

Default

THREE.Object3D.DefaultUp.clone()

userData

userData: {
    [key: string]: any;
}

An object that can be used to store custom data about the Object3d. It should not hold references to functions as these will not be cloned.

Default

Type declaration

  • [key: string]: any

uuid

uuid: string

visible

visible: boolean

Object gets rendered if true.

Default

true

Static DefaultMatrixAutoUpdate

DefaultMatrixAutoUpdate: boolean

Static DefaultUp

DefaultUp: Vector3

Methods

add

  • Adds object as child of this object.

    Parameters

    • Rest ...object: Object3D<Event>[]

    Returns BoxOutline

addEventListener

  • Adds a listener to an event type.

    Type Parameters

    • T extends string

    Parameters

    • type: T

      The type of event to listen to.

    • listener: EventListener<Event, T, BoxOutline>

      The function that gets called when the event is fired.

    Returns void

applyMatrix4

  • Applies the matrix transform to the object and updates the object's position, rotation and scale.

    Parameters

    • matrix: Matrix4

    Returns void

applyQuaternion

  • Applies the rotation represented by the quaternion to the object.

    Parameters

    • quaternion: Quaternion

    Returns BoxOutline

attach

  • Adds object as a child of this, while maintaining the object's world transform.

    Parameters

    • object: Object3D<Event>

    Returns BoxOutline

clear

  • Removes all child objects.

    Returns BoxOutline

clone

  • Parameters

    • Optional recursive: boolean

    Returns BoxOutline

computeLineDistances

  • Returns BoxOutline

copy

  • Parameters

    Returns BoxOutline

dispatchEvent

  • Fire an event type.

    Parameters

    • event: Event

    Returns void

dispose

fitBox

getObjectById

  • Searches through the object's children and returns the first with a matching id.

    Parameters

    • id: number

      Unique number of the object instance

    Returns Object3D<Event>

getObjectByName

  • Searches through the object's children and returns the first with a matching name.

    Parameters

    • name: string

      String to match to the children's Object3d.name property.

    Returns Object3D<Event>

getObjectByProperty

  • Parameters

    • name: string
    • value: string

    Returns Object3D<Event>

getWorldDirection

  • Parameters

    • target: Vector3

    Returns Vector3

getWorldPosition

  • Parameters

    • target: Vector3

    Returns Vector3

getWorldQuaternion

  • Parameters

    • target: Quaternion

    Returns Quaternion

getWorldScale

  • Parameters

    • target: Vector3

    Returns Vector3

hasEventListener

  • Checks if listener is added to an event type.

    Type Parameters

    • T extends string

    Parameters

    • type: T

      The type of event to listen to.

    • listener: EventListener<Event, T, BoxOutline>

      The function that gets called when the event is fired.

    Returns boolean

localToWorld

  • Updates the vector from local space to world space.

    Parameters

    • vector: Vector3

      A local vector.

    Returns Vector3

lookAt

  • Optionally, the x, y and z components of the world space position. Rotates the object to face a point in world space. This method does not support objects having non-uniformly-scaled parent(s).

    Parameters

    • vector: number | Vector3

      A world vector to look at.

    • Optional y: number
    • Optional z: number

    Returns void

raycast

  • Parameters

    • raycaster: Raycaster
    • intersects: Intersection<Object3D<Event>>[]

    Returns void

remove

  • Removes object as child of this object.

    Parameters

    • Rest ...object: Object3D<Event>[]

    Returns BoxOutline

removeEventListener

  • Removes a listener from an event type.

    Type Parameters

    • T extends string

    Parameters

    • type: T

      The type of the listener that gets removed.

    • listener: EventListener<Event, T, BoxOutline>

      The listener function that gets removed.

    Returns void

removeFromParent

  • Removes this object from its current parent.

    Returns BoxOutline

rotateOnAxis

  • Rotate an object along an axis in object space. The axis is assumed to be normalized.

    Parameters

    • axis: Vector3

      A normalized vector in object space.

    • angle: number

      The angle in radians.

    Returns BoxOutline

rotateOnWorldAxis

  • Rotate an object along an axis in world space. The axis is assumed to be normalized. Method Assumes no rotated parent.

    Parameters

    • axis: Vector3

      A normalized vector in object space.

    • angle: number

      The angle in radians.

    Returns BoxOutline

rotateX

  • Rotates the object around x axis in local space.

    Parameters

    • angle: number

      the angle to rotate in radians.

    Returns BoxOutline

rotateY

  • Rotates the object around y axis in local space.

    Parameters

    • angle: number

      the angle to rotate in radians.

    Returns BoxOutline

rotateZ

  • Rotates the object around z axis in local space.

    Parameters

    • angle: number

      the angle to rotate in radians.

    Returns BoxOutline

setRotationFromAxisAngle

  • axis -- A normalized vector in object space. angle -- angle in radians

    Parameters

    • axis: Vector3

      A normalized vector in object space.

    • angle: number

      angle in radians

    Returns void

setRotationFromEuler

  • Calls setRotationFromEuler(euler) on the .quaternion.

    Parameters

    • euler: Euler

      Euler angle specifying rotation amount.

    Returns void

setRotationFromMatrix

  • Calls setFromRotationMatrix(m) on the .quaternion.

    Note that this assumes that the upper 3x3 of m is a pure rotation matrix (i.e, unscaled).

    Parameters

    • m: Matrix4

      rotate the quaternion by the rotation component of the matrix.

    Returns void

setRotationFromQuaternion

  • Copy the given quaternion into .quaternion.

    Parameters

    • q: Quaternion

      normalized Quaternion

    Returns void

toJSON

  • Parameters

    • Optional meta: {
          geometries: any;
          images: any;
          materials: any;
          textures: any;
      }
      • geometries: any
      • images: any
      • materials: any
      • textures: any

    Returns any

translateOnAxis

  • Translate an object by distance along an axis in object space. The axis is assumed to be normalized.

    Parameters

    • axis: Vector3

      A normalized vector in object space.

    • distance: number

      The distance to translate.

    Returns BoxOutline

translateX

  • Translates object along x axis by distance.

    Parameters

    • distance: number

      Distance.

    Returns BoxOutline

translateY

  • Translates object along y axis by distance.

    Parameters

    • distance: number

      Distance.

    Returns BoxOutline

translateZ

  • Translates object along z axis by distance.

    Parameters

    • distance: number

      Distance.

    Returns BoxOutline

traverse

  • Parameters

    • callback: ((object: Object3D<Event>) => any)
        • (object: Object3D<Event>): any

        • Parameters

          • object: Object3D<Event>

          Returns any

    Returns void

traverseAncestors

  • Parameters

    • callback: ((object: Object3D<Event>) => any)
        • (object: Object3D<Event>): any

        • Parameters

          • object: Object3D<Event>

          Returns any

    Returns void

traverseVisible

  • Parameters

    • callback: ((object: Object3D<Event>) => any)
        • (object: Object3D<Event>): any

        • Parameters

          • object: Object3D<Event>

          Returns any

    Returns void

updateMatrix

  • Updates local transform.

    Returns void

updateMatrixWorld

  • Updates global transform of the object and its children.

    Parameters

    • Optional force: boolean

    Returns void

updateMorphTargets

  • Returns void

updateWorldMatrix

  • Updates the global transform of the object.

    Parameters

    • updateParents: boolean

      recursively updates global transform of ancestors.

    • updateChildren: boolean

      recursively updates global transform of descendants.

    Returns void

worldToLocal

  • Updates the vector from world space to local space.

    Parameters

    • vector: Vector3

      A world vector.

    Returns Vector3

Settings

Member Visibility

Theme

Generated using TypeDoc