Home Reference Source 
import {ToolProperty} from './scripts/path-controller/toolsys/toolprop.js'
public class | source

ToolProperty

Extends:

ToolPropertyIF → ToolProperty

Direct Subclass:

BoolProperty, Curve1DProperty, EnumProperty, FloatArrayProperty, ListProperty, Mat4Property, NumProperty, QuatProperty, StringProperty, StringSetProperty, _NumberPropertyBase

Indirect Subclass:

FloatProperty, IntProperty, ReportProperty, Vec2Property, Vec3Property, Vec4Property, VecPropertyBase

Static Method Summary

Static Public Methods
public static

calcRelativeStep(step: *, value: *, logBase: number): *

public static

getClass(type: *): *

public static
public static

makeUIName(name: *): *

public static

register(cls: *): *

public static
public static

Constructor Summary

Public Constructor
public

Member Summary

Public Members
public

apiname: *

public
public

callbacks: {}

public

data: *

public
public
public
public

flag: *

public

icon: *

public

icon2: *

public

radix: *

public
public
public
public

subtype: *

public

type: *

public
public

uiname: *

public

Method Summary

Public Methods
public
public
public

copy(): *

public

copyTo(b: *)

public

equals(b: *)

public

getStep(value: number): *

public

getValue(): *

public

loadJSON(obj: *): *

public

loadSTRUCT(reader: *)

public

noUnits(): *

public

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

public

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

public

once(type: *, cb: *): *

public

private(): *

public

report()

public
public

setBaseUnit(unit: *): *

public

setDescription(s: *): *

public

setDisplayUnit(unit: *): *

public

setFlag(f: *, combine: boolean): *

public

setIcon(icon: *): *

public

setIcon2(icon: *): *

public

setRange(min: *, max: *): *

public

setRelativeStep(step: *)

public

setStep(step: *): *

public

setUIName(s: *): *

public

setUIRange(min: *, max: *): *

public

setValue(val: *)

public

toJSON(): {"type": *, "subtype": *, "apiname": *, "uiname": *, "description": *, "flag": *, "icon": *, "data": *, "range": *, "uiRange": *, "step": *}

Private Methods
private

_fire(type: *, arg1: *, arg2: *): *

Inherited Summary

From class ToolPropertyIF
public

apiname: *

public

data: *

public
public

flag: *

public

icon: *

public

subtype: *

public

type: *

public

uiname: *

public

copy()

public

copyTo(b: *)

public

equals(b: *)

public
public

off(type: *, cb: *)

public

on(type: *, cb: *)

public

setIcon(icon: *)

public

setRange(min: *, max: *)

public

setStep(step: *)

public

setUIRange(min: *, max: *)

public

setUnit(unit: *)

public

setValue(val: *)

private

_fire(type: *, arg1: *, arg2: *)

Static Public Methods

public static calcRelativeStep(step: *, value: *, logBase: number): * source

Params:

NameTypeAttributeDescription
step *
value *
logBase number
  • optional
  • default: 1.5

Return:

*

public static getClass(type: *): * source

Params:

NameTypeAttributeDescription
type *

Return:

*

public static internalRegister(cls: *) source

Params:

NameTypeAttributeDescription
cls *

public static makeUIName(name: *): * source

Params:

NameTypeAttributeDescription
name *

Return:

*

public static register(cls: *): * source

Params:

NameTypeAttributeDescription
cls *

Return:

*

public static setDefaultDecimalPlaces(n: *) source

Params:

NameTypeAttributeDescription
n *

public static setDefaultRadix(n: *) source

Params:

NameTypeAttributeDescription
n *

Public Constructors

public constructor() source

Override:

ToolPropertyIF#constructor

Public Members

public apiname: * source

Override:

ToolPropertyIF#apiname

public baseUnit: * source

public callbacks: {} source

public data: * source

Override:

ToolPropertyIF#data

public decimalPlaces: * source

