Class Viewer3d

Hierarchy

Cbn.ctrls.Base
- Viewer3d

Index

Constructors

Properties

Methods

getCtrlPropValue getHeight getSize getTooltip getViewer hasCls injectViewer on setCtrlBckgr setCtrlHeight setCtrlVisibility setCtrlWidth setDisabled setTooltipContent setUserCssClass startAR un

Constructors

constructor

new Viewer3d(): Viewer3d
Returns Viewer3d

Inherited from Base.constructor

Properties

ctrlId

ctrlId: string

This is the actual name of the component

el

el: ExtElement

rendered

rendered: boolean

self

self: {
TypeStr: string;
}

Type declaration

TypeStr: string

`Static` TypeStr

TypeStr: string

Methods

getCtrlPropValue

getCtrlPropValue(propertyName: string): any
Parameters
- propertyName: string
  
  One of CtrlProperties
Returns any

Inherited from Base.getCtrlPropValue

getHeight

getHeight(): number
Returns number

Inherited from Base.getHeight

getSize

getSize(): {
height: number;
width: number;
}
Returns {
height: number;
width: number;
}
- height: number
- width: number
Inherited from Base.getSize

getTooltip

getTooltip(): Instance
Returns a tooltip instance of the control based on tippy.js

See
Documentation of tippy.js

Returns Instance

Inherited from Base.getTooltip

getViewer

getViewer(): Promise<Viewer>
Waits until the viewer was fully loaded & bootstrapped before returning the viewer instance.

Returns
A Viewer instance or throws if an unexpected error occurs during bootstrapping.

Returns Promise<Viewer>

hasCls

hasCls(cls: string): boolean
Parameters
- cls: string
Returns boolean

Inherited from Base.hasCls

injectViewer

injectViewer(ViewerClass: any, eventCallbacks?: {
    onAfterParametersApplied?: ((modelVisibility: ModelVisibilityEntry[], parameterValues: ParameterValues) => void);
    onAfterViewerCreated?: ((viewer: Viewer) => Promise<void>);
    onBeforeCreateViewer?: ((viewerSettings: ViewerSettings) => void);
}): void

When setting the viewer controls version property to Injected, this function is used to provide the viewer which should be used by the control.

Example usage:

import { Viewer } from '@combeenation/3d-viewer';
// ...
CfgrUtils.onCfgrReady(() => {
  // ...
  CtrlUtils.getViewerCtrl('viewer3d').injectViewer(Viewer);
  // ...
});

See Combeenation docs for more details on how to use this.

Parameters

ViewerClass: any

`Optional` eventCallbacks: {
    onAfterParametersApplied?: ((modelVisibility: ModelVisibilityEntry[], parameterValues: ParameterValues) => void);
    onAfterViewerCreated?: ((viewer: Viewer) => Promise<void>);
    onBeforeCreateViewer?: ((viewerSettings: ViewerSettings) => void);
}

Defintion of viewer control callbacks

import { Viewer, ViewerSettings, ModelVisibilityEntry, ParameterValues } from '@combeenation/3d-viewer';
// ...

viewerCtrl.injectViewer(Viewer, {
 onBeforeCreateViewer: (viewerSettings: ViewerSettings) => {
  // overwrite settings which are used for the viewer creation
   viewerSettings.limitTextureSize = { devices: 'iPhone', size: 512 };
 },
 onAfterViewerCreated: async (viewer: Viewer) => {
  // viewer is available at this time but the initial parameters have not been applied yet
  // => good chance to add custom parameters
  setCustomParameterObservers(viewer);
  // also create some material clones that are targeted by the initial parameter update
  await createMaterialClones();
  // also setup scene (add lights, ground, etc...)
  initSetupScene(viewer);
 },
 onAfterParametersApplied: (modelVisibility: ModelVisibilityEntry[], parameterValues: ParameterValues) => {
   // e.g. center camera if model has been changed
   if (modelVisibility.length) {
     await centerCamera();
   }
 },
});

Optional onAfterParametersApplied?: ((modelVisibility: ModelVisibilityEntry[], parameterValues: ParameterValues) => void)
- - (modelVisibility: ModelVisibilityEntry[], parameterValues: ParameterValues): void
  - Parameters
    - modelVisibility: ModelVisibilityEntry[]
    - parameterValues: ParameterValues
    Returns void
Optional onAfterViewerCreated?: ((viewer: Viewer) => Promise<void>)
- - (viewer: Viewer): Promise<void>
  - Parameters
    - viewer: Viewer
    Returns Promise<void>
Optional onBeforeCreateViewer?: ((viewerSettings: ViewerSettings) => void)
- - (viewerSettings: ViewerSettings): void
  - Parameters
    - viewerSettings: ViewerSettings
    Returns void

Returns void

on

on(eventName: string, callback: Function, scope?: any, options?: object): void
This function is actually inherited from ExtJS: https://docs.sencha.com/extjs/6.2.0/modern/Ext.mixin.Observable.html#method-on
Parameters
- eventName: string
- callback: Function
- Optional scope: any
- Optional options: object
Returns void

