FatLineSegments

Returns

FatLineSegments

Overrides

Drawable<FatLineMaterial, FatLineBufferGeometry>.constructor

Properties

DefaultUp

static DefaultUp: Vector3

Every objects in 3D space must have a default up direction.

Default Value

Vector3(0, 1, 0)

Inherited from

Drawable.DefaultUp

id

id: number

Unique number for each object3D instance.

Inherited from

Drawable.id

scene

scene: Nullable<Scene3D>

The scene which this object belong to.

Inherited from

Drawable.scene

updateDirtyId

updateDirtyId: number

The number is the frame id which this object is changed or participates change of scene graph. If this value equals to frame id - 1,

Default Value

-1 means no change happen

Inherited from

Drawable.updateDirtyId

name

name: string

The name of this object, it is empty if useless.

Inherited from

Drawable.name

isObject3D

isObject3D: boolean

Used to check type of this or extended instance. This value should not be changed by user.

Inherited from

Drawable.isObject3D

parent

parent: Nullable<Object3D>

Object’s parent node in the scene graph. An object can have at most one parent.

Inherited from

Drawable.parent

children

children: Object3D[]

Array with object’s children.

Remarks

See Group| Group for information on manually grouping objects.

Inherited from

Drawable.children

up

up: Vector3

This is used by the lookAt method, for example, to determine the orientation of the result. Default is DefaultUp.

Inherited from

Drawable.up

worldMatrixUpdateTimestamp

worldMatrixUpdateTimestamp: number

Record when this object’s world matrix last updated.

Inherited from

Drawable.worldMatrixUpdateTimestamp

transformChanged

transformChanged: boolean

Record whether the object’s any attribute| attribute is updated.

Inherited from

Drawable.transformChanged

visibleChanged

visibleChanged: boolean

Inherited from

Drawable.visibleChanged

matrixWorld

matrixWorld: Matrix4

The global transform of the object. If the Object3D has no parent, then it’s identical to the local transform matrix.

Inherited from

Drawable.matrixWorld

matrixWorldNeedsUpdate

matrixWorldNeedsUpdate: boolean

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

Default Value

false

Inherited from

Drawable.matrixWorldNeedsUpdate

netVisibility

netVisibility: boolean

Record if the object is really visible in rendering process. If the Object3D has no parent, it would be set by visible;

Inherited from

Drawable.netVisibility

localMatrixNeedUpdate

localMatrixNeedUpdate: boolean

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

Default Value

false

Inherited from

Drawable.localMatrixNeedUpdate

renderOrder

renderOrder: number

This value allows the default rendering order of scene graph objects to be overridden although opaque and transparent objects remain sorted independently. When this property is set for an instance of Group| Group, all descendants objects will be sorted and rendered together. Sorting is from lowest to highest renderOrder.

Default Value

0

Inherited from

Drawable.renderOrder

drawMode

drawMode: DrawMode

This is a decisive attribute for drawing method.

Default Value

Mesh.

Inherited from

Drawable.drawMode

overlayLayers

overlayLayers: number

Inherited from

Drawable.overlayLayers

castShadow

castShadow: boolean

Mark this drawable can cast shadow

Inherited from

Drawable.castShadow

castPlanarShadow

castPlanarShadow: boolean

Mark this drawable can cast shadow

Inherited from

Drawable.castPlanarShadow

isDrawable

isDrawable: boolean

Used to check type of this or extended instance. This value should not be changed by user.

Inherited from

Drawable.isDrawable

materialChanged

materialChanged: boolean

Mark the material reference changed.

Default Value

true

Inherited from

Drawable.materialChanged

geometryChanged

geometryChanged: boolean

Mark the geometry reference changed.

Default Value

true

Inherited from

Drawable.geometryChanged

frontFaceCW

frontFaceCW: boolean

Specify the winding orientation of mesh as counter-clock-wise, only meaningful on mesh.

Default Value

false.

Inherited from

