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

DataAPI

You can directly use an instance of this class. api

Extends:

ModelInterface → DataAPI

Static Method Summary

Static Public Methods
public static

registerTool(cls: *): *

public static

toolRegistered(cls: *): *

Constructor Summary

Public Constructor
public

Member Summary

Public Members
public get

list: *

public
public

structs: *[]

Method Summary

Public Methods
public

createTool(ctx: *, path: *, inputs: {}): *

public

getStruct(cls: *): *

public

getStructs(): *

public

getToolDef(path: *): *

public

getToolPathHotkey(ctx: *, path: *): *

public

getToolPathHotkey_intern(ctx: *, path: *): *

public

hasStruct(cls: *): *

public

inheritStruct(cls: *, parent: *, auto_create_parent: boolean): *

public

mapStruct(cls: *, auto_create: boolean, name: *): *

public

massSetProp(ctx: *, massSetPath: *, value: *)

public

mergeStructs(dest: *, src: *)

public

parseToolArgs(path: *): *

public

parseToolPath(path: *): *

public
public
public

resolveMassSetPaths(ctx: *, massSetPath: *): *

public

resolvePath(ctx: *, inpath: *, ignoreExistence: boolean, dstruct: *): *

public

resolvePathOld2(ctx: *, path: *): {"parent": *, "obj": *, "value": *, "key": *, "dstruct": *, "subkey": *, "prop": *, "arg": *, "type": *, "_path": *}

public

resolvePath_intern(ignoreExistence:: *): {"dpath": *, "parent": *, "obj": *, "value": *, "key": *, "dstruct": *, "prop": *, "subkey": *}

get meta information for a datapath.
public

resolvePathold(ctx: *, path: *): {"parent": *, "obj": *, "value": *, "key": *, "dstruct": *, "prop": *}

public

setRoot(sdef: *)

Private Methods
private

_addClass(cls:: *, auto_create:: *): IterableIterator<*>

Look up struct definition for a class.
private

_stripToolUIName(path: *, uiNameOut: *): *

Inherited Summary

From class ModelInterface
public static

registerTool(tool: *)

public static

toolRegistered(tool: *)

public get

list: *

public
public

createTool(path: *, inputs: {}, constructor_argument: *)

public

execOrRedo(compareInputs: *): *

runs .undo,.redo if toolstack head is same as tool
public

execTool(ctx: *, path: *, inputs: {}, constructor_argument: *): *

public

getDescription(ctx: *, path: *): *

public

getPropName(ctx: *, path: *): *

public

getToolDef(path: *)

public

getToolPathHotkey(ctx: *, path: *): *

public

getValue(ctx: *, path: *, rootStruct: *): *

public

massSetProp(ctx: *, mass_set_path: *, value: *)

public

parseToolPath(path: *)

public
public
public

resolveMassSetPaths(ctx: *, mass_set_path: *)

takes a mass_set_path and returns an array of individual paths
public

resolvePath(ctx: *, path: *, ignoreExistence: *, rootStruct: *)

public

setValue(ctx: *, path: *, val: *, rootStruct: *)

public

validPath(ctx: *, path: *, rootStruct: *): boolean

Static Public Methods

public static registerTool(cls: *): * source

Override:

ModelInterface#registerTool

Params:

NameTypeAttributeDescription
cls *

Return:

*

public static toolRegistered(cls: *): * source

Override:

ModelInterface#toolRegistered

Params:

NameTypeAttributeDescription
cls *

Return:

*

Public Constructors

public constructor() source

Override:

ModelInterface#constructor

Public Members

public get list: * source

Override:

ModelInterface#list

public rootContextStruct: * source

public structs: *[] source

Public Methods

public createTool(ctx: *, path: *, inputs: {}): * source

Override:

ModelInterface#createTool

Params:

NameTypeAttributeDescription
ctx *
path *
inputs {}
  • optional
  • default: {}

Return:

*

public getStruct(cls: *): * source

Params:

NameTypeAttributeDescription
cls *

Return:

*

public getStructs(): * source

Return:

*

public getToolDef(path: *): * source

Override:

