Class GraphicsContextHandler

A class for managing multiple GraphicsContext objects.

Since

2.0.0

Index

Constructors

constructor

new GraphicsContextHandler(
activeContext: GraphicsContext,
otherContexts?: GraphicsContext[],
): GraphicsContextHandler
The constructor for the GraphicsContextHandler class.
Parameters
- activeContext: GraphicsContext
  {GraphicsContext} - The GraphicsContext to make active by default.
- OptionalotherContexts: GraphicsContext[]
  {GraphicsContext[]} - An optional array of additional GraphicsContext objects to add to the handler.
Returns GraphicsContextHandler
Since
2.0.0
- Defined in sketch/graphics/graphics-context-handler.ts:60

Accessors

activeContext

get activeContext(): GraphicsContext
Returns GraphicsContext
The currently active GraphicsContext.

Since
2.0.0
- Defined in sketch/graphics/graphics-context-handler.ts:74

activeGraphics

get activeGraphics(): Graphics
Returns Graphics
The p5.Graphics object associated with the active GraphicsContext.

Since
2.0.0
- Defined in sketch/graphics/graphics-context-handler.ts:83

contexts

get contexts(): GraphicsContext[]
Returns GraphicsContext[]
All GraphicsContext objects in the handler.

Since
2.0.0
- Defined in sketch/graphics/graphics-context-handler.ts:92

graphics

get graphics(): Graphics[]
Returns Graphics[]
An array of the p5.Graphics objects associated with all GraphicsContext objects in the handler.

Since
2.0.0
- Defined in sketch/graphics/graphics-context-handler.ts:101

names

get names(): string[]
Returns string[]
An array of the names of all GraphicsContext objects in the handler.

Since
2.0.0
- Defined in sketch/graphics/graphics-context-handler.ts:110

Methods

addContext

addContext(context: GraphicsContext): boolean
Adds a GraphicsContext to the handler.
Parameters
- context: GraphicsContext
  {GraphicsContext} - The GraphicsContext to add.
Returns boolean
true if the context was added successfully, false otherwise.

Since
2.0.0
- Defined in sketch/graphics/graphics-context-handler.ts:123

addContexts

addContexts(contexts: GraphicsContext[]): boolean
Adds multiple GraphicsContext objects to the handler.
Parameters
- contexts: GraphicsContext[]
  {GraphicsContext[]} - The GraphicsContext objects to add.
Returns boolean
true if all contexts were added successfully, false otherwise.

Since
2.0.0
- Defined in sketch/graphics/graphics-context-handler.ts:136

setActiveContext

setActiveContext(name: string): void
Sets the active GraphicsContext to the context with the specified name.
Parameters
- name: string
  {string} - The name of the GraphicsContext to set as active.
Returns void
Throws
if the context with the specified name is not found.

Since
2.0.0
- Defined in sketch/graphics/graphics-context-handler.ts:157

Class GraphicsContextHandler

Since

Index

Constructors

Accessors

Methods

Constructors

constructor

Parameters

Returns GraphicsContextHandler

Since

Accessors

activeContext

Returns GraphicsContext

Since

activeGraphics

Returns Graphics

Since

contexts

Returns GraphicsContext[]

Since

graphics

Returns Graphics[]

Since

names

Returns string[]

Since

Methods

addContext

Parameters

Returns boolean

Since

addContexts

Parameters

Returns boolean

Since

setActiveContext

Parameters

Returns void

Throws

Since

Settings

On This Page