Variable iObjectCommonsConst

Type declaration

• add: ((superAdd) => ((...object) => this))

  • • (superAdd): ((...object) => this)

    • Parameters

      • superAdd: ((...object) => this)

        • • (...object): this

          • Parameters

            • Rest ...object: Object3D<Event, string>[]

            Returns this

      Returns ((...object) => this)

      • • (...object): this

        • Parameters

          • Rest ...object: Object3D<Event, string>[]

          Returns this

• autoCenter: (<T>(this, setDirty?) => T)

  • • <T>(this, setDirty?): T

    • Type Parameters

      • T extends IObject3D<IObject3DEvent<IObject3DEventTypes>, IObject3DEventTypes>

      Parameters

      • this: T

      • setDirty: boolean = true

      Returns T

• autoScale: (<T>(this, autoScaleRadius?, isCentered?, setDirty?) => T)

  • • <T>(this, autoScaleRadius?, isCentered?, setDirty?): T

    • Type Parameters

      • T extends IObject3D<IObject3DEvent<IObject3DEventTypes>, IObject3DEventTypes>

      Parameters

      • this: T

      • Optional autoScaleRadius: number

      • Optional isCentered: boolean

      • setDirty: boolean = true

      Returns T

• clone: ((superClone) => ((recursive?) => this))

  • • (superClone): ((recursive?) => this)

    • Parameters

      • superClone: ((recursive?) => this)

        • • (recursive?): this

          • Parameters

            • Optional recursive: boolean

            Returns this

      Returns ((recursive?) => this)

      • • (recursive?): this

        • Parameters

          • Optional recursive: boolean

          Returns this

• copy: ((superCopy) => ((source, recursive?, ...args) => this))

  • • (superCopy): ((source, recursive?, ...args) => this)

    • Parameters

      • superCopy: ((source, recursive?, ...args) => this)

        • • (source, recursive?, ...args): this

          • Parameters

            • source: this

            • Optional recursive: boolean

            • Rest ...args: any[]

            Returns this

      Returns ((source, recursive?, ...args) => this)

      • • (source, recursive?, ...args): this

        • Parameters

          • source: this

          • Optional recursive: boolean

          • Rest ...args: any[]

          Returns this

• dispatchEvent: ((superDispatch) => ((this, event) => void))

  • • (superDispatch): ((this, event) => void)

    • Parameters

      • superDispatch: ((event) => void)

        • • (event): void

          • Fire an event type.

            Parameters

            • event: IObject3DEvent<IObject3DEventTypes> & {
                  [a: string]: any;
              }

              The event that gets fired.

            Returns void

      Returns ((this, event) => void)

      • • (this, event): void

        • Parameters

          • this: IObject3D<IObject3DEvent<IObject3DEventTypes>, IObject3DEventTypes>

          • event: IObject3DEvent<IObject3DEventTypes>

          Returns void

• dispose: ((superDispose?) => ((this, removeFromParent?) => void))

  • • (superDispose?): ((this, removeFromParent?) => void)

    • Parameters

      • Optional superDispose: ((removeFromParent?) => void)

        • • (removeFromParent?): void

          • Parameters

            • Optional removeFromParent: boolean

              remove from parent. Default true

            Returns void

      Returns ((this, removeFromParent?) => void)

      • • (this, removeFromParent?): void

        • Parameters

          • this: IObject3D<IObject3DEvent<IObject3DEventTypes>, IObject3DEventTypes>

          • removeFromParent: boolean = true

          Returns void

• eventCallbacks: {
      onAddedToParent: ((this, e) => void);
      onGeometryUpdate: ((this, e) => void);
      onRemovedFromParent: ((this, e) => void);
  }

  • onAddedToParent: ((this, e) => void)

    • • (this, e): void

      • Parameters

        • this: IObject3D<IObject3DEvent<IObject3DEventTypes>, IObject3DEventTypes>

        • e: Event

        Returns void

  • onGeometryUpdate: ((this, e) => void)

    • • (this, e): void

      • Parameters

        • this: IObject3D<IObject3DEvent<IObject3DEventTypes>, IObject3DEventTypes>

        • e: IGeometryEvent<"geometryUpdate">

        Returns void

  • onRemovedFromParent: ((this, e) => void)

    • • (this, e): void

      • Parameters

        • this: IObject3D<IObject3DEvent<IObject3DEventTypes>, IObject3DEventTypes>

        • e: Event

        Returns void

