Options
All
  • Public
  • Public/Protected
  • All
Menu

Class NgxControlComponent

NgxControlComponent

See the ngx3js docs page for details. See the ngx control page for a live demo.

Three Type Type Key Acceptable Input
OrbitControls OrbitControls, Orbit autoRotate, autoRotateSpeed, enableDamping, dampingFactor, enablePan, enableKeys, screenSpacePanning, minDistance, maxDistance, enableZoom, minZoom, maxZoom, rotateSpeed, zoomSpeed, panSpeed, minPolarAngle, maxPolarAngle
TransformControls TransformControls, Transform eventListener(dragging-changed, objectChange)
DragControls DragControls, Drag camera
TrackballControls TrackballControls, Trackball staticMoving, keys
FlyControls FlyControls, Fly camera, movementSpeed, rollSpeed, dragToLook, autoForward
PointerLockControls PointerLockControls, PointerLock objects
FirstPersonControls FirstPersonControls, FirstPerson movementSpeed, lookSpeed, lookVertical, autoForward, activeLook, heightSpeed, heightCoef, heightMin, heightMax, verticalMin, verticalMax, mouseDragOn
ArcballControls ArcballControls, Arcball camera, gizmoVisible
NgxSelectBoxControls SelectBoxControls, SelectBox camera
CsmControls CsmControls, Csm maxFar, cascades, mode, shadowMapSize, lightDirectionX, lightDirectionY, lightDirectionZ
NgxPlaneControls PlaneControls, Plane rotateSpeed, zoomSpeed, panSpeed, minDistance, maxDistance
<ngx3js-renderer
[controlType]="'orbit'"
[controlOptions]="{ enablePan: false, enableDamping: true }"
></ngx3js-renderer>
<ngx3js-control
[type]="'arcball'" [gizmoVisible]="true"
></ngx3js-control>
<ngx3js-control
[type]="'DeviceOrientationControls'"
></ngx3js-control>
<ngx3js-control
[type]="'plane'"
></ngx3js-control>
<ngx3js-control
[type]="'FlyControls'"
[movementSpeed]="1000" [rollSpeed]="7.5" [autoForward]="false"
[dragToLook]="false"
></ngx3js-control>
<ngx3js-control
[type]="'PointerLockControls'"
(onLoad)="setPointerLock($event)"
>
</ngx3js-control>
<ngx3js-control
[type]="'DragControls'"
(onLoad)="setDragControl($event)"
></ngx3js-control>
<ngx3js-renderer
[controlType]="'FirstPerson'" [controlOptions]="{
enablePan: false,
enableDamping: true,
movementSpeed: 1000,
lookSpeed: 0.125,
lookVertical: true
}"
></ngx3js-renderer>
<ngx3js-control
[type]="'TransformControls'"
(eventListener)="setTransformEventListener($event)"
(onLoad)="setTransformControl($event)"
></ngx3js-control>
<ngx3js-control
[type]="'TrackballControls'" [rollSpeed]="1.0" [zoomSpeed]="1.2 "
[panSpeed]="0.8" [keys]="['KeyA', 'KeyS', 'KeyD']"
></ngx3js-control>
<ngx3js-renderer
[controlType]="'selectbox'"
[controlOptions]="{
enablePan: false,
enableDamping: true
}"
></ngx3js-renderer>
<ngx3js-control
[type]="'csm'" [maxFar]="1000" [cascades]="4 "
[mode]="'practical'" [scene]="scene" [shadowMapSize]="1024 "
[lightDirectionX]="-1" [lightDirectionY]="-1" [lightDirectionZ]="-1 "
[camera]="camera"
(onLoad)="setCsm($event)"
></ngx3js-control>

Hierarchy

Implements

  • OnInit
  • OnDestroy
  • OnChanges
  • AfterContentInit

Index

Constructors

constructor

Properties

Protected OBJECT_ATTR

OBJECT_ATTR: string[] = ...

Object attr of abstract subscribe component

Protected _changeList

_changeList: string[] = null

Change list of abstract subscribe component

Protected _needUpdate

_needUpdate: boolean = true

Need update of abstract subscribe component

activeLook

activeLook: boolean = null

