File

projects/atft/src/lib/object/mesh/box-mesh.component.ts

Extends

AbstractMesh

Metadata

providers	`provideParent(BoxMeshComponent)`
selector	`atft-box-mesh`
template	`<ng-content></ng-content>`

Index

Properties

Protected childlren
Protected object

Constructor

constructor(rendererService: RendererService, parent: AbstractObject3D<any>)

Defined in projects/atft/src/lib/object/mesh/box-mesh.component.ts:49

Parameters :

Name	Type	Optional
rendererService	`RendererService`	No
parent	`AbstractObject3D<any>`	No

Inputs

depth
Type : `number`
Default value : `1.0`
Defined in projects/atft/src/lib/object/mesh/box-mesh.component.ts:31
Depth; that is, the length of the edges parallel to the Z axis. Optional; defaults to 1.

depthSegments
Type : `number`
Default value : `1`
Defined in projects/atft/src/lib/object/mesh/box-mesh.component.ts:49
Number of segmented rectangular faces along the depth of the sides. Optional; defaults to 1.

height
Type : `number`
Default value : `1.0`
Defined in projects/atft/src/lib/object/mesh/box-mesh.component.ts:25
Height; that is, the length of the edges parallel to the Y axis. Optional; defaults to 1.

heightSegments
Type : `number`
Default value : `1`
Defined in projects/atft/src/lib/object/mesh/box-mesh.component.ts:43
Number of segmented rectangular faces along the height of the sides. Optional; defaults to 1.

width
Type : `number`
Default value : `1.0`
Defined in projects/atft/src/lib/object/mesh/box-mesh.component.ts:19
Width; that is, the length of the edges parallel to the X axis. Optional; defaults to 1.

widthSegments
Type : `number`
Default value : `1`
Defined in projects/atft/src/lib/object/mesh/box-mesh.component.ts:37
Number of segmented rectangular faces along the width of the sides. Optional; defaults to 1.

castShadow
Type : `boolean`
Default value : `true`
Inherited from `AbstractMesh`
Defined in `AbstractMesh:16`

depthWrite
Type : `boolean`
Default value : `true`
Inherited from `AbstractMesh`
Defined in `AbstractMesh:22`

material
Type : `string`
Inherited from `AbstractMesh`
Defined in `AbstractMesh:10`

materialColor
Type : `string \| number`
Default value : `'#5DADE2'`
Inherited from `AbstractMesh`
Defined in `AbstractMesh:13`

receiveShadow
Type : `boolean`
Default value : `true`
Inherited from `AbstractMesh`
Defined in `AbstractMesh:19`

layer
Type : `number`
Default value : `0`
Inherited from `AbstractObject3D`
Defined in `AbstractObject3D:42`

name
Type : `string`
Default value : `uuidv4()`
Inherited from `AbstractObject3D`
Defined in `AbstractObject3D:40`

rotateX
Type : `number`
Inherited from `AbstractObject3D`
Defined in `AbstractObject3D:24`
Rotation in Euler angles (radians) with order X, Y, Z.

rotateY
Type : `number`
Inherited from `AbstractObject3D`
Defined in `AbstractObject3D:25`

rotateZ
Type : `number`
Inherited from `AbstractObject3D`
Defined in `AbstractObject3D:26`

scaleX
Type : `number`
Default value : `1`
Inherited from `AbstractObject3D`
Defined in `AbstractObject3D:36`

scaleY
Type : `number`
Default value : `1`
Inherited from `AbstractObject3D`
Defined in `AbstractObject3D:37`

scaleZ
Type : `number`
Default value : `1`
Inherited from `AbstractObject3D`
Defined in `AbstractObject3D:38`

translateX
Type : `number`
Inherited from `AbstractObject3D`
Defined in `AbstractObject3D:31`
Translate the geometry. This is typically done as a one time operation, and not during a loop.

translateY
Type : `number`
Inherited from `AbstractObject3D`
Defined in `AbstractObject3D:32`

translateZ
Type : `number`
Inherited from `AbstractObject3D`
Defined in `AbstractObject3D:33`

Outputs

changed
Type : `EventEmitter`
Inherited from `AbstractObject3D`
Defined in `AbstractObject3D:44`

Methods

Protected newObject3DInstance

newObject3DInstance()

Inherited from AbstractObject3D

Defined in AbstractObject3D:58

Returns : any

Public applyMaterial

applyMaterial()

Inherited from AbstractMesh

Defined in AbstractMesh:50

Returns : void

Protected applyShadowProps

applyShadowProps(mesh: THREE.Mesh)

Inherited from AbstractMesh

Defined in AbstractMesh:28

Parameters :

Name	Type	Optional
mesh	`THREE.Mesh`	No

Returns : void

Protected getMaterial

getMaterial()

Inherited from AbstractMesh

Defined in AbstractMesh:24

Returns : THREE.Material

Public ngOnChanges

ngOnChanges(changes: SimpleChanges)

Inherited from AbstractObject3D

Defined in AbstractObject3D:33

Parameters :

