@add-on-hlapi-sdk / GroupNode
Class: GroupNode
A GroupNode represents a Group object in the scenegraph, which has a collection of generic children as well as a separate, optional vector mask child.
Hierarchy
↳
GroupNode
Table of contents
Accessors
- absoluteRotation
- absoluteTransform
- allChildren
- blendMode
- children
- locked
- maskShape
- opacity
- parent
- relativeRotation
- relativeTransform
- translateX
- translateY
- type
Methods
Accessors
absoluteRotation
• get absoluteRotation(): number
The node's absolute (global) rotation angle in degrees – includes any cumulative rotation from the node's parent containers.
Returns
number
Inherited from
ContainerNode.absoluteRotation
• set absoluteRotation(value): void
Parameters
| Name | Type |
|---|---|
value | number |
Returns
void
Inherited from
ContainerNode.absoluteRotation
absoluteTransform
• get absoluteTransform(): mat2d
The node's absolute (global) transform matrix.
Returns
Inherited from
ContainerNode.absoluteTransform
allChildren
• get allChildren(): Readonly<Iterable<Node>>
Returns a read-only list of all children of the node. General-purpose content containers such as ArtboardNode or
GroupNode also provide a mutable children list. Other nodes with a more specific structure can
hold children in various discrete "slots"; this allChildren list includes all such children and reflects their
overall display z-order.
Returns
Readonly<Iterable<Node>>
Inherited from
ContainerNode.allChildren
blendMode
• get blendMode(): BlendModeValue
Blend mode determines how a node is composited onto the content below it. The default value is normal for most nodes, and passThrough for GroupNodes.
Returns
Inherited from
ContainerNode.blendMode
• set blendMode(value): void
Parameters
| Name | Type |
|---|---|
value |
Returns
void
Inherited from
ContainerNode.blendMode
children
• get children(): ItemList<Node>
The Group's regular children. Does not include the maskShape if one is present. Use the methods on this ItemList object to get, add, and remove children.
Returns
Overrides
ContainerNode.children
locked
• get locked(): boolean
The node's lock/unlock state. Locked nodes are excluded from the selection (see selection), and cannot be edited by the user unless they are unlocked first.
Returns
boolean
Inherited from
ContainerNode.locked
• set locked(locked): void
Parameters
| Name | Type |
|---|---|
locked | boolean |
Returns
void
Inherited from
ContainerNode.locked
maskShape
• get maskShape(): undefined | FillableNode
A vector shape that acts as a clipping mask for the content of this group. The mask node is separate from the Group's generic 'children' collection, though both are part of the overall 'allChildren' of this Group.
Returns
undefined | FillableNode
undefined if no mask is set on this group.
• set maskShape(mask): void
If set to a vector shape, adds a mask or replaces the exsiting mask on this Group. If set to undefined, removes any mask that was previously set on this Group.
Throws
if the given node type cannot be used as a vector mask.
Parameters
| Name | Type |
|---|---|
mask | undefined | FillableNode |
Returns
void
opacity
• get opacity(): number
The node's opacity, from 0.0 to 1.0
Returns
number
Inherited from
ContainerNode.opacity
• set opacity(opacity): void
Parameters
| Name | Type |
|---|---|
opacity | number |
Returns
void
Inherited from
ContainerNode.opacity
parent
• get parent(): undefined | Node
The node's parent. Undefined if the node is an orphan, or if the node is the artwork root.
Returns
undefined | Node
Inherited from
ContainerNode.parent
relativeRotation
• get relativeRotation(): number
The node's local rotation value in degrees, relative to its parent's axes. Modifying this value will also adjust the node's x & y translation such that the node's center is in the same location after the rotation – i.e. this setter rotates the node about its bounding box's center, not its origin.
Returns
number
Inherited from
ContainerNode.relativeRotation
• set relativeRotation(value): void
Parameters
| Name | Type |
|---|---|
value | number |
Returns
void
Inherited from
ContainerNode.relativeRotation
relativeTransform
• get relativeTransform(): mat2d
The node's transform matrix relative to its parent.
Returns
Inherited from
ContainerNode.relativeTransform
translateX
• get translateX(): number
The translation of the node along its parent's x-axis.
Returns
number
Inherited from
ContainerNode.translateX
• set translateX(value): void
Parameters
| Name | Type |
|---|---|
value | number |
Returns
void
Inherited from
ContainerNode.translateX
translateY
• get translateY(): number
The translation of the node along its parent's y-axis.
Returns
number
Inherited from
ContainerNode.translateY
• set translateY(value): void
Parameters
| Name | Type |
|---|---|
value | number |
Returns
void
Inherited from
ContainerNode.translateY
type
• get type(): SceneNodeTypeValueID
The node's type.
Returns
Inherited from
ContainerNode.type
Methods
removeFromParent
▸ removeFromParent(): void
Removes the node from its parent - for a basic ContainerNode, this is equivalent to node.parent.children.remove(node).
For nodes with other slots, removes the child from whichever slot it resides in, if possible. Throws if the slot does
not support removal. Also throws if node is the artwork root. No-op if node is already an orphan.
Returns
void
Inherited from
ContainerNode.removeFromParent
