import {WallItem} from 'blueprint3d-js/scripts/items/wall_item.js'

public class | source

WallItem

Extends:

three~Mesh → Item → WallItem

Direct Subclass:

InWallItem, WallFloorItem

Indirect Subclass:

InWallFloorItem

A Wall Item is an entity to be placed related to a wall.

Constructor Summary

Public Constructor
public	constructor()

Member Summary

Public Members
public	addToWall: boolean
public	allowRotate: boolean
public	backVisible: boolean
public	boundToFloor: boolean
public	currentWallEdge: * The currently applied wall edge.
public	frontVisible: boolean
public	refVec: * used for finding rotations
public	sizeX: number
public	sizeY: number
public	visible: *
public	wallOffsetScalar: number

Method Summary

Public Methods
public	boundMove(vec3: *) takes the move vec3, and makes sure object stays bounded on plane
public	changeWallEdge(wallEdge: *)
public	closestWallEdge(): * Get the closet wall edge.
public	customIntersectionPlanes(): * Returns an array of planes to use other than the ground plane for passing intersection to clickPressed and clickDragged
public	getWallOffset(): *
public	moveToPosition(vec3: , intersection: )
public	placeInRoom()
public	redrawWall()
public	removed()
public	resized()
public	updateEdgeVisibility(visible: , front: )
public	updateSize()

Inherited Summary

From class Item
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: *
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() source

Constructs an item.

Override:

Item#constructor

Public Members

public addToWall: boolean source

public allowRotate: boolean source

Show rotate option in context menu

Override:

Item#allowRotate

public backVisible: boolean source

public boundToFloor: boolean source

public currentWallEdge: * source

The currently applied wall edge.

public frontVisible: boolean source

public refVec: * source

used for finding rotations

public sizeX: number source

public sizeY: number source

public visible: * source

public wallOffsetScalar: number source

Public Methods

public boundMove(vec3: *) source

takes the move vec3, and makes sure object stays bounded on plane

Params:

Name	Type	Attribute	Description
vec3	*

public changeWallEdge(wallEdge: *) source

Params:

Name	Type	Attribute	Description
wallEdge	*

public closestWallEdge(): * source

Get the closet wall edge.

Return:

*	The wall edge.

public customIntersectionPlanes(): * source

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

Override:

Item#customIntersectionPlanes

Return:

public getWallOffset(): * source

Return:

public moveToPosition(vec3: , intersection: ) source

Override:

Item#moveToPosition

Params:

Name	Type	Attribute	Description
vec3	*
intersection	*

public placeInRoom() source

Override:

Item#placeInRoom

public redrawWall() source

public removed() source

Override:

Item#removed

public resized() source

Subclass can define to take action after a resize.

Override:

Item#resized

public updateEdgeVisibility(visible: , front: ) source

Params:

Name	Type	Attribute	Description
visible	*
front	*

WallItem

Extends:

Direct Subclass:

Indirect Subclass:

Constructor Summary

Member Summary

Method Summary

Inherited Summary

Public Constructors

public constructor() source

Override:

Public Members

public addToWall: boolean source

public allowRotate: boolean source

Override:

public backVisible: boolean source

public boundToFloor: boolean source

public currentWallEdge: * source

public frontVisible: boolean source

public refVec: * source

public sizeX: number source

public sizeY: number source

public visible: * source

public wallOffsetScalar: number source

Public Methods

public boundMove(vec3: *) source

Params:

public changeWallEdge(wallEdge: *) source

Params:

public closestWallEdge(): * source

Return:

public customIntersectionPlanes(): * source

Override:

Return:

public getWallOffset(): * source

Return:

public moveToPosition(vec3: *, intersection: *) source

Override:

Params:

public placeInRoom() source

Override:

public redrawWall() source

public removed() source

Override:

public resized() source

Override:

public updateEdgeVisibility(visible: *, front: *) source

Params:

public updateSize() source

public moveToPosition(vec3: , intersection: ) source

public updateEdgeVisibility(visible: , front: ) source