Drawable.frontFaceCW

modelViewMatrix

modelViewMatrix: Matrix4

Store the Model-View matrix for this object. It is not suggested to change the matrix because it will be update automatically when camera move.

Inherited from

Drawable.modelViewMatrix

normalMatrix

normalMatrix: Matrix3

This matrix is used to calculate the normal in eye-space.

Inherited from

Drawable.normalMatrix

worldBoundingDirty

worldBoundingDirty: boolean

Mark bounding need to be recalculated.

Default Value

true

Inherited from

Drawable.worldBoundingDirty

worldBoundingBox

worldBoundingBox: Box3

Calculate the bounding as box.

Inherited from

Drawable.worldBoundingBox

worldBoundingSphere

worldBoundingSphere: Sphere

Calculate the bounding as sphere.

Inherited from

Drawable.worldBoundingSphere

z

z: number

The distance from object to camera in the direction of camera. Use this value to simply estimate the depth in 3D scene.

Inherited from

Drawable.z

onBeforeRender

onBeforeRender: Nullable<RenderHook>

This method allow user manually process data before the engine drawing object.

Remarks

See RenderHook| RenderHook for more details.

Inherited from

Drawable.onBeforeRender

viewIndependentScale

viewIndependentScale: number

This is used to scale a drawable object by specified number when enableViewIndependentScale| enableViewIndependentScale is true.

Inherited from

Drawable.viewIndependentScale

categoryId

categoryId: string

Reserved attribute

Inherited from

Drawable.categoryId

sourceType

sourceType: string

Record the object rendered as instance or other type.

Inherited from

Drawable.sourceType

shouldUseGeometryGroupsWhenOnlyHasOneMaterial

shouldUseGeometryGroupsWhenOnlyHasOneMaterial: boolean

Inherited from

Drawable.shouldUseGeometryGroupsWhenOnlyHasOneMaterial

UseFallBack

static UseFallBack: boolean

If require engine to draw this as Line instead of Mesh, set this to true.

isFatLineSegments

isFatLineSegments: boolean

Check the type whether it belongs to FatLineSegments. This value should not be changed by user.

__isFatLineSegments

__isFatLineSegments: boolean

userData

readonly userData: Record<keyof any, any>

Inherited from

Drawable.userData

_uuid

_uuid: any

Inherited from

Drawable._uuid

uuid

uuid: string

Inherited from

Drawable.uuid

_listeners

_listeners: Map<Symbol, Listener<never>[]>

Inherited from

Drawable._listeners

Accessors

layers

Get Signature

get layers(): Layers

Returns

Layers

Set Signature

set layers(v): void

Parameters

v

Layers

Returns

void

Inherited from

Drawable.layers

interactionLayers

Get Signature

get interactionLayers(): Layers | undefined

Returns

Layers | undefined

Set Signature

set interactionLayers(v): void

Parameters

v

Layers | undefined

Returns

void

Inherited from

Drawable.interactionLayers

groupLayer

Get Signature

get groupLayer(): Layers | undefined

Returns

Layers | undefined

Set Signature

set groupLayer(v): void

Parameters

v

Layers | undefined

Returns

void

Inherited from

Drawable.groupLayer

position

Get Signature

get position(): Vector3

Returns

Set Signature

set position(_position): void

A vector representing the object’s local position.

Parameters

_position

Returns

void

Inherited from

Drawable.position

rotation

Get Signature

get rotation(): Euler

Returns

Euler

Set Signature

set rotation(rotation): void

Object’s local rotation, in radians.

Parameters

rotation

Euler

Returns

void

Inherited from

Drawable.rotation

quaternion

Get Signature

get quaternion(): Quaternion

Returns

Set Signature

set quaternion(_quaternion): void

Object’s local rotation as a Quaternion.

Remarks

See Quaternion for more details.

Parameters

_quaternion

Returns

void

Inherited from

Drawable.quaternion

scale

Get Signature

get scale(): Vector3

Returns