ModelInterface#getToolDef

Params:

NameTypeAttributeDescription
path *

Return:

*

public getToolPathHotkey(ctx: *, path: *): * source

Override:

ModelInterface#getToolPathHotkey

Params:

NameTypeAttributeDescription
ctx *
path *

Return:

*

public getToolPathHotkey_intern(ctx: *, path: *): * source

Params:

NameTypeAttributeDescription
ctx *
path *

Return:

*

public hasStruct(cls: *): * source

Params:

NameTypeAttributeDescription
cls *

Return:

*

public inheritStruct(cls: *, parent: *, auto_create_parent: boolean): * source

Params:

NameTypeAttributeDescription
cls *
parent *
auto_create_parent boolean
  • optional
  • default: false

Return:

*

public mapStruct(cls: *, auto_create: boolean, name: *): * source

Params:

NameTypeAttributeDescription
cls *
auto_create boolean
  • optional
  • default: true
name *
  • optional

Return:

*

public massSetProp(ctx: *, massSetPath: *, value: *) source

Override:

ModelInterface#massSetProp

Params:

NameTypeAttributeDescription
ctx *
massSetPath *
value *

public mergeStructs(dest: *, src: *) source

Params:

NameTypeAttributeDescription
dest *
src *

public parseToolArgs(path: *): * source

Params:

NameTypeAttributeDescription
path *

Return:

*

public parseToolPath(path: *): * source

Override:

ModelInterface#parseToolPath

Params:

NameTypeAttributeDescription
path *

Return:

*

public popReportContext() source

Override:

ModelInterface#popReportContext

public pushReportContext(name: *) source

Override:

ModelInterface#pushReportContext

Params:

NameTypeAttributeDescription
name *

public resolveMassSetPaths(ctx: *, massSetPath: *): * source

takes a mass_set_path and returns an array of individual paths

Override:

ModelInterface#resolveMassSetPaths

Params:

NameTypeAttributeDescription
ctx *
massSetPath *

Return:

*

public resolvePath(ctx: *, inpath: *, ignoreExistence: boolean, dstruct: *): * source

Override:

ModelInterface#resolvePath

Params:

NameTypeAttributeDescription
ctx *
inpath *
ignoreExistence boolean
  • optional
  • default: false
dstruct *
  • optional
  • default: undefined

Return:

*

public resolvePathOld2(ctx: *, path: *): {"parent": *, "obj": *, "value": *, "key": *, "dstruct": *, "subkey": *, "prop": *, "arg": *, "type": *, "_path": *} source

Params:

NameTypeAttributeDescription
ctx *
path *

Return:

{"parent": *, "obj": *, "value": *, "key": *, "dstruct": *, "subkey": *, "prop": *, "arg": *, "type": *, "_path": *}

public resolvePath_intern(ignoreExistence:: *): {"dpath": *, "parent": *, "obj": *, "value": *, "key": *, "dstruct": *, "prop": *, "subkey": *} source

get meta information for a datapath.

Params:

NameTypeAttributeDescription
ignoreExistence: *

don't try to get actual data associated with path, just want meta information

Return:

{"dpath": *, "parent": *, "obj": *, "value": *, "key": *, "dstruct": *, "prop": *, "subkey": *}

public resolvePathold(ctx: *, path: *): {"parent": *, "obj": *, "value": *, "key": *, "dstruct": *, "prop": *} source

Params:

NameTypeAttributeDescription
ctx *
path *

Return:

{"parent": *, "obj": *, "value": *, "key": *, "dstruct": *, "prop": *}

public setRoot(sdef: *) source

Params:

NameTypeAttributeDescription
sdef *

Private Methods

private _addClass(cls:: *, auto_create:: *): IterableIterator<*> source

Look up struct definition for a class.

Params:

NameTypeAttributeDescription
cls: *

the class
auto_create: *

If true, automatically create definition if not already existing.

Return:

IterableIterator<*>

private _stripToolUIName(path: *, uiNameOut: *): * source

Params:

NameTypeAttributeDescription
path *
uiNameOut *
  • optional
  • default: undefined

Return:

*