Skip to content

Commit a3195a5

Browse files
authored
Merge pull request #18 from SudoMagicCode/SudoMagic/mr-working
Updates documentation structure and content
2 parents bdc363c + 4661127 commit a3195a5

30 files changed

Lines changed: 2887 additions & 16851 deletions

.github/workflows/deploy.yaml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -22,7 +22,7 @@ jobs:
2222
- uses: actions/checkout@v3
2323
- uses: actions/setup-node@v3
2424
with:
25-
node-version: 18
25+
node-version: 24
2626
cache-dependency-path: docs/yarn.lock
2727
cache: yarn
2828

.github/workflows/test-deploy.yaml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -20,7 +20,7 @@ jobs:
2020
- uses: actions/checkout@v3
2121
- uses: actions/setup-node@v3
2222
with:
23-
node-version: 18
23+
node-version: 24
2424
cache-dependency-path: docs/yarn.lock
2525
cache: yarn
2626

docs/docs/HQ-guide/HQ-guide.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
---
22
layout: default
33
title: The Interactive & Immersive HQ
4-
sidebar_position: 3
4+
sidebar_position: 4
55
---
66

77
import DocCardList from '@theme/DocCardList';

docs/docs/SM-guide/002-preference-settings.md

Lines changed: 17 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -4,9 +4,9 @@ description: An overview of TouchDesigner preferences
44
slug: /SM-guide/preferences
55
---
66

7-
# Recommended Preference Settings
7+
## Recommended Preference Settings
88

9-
Preferences is a dialog for setting personal default settings for various TouchDesigner options. These preferences are found in the Edit menu under Preferences.... These options are saved so they apply to your next TouchDesigner session.
9+
Preferences is a dialog for setting personal default settings for various TouchDesigner options. These preferences are found in the Edit menu under Preferences.... These options are saved so they apply to your next TouchDesigner session.
1010

1111
From the Edit menu select the Preferences dialog box. Alternatively, you could use the keyboard short-cut Alt + p
1212

@@ -15,41 +15,45 @@ Here you’ll find a number of preferences for setting up your TouchDesigner env
1515
Alternatively, you can find the preference file located here:
1616

1717
Platform | Path |
18-
:--- | :--- |
18+
:--- | :--- |
1919
Windows | `C:/Users/{username}/AppData/Local/Derivative/TouchDesigner/pref.txt`
2020
macOS | `~Library/Application Support/Derivative/TouchDesigner</pref.txtcode>`
2121

2222
## Grid Snap
23+
2324
By default the grid snap setting in TouchDesigner is set to course. Most of the networks you’ll find in our repos have been set with a fine network grid, which means if you re-arrange an operator, it will be difficult to find your way back into alignment with the project. For this reason, it’s worth changing your Snap to Grid to be fine.
2425

2526
## Resize
27+
2628
For the sanity of other programmers, it’s well worth turning off the resize TOP and COMP checkboxes in your Network preferences tab. This keeps a uniform look to all TOPs and COMPs unless you choose to specifically deviate from the normal size.
2729

2830
This is often an area of spirited discussion, and programmers often have very specific opinions about the right approach for sizing and network organization. That being said, it’s worth remembering that a formal structure to the choices made in sizing and placement help make a TouchDesigner network more readable and navigable. First starting with normed sizes allows the programmer to make specific choices, rather than arbitrary ones – a common byproduct of the use of auto resizing. for both TOPs and COMPs.
2931

3032
Said another way, if the size and placement of your operators communicates meaning in your networks - then it's in your best intrest to make those decisiosn conscisouly.
3133

3234
## External Editors
35+
3336
It’s often desirable to have an external editor for text and table elements in touch. Many of us use Sublime Text thought there are a wide variety of text editors that you might choose. External editors allow for syntax highlighting, and a variety of advanced features for speeding up the process of writing code. To set an external editor you need to use the DATs tab of the preferences window. Here you’ll find two fields where you can enter the paths to the executables for the applications you’d like to use.
3437

3538
An example preference file:
3639

3740
```
38-
dats.texteditor C:/Users/ragan/AppData/Local/Programs/Microsoft VS Code/Code.exe
39-
obj.adaptivehomedefault 0
40-
chops.graphdisplay2 6
41-
network.fitpaneltotile 0
42-
general.inc 0
43-
network.zoomdelay 0.19999999
44-
network.gridsnapdiv 2
45-
network.fittoptotile 0
46-
network.zoomboost 1.0000002
41+
dats.texteditor C:/Users/ragan/AppData/Local/Programs/Microsoft VS Code/Code.exe
42+
obj.adaptivehomedefault 0
43+
chops.graphdisplay2 6
44+
network.fitpaneltotile 0
45+
general.inc 0
46+
network.zoomdelay 0.19999999
47+
network.gridsnapdiv 2
48+
network.fittoptotile 0
49+
network.zoomboost 1.0000002
4750
```
4851

4952
## Links to Derivative's official docs
53+
5054
* [Preference Dialog]
5155
* [Preference Class]
5256

5357
<!-- links -->
5458
[Preference Dialog]: https://docs.derivative.ca/Dialogs:Preferences_Dialog
55-
[Preference Class]:https://docs.derivative.ca/Preferences_Class
59+
[Preference Class]:https://docs.derivative.ca/Preferences_Class

docs/docs/SM-guide/003-nodes.md

Lines changed: 0 additions & 140 deletions
This file was deleted.

docs/docs/SM-guide/004-network-organization.md

Lines changed: 0 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -4,8 +4,6 @@ description: Organizing your thoughts and your noodles
44
slug: /SM-guide/network-organization
55
---
66

7-
# Network Organization
8-
97
A network’s re-usability lives and dies in its organization and structuring. While there are limits to a modular approach, it’s well worth considering the larger implications around cultivating a forward focused temperament when building new systems. Every project will eventually come up against deadlines, changes orders, and the necessities of project delivery. To the best of our abilities, however, we might consider a tempered approach to thinking about how a particular element might be able to be used and re-used in future projects.
108

119
To that end, clear organization and careful planning help facilitate this process. For the sake of a simple case study, let’s for a moment consider instancing networks. For the uninitiated, instancing allows you to reuse a single piece of geometry once it’s been passed to the GPU. This method of drawing geometry is significantly cheaper, computationally, than drawing additional copies of the geometry on the CPU. In principle, you only draw the geometry once, then create a transformation matrix for subsequent copies of the original geometry. The transformation of the copies is most efficiently done in CHOP channels, sometimes initially fed by a geometry converted to channel data.
@@ -25,8 +23,6 @@ If you’re not yet sold on this idea, at the very least consider dividing up yo
2523
* Limit the complexity of any given network – if you find a network is growing to be too sprawling, how might you re-organize or compartmentalize your implementation?
2624
* Think of your work in terms of a test against the other members of the team – would this structure and approach pass a Barry test? a Vlad test? a Bryant test?
2725

28-
29-
3026
:::
3127

3228
:::danger Don’t

0 commit comments

Comments
 (0)