12.19.01
'Gear-O-Matic!' v1.00

>>> Quick Start Tutorial <<<

HERE WE GO!...


- This little tutorial will show you how to create/animate a compound gear train composed of three simple gear train pairs.
It's easy, and fun. You will create one pair using the default settings; one from scratch; and pick one from a library.
Finally, you will animate and modify the gear train animation using the required/supplied script called 'ORTFixer!&Helper.'

NOTE:
- A basic understanding of MAX and running MAXScripts is expected. 
- GGA = 'Gear Generation/Animation' rollout.
  BGT = 'Build Gear Train' rollout.
  ORT = 'ORTFixer!&Helper' rollout.
* Help is provided via the 'info' buttons by the parameters, by mouse-over tooltips, and in the
  'Purpose/Usage/Comments/Quirks/FuturePlans...' rollout.
* Lots of functionality is 'hidden' under the buttons by using ctrl, alt, and shift modifiers.


1) Create the Default Gear Pair.
- Reset MAX.
- Run 'Gear-O-Matic!'
- Click the BIG ">>> Gear-O-Matic!' It! <<<" button in GGA/Generation.
- DONE!
- Increase the animation length to 500 frames.
- Scrub the time slider to see the default animation (it's on 'Pinion01-RotControl').

2) Adjust the Gear Pair for Proper Teeth Meshing.
- Enter 1.75 in the "Rot" spinner in GGA/Adjustment
 (zoom in and scrub to see the meshing).

3) Create a Gear Pair from Scratch.
- in GGA/Setup:
	- Set 'Gear Ratio' spinner#1 to 4 (for a 4 to 1 gear ratio).
	- Set 'Circular Pitch Diameter...' to 75.
	- Set 'Number of Teeth...' to 40.
	- Set 'Tooth Segments' to 1.
	- Set 'Tooth Thickness' to 2.5.
	- Set 'Addendum...' to 1.8 (makes the teeth "taller").
	- Set 'Dedendum...' to 1.7 (makes the teeth "deeper").
	  NOTE:
	  	- To avoid tooth interference, 'Addendum' must always be < 'Dedendum'.
	- Set 'Face Width' to 20.
	- Check 'Skip Every Other Tooth.'
- Click ">>> Gear-O-Matic!' It! <<<"

4) Build a Gear Train.
- in BGT/Setup:
	- Click "Pick 'Source' Pair".
	- Use keyboard shortcut "h" to select by name. Select '[GearPair-02]'.
	- Click "Pick 'Destination' Pair".
	- Use keyboard shortcut "h" to select by name. Select '[GearPair-01]'.
	  (selection can be done graphically, also).
	- Click '>>> Build Gear Train <<<'
	 ('Pinion02' aligns with 'Wheel01').
	- Raise the BGT/Adjustment "Pos" spinner to 16.0
	  (observe the effect in the Right viewport).
- Scrub the time slider to see the gear train animate!
  (ALL motion is controlled by 'Pinion01-RotControl').
- Zoom in to where 'Wheel02' and 'Pinion02' mesh.
- Adjust the "Rot" spinner in GGA/Adjustment to -2.13.
  NOTE:
  	- The pinion rotation will reverse direction with each added gear train, thus
  	the wheel adjustment will reverse, also.
	- The teeth don't stay meshed perfectly, because the teeth are straight (since 'Tooth Segments=1').
	A curved, "involute" tooth profile is required for proper meshing. Though the script is based
	on mechanical engineering principles, provisions have been made for deviation, because,
	"If it looks right,	it is right!".
  
5) Generate a Preset Gear.
- Click GGA/Setup 'Presets, Save/Load Custom' button to launch the associated floater.
- Click "1:2..." in Load/Presets
  (observe how the parameters change in GGA/Setup).
- Click ">>> Gear-O-Matic!' It! <<<"

6) Add to the Gear Train.
- in BGT/Setup:
	- Click "Pick 'Source' Pair".
	- Use keyboard shortcut "h" to select by name. Select '[GearPair-03]'.
	- Click "Pick 'Destination' Pair".
	- Use keyboard shortcut "h" to select by name. Select '[GearPair-02]'.
	- Click '>>> Build Gear Train <<<'
	 ('Pinion03' aligns with 'Wheel02').
	- Raise the BGT/Adjustment "Pos" spinner to 25.0
	  (observe the effect in the Right viewport).
	- "Rot" and "Scale" to taste.
	  NOTE:
	  	- No rotation adjustment is required, because the gear parameters generated a
		"zero backlash" gear whose teeth mesh together with no gap.
		   
* CONGRATULATIONS!, you have just created and animated your first compound gear train!
- Save the scene.

7) Reloading the Animation (max r3.x only).
- Reload the scene.
- Scrub the time slider and notice that the animation stops!(?)
  This is due to a bug with MAX and script controllers. No problem; read on...
- Click "Launch 'ORTFixer!&Helper'" in ORT.
- Click "Pick 'Drive Pinion RotControl'"
- Select 'Pinion01-RotControl'.
- Click the BIG ">>> Fix Out-Of-Range Types <<<" button
  (the animation plays correctly, now).
  
8) Modifying the Animation (max r3.x AND r4.x).
- If Step 7 was skipped...
    - Click "Launch 'ORTFixer!&Helper'" in ORT.
    - Click "Pick 'Drive Pinion RotControl'"
    - Select 'Pinion01-RotControl'.
- Uncheck 'Match ORT to drive pinion RotControl' checkbox.
- Select the PingPong radiobutton.
- Click ">>> Fix Out-Of-Range Types <<<"
- Scrub away!
- Animate the drive pinion dummy to taste.
- Click ">>> Fix Out-Of-Range Types <<<"
- Scrub away...

*And see readme-Tutorial-AddDetail.txt: "...creates 'cut-outs' in the gear."
(use the associated button in the 'Purpose/Usage/Comments/Quirks/FuturePlans...' rollout)

Thanx for trying 'Gear-O-Matic!'

ENJOY...


s*
a.k.a. "codeWarrior()"
swami@flc.rr.com

- Feedback and bug reports are welcomed.

* See TEST-GearTrain11-v1_2.max for an interesting gear train/visualization...