SingleBufferRenderStageBase | grimoirejs-fundamental

Hierarchy

RenderStageBase
- SingleBufferRenderStageBase

Index

Constructors

constructor

Properties

Object literals

Constructors

constructor

new SingleBufferRenderStageBase(): SingleBufferRenderStageBase

Inherited from IDObject.__constructor
- Defined in /home/ubuntu/grimoirejs-fundamental/node_modules/grimoirejs/ref/Base/IDObject.d.ts:15
Returns SingleBufferRenderStageBase

Properties

_out

_out: Promise<IRenderingTarget>

attributes

attributes: NSDictionary<Attribute>

Attributes managed by this component

type: {NSDictionary}

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}

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

out: IRenderingTarget

tree

tree: GomlInterface

Tree interface for the tree this node is attached.

returns: [description]

Methods

$awake

$awake(): void

- Defined in Components/RenderStage/SingleBufferRenderStageBase.ts:42
Returns void

$click

$click(v: ViewportMouseEvent): void

Inherited from RenderStageBase.$click
- Defined in Components/RenderStage/RenderStageBase.ts:47
Parameters
- v: ViewportMouseEvent
Returns void

$dblclick

$dblclick(v: ViewportMouseEvent): void

Inherited from RenderStageBase.$dblclick
- Defined in Components/RenderStage/RenderStageBase.ts:51
Parameters
- v: ViewportMouseEvent
Returns void

$mousedown

$mousedown(v: ViewportMouseEvent): void

Inherited from RenderStageBase.$mousedown
- Defined in Components/RenderStage/RenderStageBase.ts:39
Parameters
- v: ViewportMouseEvent
Returns void

$mouseenter

$mouseenter(v: ViewportMouseEvent): void

Inherited from RenderStageBase.$mouseenter
- Defined in Components/RenderStage/RenderStageBase.ts:31
Parameters
- v: ViewportMouseEvent
Returns void

$mouseleave

$mouseleave(v: ViewportMouseEvent): void

Inherited from RenderStageBase.$mouseleave
- Defined in Components/RenderStage/RenderStageBase.ts:35
Parameters
- v: ViewportMouseEvent
Returns void

$mousemove

$mousemove(v: ViewportMouseEvent): void

Inherited from RenderStageBase.$mousemove
- Defined in Components/RenderStage/RenderStageBase.ts:27
Parameters
- v: ViewportMouseEvent
Returns void

$mouseup

$mouseup(v: ViewportMouseEvent): void

Inherited from RenderStageBase.$mouseup
- Defined in Components/RenderStage/RenderStageBase.ts:43
Parameters
- v: ViewportMouseEvent
Returns void

Protected ___addAtribute

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

Inherited from Component.__addAtribute
- Defined in /home/ubuntu/grimoirejs-fundamental/node_modules/grimoirejs/ref/Node/Component.d.ts:77
Parameters
- name: string
- attribute: IAttributeDeclaration
Returns void

Protected ___addAttribute

___addAttribute(name: string, attribute: IAttributeDeclaration): Attribute

Inherited from Component.__addAttribute
- Defined in /home/ubuntu/grimoirejs-fundamental/node_modules/grimoirejs/ref/Node/Component.d.ts:83
Add additional attribute to this component.

Parameters
- name: string
- attribute: IAttributeDeclaration
Returns Attribute

Protected ___beforeRender

___beforeRender(): boolean

Overrides RenderStageBase.___beforeRender
- Defined in Components/RenderStage/SingleBufferRenderStageBase.ts:56
Setup rendering target(Attaching FBO, clearning depth or color buffers)

Returns boolean

Protected ___bindAttributes

___bindAttributes(): void

Inherited from Component.__bindAttributes
- Defined in /home/ubuntu/grimoirejs-fundamental/node_modules/grimoirejs/ref/Node/Component.d.ts:85
Returns void

Protected ___removeAttributes

___removeAttributes(name?: string): void

Inherited from Component.__removeAttributes
- Defined in /home/ubuntu/grimoirejs-fundamental/node_modules/grimoirejs/ref/Node/Component.d.ts:84
Parameters
- Optional name: string
Returns void

addEnabledObserver

addEnabledObserver(observer: function): void

Inherited from Component.addEnabledObserver
- Defined in /home/ubuntu/grimoirejs-fundamental/node_modules/grimoirejs/ref/Node/Component.d.ts:69
Parameters
- observer: function
  - - (component: Component): void
    - Parameters
      - component: Component
      Returns void
Returns void

awake

awake(): boolean

Inherited from Component.awake
- Defined in /home/ubuntu/grimoirejs-fundamental/node_modules/grimoirejs/ref/Node/Component.d.ts:75
Returns boolean