Name	Type	Optional
changes	`SimpleChanges`	No

Returns : void

Public addChild

addChild(object: AbstractObject3D<any>)

Inherited from AbstractObject3D

Defined in AbstractObject3D:143

Parameters :

Name	Type	Optional
object	`AbstractObject3D<any>`	No

Returns : void

Protected afterInit

afterInit()

Inherited from AbstractObject3D

Defined in AbstractObject3D:156

Returns : void

Public applyRotation

applyRotation()

Inherited from AbstractObject3D

Defined in AbstractObject3D:118

Returns : void

Public applyScale

applyScale()

Inherited from AbstractObject3D

Defined in AbstractObject3D:135

Returns : void

Public applyTranslation

applyTranslation()

Inherited from AbstractObject3D

Defined in AbstractObject3D:127

Returns : void

Public findByName

findByName(name: string)

Inherited from AbstractObject3D

Defined in AbstractObject3D:185

Parameters :

Name	Type	Optional
name	`string`	No

Returns : any

Public getChildren

getChildren()

Inherited from AbstractObject3D

Defined in AbstractObject3D:202

Returns : Array<AbstractObject3D<any>>

Public getObject

getObject()

Inherited from AbstractObject3D

Defined in AbstractObject3D:175

Returns : T

Public ngAfterViewInit

ngAfterViewInit()

Inherited from AbstractObject3D

Defined in AbstractObject3D:181

Returns : void

Public ngOnDestroy

ngOnDestroy()

Inherited from AbstractObject3D

Defined in AbstractObject3D:86

Returns : void

Public ngOnInit

ngOnInit()

Inherited from AbstractObject3D

Defined in AbstractObject3D:97

Returns : void

Protected recursionByName

recursionByName(currentNode: AbstractObject3D<any>, name: string)

Inherited from AbstractObject3D

Defined in AbstractObject3D:192

Parameters :

Name	Type	Optional
currentNode	`AbstractObject3D<any>`	No
name	`string`	No

Returns : any

Public removeChild

removeChild(object: AbstractObject3D<any>)

Inherited from AbstractObject3D

Defined in AbstractObject3D:160

Parameters :

Name	Type	Optional
object	`AbstractObject3D<any>`	No

Returns : void

Public removeChildByName

removeChildByName(name: string)

Inherited from AbstractObject3D

Defined in AbstractObject3D:206

Parameters :

Name	Type	Optional
name	`string`	No

Returns : void

Public updateParent

updateParent()

Inherited from AbstractObject3D

Defined in AbstractObject3D:111

Returns : void

Properties

Protected childlren

Type : Array<AbstractObject3D<any>>

Default value : []

Inherited from AbstractObject3D

Defined in AbstractObject3D:46

Protected object

Type : T

Inherited from AbstractObject3D

Defined in AbstractObject3D:48

import { Component, Input, Optional, SkipSelf } from '@angular/core';
import * as THREE from 'three';
import { RendererService } from '../../renderer/renderer.service';
import { provideParent } from '../../util';
import { AbstractObject3D } from '../abstract-object-3d';
import { AbstractMesh } from './abstract-mesh-3d';

@Component({
  selector: 'atft-box-mesh',
  providers: [provideParent(BoxMeshComponent)],
  template: '<ng-content></ng-content>'
})
export class BoxMeshComponent extends AbstractMesh {

  /**
   * Width; that is, the length of the edges parallel to the X axis. Optional; defaults to 1.
   */
  @Input()
  width = 1.0;

  /**
   * Height; that is, the length of the edges parallel to the Y axis. Optional; defaults to 1.
   */
  @Input()
  height = 1.0;

  /**
   * Depth; that is, the length of the edges parallel to the Z axis. Optional; defaults to 1.
   */
  @Input()
  depth = 1.0;

  /**
   * Number of segmented rectangular faces along the width of the sides. Optional; defaults to 1.
   */
  @Input()
  widthSegments = 1;

  /**
   * Number of segmented rectangular faces along the height of the sides. Optional; defaults to 1.
   */
  @Input()
  heightSegments = 1;

  /**
   * Number of segmented rectangular faces along the depth of the sides. Optional; defaults to 1.
   */
  @Input()
  depthSegments = 1;

  constructor(
    protected override rendererService: RendererService,
    @SkipSelf() @Optional() protected override parent: AbstractObject3D<any>
  ) {
    super(rendererService, parent);
  }

  protected newObject3DInstance() {
    // console.log('BoxMeshComponent.newObject3DInstance');
    const geometry = new THREE.BoxGeometry(this.width, this.height, this.depth,
      this.widthSegments, this.heightSegments, this.depthSegments);
    const material = this.getMaterial();
    const mesh = new THREE.Mesh(geometry, material);
    this.applyShadowProps(mesh);
    return mesh;
  }

}

Legend

Html element

Component

Html element with directive

File

Extends

Metadata

Index

Properties

Methods

Inputs

Outputs

Constructor

Inputs

Outputs

Methods

Properties

results matching ""

No results matching ""