Home Reference Source Repository
import Sketcher from 'awv3-next/sketcher/sketcher.js'
public class | source

Sketcher

Extends:

EventsPlugin → Sketcher

Static Member Summary

Static Public Members
public static

Static Method Summary

Static Public Methods
public static

mixinPixelSizedGeometry(pixelSizes: *)

A mixin which adds capability of specifying sizes in screen pixels.

public static

registerVisualization(view: *, obj: *)

Makes given THREE object suitable for visualization on given View.

Constructor Summary

Public Constructor
public

constructor(options: *)

Member Summary

Public Members
public
public
public

font: *

public
public
public

socket: *

public
public

view: *

Method Summary

Public Methods
public

askConstraintParams(oldParams: *): *

public
public
public

chooseTool(toolName: *): *

public

click(): *

public
public

deselectSketch(options: *): boolean

public
public
public

moveUnderConstraints(object: *, newPnt: *)

public

newSketch(position: *, quaternion: *, item: *): *

public

newSketchFromPlane(plane: *): *

public

onDisabled(integration: *): *

public

onEnabled(integration: *)

public
public

selectSketch(sketch: *): boolean

public

setActionCursor(action: *)

public
public

setPrompt(promptText: *)

public

showSketchControlElements(isInSketch: *)

public

sketchAreaClicked(sketch: *)

public
public
public

switchToOrthographicCamera(view: *, sketch: *)

public

Inherited Summary

From class Events
public static

mixin(object: *, handlers: *)

public

bubble(type: *, args: ...*): *

public

emit(type: *, args: ...*): *

public

findListener(type: *): *

public

hasListener(type: *, callback: *): *

public

inspect(callback: *)

public

on(arg1: {}, arg2: *, remove: boolean, priority: *): *

public

onFirst(type: *, callback: *)

public

onLast(type: *, callback: *)

public

once(type: *, callback: *)

public
public

removeListener(types: *, callback: *): *

public
From class Plugin
public

data: *

public
public

apply(objects: *)

public
public
public
public

Static Public Members

public static pixelSizes: * source

Static Public Methods

public static mixinPixelSizedGeometry(pixelSizes: *) source

A mixin which adds capability of specifying sizes in screen pixels. All sizes are kept in a single list 'pixelSizes'. Method 'updateSizes' is added: it should be called by user when camera/size changes. It passes geometrical sizes (in local object space) to method 'setGeomSizes'. If 'getSizingPoint' method is present in class, it is called to get calibrating position in local space of the object (otherwise origin is used).

Params:

NameTypeAttributeDescription
pixelSizes *

public static registerVisualization(view: *, obj: *) source

Makes given THREE object suitable for visualization on given View. It adds interaction on the object with update method. The update method allows to automatically recalculate sizes and visible geometry of the object. The function can be called many times, but the object must not have other interaction on it. Ideally, this method should be called immediately after the object has been created.

Params:

NameTypeAttributeDescription
view *
obj *

Public Constructors

public constructor(options: *) source

Override:

Plugin#constructor

Params:

NameTypeAttributeDescription
options *

Public Members

public currentCursor: * source

public currentSketch: * source

public font: * source

public modelMethods: * source

public namedElements: * source

public socket: * source

public stateDiff: * source

public view: * source

Public Methods

public askConstraintParams(oldParams: *): * source

Params:

NameTypeAttributeDescription
oldParams *

Return:

*

public autoconstraintAll() source

public checkSolveResult(result: *): boolean source

Params:

NameTypeAttributeDescription
result *

Return:

boolean

public chooseTool(toolName: *): * source

Params:

NameTypeAttributeDescription
toolName *

Return:

*

public click(): * source

Return:

*

public deleteSketch(): * source

Return:

*

public deselectSketch(options: *): boolean source

Params:

NameTypeAttributeDescription
options *

Return:

boolean

public initElements() source

public interactionPointMoved() source

public moveUnderConstraints(object: *, newPnt: *) source

Params:

NameTypeAttributeDescription
object *
newPnt *

public newSketch(position: *, quaternion: *, item: *): * source

Params:

NameTypeAttributeDescription
position *
quaternion *
item *

Return:

*

public newSketchFromPlane(plane: *): * source

Params:

NameTypeAttributeDescription
plane *

Return:

*

public onDisabled(integration: *): * source

Override:

Plugin#onDisabled

Params:

NameTypeAttributeDescription
integration *

Return:

*

public onEnabled(integration: *) source

Override:

Plugin#onEnabled

Params:

NameTypeAttributeDescription
integration *

public refresh() source

public selectSketch(sketch: *): boolean source

Params:

NameTypeAttributeDescription
sketch *

Return:

boolean

public setActionCursor(action: *) source

Params:

NameTypeAttributeDescription
action *

public setIncrementalLevel(value: *) source

Params:

NameTypeAttributeDescription
value *

public setPrompt(promptText: *) source

Params:

NameTypeAttributeDescription
promptText *

public showSketchControlElements(isInSketch: *) source

Params:

NameTypeAttributeDescription
isInSketch *

public sketchAreaClicked(sketch: *) source

Params:

NameTypeAttributeDescription
sketch *

public sketchAreaRightClicked(sketch: *) source

Params:

NameTypeAttributeDescription
sketch *

public solveConstraints(): * source

Return:

*

public switchToOrthographicCamera(view: *, sketch: *) source

Params:

NameTypeAttributeDescription
view *
sketch *

public switchToPerspectiveCamera(view: *) source

Params:

NameTypeAttributeDescription
view *