Options
All
  • Public
  • Public/Protected
  • All
Menu

Class CanvasController

CanvasController is a controller used to display a simple blank canvas. It can be used for debuging texture

How to use

``` javascript

For more information about basic use see <a href="BaseController.html">BaseController</a>

Hierarchy

Index

Constructors

Properties

Methods

Constructors

constructor

Properties

listen

listen: boolean = false

If true, the controller value will be updated automatically if target object is modified. Carefull: heavy use may reduce performance

group.add('someProperty', target, { listen: true })

disabled

disabled: boolean = false

If true, the controller will not be editable

name

name: string

Display name of a controller, defaultly equal to property.

group.add('someProperty', target, { name: 'Custom display name' })

property

property: string

property controlled in the target object

target

target: Object

source object in which the property key is defined

parent

parent: BaseGroup

width

width: number = 512

height

height: number = 512

canvas

canvas: Promise<HTMLCanvasElement>

Public access to generated canvas

step

step: number

If not defined step will be calculated automatically based on initial value

Methods

forceUpdate

  • forceUpdate(): void

  • Manually update controller value in the form if target has changed

    Returns void

destroy

  • destroy(): void

  • Delete the controller

    Returns void

add

  • add(property: string, target?: Object, params?: any): void

  • Add a controller in the same Group of current controller

    Parameters

    • property: string
    • target: Object = undefined
    • params: any = undefined

    Returns void

valueOf

  • valueOf(): any

Generated using TypeDoc