NgxAutoRotationController

Auto rotation controller

See the ngx3js docs page for details.

Hierarchy

NgxAbstractThreeController
- NgxAutoRotationController

Constructors

constructor

new NgxAutoRotationController(refObject3D: I3JS.Object3D<Event>, refObject2D: IHtmlCollection): NgxAutoRotationController

Inherited from NgxAbstractThreeController.constructor
- Defined in lib/controller.abstract.ts:105
Creates an instance of abstract three controller.

Parameters
- refObject3D: I3JS.Object3D<Event>
- refObject2D: IHtmlCollection
Returns NgxAutoRotationController

Properties

_cameras

_cameras: QueryList<NgxCameraComponent> = null

The Cameras of abstract three controller

_canvases

_canvases: QueryList<NgxCanvasComponent> = null

The Canvases of abstract three controller

_renderer

_renderer: Renderer = null

The Renderer of abstract three controller

_scenes

_scenes: QueryList<NgxSceneComponent> = null

The Scenes of abstract three controller

Protected _tweenTimer

_tweenTimer: I3JS.Tween<any> = null

Tween timer of abstract three controller

Protected amplitude

amplitude: number = null

The Amplitude of abstract three controller

Protected duration

duration: number = 3

The duration run animation in sec

Protected easing

easing: string = null

The Easing method

Protected enable

enable: boolean = true

Enable This Controller

Protected linearRatio

linearRatio: number = null

Linear ratio of abstract three controller

Protected overshoot

overshoot: number = null

The Overshoot of abstract three controller

Protected period

period: number = null

The Period of abstract three controller

Protected power

power: number = null

The Power of abstract three controller

Protected refObject

refObject: I3JS.Object3D<Event> = null

Ref object of abstract three controller

Protected refObject2d

refObject2d: IHtmlCollection = null

Ref object2d of abstract three controller

Protected repeat

repeat: number = null

The Repeat Count

Protected steps

steps: number = null

The Steps of abstract three controller

Protected template

template: string = null

Protected x

x: number = 0

The X of auto rotation controller

Protected y

y: number = 0

The Y of auto rotation controller

Protected yoyo

yoyo: boolean = null

Protected yoyoMode

yoyoMode: boolean = null

Yoyo mode of abstract three controller

Protected z

z: number = 0

The Z of auto rotation controller

Accessors

Protected camera

get camera(): I3JS.Camera

Inherited from NgxAbstractThreeController.camera
- Defined in lib/controller.abstract.ts:459
Gets camera

Returns I3JS.Camera

Protected geometry

get geometry(): I3JS.BufferGeometry

Inherited from NgxAbstractThreeController.geometry
- Defined in lib/controller.abstract.ts:429
Gets geometry

Returns I3JS.BufferGeometry

Protected material

get material(): I3JS.Material

Inherited from NgxAbstractThreeController.material
- Defined in lib/controller.abstract.ts:401
Gets material

Returns I3JS.Material

Protected materials

get materials(): I3JS.Material[]

Inherited from NgxAbstractThreeController.materials
- Defined in lib/controller.abstract.ts:415
Gets materials

Returns I3JS.Material[]

Protected position

get position(): I3JS.Vector3

Inherited from NgxAbstractThreeController.position
- Defined in lib/controller.abstract.ts:380
Gets position

Returns I3JS.Vector3

Protected rotation

get rotation(): I3JS.Euler

Inherited from NgxAbstractThreeController.rotation
- Defined in lib/controller.abstract.ts:394
Gets rotation

Returns I3JS.Euler

Protected scale

get scale(): I3JS.Vector3

Inherited from NgxAbstractThreeController.scale
- Defined in lib/controller.abstract.ts:387
Gets scale

Returns I3JS.Vector3

Protected scene

get scene(): I3JS.Scene

Inherited from NgxAbstractThreeController.scene
- Defined in lib/controller.abstract.ts:439
Gets scene

Returns I3JS.Scene

Methods

awake

awake(): void

Inherited from NgxAbstractThreeController.awake
- Defined in lib/controller.abstract.ts:731
Awakes abstract three controller

Returns void

fixedUpdate

fixedUpdate(): void

Inherited from NgxAbstractThreeController.fixedUpdate
- Defined in lib/controller.abstract.ts:771
Fixed update

