Class BaseObject<Geometry_Params>

Type Parameters

Geometry_Params = any

Hierarchy (view full)

BaseObject

Constructors

constructor

new BaseObject<Geometry_Params>(__namedParameters): BaseObject<Geometry_Params>
Type Parameters
- Geometry_Params = any
Parameters
- __namedParameters: BaseObjectParams & {
  prefabName?: string;
  }
Returns BaseObject<Geometry_Params>
- Defined in packages/pebble/core/src/baseObject.ts:101

Properties

_id

_id: string

_prefabId

_prefabId: string

`Private` _scriptsTypes

_scriptsTypes: typeof BaseBehaviour[] = []

initiaProps

initiaProps: any = {}

name

name: string

`Private` scripts

scripts: {
[key: string]: BaseBehaviour;
}

Type declaration

[key: string]: BaseBehaviour

`Optional` threeObj

threeObj?: Object3D<Event>

Methods

`Private` applyDefaults

applyDefaults(props): void
Parameters
- props: any
Returns void
- Defined in packages/pebble/core/src/baseObject.ts:201

`Private` applyNestedValues

applyNestedValues(target, values, field): void
Parameters
- target: any
- values: any
- field: any
Returns void
- Defined in packages/pebble/core/src/baseObject.ts:171

applyThreeProps

applyThreeProps(): void
Returns void
- Defined in packages/pebble/core/src/baseObject.ts:265

createThreeObject

createThreeObject(): Promise<void>
Returns Promise<void>
- Defined in packages/pebble/core/src/baseObject.ts:217

destroy

destroy(): void
Returns void
- Defined in packages/pebble/core/src/baseObject.ts:286

getAllGizmos

getAllGizmos(): Object3D<Event>[]
Returns Object3D<Event>[]
- Defined in packages/pebble/core/src/baseObject.ts:151

`Protected` getGizmos

getGizmos(): Object3D<Event>[]
Returns Object3D<Event>[]
- Defined in packages/pebble/core/src/baseObject.ts:167

getScript

getScript<T>(scriptType): InstanceType<T>
Type Parameters
- T extends typeof BaseBehaviour
Parameters
- scriptType: T
Returns InstanceType<T>
- Defined in packages/pebble/core/src/baseObject.ts:85

`Protected` getThreeObject

getThreeObject(): undefined | Object3D<Event> | Promise<undefined | Object3D<Event>>
Returns undefined | Object3D<Event> | Promise<undefined | Object3D<Event>>
- Defined in packages/pebble/core/src/baseObject.ts:193

initializeScripts

initializeScripts(callback): void
Parameters
- callback: ((script) => BaseBehaviour)
  - - (script): BaseBehaviour
    - Parameters
      script: typeof BaseBehaviour
      Returns BaseBehaviour
Returns void
- Defined in packages/pebble/core/src/baseObject.ts:93

`Protected` registerEditableField

registerEditableField<T>(editableParams): void
Type Parameters
- T = any
Parameters
- editableParams: {
  [key: string]: Editable<T>;
  }
  - [key: string]: Editable<T>
Returns void
- Defined in packages/pebble/core/src/baseObject.ts:130

`Protected` registerMaterial

registerMaterial(defaultMaterialProps, materialProps): any
Parameters
- defaultMaterialProps: MeshBasicMaterialParameters
- materialProps: MeshBasicMaterialParameters
Returns any
- Defined in packages/pebble/core/src/baseObject.ts:246

registerScript

registerScript<T>(scriptType): void
Type Parameters
- T extends typeof BaseBehaviour
Parameters
- scriptType: Partial<T>
Returns void
- Defined in packages/pebble/core/src/baseObject.ts:81

start

start(_pebbleScene): void
Parameters
- _pebbleScene: PebbleScene
Returns void
- Defined in packages/pebble/core/src/baseObject.ts:276

update

update(delta): void
Parameters
- delta: number
Returns void
- Defined in packages/pebble/core/src/baseObject.ts:280

updateGeometry

updateGeometry(): Promise<void>
Returns Promise<void>
- Defined in packages/pebble/core/src/baseObject.ts:256

updateMaterial

updateMaterial(materialProps): void
Parameters
- materialProps: any
Returns void
- Defined in packages/pebble/core/src/baseObject.ts:234

`Protected` watchParams

watchParams<T>(params, callback): any
Type Parameters
- T extends object
Parameters
- params: T
- callback: ((val) => void)
  - - (val): void
    - Parameters
      val: any
      Returns void
Returns any
- Defined in packages/pebble/core/src/baseObject.ts:227

`Static` LoadAssets

LoadAssets(): Promise<void>
Returns Promise<void>
- Defined in packages/pebble/core/src/baseObject.ts:89

Generated using TypeDoc