Home Reference Source 
import {DataPath} from './scripts/path-controller/controller/controller_base.js'
public class | source

DataPath

Constructor Summary

Public Constructor
public

Member Summary

Public Members
public

apiname: *

public

data: *

public
public

getSet: {"get": *, "set": *}

public

path: *

public
public

struct: *

public

type: *

public

Method Summary

Public Methods
public

baseUnit(unit: *): *

public

copy(): *

public

customGet(get: *): *

public

customGetSet(get: *, set: *): *

For the callbacks 'this' points to an internal ToolProperty; Referencing object lives in 'this.dataref'; calling context in 'this.ctx'; and the datapath is 'this.datapath'
public

customPropCallback(callback: *): *

used to override tool property settings, e.g.
public

customSet(set: *): *

public

decimalPlaces(n: *): *

public

description(d: *): *

public

descriptions(description_map: *): *

public

displayUnit(unit: *): *

public
public

expRate(exp: *): *

public

Tell DataPathSetOp to save/load entire app state for undo/redo
public

icon(i: *): *

public

icon2(i: *): *

public

icons(icons: *): *

public

icons2(icons: *): *

secondary icons (e.g.
public

noUndo(): *

this property should not be treated as something that should be kept track off in the undo stack
public

noUnits(): *

public

off(type: *, cb: *)

public

on(type: *, cb: *): *

db will be executed with underlying data object that contains this path in 'this.dataref'
public

radix(r: *): *

public

range(min: *, max: *): *

public

readOnly(): *

public

read_only(): *

public

relativeStep(s: *): *

public
public

setProp(prop: *)

public
public

slideSpeed(speed: *): *

public

step(s: *): *

public

uiNameGetter(func: *): *

like other callbacks (until I refactor it), func will be called with a mysterious object that stores the following properties:
public

uiNames(uinames: *): *

public

uiRange(min: *, max: *): *

public

uniformSlider(state: boolean): *

adds a slider for moving vector component sliders simultaneously
public

unit(unit: *): *

Public Constructors

public constructor() source

Public Members

public apiname: * source

public data: * source

public flag: number source

public getSet: {"get": *, "set": *} source

public path: * source

public propGetter: * source

public struct: * source

public type: * source

public ui_name_get: * source

Public Methods

public baseUnit(unit: *): * source

Params:

NameTypeAttributeDescription
unit *

Return:

*

public copy(): * source

Return:

*

public customGet(get: *): * source

Params:

NameTypeAttributeDescription
get *

Return:

*

public customGetSet(get: *, set: *): * source

For the callbacks 'this' points to an internal ToolProperty; Referencing object lives in 'this.dataref'; calling context in 'this.ctx'; and the datapath is 'this.datapath'

Params:

NameTypeAttributeDescription
get *
set *

Return:

*

public customPropCallback(callback: *): * source

used to override tool property settings, e.g. ranges, units, etc; returns a base class instance of ToolProperty.

The this context points to the original ToolProperty and contains a few useful references:

this.dataref - an object instance of this struct type this.ctx - a context

callback takes one argument, a new (freshly copied of original) tool property to modify

Params:

NameTypeAttributeDescription
callback *

Return:

*

public customSet(set: *): * source

Params:

NameTypeAttributeDescription
set *

Return:

*

public decimalPlaces(n: *): * source

Params:

NameTypeAttributeDescription
n *

Return:

*

public description(d: *): * source

Params:

NameTypeAttributeDescription
d *

Return:

*

public descriptions(description_map: *): * source

Params:

NameTypeAttributeDescription
description_map *

Return:

*

public displayUnit(unit: *): * source

Params:

NameTypeAttributeDescription
unit *

Return:

*

public editAsBaseUnit(): * source

Return:

*

public expRate(exp: *): * source

Params:

NameTypeAttributeDescription
exp *

Return:

*

public fullSaveUndo(): * source

Tell DataPathSetOp to save/load entire app state for undo/redo

Return:

*

public icon(i: *): * source

Params:

NameTypeAttributeDescription
i *

Return:

*

public icon2(i: *): * source

Params:

NameTypeAttributeDescription
i *

Return:

*

public icons(icons: *): * source

Params:

NameTypeAttributeDescription
icons *

Return:

*

public icons2(icons: *): * source

secondary icons (e.g. disabled states)

Params:

NameTypeAttributeDescription
icons *

Return:

*

public noUndo(): * source

this property should not be treated as something that should be kept track off in the undo stack

Return:

*

public noUnits(): * source

Return:

*

public off(type: *, cb: *) source

Params:

NameTypeAttributeDescription
type *
cb *

public on(type: *, cb: *): * source

db will be executed with underlying data object that contains this path in 'this.dataref'

main event is 'change'

Params:

NameTypeAttributeDescription
type *
cb *

Return:

*

public radix(r: *): * source

Params:

NameTypeAttributeDescription
r *

Return:

*

public range(min: *, max: *): * source

Params:

NameTypeAttributeDescription
min *
max *

Return:

*

public readOnly(): * source

Return:

*

public read_only(): * source

Return:

*

public relativeStep(s: *): * source

Params:

NameTypeAttributeDescription
s *

Return:

*

public rollerSlider(): * source

Return:

*

public setProp(prop: *) source

Params:

NameTypeAttributeDescription
prop *

public simpleSlider(): * source

Return:

*

public slideSpeed(speed: *): * source

Params:

NameTypeAttributeDescription
speed *

Return:

*

public step(s: *): * source

Params:

NameTypeAttributeDescription
s *

Return:

*

public uiNameGetter(func: *): * source

like other callbacks (until I refactor it), func will be called with a mysterious object that stores the following properties:

this.dataref : owning object reference this.datactx : ctx this.datapath : datapath

Params:

NameTypeAttributeDescription
func *

Return:

*

public uiNames(uinames: *): * source

Params:

NameTypeAttributeDescription
uinames *

Return:

*

public uiRange(min: *, max: *): * source

Params:

NameTypeAttributeDescription
min *
max *

Return:

*

public uniformSlider(state: boolean): * source

adds a slider for moving vector component sliders simultaneously

Params:

NameTypeAttributeDescription
state boolean
  • optional
  • default: true

Return:

*

public unit(unit: *): * source

Params:

NameTypeAttributeDescription
unit *

Return:

*