Class RenderNode

constructor

• new RenderNode(name: string, manager: RenderNodeManager): RenderNode

  Parameters

  • name: string

    The name of the RenderNode.
  • manager: RenderNodeManager

    The manager that owns this RenderNode.

  Returns RenderNode

manager

name

onRunBegin

• onRunBegin(drawingContext: DrawingContext): void

  By default this is an empty method hook that you can override and use in your own custom render nodes.

  This method is called at the start of the run method. Don't forget to call it in your custom method.

  Parameters

  • drawingContext: DrawingContext

    The context currently in use.

  Returns void

onRunEnd

• onRunEnd(drawingContext: DrawingContext): void

  By default this is an empty method hook that you can override and use in your own custom render nodes.

  This method is called at the end of the run method. Don't forget to call it in your custom method.

  Parameters

  • drawingContext: DrawingContext

    The context currently in use.

  Returns void

run

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

  Run the RenderNode. This is a stub method that should be overridden by the specific implementation.

  This method may be wrapped by setDebug.

  Parameters

  • ...args: any[]

    Arguments to pass to the node. These will vary depending on the node.

  Returns void

setDebug

• setDebug(debug: boolean): void

  Set whether the node should report debug information. It wraps the run method with additional debug information.

  Parameters

  • debug: boolean

    Whether to report debug information.

  Returns void