Options
All
  • Public
  • Public/Protected
  • All
Menu

Class RenderSceneComponent

Hierarchy

Index

Constructors

constructor

  • Returns RenderSceneComponent

Properties

_out

_out: Promise<IRenderingTarget>

attributes

attributes: NSDictionary<Attribute>

Attributes managed by this component

type

{NSDictionary}

camera

clearColor

clearColor: Color4

clearColorEnabled

clearColorEnabled: boolean

clearDepth

clearDepth: number

clearDepthEnabled

clearDepthEnabled: boolean

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}

layer

layer: string

metadata

metadata: object

Type declaration

  • [key: string]: any

name

name: NSIdentity

Name of this component

type

{NSIdentity}

node

node: GomlNode

Node this component is attached

type

{GomlNode}

out

technique

technique: string

tree

tree: GomlInterface

Tree interface for the tree this node is attached.

returns

[description]

Methods

$awake

  • $awake(): void

$click

$dblclick

$mount

  • $mount(): void

$mousedown

$mouseenter

$mouseleave

$mousemove

$mouseup

$render

  • $render(args: IRenderRendererMessage): void

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 ___beforeRender

  • ___beforeRender(): boolean

Protected ___bindAttributes

  • ___bindAttributes(): void
  • Returns void

Protected ___removeAttributes

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

    • Optional name: string

    Returns 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

Object literals

rendererDescription

rendererDescription: object

mouse

mouse: ViewportBaseMouseState = {coords: {canvas: [0, 0],canvasNormalized: [0, 0],viewport: [0, 0],viewportNormalized: [0, 0],},left: false,right: false,inside: false,} as ViewportBaseMouseState

Static attributes

attributes: object

camera

camera: object

converter

converter: string = "Component"

default

default: null = null

target

target: string = "Camera"

layer

layer: object

converter

converter: string = "String"

default

default: string = "default"

technique

technique: object

converter

converter: string = "String"

default

default: string = "default"

Generated using TypeDoc