Class TransfrSharePlugin

Transfr Share Plugin A sample plugin that provides helpers to export and upload scene to a server and get a shareable link. It uses the options from the AssetExporterPlugin to export the scene or object, and can be configured using it's ui.

Uses the free service transfr.one by default which deletes the files after a certain time, but the url can be changed to a custom backend or a self-hosted version of transfr.

Note: since the uploaded files are publicly accessible by anyone by default, it is recommended to encrypt the file using the exporter options or use a secure backend.

Hierarchy

AViewerPluginSync<"">
- TransfrSharePlugin

Constructors

constructor

new TransfrSharePlugin(): TransfrSharePlugin
Creates THREE.EventDispatcher | EventDispatcher object.

Returns TransfrSharePlugin
Inherited from AViewerPluginSync<''>.constructor
- Defined in node_modules/@types/three/src/core/EventDispatcher.d.ts:39

Properties

`Protected` _dirty

_dirty: boolean = false

`Private` _exporting

_exporting: boolean = false

`Protected` `Optional` _viewer

_viewer?: ThreeViewer

`Protected` _viewerListeners

_viewerListeners: PartialRecord<"dispose" | "*" | "update" | "preRender" | "postRender" | "preFrame" | "postFrame" | "addPlugin" | "removePlugin" | "renderEnabled" | "renderDisabled", ((e) => void)> = {}

Type declaration

- (e): void
- Parameters
  - e: IViewerEvent
  Returns void

baseUrls

baseUrls: Record<string, string> = ...

constructor

constructor: typeof AViewerPluginSync & typeof AViewerPlugin

dependencies

dependencies: typeof AssetExporterPlugin[] = ...

enabled

enabled: boolean = true

pageUrl

pageUrl: string = window.location.href

queryParam

queryParam: string = 'm'

serverUrl

serverUrl: string = 'https://bee.transfr.one/scene.glb'

toJSON

toJSON: any = null

`Optional` uiConfig

uiConfig?: UiObjectConfig<any, string, any> = undefined

`Static` `Optional` `Readonly` OldPluginType

OldPluginType?: string

`Static` `Readonly` PluginType

PluginType: "TransfrSharePlugin" = 'TransfrSharePlugin'

Accessors

dirty

get dirty(): boolean
Returns boolean
Inherited from AViewerPluginSync.dirty
- Defined in src/viewer/AViewerPlugin.ts:107
set dirty(value): void
Parameters
- value: boolean
Returns void
Inherited from AViewerPluginSync.dirty
- Defined in src/viewer/AViewerPlugin.ts:111

Methods

`Protected` _onViewerEvent

_onViewerEvent(e): IViewerEvent
Parameters
- e: IViewerEvent
Returns IViewerEvent
Inherited from AViewerPluginSync._onViewerEvent
- Defined in src/viewer/AViewerPlugin.ts:63

`Protected` _storeKey

_storeKey(prefix?): string
Parameters
- Optional prefix: string
Returns string
Inherited from AViewerPluginSync._storeKey
- Defined in src/viewer/AViewerPlugin.ts:49

disable

disable(key): void
Parameters
- key: any
Returns void
Inherited from AViewerPluginSync.disable
- Defined in src/viewer/AViewerPlugin.ts:70

dispose

dispose(): void
Returns void
Inherited from AViewerPluginSync.dispose
- Defined in src/viewer/AViewerPlugin.ts:29

enable

enable(key): void
Parameters
- key: any
Returns void
Inherited from AViewerPluginSync.enable
- Defined in src/viewer/AViewerPlugin.ts:75

exportObject

exportObject(model?): Promise<undefined | BlobExt>
Parameters
- Optional model: IObject3D<IObject3DEvent<IObject3DEventTypes>, IObject3DEventTypes>
Returns Promise<undefined | BlobExt>
- Defined in plugins/network/src/TransfrSharePlugin.ts:34

exportState

exportState(): ISerializedConfig | Record<string, never>
Returns ISerializedConfig | Record<string, never>
Inherited from AViewerPluginSync.exportState
- Defined in src/viewer/AViewerPlugin.ts:54

fromJSON

fromJSON(data, meta?): null | TransfrSharePlugin | Promise<null | TransfrSharePlugin>
Parameters
- data: ISerializedConfig
- Optional meta: SerializationMetaType
Returns null | TransfrSharePlugin | Promise<null | TransfrSharePlugin>
Inherited from AViewerPluginSync.fromJSON
- Defined in src/viewer/AViewerPlugin.ts:41

getLink

