import {Item} from 'blueprint3d-js/scripts/items/item.js'

public class | source

Item

Extends:

three~Mesh → Item

Direct Subclass:

FloorItem, RoofItem, WallItem

Indirect Subclass:

InWallFloorItem, InWallItem, OnFloorItem, WallFloorItem

An Item is an abstract entity for all things placed in the scene, e.g. at walls or on the floor.

Constructor Summary

Public Constructor
public	constructor(model: , metadata: , geometry: , material: , position: , rotation: , scale: *) Constructs an item.

Member Summary

Public Members
public	allowRotate: boolean Show rotate option in context menu
public	bhelper: *
public	canvasMaterialWD: *
public	canvasMaterialWH: *
public	canvasPlaneWD: *
public	canvasPlaneWH: *
public	canvasTextureWD: *
public	canvasTextureWH: *
public	canvasWD: *
public	canvasWH: *
public	canvascontextWD: *
public	canvascontextWH: *
public	castShadow: boolean
public	dragOffset: * dragging
public	emissiveColor: number
public	error: boolean
public	errorColor: number
public	errorGlow: *
public	fixed: boolean
public	geometry: *
public	halfSize: *
public	highlighted: boolean
public	hover: boolean
public	material: *
public	metadata: *
public	model: *
public	obstructFloorMoves: boolean Does this object affect other floor items
public	originalmaterial: *
public	position_set: boolean
public	receiveShadow: boolean
public	resizable: *
public	resizeProportionally: boolean
public	scene: *
public	selected: boolean
public	texture: *
public	wirematerial: *

Method Summary

Public Methods
public	clickDragged(intersection: *)
public	clickPressed(intersection: *) intersection has attributes point (vec3) and object (THREE.Mesh)
public	clickReleased()
public	createGlow(color: , opacity: , ignoreDepth: ):
public	customIntersectionPlanes(): *[] Returns an array of planes to use other than the ground plane for passing intersection to clickPressed and clickDragged
public	getCorners(xDim: , yDim: , position: ): returns the 2d corners of the bounding polygon
public	getDepth(): *
public	getHeight(): *
public	getMaterial(): *
public	getMaterialColor(index: ):
public	getMetaData(): {"item_name": , "item_type": , "format": , "model_url": , "xpos": , "ypos": , "zpos": , "rotation": , "scale_x": , "scale_y": , "scale_z": , "fixed": , "material_colors": *}
public	getProportionalResize(): *
public	getWidth(): *
public	hideError()
public	initObject()
public	isValidPosition(): boolean
public	mouseOff()
public	mouseOver()
public	moveToPosition(vec3: *)
public	objectHalfSize(): *
public	placeInRoom()
public	remove()
public	removed()
public	resize(height: , width: , depth: *)
public	resized() Subclass can define to take action after a resize.
public	rotate(intersection: *)
public	setFixed(fixed: *)
public	setMaterialColor(color: , index: )
public	setProportionalResize(flag: *)
public	setScale(x: , y: , z: *)
public	setSelected()
public	setUnselected()
public	showError(vec3: *)
public	switchWireframe(flag: *)
public	updateCanvasTexture(canvas: , context: , material: , w: , h: , wPrefix: , hPrefix: *)
public	updateHighlight() on is a bool

Public Constructors

public constructor(model: , metadata: , geometry: , material: , position: , rotation: , scale: *) source

Constructs an item.

Params:

Name	Type	Attribute	Description
model	*		TODO
metadata	*		TODO
geometry	*		TODO
material	*		TODO
position	*		TODO
rotation	*		TODO
scale	*		TODO

Public Members

public allowRotate: boolean source

Show rotate option in context menu

public bhelper: * source

public canvasMaterialWD: * source

public canvasMaterialWH: * source

public canvasPlaneWD: * source

public canvasPlaneWH: * source

public canvasTextureWD: * source

public canvasTextureWH: * source

public canvasWD: * source

public canvasWH: * source

public canvascontextWD: * source

public canvascontextWH: * source

public castShadow: boolean source

public dragOffset: * source

dragging

public emissiveColor: number source

public error: boolean source

public errorColor: number source

public errorGlow: * source

public fixed: boolean source

public geometry: * source

public halfSize: * source

public highlighted: boolean source

public hover: boolean source

public material: * source

public metadata: * source

public model: * source

public obstructFloorMoves: boolean source

Does this object affect other floor items

public originalmaterial: * source

public position_set: boolean source

public receiveShadow: boolean source

public resizable: * source

public resizeProportionally: boolean source

public scene: * source

public selected: boolean source

public texture: * source

public wirematerial: * source

Public Methods

public clickDragged(intersection: *) source

Params:

Name	Type	Attribute	Description
intersection	*

public clickPressed(intersection: *) source

intersection has attributes point (vec3) and object (THREE.Mesh)

Params:

Name	Type	Attribute	Description
intersection	*

public clickReleased() source

public createGlow(color: , opacity: , ignoreDepth: ): source

Params:

Name	Type	Attribute	Description
color	*
opacity	*
ignoreDepth	*

Return:

public customIntersectionPlanes(): *[] source

Returns an array of planes to use other than the ground plane for passing intersection to clickPressed and clickDragged

Return:

*[]

public getCorners(xDim: , yDim: , position: ): source

returns the 2d corners of the bounding polygon

offset is Vector3 (used for getting corners of object at a new position)