Inherited from Base.on

setCtrlBckgr

setCtrlBckgr(value: string): void
Parameters
- value: string
  
  A css compliant background string
Returns void

Inherited from Base.setCtrlBckgr

setCtrlHeight

setCtrlHeight(value: string | number): void
Parameters
- value: string | number
  
  CSS size string with or without unit or number which will be interpreted as px
Returns void

Inherited from Base.setCtrlHeight

setCtrlVisibility

setCtrlVisibility(value: boolean | CtrlVisibility, updateCtrlProperty?: boolean): void
Show or hide the control
Parameters
- value: boolean | CtrlVisibility
  
  True: "Show"
  False: "PluggedOut"
- Optional updateCtrlProperty: boolean
Returns void

Inherited from Base.setCtrlVisibility

setCtrlWidth

setCtrlWidth(value: string): void
Parameters
- value: string
  
  CSS size string with or without unit or number which will be interpreted as px
Returns void

Inherited from Base.setCtrlWidth

setDisabled

setDisabled(value: boolean): void
Parameters
- value: boolean
Returns void

Inherited from Base.setDisabled

setTooltipContent

setTooltipContent(content: string): void
Set the content of the tooltip
Parameters
- content: string
  
  Plain text or HTML
Returns void

Inherited from Base.setTooltipContent

setUserCssClass

setUserCssClass(cls: string): void
Parameters
- cls: string
  
  One or more CSS classes which are added to the control. Previously added classes are removed.
Returns void

Inherited from Base.setUserCssClass

startAR

startAR(arParams: StartARSettings): void
Starts augmented reality session for the current scene content of the viewer control.

This includes:
- preparation and optimization of the 3d model for AR
- redirection to AR endpoint on AR capable devices (mobiles)
- create QR code with link to AR endpoint on non AR capable devices (desktops)
- handle popups blocked by browsers by showing a manual link to the AR endpoint instead of performing the automatic redirect
See Combeenation docs for more details on how to use this.
Parameters
- arParams: StartARSettings
Returns void

un

un(eventName: string, callback: Function, scope?: any): void
This function is actually inherited from ExtJS: https://docs.sencha.com/extjs/6.2.0/modern/Ext.mixin.Observable.html#method-un
Parameters
- eventName: string
- callback: Function
- Optional scope: any
Returns void

Inherited from Base.un

Class Viewer3d

Hierarchy

Index

Constructors

Properties

Methods

Constructors

constructor

Returns Viewer3d

Properties

ctrlId

el

rendered

self

Type declaration

TypeStr: string

Static TypeStr

Methods

getCtrlPropValue

Parameters

propertyName: string

Returns any

getHeight

Returns number

getSize

Returns { height: number; width: number; }

height: number

width: number

getTooltip

See

Returns Instance

getViewer

Returns

Returns Promise<Viewer>

hasCls

Parameters

cls: string

Returns boolean

injectViewer

Parameters

ViewerClass: any

Optional eventCallbacks: { onAfterParametersApplied?: ((modelVisibility: ModelVisibilityEntry[], parameterValues: ParameterValues) => void); onAfterViewerCreated?: ((viewer: Viewer) => Promise<void>); onBeforeCreateViewer?: ((viewerSettings: ViewerSettings) => void); }

Optional onAfterParametersApplied?: ((modelVisibility: ModelVisibilityEntry[], parameterValues: ParameterValues) => void)

Parameters

modelVisibility: ModelVisibilityEntry[]

parameterValues: ParameterValues

Returns void

Optional onAfterViewerCreated?: ((viewer: Viewer) => Promise<void>)

Parameters

viewer: Viewer

Returns Promise<void>

Optional onBeforeCreateViewer?: ((viewerSettings: ViewerSettings) => void)

Parameters

viewerSettings: ViewerSettings

Returns void

Returns void

on

Parameters

eventName: string

callback: Function

Optional scope: any

Optional options: object

Returns void

setCtrlBckgr

Parameters

value: string

Returns void

setCtrlHeight

Parameters

value: string | number

Returns void

setCtrlVisibility

Parameters

value: boolean | CtrlVisibility

Optional updateCtrlProperty: boolean

Returns void

setCtrlWidth

Parameters

value: string

Returns void

`Static` TypeStr

Returns {
height: number;
width: number;
}

`Optional` eventCallbacks: {
onAfterParametersApplied?: ((modelVisibility: ModelVisibilityEntry[], parameterValues: ParameterValues) => void);
onAfterViewerCreated?: ((viewer: Viewer) => Promise<void>);
onBeforeCreateViewer?: ((viewerSettings: ViewerSettings) => void);
}

`Optional` onAfterParametersApplied?: ((modelVisibility: ModelVisibilityEntry[], parameterValues: ParameterValues) => void)

`Optional` onAfterViewerCreated?: ((viewer: Viewer) => Promise<void>)

`Optional` onBeforeCreateViewer?: ((viewerSettings: ViewerSettings) => void)

`Optional` scope: any

`Optional` options: object

`Optional` updateCtrlProperty: boolean

`Optional` scope: any