getLink(model?): Promise<string>
Export and get the link of the 3d model or scene
Parameters
- Optional model: IObject3D<IObject3DEvent<IObject3DEventTypes>, IObject3DEventTypes>
Returns Promise<string>
- Defined in plugins/network/src/TransfrSharePlugin.ts:46

importState

importState(state): Promise<void>
Parameters
- state: any
Returns Promise<void>
Inherited from AViewerPluginSync.importState
- Defined in src/viewer/AViewerPlugin.ts:57

isDisabled

isDisabled(): boolean
Returns boolean
Inherited from AViewerPluginSync.isDisabled
- Defined in src/viewer/AViewerPlugin.ts:80

onAdded

onAdded(viewer): void
Parameters
- viewer: ThreeViewer
Returns void
Inherited from AViewerPluginSync.onAdded
- Defined in src/viewer/AViewerPlugin.ts:141

onRemove

onRemove(viewer): void
Parameters
- viewer: ThreeViewer
Returns void
Inherited from AViewerPluginSync.onRemove
- Defined in src/viewer/AViewerPlugin.ts:145

`Optional` setDirty

setDirty(...args): any
Parameters
- Rest ...args: any[]
Returns any
Inherited from AViewerPluginSync.setDirty
- Defined in src/viewer/AViewerPlugin.ts:84

shareEditorLink

shareEditorLink(): Promise<null | string>
Returns Promise<null | string>
- Defined in plugins/network/src/TransfrSharePlugin.ts:112

shareGlb

shareGlb(): Promise<null | string>
Returns Promise<null | string>
- Defined in plugins/network/src/TransfrSharePlugin.ts:124

shareLink

shareLink(base?, param?): Promise<null | string>
Upload the scene and copy the link to clipboard along with the base url and query param if provided
Parameters
- Optional base: string | URL
- Optional param: string
Returns Promise<null | string>
- Defined in plugins/network/src/TransfrSharePlugin.ts:80

sharePageLink

sharePageLink(): Promise<null | string>
Returns Promise<null | string>
- Defined in plugins/network/src/TransfrSharePlugin.ts:120

shareViewerLink

shareViewerLink(): Promise<null | string>
Returns Promise<null | string>
- Defined in plugins/network/src/TransfrSharePlugin.ts:116

Class TransfrSharePlugin

Hierarchy

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Returns TransfrSharePlugin

Properties

Protected _dirty

Private _exporting

Protected Optional _viewer

Protected _viewerListeners

Type declaration

Parameters

e: IViewerEvent

Returns void

baseUrls

constructor

dependencies

enabled

pageUrl

queryParam

serverUrl

toJSON

Optional uiConfig

Static Optional Readonly OldPluginType

Static Readonly PluginType

Accessors

dirty

Returns boolean

Parameters

value: boolean

Returns void

Methods

Protected _onViewerEvent

Parameters

e: IViewerEvent

Returns IViewerEvent

Protected _storeKey

Parameters

Optional prefix: string

Returns string

disable

Parameters

key: any

Returns void

dispose

Returns void

enable

Parameters

key: any

Returns void

exportObject

Parameters

Optional model: IObject3D<IObject3DEvent<IObject3DEventTypes>, IObject3DEventTypes>

Returns Promise<undefined | BlobExt>

exportState

Returns ISerializedConfig | Record<string, never>

fromJSON

Parameters

data: ISerializedConfig

Optional meta: SerializationMetaType

Returns null | TransfrSharePlugin | Promise<null | TransfrSharePlugin>

getLink

Parameters

Optional model: IObject3D<IObject3DEvent<IObject3DEventTypes>, IObject3DEventTypes>

Returns Promise<string>

importState

Parameters

state: any

Returns Promise<void>

isDisabled

Returns boolean

onAdded

Parameters

viewer: ThreeViewer

Returns void

`Protected` _dirty

`Private` _exporting

`Protected` `Optional` _viewer

`Protected` _viewerListeners

`Optional` uiConfig

`Static` `Optional` `Readonly` OldPluginType

`Static` `Readonly` PluginType

`Protected` _onViewerEvent

`Protected` _storeKey

`Optional` prefix: string

`Optional` model: IObject3D<IObject3DEvent<IObject3DEventTypes>, IObject3DEventTypes>

`Optional` meta: SerializationMetaType

`Optional` model: IObject3D<IObject3DEvent<IObject3DEventTypes>, IObject3DEventTypes>

`Optional` setDirty

`Rest` ...args: any[]

`Optional` base: string | URL

`Optional` param: string