Returns void

Protected getAbstractMaterialComponent

getAbstractMaterialComponent(refObject?: I3JS.Object3D<Event>): NgxAbstractMaterialComponent

Inherited from NgxAbstractThreeController.getAbstractMaterialComponent
- Defined in lib/controller.abstract.ts:629
Gets abstract material component

Parameters
- Optional refObject: I3JS.Object3D<Event>
Returns NgxAbstractMaterialComponent
abstract material component

Protected getAmplitude

getAmplitude(def?: number): number

Inherited from NgxAbstractThreeController.getAmplitude
- Defined in lib/controller.abstract.ts:156
Gets amplitude

Parameters
- Optional def: number
Returns number
amplitude

Protected getCameraByName

getCameraByName(name: string): I3JS.Camera

Inherited from NgxAbstractThreeController.getCameraByName
- Defined in lib/controller.abstract.ts:475
Gets camera by name

Parameters
- name: string
  
  The name of the object (doesn't need to be unique). Default is an empty string.
Returns I3JS.Camera
camera by name

Protected getComponent

getComponent(refObject?: I3JS.Object3D<Event>): any

Inherited from NgxAbstractThreeController.getComponent
- Defined in lib/controller.abstract.ts:579
Gets component

Parameters
- Optional refObject: I3JS.Object3D<Event>
Returns any
component

Protected getComponent2D

getComponent2D(refObject?: IHtmlCollection): NgxVisualComponent

Inherited from NgxAbstractThreeController.getComponent2D
- Defined in lib/controller.abstract.ts:595
Gets component2 d

Parameters
- Optional refObject: IHtmlCollection
Returns NgxVisualComponent
component2 d

Protected getController

getController<T>(type: new (obj: any) => T, refObject?: I3JS.Object3D<Event>): T

Inherited from NgxAbstractThreeController.getController
- Defined in lib/controller.abstract.ts:667
Gets controller

Type parameters
- T: NgxAbstractThreeController<T>
Parameters
- type: new (obj: any) => T
  - - new (obj: any): T
    - Parameters
      - obj: any
      Returns T
- Optional refObject: I3JS.Object3D<Event>
Returns T
controller

Protected getControllers

getControllers<T>(type?: new (obj: any) => T, refObject?: I3JS.Object3D<Event>): T[]

Inherited from NgxAbstractThreeController.getControllers
- Defined in lib/controller.abstract.ts:690
Gets controllers

Type parameters
- T: NgxAbstractThreeController<T>
Parameters
- type: new (obj: any) => T = null
  - - new (obj: any): T
    - Parameters
      - obj: any
      Returns T
- Optional refObject: I3JS.Object3D<Event>
Returns T[]
controllers

Protected getDuration

getDuration(def?: number): number

Inherited from NgxAbstractThreeController.getDuration
- Defined in lib/controller.abstract.ts:116
Gets duration

Parameters
- Optional def: number
Returns number
duration

Protected getEasing

getEasing(def?: string, isTemplate?: boolean): I3JS.EasingFunction

Inherited from NgxAbstractThreeController.getEasing
- Defined in lib/controller.abstract.ts:217
Gets easing

Parameters
- Optional def: string
- Optional isTemplate: boolean
Returns I3JS.EasingFunction
easing

Protected getHtmlElement

getHtmlElement(refObject?: IHtmlCollection): HTMLElement

Inherited from NgxAbstractThreeController.getHtmlElement
- Defined in lib/controller.abstract.ts:612
Gets html element

Parameters
- Optional refObject: IHtmlCollection
Returns HTMLElement
html element

Protected getLinearRatio

getLinearRatio(def?: number): number

Inherited from NgxAbstractThreeController.getLinearRatio
- Defined in lib/controller.abstract.ts:176
Gets linear ratio

Parameters
- Optional def: number
Returns number
linear ratio

Protected getObjectByFunction

getObjectByFunction(fn: (arg: any) => boolean, fromTop?: boolean, obj3d?: I3JS.Object3D<Event>): I3JS.Object3D<Event>

Inherited from NgxAbstractThreeController.getObjectByFunction
- Defined in lib/controller.abstract.ts:530
Gets object by function

Parameters
- fn: (arg: any) => boolean
  - - (arg: any): boolean
    - Parameters
      - arg: any
      Returns boolean
- fromTop: boolean = false
- obj3d: I3JS.Object3D<Event> = null
Returns I3JS.Object3D<Event>
object by function

Protected getObjectByName

getObjectByName(name: string, fromTop?: boolean): I3JS.Object3D<Event>

Inherited from NgxAbstractThreeController.getObjectByName
- Defined in lib/controller.abstract.ts:493
Gets object by name

Parameters
- name: string
  
  The name of the object (doesn't need to be unique). Default is an empty string.
- fromTop: boolean = false
Returns I3JS.Object3D<Event>
object by name

Protected getObjectByProperty

getObjectByProperty(name: string, value: string, fromTop?: boolean): I3JS.Object3D<Event>

Inherited from NgxAbstractThreeController.getObjectByProperty
- Defined in lib/controller.abstract.ts:511
Gets object by property

Parameters
- name: string
  
  The name of the object (doesn't need to be unique). Default is an empty string.
- value: string
- fromTop: boolean = false
Returns I3JS.Object3D<Event>
object by property

Protected getObjectsByFunction

getObjectsByFunction(fn: (arg: any) => boolean, fromTop?: boolean, obj3d?: I3JS.Object3D<Event>, result?: I3JS.Object3D<Event>[]): I3JS.Object3D<Event>[]

Inherited from NgxAbstractThreeController.getObjectsByFunction
- Defined in lib/controller.abstract.ts:557
Gets objects by function

Parameters
- fn: (arg: any) => boolean
  - - (arg: any): boolean
    - Parameters
      - arg: any
      Returns boolean
- fromTop: boolean = false
- obj3d: I3JS.Object3D<Event> = null
- result: I3JS.Object3D<Event>[] = []
Returns I3JS.Object3D<Event>[]
objects by function

Protected getPeriod

getPeriod(def?: number): number

Inherited from NgxAbstractThreeController.getPeriod
- Defined in lib/controller.abstract.ts:166
Gets period

Parameters
- Optional def: number
Returns number
period

Protected getPower

getPower(def?: number): number

Inherited from NgxAbstractThreeController.getPower
- Defined in lib/controller.abstract.ts:186
Gets power

Parameters
- Optional def: number
Returns number
power

Protected getRepeat

getRepeat(def?: number): number

Inherited from NgxAbstractThreeController.getRepeat
- Defined in lib/controller.abstract.ts:126
Gets repeat

Parameters
- Optional def: number
Returns number
repeat

Protected getSteps

getSteps(def?: number): number

Inherited from NgxAbstractThreeController.getSteps
- Defined in lib/controller.abstract.ts:206
Gets steps

Parameters
- Optional def: number
Returns number
steps

Protected getTweenTimer

getTweenTimer(object: object): I3JS.Tween<any>

Inherited from NgxAbstractThreeController.getTweenTimer
- Defined in lib/controller.abstract.ts:746
Gets tween timer

Parameters
- object: object
Returns I3JS.Tween<any>

Protected getYoyo

getYoyo(def?: boolean): boolean

Inherited from NgxAbstractThreeController.getYoyo
- Defined in lib/controller.abstract.ts:136
Gets yoyo

Parameters
- Optional def: boolean
Returns boolean
true if yoyo

Protected getYoyoMode

getYoyoMode(def?: boolean): boolean

Inherited from NgxAbstractThreeController.getYoyoMode
- Defined in lib/controller.abstract.ts:196
Gets yoyo mode

Parameters
- Optional def: boolean
Returns boolean
true if yoyo mode

lateUpdate

lateUpdate(): void

Inherited from NgxAbstractThreeController.lateUpdate
- Defined in lib/controller.abstract.ts:782
Lates update

Returns void

onApplicationQuit

onApplicationQuit(): void

Inherited from NgxAbstractThreeController.onApplicationQuit
- Defined in lib/controller.abstract.ts:787
Determines whether application quit on

Returns void

onDestory

onDestory(): void

Inherited from NgxAbstractThreeController.onDestory
- Defined in lib/controller.abstract.ts:799
Determines whether destory on

Returns void

onDisable

onDisable(): void

Inherited from NgxAbstractThreeController.onDisable
- Defined in lib/controller.abstract.ts:792
Determines whether disable on

Returns void

onEnable

onEnable(): void

Inherited from NgxAbstractThreeController.onEnable
- Defined in lib/controller.abstract.ts:756
Determines whether enable on

Returns void

reset

reset(): void

Inherited from NgxAbstractThreeController.reset
- Defined in lib/controller.abstract.ts:761
Resets abstract three controller

Returns void

setCanvas

setCanvas(canvas: IHtmlCollection): void

Inherited from NgxAbstractThreeController.setCanvas
- Defined in lib/controller.abstract.ts:357
Sets canvas

Parameters
- canvas: IHtmlCollection
Returns void

setObject2d

setObject2d(refObject: IHtmlCollection): void

Inherited from NgxAbstractThreeController.setObject2d
- Defined in lib/controller.abstract.ts:373
Sets object2d

Parameters
- refObject: IHtmlCollection
Returns void

setObject3d

setObject3d(refObject: I3JS.Object3D<Event>): void

Inherited from NgxAbstractThreeController.setObject3d
- Defined in lib/controller.abstract.ts:365
Sets object3d

Parameters
- refObject: I3JS.Object3D<Event>
Returns void

setRenderer

setRenderer(renderer: Renderer, scenes: QueryList<NgxSceneComponent>, cameras: QueryList<NgxCameraComponent>, canvases: QueryList<NgxCanvasComponent>): void

Inherited from NgxAbstractThreeController.setRenderer
- Defined in lib/controller.abstract.ts:296
Sets renderer

Parameters
- renderer: Renderer
- scenes: QueryList<NgxSceneComponent>
- cameras: QueryList<NgxCameraComponent>
- canvases: QueryList<NgxCanvasComponent>
Returns void

setScene

setScene(scene: I3JS.Scene): void

Inherited from NgxAbstractThreeController.setScene
- Defined in lib/controller.abstract.ts:349
Sets scene

Parameters
- scene: I3JS.Scene
Returns void

setVariables

setVariables(variables: {}): void

Overrides NgxAbstractThreeController.setVariables
- Defined in lib/controller.abstract.ts:828
Sets variables

Parameters
- variables: {}
  - [key: string]: any
Returns void

start

start(): void

Inherited from NgxAbstractThreeController.start
- Defined in lib/controller.abstract.ts:766
Starts abstract three controller

Returns void

update

update(rendererTimer: IRendererTimer): void

Inherited from NgxAbstractThreeController.update
- Defined in lib/controller.abstract.ts:777
Updates abstract three controller

Parameters
- rendererTimer: IRendererTimer
Returns void

Hierarchy

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Parameters

refObject3D: I3JS.Object3D<Event>

refObject2D: IHtmlCollection

Returns NgxAutoRotationController

Properties

_cameras

_canvases

_renderer

_scenes

Protected _tweenTimer

Protected amplitude

Protected duration

Protected easing

Protected enable

Protected linearRatio

Protected overshoot

Protected period

Protected power

Protected refObject

Protected refObject2d

Protected repeat

Protected steps

Protected template

Protected x

Protected y

Protected yoyo

Protected yoyoMode

Protected z

Accessors

Protected camera

Returns I3JS.Camera

Protected geometry

Returns I3JS.BufferGeometry

Protected material

Returns I3JS.Material

Protected materials

Returns I3JS.Material[]

Protected position

Returns I3JS.Vector3

Protected rotation

Returns I3JS.Euler

Protected scale

Returns I3JS.Vector3

Protected scene

Returns I3JS.Scene

Methods

awake

Returns void

fixedUpdate

Returns void

Protected getAbstractMaterialComponent

Parameters

Optional refObject: I3JS.Object3D<Event>

Returns NgxAbstractMaterialComponent

Protected getAmplitude

Parameters

Optional def: number

Returns number

Protected getCameraByName

Parameters

name: string

Returns I3JS.Camera

Protected getComponent

Parameters

Optional refObject: I3JS.Object3D<Event>

Returns any

Protected getComponent2D

Parameters

Optional refObject: IHtmlCollection

Returns NgxVisualComponent

Protected getController

Type parameters