Options
All
  • Public
  • Public/Protected
  • All
Menu

Class AMaterialModel

Hierarchy

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

  • new AMaterialModel(name?: string, materialClass?: ClassInterface<Material>, defaults?: MaterialParameters, sharedParams?: MaterialParams, ...args: any[]): AMaterialModel

Properties

_defaults

_defaults: MaterialParams

Protected _eventCallbackDicts

_eventCallbackDicts: {} = {}

Type declaration

Protected _parent

_parent: null | AObjectNode

Protected _subscriptions

_subscriptions: {} = {}

Type declaration

children

children: AObjectNode[]

materialClass

materialClass: ClassInterface<Material>

name

name: string

sharedParameters

sharedParameters: {}

Type declaration

  • [name: string]: any

state

state: {} = {}

Type declaration

  • [name: string]: any

uid

uid: string

Static AObjectStateKeys

AObjectStateKeys: string[] = []

Static AObjectVersion

AObjectVersion: number = 1

Static Events

Events: typeof AModelEvents = ...

Accessors

ClassConstructor

  • get ClassConstructor(): typeof AObject

defaults

  • get defaults(): ParamInterface
  • set defaults(v: ParamInterface): void

parent

serializationLabel

  • get serializationLabel(): any

stateSnapshop

  • get stateSnapshop(): {}

Methods

CreateMaterial

_CreateTHREEJS

  • _CreateTHREEJS(): Material

_attachToNewParent

_childrenListToUIDs

  • _childrenListToUIDs(childrenList: AObjectNode[]): string[]

_getEventCallbackDict

_getListeners

  • _getListeners(): {}

_removeChild

  • _removeChild(child: AObjectNode, triggerNewParentEvent?: boolean): void

_removeFromParent

  • _removeFromParent(triggerNewParentEvent?: boolean): void

_uidsToChildrenList

activateSubscription

  • activateSubscription(name: string): void

addChild

addEventListener

  • addEventListener(eventName: string, callback: (...args: any[]) => void, handle?: string): AEventCallbackSwitch

addEventListeners

  • addEventListeners(eventName: string, callbacks: ((...args: any[]) => void)[], handle?: string): AEventCallbackSwitch

addOneTimeEventListener

  • addOneTimeEventListener(eventName: string, callback: (...args: any[]) => void, handle?: string): AEventCallbackSwitch

addStateKeyListener

  • addStateKeyListener(state_key: string, callback: (self: AObject) => void, handle?: string, synchronous?: boolean): AStateCallbackSwitch

  • Sets a callback function to be called whenever the state specified in state_key changes. The return value callbackSwitch is a callback switch. You can activate the listener with callbackSwitch.activate() and deactive with callbackSwitch.deactivate(). Example Usage:

    var callbackswitch = model.addStateKeyListener('name',()=>{
         n_name_changes = n_name_changes+1;
    })

    Parameters

    • state_key: string

      the name of the state to listen to

    • callback: (self: AObject) => void

      the callback to be executed when state changes

    • Optional handle: string

      the handle / unique identifier for

    • synchronous: boolean = true

      whether callbacks should happen synchronously or allow for batching

    Returns AStateCallbackSwitch

addStateListener

  • addStateListener(callback: (self: AObject) => void, handle?: string, synchronous?: boolean): AStateCallbackSwitch

clearSubscriptions

  • clearSubscriptions(): void

deactivateSubscription

  • deactivateSubscription(name: string): void

dispose

  • dispose(): void

filterChildren

filterDescendants

getCameraNodes

  • getCameraNodes(): void

getChildWithID

getDescendantList

getMaterialGUIParams

  • getMaterialGUIParams(material: AMaterial): {}

mapOverChildren

  • mapOverChildren(fn: (child: AObjectNode) => void | any[]): (void | any[])[]

mapOverDescendants

  • mapOverDescendants(fn: (child: AObjectNode) => void | any[]): (void | any[])[]

release

  • release(...args: any[]): void

releaseChildren

  • releaseChildren(...args: any[]): (void | any[])[]

removeChild

removeChildren

  • removeChildren(): (void | any[])[]

removeEventListener

  • removeEventListener(eventName: string, handle: string): void

removeListener

  • removeListener(handle: string): void

reorderChildren

  • reorderChildren(uidList: string[]): void

reparent

setSharedParam

  • setSharedParam(name: string, val: any): void

setSharedParameters

  • setSharedParameters(params: MaterialParams): void

signalEvent

  • signalEvent(eventName: string, ...args: any[]): void

subscribe

toJSON

  • toJSON(): {}

unsubscribe

  • unsubscribe(name: string, errorIfAbsent?: boolean): void

Static CreateWithState

  • CreateWithState(state: {}): AObject

Static MaterialGUIColorControl

  • MaterialGUIColorControl(material: AMaterial, paramKey?: string): {}

Static MaterialGUIControl

  • MaterialGUIControl(material: AMaterial, paramName: string, defaultValue: any, otherSpecs: {}): {}

Static SerializationLabel

  • SerializationLabel(): any

Static fromJSON

Generated using TypeDoc