public description: * source

Override:

ToolPropertyIF#description

public displayUnit: * source

public flag: * source

Override:

ToolPropertyIF#flag

public icon: * source

Override:

ToolPropertyIF#icon

public icon2: * source

public radix: * source

public range: undefined[] source

public step: number source

public stepIsRelative: boolean source

public subtype: * source

Override:

ToolPropertyIF#subtype

public type: * source

Override:

ToolPropertyIF#type

public uiRange: undefined[] source

public uiname: * source

Override:

ToolPropertyIF#uiname

public wasSet: boolean source

Public Methods

public calcMemSize(): * source

Return:

*

public clearEventCallbacks(): * source

Return:

*

public copy(): * source

Override:

ToolPropertyIF#copy

Return:

*

public copyTo(b: *) source

Override:

ToolPropertyIF#copyTo

Params:

NameTypeAttributeDescription
b *

public equals(b: *) source

Override:

ToolPropertyIF#equals

Params:

NameTypeAttributeDescription
b *

public getStep(value: number): * source

Params:

NameTypeAttributeDescription
value number
  • optional
  • default: 1

Return:

*

public getValue(): * source

Override:

ToolPropertyIF#getValue

Return:

*

public loadJSON(obj: *): * source

Params:

NameTypeAttributeDescription
obj *

Return:

*

public loadSTRUCT(reader: *) source

Params:

NameTypeAttributeDescription
reader *

public noUnits(): * source

Return:

*

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

Override:

ToolPropertyIF#off

Params:

NameTypeAttributeDescription
type *
cb *

Return:

*

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

Override:

ToolPropertyIF#on

Params:

NameTypeAttributeDescription
type *
cb *

Return:

*

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

Params:

NameTypeAttributeDescription
type *
cb *

Return:

*

public private(): * source

Return:

*

public report() source

public saveLastValue(): * source

Return:

*

public setBaseUnit(unit: *): * source

Params:

NameTypeAttributeDescription
unit *

Return:

*

public setDescription(s: *): * source

Params:

NameTypeAttributeDescription
s *

Return:

*

public setDisplayUnit(unit: *): * source

Params:

NameTypeAttributeDescription
unit *

Return:

*

public setFlag(f: *, combine: boolean): * source

Params:

NameTypeAttributeDescription
f *
combine boolean
  • optional
  • default: false

Return:

*

public setIcon(icon: *): * source

Override:

ToolPropertyIF#setIcon

Params:

NameTypeAttributeDescription
icon *

Return:

*

public setIcon2(icon: *): * source

Params:

NameTypeAttributeDescription
icon *

Return:

*

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

Override:

ToolPropertyIF#setRange

Params:

NameTypeAttributeDescription
min *
max *

Return:

*

public setRelativeStep(step: *) source

Params:

NameTypeAttributeDescription
step *

public setStep(step: *): * source

Override:

ToolPropertyIF#setStep

Params:

NameTypeAttributeDescription
step *

Return:

*

public setUIName(s: *): * source

Params:

NameTypeAttributeDescription
s *

Return:

*

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

Override:

ToolPropertyIF#setUIRange

Params:

NameTypeAttributeDescription
min *
max *

Return:

*

public setValue(val: *) source

Override:

ToolPropertyIF#setValue

Params:

NameTypeAttributeDescription
val *

public toJSON(): {"type": *, "subtype": *, "apiname": *, "uiname": *, "description": *, "flag": *, "icon": *, "data": *, "range": *, "uiRange": *, "step": *} source

Return:

{"type": *, "subtype": *, "apiname": *, "uiname": *, "description": *, "flag": *, "icon": *, "data": *, "range": *, "uiRange": *, "step": *}

Private Methods

private _fire(type: *, arg1: *, arg2: *): * source

Override:

ToolPropertyIF#_fire

Params:

NameTypeAttributeDescription
type *
arg1 *
arg2 *

Return:

*