Polygon
Generates an image of a regular 2D polygon.
Polygon
Method #
Generates a single regular polygon as an image, great for use with a point renderer, or as a building block for more complicated effects.
This node can be connected to any node which accepts an image input.
Parameters
These properties control the 3D transforms of the node. Transforms will generally be inherited by child nodes, although they can be ignored through the Inherit Transform Channels attributes.
Parameter Details Position X The objects position along the local x-axis.
Position Y The objects position along the local y-axis.
Position Z The objects position along the local z-axis.
Rotation Heading The objects rotation around the local y-axis.
Rotation Pitch The objects rotation around the local x-axis.
Rotation Bank The objects rotation around the local z-axis.
Scale X The objects scale along the local x-axis.
Scale Y The objects scale along the local y-axis.
Scale Z The objects scale along the local z-axis.
Control the inheritance of the transforms from the parent.
These properties control the core behaviours of the node.
Parameter Details Active Enables or disables the effect. Disabling the effect means it will no longer compute, so disabling a node when not in use can improve performance.
Preview In Viewport Preview the generated image as an overlay in the viewport.
- Off : No preview is generated.
- RGBA : Preview the image blended with alpha in the viewport.
- RGB : Preview the colour channels in the viewport.
- Alpha : Preview the alpha channel in the viewport.
- PIP : Preview the image blended with alpha in the viewport, in a smaller picture in picture display, on top of the existing content.
Width The resolution of the generated image horizontally.
Height The resolution of the generated image vertically.
Update Time Mode How the generator updates with relation to the timecode.
- Locked To Timecode : The generator animations are locked to the timecode and the same time will always yield the same result.
- Running / Loopable : The generator animations are disconnected from the timecode and will loop seamlessly at the end of the layer.
Orientation Sets the rotation of the shape independently from the transform controls.
Scale A uniform scaling value. Use this rather than the transform controls to maintain the same level of softness (described below) at all scales.
Softness The amount of feathering at the edges of the polygon.
Sides The number of sides that the shape has.
Filled Indicates whether the polygon should be filled in, or should be drawn as outlines only.
These properties control how the generators are coloured and blended with other images.
Parameter Details Colour Change the colour of the generated image.
Blend Amount The amount the generated image blends with the project, depending on the compositing mode chosen.
Blend Mode Choose how the image blends with the scene. See Blend Modes for details.
- Solid : The generator is solid, with a filled alpha channel. Blend amount is ignored.
- Blend : The generator RGBA values have matching alpha channels.
- Pre-Mul Blend : The RGB values are solid white, and the generator colours are stored in the alpha channel alpha. Usually gives the best results for colour blending.
Inputs
These properties control the 3D transforms of the node. Transforms will generally be inherited by child nodes, although they can be ignored through the Inherit Transform Channels attributes.
| Parameter | Details |
|---|---|
| Position X | The objects position along the local x-axis. |
| Position Y | The objects position along the local y-axis. |
| Position Z | The objects position along the local z-axis. |
| Rotation Heading | The objects rotation around the local y-axis. |
| Rotation Pitch | The objects rotation around the local x-axis. |
| Rotation Bank | The objects rotation around the local z-axis. |
| Scale X | The objects scale along the local x-axis. |
| Scale Y | The objects scale along the local y-axis. |
| Scale Z | The objects scale along the local z-axis. |
Control the inheritance of the transforms from the parent.
These properties control the core behaviours of the node.
| Parameter | Details |
|---|---|
| Active | Enables or disables the effect. Disabling the effect means it will no longer compute, so disabling a node when not in use can improve performance. |
| Preview In Viewport | Preview the generated image as an overlay in the viewport.
|
| Width | The resolution of the generated image horizontally. |
| Height | The resolution of the generated image vertically. |
| Update Time Mode | How the generator updates with relation to the timecode.
|
| Orientation | Sets the rotation of the shape independently from the transform controls. |
| Scale | A uniform scaling value. Use this rather than the transform controls to maintain the same level of softness (described below) at all scales. |
| Softness | The amount of feathering at the edges of the polygon. |
| Sides | The number of sides that the shape has. |
| Filled | Indicates whether the polygon should be filled in, or should be drawn as outlines only. |
These properties control how the generators are coloured and blended with other images.
| Parameter | Details |
|---|---|
| Colour | Change the colour of the generated image. |
| Blend Amount | The amount the generated image blends with the project, depending on the compositing mode chosen. |
| Blend Mode | Choose how the image blends with the scene. See Blend Modes for details.
|
| Name | Description | Typical Input |
|---|---|---|
| Colour Ramp | Specify a range of colours the generator can use through its gradient. | Colour Ramp |
| Transform Modifiers | Apply the transforms of another node to this node. | Null |
| Target Node | Modifiy the rotations of the node to always direct the z axis towards the input. | Null |
| Local Transform Override | Apply the transforms of another node to this node, relative to its parent. | Null |