The activeLook of control

autoForward

autoForward: boolean = null

The autoForward of control

autoRotate

autoRotate: boolean = null

The autoRotate of control

autoRotateSpeed

autoRotateSpeed: number = null

The autoRotateSpeed of control

camera

camera: any = null

The camera of control

cascades

cascades: number = null

The cascades of control

constrainVertical

constrainVertical: boolean = null

The constrainVertical of control

dampingFactor

dampingFactor: number = null

The dampingFactor of control

debug

debug: boolean = false

Debug this Object

dragToLook

dragToLook: boolean = null

The dragToLook of control

enableDamping

enableDamping: boolean = null

The enableDamping of control

enableKeys

enableKeys: boolean = null

The enableKeys of control

enablePan

enablePan: boolean = null

The enablePan of control

enableZoom

enableZoom: boolean = null

The enableZoom of control

enabled

enabled: boolean = true

Enabled or Not

gizmoVisible

gizmoVisible: boolean = null

The gizmoVisible of control

heightCoef

heightCoef: number = null

The heightCoef of control

heightMax

heightMax: number = null

The heightMax of control

heightMin

heightMin: number = null

The heightMin of control

heightSpeed

heightSpeed: boolean = null

The heightSpeed of control

Protected id

id: string = ''

The Id of abstract subscribe component

keys

keys: string[] = null

The keys of control

lightDirectionX

lightDirectionX: number = null

The lightDirectionX of control

lightDirectionY

lightDirectionY: number = null

The lightDirectionY of control

lightDirectionZ

lightDirectionZ: number = null

The lightDirectionZ of control

lookSpeed

lookSpeed: number = null

The lookSpeed of control

lookVertical

lookVertical: boolean = null

The lookVertical of control

maxAzimuthAngle

maxAzimuthAngle: number = null

Input of ngx control component

maxDistance

maxDistance: number = null

The maxDistance of control

maxFar

maxFar: number = null

The maxFar of control

maxPolarAngle

maxPolarAngle: number = null

The maxPolarAngle of control

maxZoom

maxZoom: number = null

The maxZoom of control

minAzimuthAngle

minAzimuthAngle: number = null

Input of ngx control component

minDistance

minDistance: number = null

The minDistance of control

minPolarAngle

minPolarAngle: number = null

The minPolarAngle of control

minZoom

minZoom: number = null

The minZoom of control

mode

mode: string = null

The mode of control

Notice - case insensitive.

mouseDragOn

mouseDragOn: boolean = null

The mouseDragOn of control

movementSpeed

movementSpeed: number = null

The movementSpeed of control

onDestory

onDestory: EventEmitter<NgxControlComponent> = ...

Will be called when before destory. The argument will be the loaded self

onLoad

onLoad: EventEmitter<NgxControlComponent> = ...

Will be called when load completes. The argument will be the loaded self

overrideParams

overrideParams: {} = null

The override params

Type declaration

  • [key: string]: any

panSpeed

panSpeed: number = null

The panSpeed of control

Protected parent

parent: any = null

The Parent of abstract subscribe component

rollSpeed

rollSpeed: number = null

The rollSpeed of control

rotateSpeed

rotateSpeed: number = null

The rotateSpeed of control

scene

scene: any = null

The scene of control

screenSpacePanning

screenSpacePanning: boolean = null

The screenSpacePanning of control

Protected selfAny

selfAny: any = ...

shadowMapSize

shadowMapSize: number = null

The shadowMapSize of control

staticMoving

staticMoving: boolean = null

The staticMoving of control

Protected subscribeType

subscribeType: string = null

Subscribe type of abstract subscribe component

target

target: any = null

The target of control

tween

tween: {} = null

Tween animation params

Type declaration

  • [key: string]: any

type

type: string = 'orbit'

The type of control

See the ngx TransformControls control page for a live demo. See the ngx DragControls control page for a live demo. See the ngx OrbitControls control page for a live demo.

