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

DataStruct

Constructor Summary

Public Constructor
public

Member Summary

Public Members
public

dpath: *

public
public
public

members: *[]

public

name: *

public

pathmap: {}

Method Summary

Public Methods
public

add(m: *): *

public

arrayList(path: *, apiname: *, structdef: *, uiname: *, description: *): *

public

bool(path: *, apiname: *, uiname: *, description: *): *

public

color3(path: *, apiname: *, uiname: *, description: *): *

public

color3List(path: *, apiname: *, uiname: *, description: *): *

public

color4(path: *, apiname: *, uiname: *, description: *): *

public

color4List(path: *, apiname: *, uiname: *, description: *): *

public

copy(): *

public

curve1d(path: *, apiname: *, uiname: *, description: *): *

public

customGet(getter: *): *

public

customGetSet(getter: *, setter: *): *

public

dynamicStruct(path: *, apiname: *, uiname: *, default_struct: *): *

Like .struct, but the type of struct is looked up for objects at runtime.
public

enum(path: *, apiname: *, enumdef: *, uiname: *, description: *): *

public

flags(path: *, apiname: *, enumdef: *, uiname: *, description: *): *

public

float(path: *, apiname: *, uiname: *, description: *): *

public

fromToolProp(path: *, prop: *, apiname: *): *

public

int(path: *, apiname: *, uiname: *, description: *, prop: *): *

public

list(path: *, apiname: *, funcs: *): *

public

remove(m: *)

public

report(path: *, apiname: *, uiname: *, description: *): *

public

string(path: *, apiname: *, uiname: *, description: *): *

public

struct(path: *, apiname: *, uiname: *, existing_struct: *): *

public

textblock(path: *, apiname: *, uiname: *, description: *): *

public

vec2(path: *, apiname: *, uiname: *, description: *): *

public

vec3(path: *, apiname: *, uiname: *, description: *): *

public

vec4(path: *, apiname: *, uiname: *, description: *): *

public

vectorList(size: *, path: *, apiname: *, uiname: *, description: *, subtype: *): *

Public Constructors

public constructor() source

Public Members

public dpath: * source

public flag: number source

public inheritFlag: number source

public members: *[] source

public name: * source

public pathmap: {} source

Public Methods

public add(m: *): * source

Params:

NameTypeAttributeDescription
m *

Return:

*

public arrayList(path: *, apiname: *, structdef: *, uiname: *, description: *): * source

Params:

NameTypeAttributeDescription
path *
apiname *
structdef *
uiname *
description *

Return:

*

public bool(path: *, apiname: *, uiname: *, description: *): * source

Params:

NameTypeAttributeDescription
path *
apiname *
uiname *
description *

Return:

*

public color3(path: *, apiname: *, uiname: *, description: *): * source

Params:

NameTypeAttributeDescription
path *
apiname *
uiname *
description *

Return:

*

public color3List(path: *, apiname: *, uiname: *, description: *): * source

Params:

NameTypeAttributeDescription
path *
apiname *
uiname *
description *

Return:

*

public color4(path: *, apiname: *, uiname: *, description: *): * source

Params:

NameTypeAttributeDescription
path *
apiname *
uiname *
description *
  • optional
  • default: uiname

Return:

*

public color4List(path: *, apiname: *, uiname: *, description: *): * source

Params:

NameTypeAttributeDescription
path *
apiname *
uiname *
description *

Return:

*

public copy(): * source

Return:

*

public curve1d(path: *, apiname: *, uiname: *, description: *): * source

Params:

NameTypeAttributeDescription
path *
apiname *
uiname *
description *

Return:

*

public customGet(getter: *): * source

Params:

NameTypeAttributeDescription
getter *

Return:

*

public customGetSet(getter: *, setter: *): * source

Params:

NameTypeAttributeDescription
getter *
setter *

Return:

*

public dynamicStruct(path: *, apiname: *, uiname: *, default_struct: *): * source

Like .struct, but the type of struct is looked up for objects at runtime. Note that to work correctly each object must create its own struct definition via api.mapStruct

Params:

NameTypeAttributeDescription
path *
apiname *
uiname *
default_struct *

: default struct if one can't be looked up

Return:

*

public enum(path: *, apiname: *, enumdef: *, uiname: *, description: *): * source

Params:

NameTypeAttributeDescription
path *
apiname *
enumdef *
uiname *
description *

Return:

*

public flags(path: *, apiname: *, enumdef: *, uiname: *, description: *): * source

Params:

NameTypeAttributeDescription
path *
apiname *
enumdef *
uiname *
description *

Return:

*

public float(path: *, apiname: *, uiname: *, description: *): * source

Params:

NameTypeAttributeDescription
path *
apiname *
uiname *
description *

Return:

*

public fromToolProp(path: *, prop: *, apiname: *): * source

Params:

NameTypeAttributeDescription
path *
prop *
apiname *

Return:

*

public int(path: *, apiname: *, uiname: *, description: *, prop: *): * source

Params:

NameTypeAttributeDescription
path *
apiname *
uiname *
description *
prop *
  • optional
  • default: undefined

Return:

*

public list(path: *, apiname: *, funcs: *): * source

Params:

NameTypeAttributeDescription
path *
apiname *
funcs *

Return:

*

public remove(m: *) source

Params:

NameTypeAttributeDescription
m *

public report(path: *, apiname: *, uiname: *, description: *): * source

Params:

NameTypeAttributeDescription
path *
apiname *
uiname *
description *

Return:

*

public string(path: *, apiname: *, uiname: *, description: *): * source

Params:

NameTypeAttributeDescription
path *
apiname *
uiname *
description *

Return:

*

public struct(path: *, apiname: *, uiname: *, existing_struct: *): * source

Params:

NameTypeAttributeDescription
path *
apiname *
uiname *
existing_struct *
  • optional
  • default: undefined

Return:

*

public textblock(path: *, apiname: *, uiname: *, description: *): * source

Params:

NameTypeAttributeDescription
path *
apiname *
uiname *
description *

Return:

*

public vec2(path: *, apiname: *, uiname: *, description: *): * source

Params:

NameTypeAttributeDescription
path *
apiname *
uiname *
description *

Return:

*

public vec3(path: *, apiname: *, uiname: *, description: *): * source

Params:

NameTypeAttributeDescription
path *
apiname *
uiname *
description *

Return:

*

public vec4(path: *, apiname: *, uiname: *, description: *): * source

Params:

NameTypeAttributeDescription
path *
apiname *
uiname *
description *

Return:

*

public vectorList(size: *, path: *, apiname: *, uiname: *, description: *, subtype: *): * source

Params:

NameTypeAttributeDescription
size *
path *
apiname *
uiname *
description *
subtype *

Return:

*