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

ModelInterface

Direct Subclass:

DataAPI

Static Method Summary

Static Public Methods
public static

registerTool(tool: *)

public static

toolRegistered(tool: *)

Constructor Summary

Public Constructor
public

Member Summary

Public Members
public get

list: *

public

Method Summary

Public Methods
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(tool: *) source

Params:

NameTypeAttributeDescription
tool *

public static toolRegistered(tool: *) source

Params:

NameTypeAttributeDescription
tool *

Public Constructors

public constructor() source

Public Members

public get list: * source

public prefix: string source

Public Methods

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

Params:

NameTypeAttributeDescription
path *
inputs {}
  • optional
  • default: {}
constructor_argument *
  • optional
  • default: undefined

public execOrRedo(compareInputs: *): * source

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

otherwise, .execTool(ctx, tool) is called.

Params:

NameTypeAttributeDescription
compareInputs *

: check if toolstack head has identical input values, defaults to false

Return:

*

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

Params:

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

Return:

*

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

Params:

NameTypeAttributeDescription
ctx *
path *

Return:

*

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

Params:

NameTypeAttributeDescription
ctx *
path *

Return:

*

public getToolDef(path: *) source

Params:

NameTypeAttributeDescription
path *

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

Params:

NameTypeAttributeDescription
ctx *
path *

Return:

*

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

Params:

NameTypeAttributeDescription
ctx *
path *
rootStruct *
  • optional
  • default: undefined

Return:

*

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

Params:

NameTypeAttributeDescription
ctx *
mass_set_path *
value *

public parseToolPath(path: *) source

Params:

NameTypeAttributeDescription
path *

public popReportContext() source

public pushReportContext(name: *) source

Params:

NameTypeAttributeDescription
name *

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

takes a mass_set_path and returns an array of individual paths

Params:

NameTypeAttributeDescription
ctx *
mass_set_path *

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

Params:

NameTypeAttributeDescription
ctx *
path *
ignoreExistence *
rootStruct *

Example:


return {
  obj      : [object owning property key]
  parent   : [parent of obj]
  key      : [property key]
  subkey   : used by flag properties, represents a key within the property
  value    : [value of property]
  prop     : [optional toolprop.ToolProperty representing the property definition]
  struct   : [optional datastruct representing the type, if value is an object]
  mass_set : mass setter string, if controller implementation supports it
}

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

Params:

NameTypeAttributeDescription
ctx *
path *
val *
rootStruct *

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

Params:

NameTypeAttributeDescription
ctx *
path *
rootStruct *

Return:

boolean