dispose

dispose(): void

Inherited from Component.dispose
- Defined in /home/ubuntu/grimoirejs-fundamental/node_modules/grimoirejs/ref/Node/Component.d.ts:74
Returns void

getAttribute

getAttribute(name: Name): any

Inherited from Component.getAttribute
- Defined in /home/ubuntu/grimoirejs-fundamental/node_modules/grimoirejs/ref/Node/Component.d.ts:67
Parameters
- name: Name
Returns any

getAttributeRaw

getAttributeRaw(name: Name): Attribute

Inherited from Component.getAttributeRaw
- Defined in /home/ubuntu/grimoirejs-fundamental/node_modules/grimoirejs/ref/Node/Component.d.ts:68
Parameters
- name: Name
Returns Attribute

getTypeName

getTypeName(): string

Inherited from IDObject.getTypeName
- Defined in /home/ubuntu/grimoirejs-fundamental/node_modules/grimoirejs/ref/Base/IDObject.d.ts:27
Obtain class name

Returns string

Class name of the instance.

initialized

initialized(info: ITreeInitializedInfo): void

Inherited from Component.initialized
- Defined in /home/ubuntu/grimoirejs-fundamental/node_modules/grimoirejs/ref/Node/Component.d.ts:76
Parameters
- info: ITreeInitializedInfo
Returns void

removeEnabledObserver

removeEnabledObserver(observer: function): boolean

Inherited from Component.removeEnabledObserver
- Defined in /home/ubuntu/grimoirejs-fundamental/node_modules/grimoirejs/ref/Node/Component.d.ts:70
Parameters
- observer: function
  - - (component: Component): void
    - Parameters
      - component: Component
      Returns void
Returns boolean

resolveDefaultAttributes

resolveDefaultAttributes(nodeAttributes?: object | null): any

Inherited from Component.resolveDefaultAttributes
- Defined in /home/ubuntu/grimoirejs-fundamental/node_modules/grimoirejs/ref/Node/Component.d.ts:71
Parameters
- Optional nodeAttributes: object | null
Returns any

setAttribute

setAttribute(name: Name, value: any): void

Inherited from Component.setAttribute
- Defined in /home/ubuntu/grimoirejs-fundamental/node_modules/grimoirejs/ref/Node/Component.d.ts:66
Set value of attribute

Parameters
- name: Name
- value: any
Returns void

toString

toString(): string

Inherited from IDObject.toString
- Defined in /home/ubuntu/grimoirejs-fundamental/node_modules/grimoirejs/ref/Base/IDObject.d.ts:22
Obtain stringfied object. If this method was not overridden, this method return class name.

Returns string

stringfied object

Static getUniqueRandom

getUniqueRandom(length: number): string

Inherited from IDObject.getUniqueRandom
- Defined in /home/ubuntu/grimoirejs-fundamental/node_modules/grimoirejs/ref/Base/IDObject.d.ts:15
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

clearColor

clearColor: object

converter

converter: string = "Color4"

default

default: string = "#0000"

clearColorEnabled

clearColorEnabled: object

converter

converter: string = "Boolean"

default

default: boolean = true

clearDepth

clearDepth: object

converter

converter: string = "Number"

default

default: number = 1

clearDepthEnabled

clearDepthEnabled: object

converter

converter: string = "Boolean"

default

default: boolean = true

out

out: object

converter

converter: string = "RenderingTarget"

default

default: string = "default"

Hierarchy

Index

Constructors

Properties

Methods

Object literals

Constructors

constructor

Returns SingleBufferRenderStageBase

Properties

_out

attributes

clearColor

clearColorEnabled

clearDepth

clearDepthEnabled

companion

disposed

element

enabled

id

isActive

isDefaultComponent

metadata

Type declaration

[key: string]: any

name

node

out

tree

Methods

$awake

Returns void

$click

Parameters

v: ViewportMouseEvent

Returns void

$dblclick

Parameters

v: ViewportMouseEvent

Returns void

$mousedown

Parameters

v: ViewportMouseEvent

Returns void

$mouseenter

Parameters

v: ViewportMouseEvent

Returns void

$mouseleave

Parameters

v: ViewportMouseEvent

Returns void

$mousemove

Parameters

v: ViewportMouseEvent

Returns void

$mouseup

Parameters

v: ViewportMouseEvent

Returns void

Protected ___addAtribute

Parameters

name: string

attribute: IAttributeDeclaration

Returns void

Protected ___addAttribute

Parameters

name: string

attribute: IAttributeDeclaration

Returns Attribute

Protected ___beforeRender

Returns boolean

Protected ___bindAttributes

Returns void

Protected ___removeAttributes

Parameters

Optional name: string

Returns void

addEnabledObserver