Set Signature

set scale(_scale): void

The object’s local scale.

Default Value

Vector3( 1, 1, 1 )

Parameters

_scale

Returns

void

Inherited from

Drawable.scale

matrix

Get Signature

get matrix(): Matrix4

The local transform matrix.

Returns

Set Signature

set matrix(value): void

Parameters

value

Returns

void

Inherited from

Drawable.matrix

visible

Get Signature

get visible(): boolean

Object gets rendered if true.

Default Value

true

Returns

boolean

Set Signature

set visible(value): void

Parameters

value

boolean

Returns

void

Inherited from

Drawable.visible

outlineMode

Get Signature

get outlineMode(): OutlineMode

Mark this drawable should be rendered in outline style if you set outlinePipelineMode & outlineShadingMode, get this value maybe error

Returns

OutlineMode

Set Signature

set outlineMode(v): void

Parameters

v

OutlineMode

Returns

void

Inherited from

Drawable.outlineMode

outlineShadingMode

Get Signature

get outlineShadingMode(): OutlineShadingMode

Returns

OutlineShadingMode

Set Signature

set outlineShadingMode(value): void

Parameters

value

OutlineShadingMode

Returns

void

Inherited from

Drawable.outlineShadingMode

outlineRenderMode

Get Signature

get outlineRenderMode(): OutlineRenderMode

Returns

OutlineRenderMode

Set Signature

set outlineRenderMode(value): void

OutlineRenderMode.Overlay is deprecated. use renderMode replaced

Parameters

value

OutlineRenderMode

Returns

void

Inherited from

Drawable.outlineRenderMode

renderMode

Get Signature

get renderMode(): DrawableRenderMode

Returns

DrawableRenderMode

Set Signature

set renderMode(value): void

Parameters

value

DrawableRenderMode

Returns

void

Inherited from

Drawable.renderMode

isAlwaysDynamic

Get Signature

get isAlwaysDynamic(): boolean

Returns

boolean

Set Signature

set isAlwaysDynamic(v): void

Parameters

v

boolean

Returns

void

Inherited from

Drawable.isAlwaysDynamic

enableViewIndependentScale

Get Signature

get enableViewIndependentScale(): boolean

Let this object can be scale independently.

Returns

boolean

Set Signature

set enableViewIndependentScale(v): void

Parameters

v

boolean

Returns

void

Inherited from

Drawable.enableViewIndependentScale

geometry

Get Signature

get geometry(): G

This attribute stores Geometry| Geometry or BufferGeometry| BufferGeometry (or derived classes), defining the object’s shape.

Default Value

BoxBufferGeometry| BoxBufferGeometry

Returns

G

Set Signature

set geometry(newGeo): void

Parameters

newGeo

G

Returns

void

Inherited from

Drawable.geometry

renderGeometry

Get Signature

get renderGeometry(): BufferGeometryBase

Get the geometry which is really rendered by gpu.

Returns

BufferGeometryBase

Inherited from

Drawable.renderGeometry

renderMaterial

Get Signature

get renderMaterial(): Material[]

Get the material which is really rendered by gpu.

Returns

Material[]

Inherited from

Drawable.renderMaterial

__material

Set Signature

set __material(v): void

Parameters

v

M[]

Returns

void

Inherited from

Drawable.__material

businessTag

Get Signature

get businessTag(): string

Returns

string

Set Signature

set businessTag(v): void

Parameters

v

string

Returns

void

Inherited from

Drawable.businessTag

Methods

destroy()

destroy(): void

Returns

void

Inherited from

Drawable.destroy

freeGPU()

freeGPU(): void

Returns

void

Inherited from

Drawable.freeGPU

syncData()

syncData(): void

Returns

void

Inherited from

Drawable.syncData

updateVisibility()

updateVisibility(): boolean

Scene will check the object’s visibility in each render and make change netVisibility based on its and parent’s visible.

Returns

boolean

Inherited from

Drawable.updateVisibility