• getGeometry: ((this) => undefined | IGeometry<NormalBufferAttributes>)

  • • (this): undefined | IGeometry<NormalBufferAttributes>

    • Parameters

      • this: IObject3D<IObject3DEvent<IObject3DEventTypes>, IObject3DEventTypes> & Mesh<BufferGeometry<NormalBufferAttributes, Event, string>, Material<Event, string> | Material<Event, string>[]>

      Returns undefined | IGeometry<NormalBufferAttributes>

• getMaterial: ((this) => undefined | IMaterial<IMaterialEvent<IMaterialEventTypes>, IMaterialEventTypes> | IMaterial<IMaterialEvent<IMaterialEventTypes>, IMaterialEventTypes>[])

  • • (this): undefined | IMaterial<IMaterialEvent<IMaterialEventTypes>, IMaterialEventTypes> | IMaterial<IMaterialEvent<IMaterialEventTypes>, IMaterialEventTypes>[]

    • Parameters

      • this: IObject3D<IObject3DEvent<IObject3DEventTypes>, IObject3DEventTypes>

      Returns undefined | IMaterial<IMaterialEvent<IMaterialEventTypes>, IMaterialEventTypes> | IMaterial<IMaterialEvent<IMaterialEventTypes>, IMaterialEventTypes>[]

• getMaterials: ((this) => IMaterial<IMaterialEvent<IMaterialEventTypes>, IMaterialEventTypes>[])

  • • (this): IMaterial<IMaterialEvent<IMaterialEventTypes>, IMaterialEventTypes>[]

    • Parameters

      • this: IObject3D<IObject3DEvent<IObject3DEventTypes>, IObject3DEventTypes>

      Returns IMaterial<IMaterialEvent<IMaterialEventTypes>, IMaterialEventTypes>[]

• initGeometry: ((this) => void)

  • • (this): void

    • Parameters

      • this: IObject3D<IObject3DEvent<IObject3DEventTypes>, IObject3DEventTypes>

      Returns void

• initMaterial: ((this) => void)

  • • (this): void

    • Parameters

      • this: IObject3D<IObject3DEvent<IObject3DEventTypes>, IObject3DEventTypes>

      Returns void

• makeUiConfig: ((this, isMesh?) => UiObjectConfig)

  • • (this, isMesh?): UiObjectConfig

    • Parameters

      • this: IObject3D<IObject3DEvent<IObject3DEventTypes>, IObject3DEventTypes>

      • Optional isMesh: boolean

      Returns UiObjectConfig

• refreshUi: ((this) => void)

  • • (this): void

    • Parameters

      • this: IObject3D<IObject3DEvent<IObject3DEventTypes>, IObject3DEventTypes>

      Returns void

• setDirty: ((this, options?) => void)

  • • (this, options?): void

    • Parameters

      • this: IObject3D<IObject3DEvent<IObject3DEventTypes>, IObject3DEventTypes>

      • Optional options: IObjectSetDirtyOptions

      Returns void

• setGeometry: ((this, geometry) => void)

  • • (this, geometry): void

    • Parameters

      • this: IObject3D<IObject3DEvent<IObject3DEventTypes>, IObject3DEventTypes> & Mesh<BufferGeometry<NormalBufferAttributes, Event, string>, Material<Event, string> | Material<Event, string>[]>

      • geometry: undefined | IGeometry<NormalBufferAttributes>

      Returns void

• setMaterial: ((this, material) => undefined | never[])

  • • (this, material): undefined | never[]

    • Parameters

      • this: IObject3D<IObject3DEvent<IObject3DEventTypes>, IObject3DEventTypes>

      • material: undefined | IMaterial<IMaterialEvent<IMaterialEventTypes>, IMaterialEventTypes> | IMaterial<IMaterialEvent<IMaterialEventTypes>, IMaterialEventTypes>[]

      Returns undefined | never[]

• setMaterials: ((this, materials) => void)

  • • (this, materials): void

    • Parameters

      • this: IObject3D<IObject3DEvent<IObject3DEventTypes>, IObject3DEventTypes>

      • materials: IMaterial<IMaterialEvent<IMaterialEventTypes>, IMaterialEventTypes>[]

      Returns void

• upgradeObject3D: ((this, parent?, objectProcessor?) => void)

  • • (this, parent?, objectProcessor?): void

    • Converts three.js Object3D to IObject3D, setup object events, adds utility methods, and runs objectProcessor.

      Parameters

      • this: IObject3D<IObject3DEvent<IObject3DEventTypes>, IObject3DEventTypes>

      • Optional parent: IObject3D<IObject3DEvent<IObject3DEventTypes>, IObject3DEventTypes>

      • Optional objectProcessor: IObjectProcessor

      Returns void