Three Type Value String(case insensitive)
FlyControls FlyControls, Fly
FirstPersonControls FirstPersonControls, FirstPerson
DeviceOrientationControls DeviceOrientationControls, DeviceOrientation
DragControls DragControls, Drag
TransformControls TransformControls, Transform
TrackballControls TrackballControls, Trackball
ArcballControls ArcballControls, Arcball
CSM CSM
PlaneControls PlaneControls, Plane
OrbitControls OrbitControls, Orbit

userData

userData: any = null

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.

verticalMax

verticalMax: number = null

The verticalMax of control

verticalMin

verticalMin: number = null

The verticalMin of control

windowExport

windowExport: string = null

Export this Object to window global variables

xDistance

xDistance: number = null

The xDistance of control

yDistance

yDistance: number = null

The yDistance of control

zoomSpeed

zoomSpeed: number = null

The zoomSpeed of control

Accessors

needUpdate

  • set needUpdate(value: boolean): void
  • Sets need update

    Parameters

    • value: boolean

    Returns void

Methods

addChanges

  • addChanges(key: string | string[] | SimpleChanges): void

Protected applyChanges

  • applyChanges(changes: string[]): void

Protected callOnLoad

  • callOnLoad(): void

Protected checkChanges

  • checkChanges(changes: SimpleChanges): SimpleChanges

Protected clearChanges

  • clearChanges(): void

Protected consoleLog

  • consoleLog(key: string, object: any, level?: string): void

Protected consoleLogTime

  • consoleLogTime(key: string, object: any, repeat?: number): void

Protected destroyLocalComponent

  • destroyLocalComponent(key: string): void

dispose

  • dispose(): void

Protected getChanges

  • getChanges(): string[]

getControl

  • getControl(): any

getId

  • getId(): string

getObject

  • getObject<T>(): T

getSubscribe

  • getSubscribe(): Observable<string[]>

Protected getTimeout

  • getTimeout(timeDelay?: number): Promise<void>

getUserData

  • getUserData(): {}

Protected initLocalComponent

  • initLocalComponent<T>(key: string, component: T): T

Protected isIdEuals

  • isIdEuals(id: string): boolean

ngAfterContentInit

  • ngAfterContentInit(): void

ngOnChanges

  • ngOnChanges(changes: SimpleChanges): void
  • A callback method that is invoked immediately after the default change detector has checked the directive's data-bound properties for the first time, and before any of the view or content children have been checked. It is invoked only once when the directive is instantiated. default change detector has checked data-bound properties if at least one has changed, and before the view and content children are checked.

    Parameters

    • changes: SimpleChanges

      The changed properties.

    Returns void

ngOnDestroy

  • ngOnDestroy(): void

ngOnInit

  • ngOnInit(): void
  • A callback method that is invoked immediately after the default change detector has checked the directive's data-bound properties for the first time, and before any of the view or content children have been checked. It is invoked only once when the directive is instantiated.

    Returns void

render

resetTween

  • resetTween(): void

runSubscribeNext

  • runSubscribeNext(key: string | string[]): void

setCameraDomElement

Protected setObject

  • setObject(obj: any): void

setParent

  • setParent(parent: any): boolean

setSubscribeNext

  • setSubscribeNext(key: string | string[]): void

setSubscribeType

  • setSubscribeType(subscribeType: string): void

setTween

  • setTween(tweenData: {}): void

setTweenTarget

  • setTweenTarget(tweenTarget: any): void

setUserData

  • setUserData(key: string, value: any): void

Protected subscribeListQuery

  • subscribeListQuery(queryList: QueryList<any>, subscribeKey: string, changeKey: string): void

Protected subscribeListQueryChange

  • subscribeListQueryChange(queryList: QueryList<any>, subscribeKey: string, changeKey: string): void

Protected subscribeRefer

  • subscribeRefer(key: string, subscription: Subscription): void

Protected subscribeReferList

  • subscribeReferList(key: string, subscription: Subscription): void

Protected unSubscribeRefer

  • unSubscribeRefer(key: string): void

Protected unSubscribeReferList

  • unSubscribeReferList(key: string): void

Protected unSubscription

  • unSubscription(subscriptions: Subscription[]): Subscription[]

updateInputParams

  • updateInputParams(params: {}, firstChange?: boolean, changes?: SimpleChanges, type?: string): void

Generated using TypeDoc