setMatrixUpdated()

setMatrixUpdated(): void

If the local matrix is changed, use this method to manually refresh data in scene graph.

Returns

void

Tips

It’s better to use notifySceneChange() as an alternative.

Inherited from

Drawable.setMatrixUpdated

notifySceneChange()

notifySceneChange(): void

Use this method to manually refresh data in scene graph and draw again. The engine may not notify every change of the scene. If any effect is not changed with the parameters, use this may solve.

Returns

void

Inherited from

Drawable.notifySceneChange

setMatrixDirty()

setMatrixDirty(): void

If the local matrix or world matrix is changed, use this method to make engine refresh data in scene graph automatically. This method will set matrixWorldNeedsUpdate and localMatrixNeedUpdate to true.

Returns

void

Inherited from

Drawable.setMatrixDirty

updateWorldRenderData()

updateWorldRenderData(updateID): boolean

Change matrixWorldNeedsUpdate and worldMatrixUpdateTimestamp state. This method will refresh data of world matrix by updateMatrixWorld

Parameters

updateID

number

This number is used to identify the render.

Returns

boolean

Inherited from

Drawable.updateWorldRenderData

isFlipped()

isFlipped(): boolean

If there are zero or two negative numbers in xyz, return false, otherwise return true.

Returns

boolean

Inherited from

Drawable.isFlipped

localToWorld()

localToWorld(vector): Vector3

Converts the vector from local space to world space.

Parameters

vector

A vector represents a position in local (object) coordinate.

Returns

Inherited from

Drawable.localToWorld

worldToLocal()

worldToLocal(vector): Vector3

Updates the vector from world space to local space.

Parameters

vector

A vector in world coordinate.

Returns

Inherited from

Drawable.worldToLocal

applyMatrix()

applyMatrix(matrix): void

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

Parameters

matrix

A matrix represents the information of transform.

Returns

void

Inherited from

Drawable.applyMatrix

applyQuaternion()

applyQuaternion(q): this

Applies the rotation represented by the quaternion to the object.

Parameters

q

A Quaternion represents the information of rotation.

Returns

this

Inherited from

Drawable.applyQuaternion

setRotationFromAxisAngle()

setRotationFromAxisAngle(axis, angle): void

Calls setFromAxisAngle( axis, angle ) on the Quaternion.

Parameters

axis

A normalized vector in object space.

angle

number

Angle in radians.

Returns

void

Inherited from

Drawable.setRotationFromAxisAngle

setRotationFromEuler()

setRotationFromEuler(euler): void

Calls Quaternion.setRotationFromEuler| setRotationFromEuler(euler, true) on the Quaternion.

Parameters

euler

Euler

Euler angle specifying rotation amount.

Returns

void

Inherited from

Drawable.setRotationFromEuler

setRotationFromMatrix()

setRotationFromMatrix(m): void

Calls setFromRotationMatrix(m) on the Quaternion.

Parameters

m

Euler angle specifying rotation amount.

Returns

void

Inherited from

Drawable.setRotationFromMatrix

setRotationFromQuaternion()

setRotationFromQuaternion(q): void

Copy the given quaternion to object’s quaternion.

Parameters

q

Euler angle specifying rotation amount.

Returns

void

Inherited from

Drawable.setRotationFromQuaternion

rotateOnAxis()

rotateOnAxis(axis, angle): this

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

Parameters

axis

A normalized vector in object space.

angle

number

Angle in radians.

Returns

this

Inherited from

Drawable.rotateOnAxis

rotateOnWorldAxis()

rotateOnWorldAxis(axis, angle): this

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

Parameters

axis

A normalized vector in object space.

angle

number

Angle in radians.

Returns

this

Inherited from

Drawable.rotateOnWorldAxis

rotateX()

rotateX(angle): this

Rotates the object around x axis in local space.

Parameters

angle

number

The angle to rotate in radians.

Returns

this

Inherited from

Drawable.rotateX

