-
Notifications
You must be signed in to change notification settings - Fork 5
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
VIX-1025 Merging in changes from other branches
VIX-1025 Merging in changes from other branches
- Loading branch information
Showing
5 changed files
with
212 additions
and
44 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
73 changes: 73 additions & 0 deletions
73
content/en/docs/usage/sequencer/effects/pixel/border/border_advanced.md
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,73 @@ | ||
--- | ||
title: Advanced Mode | ||
description: Creates an effect that outlines a display element with a border with advanced configuration controls. | ||
|
||
--- | ||
|
||
### Overview | ||
|
||
Creates an effect that outlines a display element with a border with advanced configuration controls. | ||
|
||
--- | ||
|
||
### String Setup | ||
|
||
* **Positioning** - Determines how the target elements are treated. Either as individual strings or by their actual location in the display preview. | ||
Locations is often referred to as whole house, but it can be any form of multiple props. | ||
Generally you want Strings when applying to one prop and locations if the target is multiple props. | ||
|
||
* **Orientation** - Controls the orientation of the display area (matrix). | ||
|
||
--- | ||
|
||
### Configuration | ||
|
||
* **Border Mode** - Selects between _Simple_, _Advanced_, or _Marquee_ borders. | ||
|
||
* **Border Type** - Selects between _Single_ or _Independent_ border width control. | ||
_Single_ border type makes all the sides of the display element a uniform thickness. | ||
|
||
--- | ||
|
||
### Border | ||
|
||
* **Thickness** - Adjusts the thickness of the border. Applies when _Single_ **Border Type** is selected. | ||
|
||
* **Top Width** - Adjusts the top border thickness. Applies when _Border Type_ is set to _Independent_. | ||
|
||
* **Bottom Width** - Adjusts the bottom border thickness. Applies when _Border Type_ is set to _Independent_. | ||
|
||
* **Left Width** - Adjusts the left border thickness. Applies when _Border Type_ is set to _Independent_. | ||
|
||
* **Right Width** - Adjusts the right border thickness. Applies when _Border Type_ is set to _Independent_. | ||
|
||
* **Width** - Configures the width of the border. | ||
|
||
* **Height** - Configures the height of the border. | ||
|
||
--- | ||
|
||
### Movement | ||
|
||
* **X Offset** - Adjusts the position of the effect along the X axis. | ||
|
||
* **Y Offset** - Adjusts the position of the effect along the Y axis. | ||
|
||
--- | ||
|
||
### Color | ||
|
||
* **Gradient Mode** - Configures how the **Color Gradient** is applied to the border | ||
(_Over Time_, _Across Element_, _Vertically Across Element_, _Diagonal Bottom-Top Element_, _Diagonal Top-Bottom Element_). | ||
|
||
* **Color Gradient** - Controls the colors of the border. | ||
|
||
--- | ||
|
||
### Brightness | ||
|
||
* **Intensity** - This is an overall brightness intensity curve over the duration of the effect. | ||
This is a legacy parameter, consider using intensity overlay layers instead. | ||
|
||
--- | ||
|
75 changes: 75 additions & 0 deletions
75
content/en/docs/usage/sequencer/effects/pixel/border/border_marquee.md
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,75 @@ | ||
--- | ||
title: Marquee Mode | ||
description: Creates an effect that outlines a display element with a marquee border. | ||
--- | ||
|
||
--- | ||
|
||
### Overview | ||
|
||
Creates an effect that outlines a display element with a marquee border. | ||
|
||
--- | ||
|
||
### String Setup | ||
|
||
* **Positioning** - Determines how the target elements are treated. Either as individual strings or by their actual location in the display preview. | ||
Locations is often referred to as whole house, but it can be any form of multiple props. | ||
Generally you want Strings when applying to one prop and locations if the target is multiple props. | ||
|
||
* **Orientation** - Controls the orientation of the display area (matrix). | ||
|
||
--- | ||
|
||
### Configuration | ||
|
||
* **Border Mode** - Selects between _Simple_, _Advanced_, or _Marquee_ borders. Refer to the links below for more information on each of the Border Modes. | ||
|
||
* **Render Level** - Controls how the marquee is rendered (_Level 0_, _Level 1_, or _Level 2_). | ||
* _Level 0_ - (default) renders the effect as a normal matrix outlining it with a border. | ||
* _Level 1_ - Converts the matrix into a single strand of pixels. The single strand is created by looping back and forth. | ||
* _Level 2_ - Converts the maxrix into a single stand of pixels. The single strand is created by always starting on the left side of the matrix. | ||
|
||
Render Levels 1 and 2 provide visually interesting patterns when this effect is placed on a mega-tree and other props. | ||
|
||
* **Thickness** - Controls the width of the marquee border as a percentage of the display element. | ||
|
||
* **Stagger** - Controls the offset between each band of pixels in the marquee border as a percentage of the display element. The **Thickness** needs to greater than 1 pixel for this control to be visible. | ||
|
||
* **Band Length** - Controls the size of the marquee color bands as a percentage of the display element. | ||
|
||
* **Skip Length** - Controls the size of the blank area between marquee color bands as a percentage of the display element. | ||
|
||
* **Reverse** - Toggles the direction of the marquee movement. | ||
|
||
* **X-Size** - Determines the size of the marquee along the x-axis. | ||
|
||
* **Y-Size** - Determines the size of the marquee along the y-axis. | ||
|
||
--- | ||
|
||
### Movement | ||
|
||
* **X Offset** - Adjusts the position of the effect along the X axis. | ||
|
||
* **Y Offset** - Adjusts the position of the effect along the Y axis. | ||
|
||
* ** Wrap X Axis ** - Allows the marquee to wrap around the display element on the x-axis. | ||
|
||
* ** Wrap Y Axis ** - Allows the marquee to wrap around the display element on the y-axis. | ||
|
||
--- | ||
|
||
### Color | ||
|
||
* **Color Gradient** - Controls the color of the bands that make up the marquee. | ||
|
||
--- | ||
|
||
### Brightness | ||
|
||
* **Intensity** - This is an overall brightness intensity curve over the duration of the effect. | ||
This is a legacy parameter, consider using intensity overlay layers instead. | ||
|
||
--- | ||
|
52 changes: 52 additions & 0 deletions
52
content/en/docs/usage/sequencer/effects/pixel/border/border_simple.md
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,52 @@ | ||
--- | ||
title: Simple Mode | ||
description: Creates an effect that outlines a display element with a simple border. | ||
|
||
--- | ||
|
||
--- | ||
|
||
### Overview | ||
|
||
Creates an effect that outlines a display element with a simple border. | ||
|
||
--- | ||
|
||
### String Setup | ||
|
||
* **Positioning** - Determines how the target elements are treated. Either as individual strings or by their actual location in the display preview. | ||
Locations is often referred to as whole house, but it can be any form of multiple props. | ||
Generally you want Strings when applying to one prop and locations if the target is multiple props. | ||
|
||
* **Orientation** - Controls the orientation of the display area (matrix). | ||
|
||
--- | ||
|
||
### Configuration | ||
|
||
* **Border Mode** - Selects between _Simple_, _Advanced_, or _Marquee_ borders. | ||
|
||
--- | ||
|
||
### Border | ||
|
||
* **Width** - Controls the thickness of the border. | ||
|
||
--- | ||
|
||
### Color | ||
|
||
* **Gradient Mode** - Configures how the **Color Gradient** is applied to the border | ||
(_Over Time_, _Across Element_, _Vertically Across Element_, _Diagonal Bottom-Top Element_, _Diagonal Top-Bottom Element_). | ||
|
||
* **Color Gradient** - Controls the colors of the border. | ||
|
||
--- | ||
|
||
### Brightness | ||
|
||
* **Intensity** - This is an overall brightness intensity curve over the duration of the effect. | ||
This is a legacy parameter, consider using intensity overlay layers instead. | ||
|
||
--- | ||
|