API ReferenceGlobalsAddonHelper

# Class: AddonHelper

# Hierarchy

  • AddonHelper

# Index

# Constructors

# Properties

# Methods

# Constructors

# constructor

+ new AddonHelper(camera: PerspectiveCamera, scriptLoader: ScriptLoader): AddonHelper

Defined in packages/configurator-core/src/utils/addon-helper.ts:46

Parameters:

Name Type
camera PerspectiveCamera
scriptLoader ScriptLoader

Returns: AddonHelper

# Properties

# addOnSpotsEnabled

addOnSpotsEnabled: boolean = false

Defined in packages/configurator-core/src/utils/addon-helper.ts:44


# previewGhostEnabled

previewGhostEnabled: boolean = false

Defined in packages/configurator-core/src/utils/addon-helper.ts:43

# Methods

# addAddOnSpots

addAddOnSpots(component: RoomleComponent, addOnSpots: AddOnSpot[]): void

Defined in packages/configurator-core/src/utils/addon-helper.ts:126

Parameters:

Name Type
component RoomleComponent
addOnSpots AddOnSpot[]

Returns: void


# changePreviewGhostVisibility

changePreviewGhostVisibility(component: PreviewComponent, visible: boolean): void

Defined in packages/configurator-core/src/utils/addon-helper.ts:210

Parameters:

Name Type
component PreviewComponent
visible boolean

Returns: void


# deleteAddonPointsForComponent

deleteAddonPointsForComponent(componentId: number): void

Defined in packages/configurator-core/src/utils/addon-helper.ts:188

Parameters:

Name Type
componentId number

Returns: void


# isAddOnSpotVisible

isAddOnSpotVisible(): boolean

Defined in packages/configurator-core/src/utils/addon-helper.ts:240

Returns: boolean


# onAddonClick

onAddonClick(handler: function): void

Defined in packages/configurator-core/src/utils/addon-helper.ts:244

Parameters:

handler: function

▸ (): void

Returns: void


# setState

setState(state: ADDON_STATE): void

Defined in packages/configurator-core/src/utils/addon-helper.ts:248

Parameters:

Name Type
state ADDON_STATE

Returns: void


# update

update(force: boolean): void

Defined in packages/configurator-core/src/utils/addon-helper.ts:206

Parameters:

Name Type Default
force boolean false

Returns: void