rotateY()

rotateY(angle): this

Rotates the object around x axis in local space.

Parameters

angle

number

The angle to rotate in radians.

Returns

this

Inherited from

Drawable.rotateY

rotateZ()

rotateZ(angle): this

Rotates the object around x axis in local space.

Parameters

angle

number

The angle to rotate in radians.

Returns

this

Inherited from

Drawable.rotateZ

translateOnAxis()

translateOnAxis(axis, distance): this

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

Parameters

axis

A normalized vector in object space.

distance

number

The distance to translate.

Returns

this

Inherited from

Drawable.translateOnAxis

translateX()

translateX(distance): this

Translates object along x axis in object space by distance units.

Parameters

distance

number

The distance to translate.

Returns

this

Inherited from

Drawable.translateX

translateY()

translateY(distance): this

Translates object along y axis in object space by distance units.

Parameters

distance

number

The distance to translate.

Returns

this

Inherited from

Drawable.translateY

translateZ()

translateZ(distance): this

Translates object along z axis in object space by distance units.

Parameters

distance

number

The distance to translate.

Returns

this

Inherited from

Drawable.translateZ

lookAt()

lookAt(_x): void

Rotates the object to face to a point in world space. This method does not support objects having non-uniformly-scaled parent(s)

Parameters

_x

A vector representing position of target in world space.

Returns

void

Inherited from

Drawable.lookAt

lookAtLocalPoint()

lookAtLocalPoint(_x): void

Rotates the object to face a point in local space.

Parameters

_x

A vector representing position of target in local space.

Returns

void

Inherited from

Drawable.lookAtLocalPoint

add()

add(o): this

Adds object as child of this object. An arbitrary number of objects may be added. Any current parent on an object passed in here will be removed, since an object can have at most one parent. The scene graph change will be immediately notify by engine after adding nodes.

Parameters

o

Object3D | Object3D[]

Parameter can be one object or objects array, all of them is added to this object.

Returns

this

Inherited from

Drawable.add

remove()

remove(object): this

Remove the specified object form children.

Parameters

object

The object which needs to be removed.

Returns

this

Inherited from

Drawable.remove

removeFromParent()

removeFromParent(): void

Returns

void

Inherited from

Drawable.removeFromParent

removeAllChildren()

removeAllChildren(): Object3D[]

Remove all children of this object.

Returns

Object3D[]

Inherited from

Drawable.removeAllChildren

removeObjects()

removeObjects(objects): this

Remove all children in specified objects from this objects. Migrate from tools common

Parameters

objects

Object3D[]

An array of objects which need to be removed.

Returns

this

Inherited from

Drawable.removeObjects

getObjectById()

getObjectById(id): Object3D

Searches through an object and its children, starting with the object itself, and returns the first with a matching id. Note that ids are assigned in chronological order: 1, 2, 3, …, incrementing by one for each new object.

Parameters

id

number

Unique number of the object instance.

Returns

Inherited from

Drawable.getObjectById

getObjectByName()

getObjectByName(name): Object3D

Searches through an object and its children, starting with the object itself, and returns the first with a matching name. Note that for most objects the name is an empty string by default. You will have to set it manually to make use of this method.

Parameters

name

string

String to match to the children’s Object3D.name property.

Returns

Inherited from

Drawable.getObjectByName

getObjectByProperty()

getObjectByProperty(name, value): Object3D

Searches through an object and its children, starting with the object itself, and returns the first with a property that matches the value given.

Parameters

name

string

The property name to search for.

value

any

Value of the given property.

Returns

Inherited from

Drawable.getObjectByProperty

getWorldPosition()

getWorldPosition(target): Vector3

Return a vector representing the position of the object in world space.

Parameters

target

the result will be copied into this Vector3.

Returns

Inherited from

Drawable.getWorldPosition

getWorldQuaternion()

getWorldQuaternion(target): Quaternion

Return a quaternion representing the rotation of the object in world space.

