Class PaintGroups

Hierarchy

PaintGroups

Index

Constructors

Properties

_node _paintGroup _paintGroupNode

Methods

clearPaintGroup crease isPaintGroup node paintGroup paintGroupNode setPaintGroup setPaintGroupNode uncrease

Constructors

constructor

new PaintGroups(node: DirectionNode<any>): PaintGroups
Parameters
- node: DirectionNode<any>
Returns PaintGroups
- Defined in DirectionNode/PaintGroups/PaintGroups.ts:9

Properties

`Private` _node

_node: DirectionNode<any>

`Private` _paintGroup

_paintGroup: PaintGroup

`Private` _paintGroupNode

_paintGroupNode: DirectionNode<any>

Methods

clearPaintGroup

clearPaintGroup(): void
Clears this node's local paint group, if any.

Called by the paint group when it is being removed.

This is an internal method and does not trigger invalidation.

Returns void
- Defined in DirectionNode/PaintGroups/PaintGroups.ts:35

crease

crease(): void
Creates a paint group for this node, and makes it explicit so it will persist once connecting to a parent node.

Returns void
- Defined in DirectionNode/PaintGroups/PaintGroups.ts:91

isPaintGroup

isPaintGroup(): boolean
Returns whether this node is a paint group root.

Returns
true if this node is a paint group root.

Returns boolean
- Defined in DirectionNode/PaintGroups/PaintGroups.ts:24

node

node(): DirectionNode<any>
Returns DirectionNode<any>
- Defined in DirectionNode/PaintGroups/PaintGroups.ts:15

paintGroup

paintGroup(): PaintGroup
Gets the paint group used for this DirectionNode.

Returns
the paint group used for this DirectionNode.

Returns PaintGroup
- Defined in DirectionNode/PaintGroups/PaintGroups.ts:67

paintGroupNode

paintGroupNode(): DirectionNode<any>
Gets the DirectionNode that is the paint group root for this DirectionNode.

Returns
the paint group root for this DirectionNode.

Returns DirectionNode<any>
- Defined in DirectionNode/PaintGroups/PaintGroups.ts:44

setPaintGroup

setPaintGroup(paintGroup: PaintGroup): void
Parameters
- paintGroup: PaintGroup
Returns void
- Defined in DirectionNode/PaintGroups/PaintGroups.ts:83

setPaintGroupNode

setPaintGroupNode(pg: DirectionNode<any>): void
Changes the paint group root.

This is an internal method and does not trigger invalidation.
Parameters
- pg: DirectionNode<any>
  
  the new paint group root
Returns void
- Defined in DirectionNode/PaintGroups/PaintGroups.ts:55

uncrease

uncrease(): void
Removes the paint group from this node, unless it is a root node.

Returns void
- Defined in DirectionNode/PaintGroups/PaintGroups.ts:103

Generated using TypeDoc