Options
All
  • Public
  • Public/Protected
  • All
Menu

Class MaterialContainerBase

Base class for container component for material and material arguments. Basically used for MaterialComponent and MaterialContainerComponent

Hierarchy

Index

Constructors

constructor

  • Returns MaterialContainerBase

Properties

Protected _lastParameters

_lastParameters: object

Type declaration

  • [key: string]: IAttributeDeclaration & object

attributes

attributes: NSDictionary<Attribute>

Attributes managed by this component

type

{NSDictionary}

companion

companion: NSDictionary<any>

The dictionary which is shared in entire tree.

returns

[description]

disposed

disposed: boolean

element

element: Element

XMLElement of this component

type

{Element}

enabled

enabled: boolean

id

id: string

ID related to this instance to identify.

isActive

isActive: boolean

isDefaultComponent

isDefaultComponent: boolean

Whether this component was created by nodeDeclaration

type

{boolean}

name

name: NSIdentity

Name of this component

type

{NSIdentity}

node

node: GomlNode

Node this component is attached

type

{GomlNode}

tree

tree: GomlInterface

Tree interface for the tree this node is attached.

returns

[description]

Static attributes

attributes: object

Type declaration

  • [name: string]: IAttributeDeclaration

Accessors

assetLoadingManager

  • get assetLoadingManager(): AssetLoadingManager

loopManager

  • get loopManager(): LoopManager

Methods

Protected ___addAtribute

  • ___addAtribute(name: string, attribute: IAttributeDeclaration): void
  • Parameters

    • name: string
    • attribute: IAttributeDeclaration

    Returns void

Protected ___addAttribute

  • ___addAttribute(name: string, attribute: IAttributeDeclaration): Attribute
  • Add additional attribute to this component.

    Parameters

    • name: string
    • attribute: IAttributeDeclaration

    Returns Attribute

Protected ___bindAttributes

  • ___bindAttributes(): void
  • Returns void

Protected ___exposeMaterialParameters

  • ___exposeMaterialParameters(material: Material, keepVariable?: boolean): void

Protected ___invoke

  • ___invoke(method: function, timeInMillis: number): void
  • Call method after specified time elapsed. If the component was disabled, specified method will be called after component being enabled.

    Parameters

    • method: function
        • Parameters

          Returns void

    • timeInMillis: number

    Returns void

    [description]

Protected ___registerAssetLoading

  • ___registerAssetLoading<T>(loadingPromise: Promise<T>): Promise<T>

Protected ___registerFrameCoroutine

  • ___registerFrameCoroutine(coroutine: function, tag?: string | symbol): void
  • Register coroutine invoked by timer in frame count. Yield values from coroutine will be used as next frame to recall the generator.

    Parameters

    • coroutine: function
        • (): IterableIterator<number>
        • Returns IterableIterator<number>

    • Optional tag: string | symbol

    Returns void

Protected ___registerTimerCoroutine

  • ___registerTimerCoroutine(coroutine: function, tag?: string | symbol): void
  • Register coroutine invoked by timer in millisecound. Yield values from coroutine will be used as next frame to recall the generator. Ensure this is not called exactly specified timing. This will be called in the frame after specified timing.

    Parameters

    • coroutine: function
        • (): IterableIterator<number>
        • Returns IterableIterator<number>

    • Optional tag: string | symbol

    Returns void

Protected ___removeAttributes

  • ___removeAttributes(name?: string): void
  • Parameters

    • Optional name: string

    Returns void

Protected ___removeExposedMaterialParameters

  • ___removeExposedMaterialParameters(): void

Protected ___unregisterFrameCoroutine

  • ___unregisterFrameCoroutine(tag?: string | symbol): void

Protected ___unregisterTimerCoroutine

  • ___unregisterTimerCoroutine(tag?: string | symbol): void

addEnabledObserver

  • addEnabledObserver(observer: function): void
  • Parameters

    • observer: function
        • (component: Component): void
        • Parameters

          • component: Component

          Returns void

    Returns void

awake

  • awake(): boolean
  • Returns boolean

dispose

  • dispose(): void
  • Returns void

getAttribute

  • getAttribute(name: Name): any
  • Parameters

    • name: Name

    Returns any

getAttributeRaw

  • getAttributeRaw(name: Name): Attribute
  • Parameters

    • name: Name

    Returns Attribute

getTypeName

  • getTypeName(): string
  • Obtain class name

    Returns string

    Class name of the instance.

initialized

  • initialized(info: ITreeInitializedInfo): void
  • Parameters

    • info: ITreeInitializedInfo

    Returns void

removeEnabledObserver

  • removeEnabledObserver(observer: function): boolean
  • Parameters

    • observer: function
        • (component: Component): void
        • Parameters

          • component: Component

          Returns void

    Returns boolean

resolveDefaultAttributes

  • resolveDefaultAttributes(nodeAttributes?: object | null): any
  • Parameters

    • Optional nodeAttributes: object | null

    Returns any

setAttribute

  • setAttribute(name: Name, value: any): void
  • Set value of attribute

    Parameters

    • name: Name
    • value: any

    Returns void

toString

  • toString(): string
  • Obtain stringfied object. If this method was not overridden, this method return class name.

    Returns string

    stringfied object

Static getUniqueRandom

  • getUniqueRandom(length: number): string
  • Generate random string

    Parameters

    • length: number

      length of random string

    Returns string

    generated string

Generated using TypeDoc