Parameters

target

the result will be copied into this Quaternion.

Returns

Inherited from

Drawable.getWorldQuaternion

getWorldScale()

getWorldScale(target): Vector3

Return a vector of the scaling factors applied to the object for each axis in world space.

Parameters

target

the result will be copied into this Vector3.

Returns

Inherited from

Drawable.getWorldScale

getWorldDirection()

getWorldDirection(target): Vector3

Return a vector representing the direction of object’s positive z-axis in world space.

Parameters

target

the result will be copied into this Vector3.

Returns

Inherited from

Drawable.getWorldDirection

traverse()

traverse(callback): void

Execute the callback on this object and all descendants.

Parameters

callback

(object) => any

A function with as first argument an object3D object.

Returns

void

Inherited from

Drawable.traverse

traverseWithChildrenSkip()

traverseWithChildrenSkip(callback): void

Execute the callback when return is false, stop traverse the object’s descendants.

Parameters

callback

(object) => boolean

A function with as first argument an object3D object, return boolean.

Returns

void

Inherited from

Drawable.traverseWithChildrenSkip

traverseVisible()

traverseVisible(callback): void

Execute the callback on this object and all descendants which is visible.

Parameters

callback

(object) => any

A function with as first argument an object3D object.

Returns

void

Inherited from

Drawable.traverseVisible

traverseAncestors()

traverseAncestors(callback): void

Execute the callback on this object and all ancestors.

Parameters

callback

(object) => any

A function with as first argument an object3D object.

Returns

void

Inherited from

Drawable.traverseAncestors

updateMatrixWorld()

updateMatrixWorld(force?): void

Update the object’s and its descendants’ matrix of global transform with. If the parameter or matrixWorldNeedsUpdate is true, matrix will not skip updates.

Parameters

force?

boolean

Whether or not force to updates the matrix.

Returns

void

Inherited from

Drawable.updateMatrixWorld

updateWorldMatrix()

updateWorldMatrix(updateParents, updateChildren, force?): void

Update the object’s and its descendants’ matrix of global transform with. will update parent or children according to the parameters

Parameters

updateParents

boolean

update parents.

updateChildren

boolean

update children.

force?

boolean

Whether or not force to updates the matrix.

Returns

void

Inherited from

Drawable.updateWorldMatrix

getLocalBounds()

getLocalBounds(localBox?): Box3

Get the whole bounding box of current object cover all children’s.

Parameters

localBox?

Box3

If this is not undefined, result will be stored to it.

Returns

Box3

Inherited from

Drawable.getLocalBounds

getUUID()

getUUID(): string

Get UUID of this object instance. This value is automatically assigned, so this shouldn’t be edited.

Returns

string

Inherited from

Drawable.getUUID

clone()

clone(recursive?): Object3D

Return a cloned instance of this class and optionally all descendants.

Parameters

recursive?

boolean

if true, descendants of the object are also cloned. Default is true.

Returns

Inherited from

Drawable.clone

getMaterials()

getMaterials(): readonly FatLineMaterial[]

Returns

readonly FatLineMaterial[]

Inherited from

Drawable.getMaterials

getMaterialCount()

getMaterialCount(): number

Returns

number

Inherited from

Drawable.getMaterialCount

setMaterial()

setMaterial(material, index): this

Add a new material into this object. If use this method, please make sure that the material| material has set to Array.

Parameters

material

a new material which is set.

index

number

the target position in the Array.

Returns

this

Inherited from

Drawable.setMaterial

setMaterials()

setMaterials(materials): this

Parameters

materials

FatLineMaterial | FatLineMaterial[]

Returns

this

Inherited from

Drawable.setMaterials

setOnlyMaterial()

setOnlyMaterial(material): this

Parameters

material

Returns

this

Inherited from

Drawable.setOnlyMaterial

expectOnlyMaterial()

expectOnlyMaterial(): FatLineMaterial

Expect this drawable only has one material, and return it.

Returns