TODO: handle rotated objects better!

Params:

Name	Type	Attribute	Description
xDim	*
yDim	*
position	*

Return:

public getDepth(): * source

Return:

public getHeight(): * source

Return:

public getMaterial(): * source

Return:

public getMaterialColor(index: ): source

Params:

Name	Type	Attribute	Description
index	*

Return:

public getMetaData(): {"item_name": , "item_type": , "format": , "model_url": , "xpos": , "ypos": , "zpos": , "rotation": , "scale_x": , "scale_y": , "scale_z": , "fixed": , "material_colors": *} source

Return:

{"item_name": *, "item_type": *, "format": *, "model_url": *, "xpos": *, "ypos": *, "zpos": *, "rotation": *, "scale_x": *, "scale_y": *, "scale_z": *, "fixed": *, "material_colors": *}

public getProportionalResize(): * source

Return:

public getWidth(): * source

Return:

public hideError() source

public initObject() source

public isValidPosition(): boolean source

Return:

boolean

public mouseOff() source

public mouseOver() source

public moveToPosition(vec3: *) source

Params:

Name	Type	Attribute	Description
vec3	*

public objectHalfSize(): * source

Return:

public placeInRoom() source

public remove() source

public removed() source

public resize(height: , width: , depth: *) source

Params:

Name	Type	Attribute	Description
height	*
width	*
depth	*

public resized() source

Subclass can define to take action after a resize.

public rotate(intersection: *) source

Params:

Name	Type	Attribute	Description
intersection	*

public setFixed(fixed: *) source

Params:

Name	Type	Attribute	Description
fixed	*

public setMaterialColor(color: , index: ) source

Params:

Name	Type	Attribute	Description
color	*
index	*

public setProportionalResize(flag: *) source

Params:

Name	Type	Attribute	Description
flag	*

public setScale(x: , y: , z: *) source

Params:

Name	Type	Attribute	Description
x	*
y	*
z	*

public setSelected() source

public setUnselected() source

public showError(vec3: *) source

Params:

Name	Type	Attribute	Description
vec3	*

public switchWireframe(flag: *) source

Params:

Name	Type	Attribute	Description
flag	*

public updateCanvasTexture(canvas: , context: , material: , w: , h: , wPrefix: , hPrefix: *) source

Params:

Name	Type	Attribute	Description
canvas	*
context	*
material	*
w	*
h	*
wPrefix	*
hPrefix	*

public updateHighlight() source

on is a bool

Item

Extends:

Direct Subclass:

Indirect Subclass:

Constructor Summary

Member Summary

Method Summary

Public Constructors

public constructor(model: *, metadata: *, geometry: *, material: *, position: *, rotation: *, scale: *) source

Params:

Public Members

public allowRotate: boolean source

public bhelper: * source

public canvasMaterialWD: * source

public canvasMaterialWH: * source

public canvasPlaneWD: * source

public canvasPlaneWH: * source

public canvasTextureWD: * source

public canvasTextureWH: * source

public canvasWD: * source

public canvasWH: * source

public canvascontextWD: * source

public canvascontextWH: * source

public castShadow: boolean source

public dragOffset: * source

public emissiveColor: number source

public error: boolean source

public errorColor: number source

public errorGlow: * source

public fixed: boolean source

public geometry: * source

public halfSize: * source

public highlighted: boolean source

public hover: boolean source

public material: * source

public metadata: * source

public model: * source

public obstructFloorMoves: boolean source

public originalmaterial: * source

public position_set: boolean source

public receiveShadow: boolean source

public resizable: * source

public resizeProportionally: boolean source

public scene: * source

public selected: boolean source

public texture: * source

public wirematerial: * source

Public Methods

public clickDragged(intersection: *) source

Params:

public clickPressed(intersection: *) source

Params:

public clickReleased() source

public createGlow(color: *, opacity: *, ignoreDepth: *): * source

Params:

Return:

public customIntersectionPlanes(): *[] source

Return:

public getCorners(xDim: *, yDim: *, position: *): * source

Params:

Return:

public getDepth(): * source

Return:

public getHeight(): * source

Return:

public getMaterial(): * source

Return:

public getMaterialColor(index: *): * source

Params:

Return:

public getMetaData(): {"item_name": *, "item_type": *, "format": *, "model_url": *, "xpos": *, "ypos": *, "zpos": *, "rotation": *, "scale_x": *, "scale_y": *, "scale_z": *, "fixed": *, "material_colors": *} source

Return:

public getProportionalResize(): * source

Return:

public getWidth(): * source

Return:

public hideError() source

public initObject() source

public isValidPosition(): boolean source

Return:

public constructor(model: , metadata: , geometry: , material: , position: , rotation: , scale: *) source

public createGlow(color: , opacity: , ignoreDepth: ): source

public getCorners(xDim: , yDim: , position: ): source

public getMaterialColor(index: ): source

public getMetaData(): {"item_name": , "item_type": , "format": , "model_url": , "xpos": , "ypos": , "zpos": , "rotation": , "scale_x": , "scale_y": , "scale_z": , "fixed": , "material_colors": *} source

public resize(height: , width: , depth: *) source

public setMaterialColor(color: , index: ) source

public setScale(x: , y: , z: *) source

public updateCanvasTexture(canvas: , context: , material: , w: , h: , wPrefix: , hPrefix: *) source