Перейти к основному содержанию

Class: CropExtension

Около 2 мин

Class: CropExtension

Crop box extension. Extension can show crop box and creates gizmos for modifying box size.

Hierarchy

Constructors

constructor

new CropExtension(viewerName, options): CropExtension

Parameters

NameTypeDescription
viewerNamestringOwner viewer name.
optionsCropExtensionOptionsoptions for extension.

Returns

CropExtension

Overrides

ExtensionBase.constructor

Properties

boxColor

boxColor: Color

Color of crop box.


getName

getName: () => string

Get unique extension name.

Type declaration

▸ (): string

Get unique extension name.

Returns

string

Inherited from

ExtensionBase.getName


gizmoColor

gizmoColor: Color

Color of handles for resizing.


helpDesc

Readonly helpDesc: string

Optional description for placing on HelpToolbar.

Inherited from

ExtensionBase.helpDesc


helpIcon

Readonly helpIcon: string

Optional icon for placing on HelpToolbar.

Inherited from

ExtensionBase.helpIcon


hideToolbar

hideToolbar: boolean

Is extension need to hide toolbar or not.

Inherited from

ExtensionBase.hideToolbar


isCropOn

isCropOn: boolean

Whether the measurement command is active or not.


planes

planes: Map<GizmoDir, Plane>

Map with box clipping planes.


state

state: any

Any extension data which can be stored in browser local storage and restored after (any extension settings, buttons state and so one). State will be saved in local storage with 'tangl-ext-extensionName' key.

Inherited from

ExtensionBase.state


type

Readonly type: string

Extension type (ext, mode, control).

Inherited from

ExtensionBase.type


viewerName

Readonly viewerName: string

Owner viewer name.

Inherited from

ExtensionBase.viewerName

Methods

getRenderManager

getRenderManager(): RenderManager

Get current RenderManager instance.

Returns

RenderManager

Inherited from

ExtensionBase.getRenderManager


restoreState

restoreState(): void

Restore extension state from the local storage.

Returns

void

Inherited from

ExtensionBase.restoreState


saveState

saveState(): void

Save extension state in the local storage.

Returns

void

Inherited from

ExtensionBase.saveState


setCrop

setCrop(on): void

Switch on or off crop box mode.

Parameters

NameTypeDescription
onbooleanIs crop box on.

Returns

void


setCropToSelected

setCropToSelected(forceZoom?): void

Sets crop box size to selected elements boundaries.

Parameters

NameType
forceZoom?boolean

Returns

void


setRestoreStateHandler

setRestoreStateHandler(handler): void

Sets external hook handler for restoring extension state in the local storage.

Parameters

NameTypeDescription
handlerFunctionhandler hook function.

Returns

void

Inherited from

ExtensionBase.setRestoreStateHandler


setRotation

setRotation(): void

Sets vertical axis rotation via picking face.

Returns

void


setSaveStateHandler

setSaveStateHandler(handler): void

Sets external hook handler for storing extension state in the local storage.

Parameters

NameTypeDescription
handlerFunctionhandler hook function.

Returns

void

Inherited from

ExtensionBase.setSaveStateHandler

Hooks

commandChanged

commandChanged(newCommand): void

Hook when current extension command is changed or finished. Called by ExtensionManager.setCurrentCommandExtension().

Parameters

NameType
newCommandExtensionBase

Returns

void

Inherited from

ExtensionBase.commandChanged


dedicatedToolbarRender

dedicatedToolbarRender(container): void

Render function for rendering dedicated toolbar content.

Parameters

NameTypeDescription
containerHTMLElementParent DOM container.

Returns

void

Inherited from

ExtensionBase.dedicatedToolbarRender


sharedToolbarRender

sharedToolbarRender(container): void

Render function for rendering shared toolbar content.

Parameters

NameTypeDescription
containerHTMLElementParent DOM container.

Returns

void

Inherited from

ExtensionBase.sharedToolbarRender


uiRender

uiRender(container): void

Render function for rendering additional UI above viewer canvas.

Parameters

NameTypeDescription
containerHTMLElementParent DOM container.

Returns

void

Inherited from

ExtensionBase.uiRender