Difference between revisions of "Palette:kantanMapper"
|Line 9:||Line 9:|
== Getting Started ==
== Getting Started ==
Kantan Mapper 2 is located in the Palette in
Kantan Mapper 2 is located in the Palette in . To begin, open the [[Palette]] and drag <code>kantanMapper</code> from Palette>onto your network pane.
|Line 179:||Line 179:|
Latest revision as of 01:21, 21 May 2020
簡単 (kantan) - japanese for easy, simple - Kantan Mapper 2 is a new projection mapping and masking toolkit for TouchDesigner. The user defines 2D polygons and bezier outlines in the field of view of a projector, then fills each shape with a selected image (TOP) with tools to warp how the image fits into the shape.
Kantan Mapper is an interface overlaid on-top of an actual projection to enable the drawing, creation and placement of various shapes onto real life objects and the possibility to assign TOP Image Nodes to these shapes and masks.
Kantan Mapper 2 is located in the Palette in 'Mapping' folder. To begin, open the Palette and drag
kantanMapper from Palette>Mapping onto your network pane.
- 1 Summary
- 2 Getting Started
- 3 Parameters - Kantan Page
- 4 General Usage
- 5 User Interface
- 6 Texture Editor
Parameters - Kantan Page
Help - Opens this page.
Open Kantan Window
Open - Opens the Kantan Mapper Interface.
Close Kantan Window
Close - Closes the Kantan Mapper Interface.
After dragging kantanMapper from Palette>Tools onto your network pane, click the "Open Kantan Window" parameter pulse button to open the KantanMapper editing interface.
Create a Shape
For quads click on the startpoint on the editing canvas and drag to the opposite endpoint of the quad.
For freeform shapes, click on the canvas to create a key and drag out the edges. To close a shape, click back on the first key created.
Transform a Shape
With the Select Shape Tool selected, select a shape on the canvas. You can drag the shape to reposition or use the outer handles to scale and rotate the shape.
Modifying a Shape
With the Select Keys and Handles Tool selected, pick a shape on the canvas if a shape is not yet selected and move the keys or handles.
Assigning a Texture
Drag a TOP onto the Texture field in the Shape Settings section.
Select a shape and hold the Alt key when transforming the shape to create a copy.
With a shape selected, click the Edit Texture Button to bring up the Texture Editor. Here, specify the area of the texture to apply to the shape or apply the shape as a mask to the texture.v
Resolution - Specify the output Resolution of the full Canvas. This should match the resolution of the projector(s) used for this project.
Window Options - Will open the Window COMP parameters for the output screen.
Toogle Output - Will open/close the output window as set-up in the Window Options.
Bg Mask - Specify a background mask by either dragging a TOP into the field or typing in the absolute path to the TOP. The button behind the field is used to enable or disable the mask.
Bg Level - Control the level of the background mask when enabled.
The Shapes Tree Viewer is a list of shapes (quads and freeform) as well as groups in a collapsible display.
Shapes and groups can be reordered by dragging them.
Shapes and groups can be nested by dragging them onto other groups.
The Editing Tools section of the UI holds the controls for selecting, creating and transforming shapes in KantanMapper.
To add a freeform shape use the Create Freeform Tool . After selecting the tool, click and drag on the canvas to create a key and it's handles. repeat and finish the shape by clicking on the first key created.
If a shape is selected and the "Select Key & Handle" tool is active, shape specific tools become available:
- enables the gridwarp mode of the selected quad. This enables the transformation of grid points and handles. Also rows and columns can be removed by selecting them and clicking the keyboard delete key.
- add a row to the gridwarp mesh by selecting the insert point on the grid directly.
- add a column to the gridwarp mesh by selecting the insert point on the grid directly.
For Freeform Shapes:
- enables adding keys inline the selected shape.
- collapses the handles of a bezier key when selecting the key and enables resizing of the handles by dragging them from the key.
Name - Change the name of the shape as shown in the Shapes Tree.
Color - Change the color of the shape. The color is shown if no texture is assigned to the shape or the texture is disabled.
Orientation - Change the orientation of the assigned texture or flip it.
Edit Texture - Open the Texture Editor.
Softedge - Apply softedge to the shape. While softedge on the quad is done via a basic shader, the softedge on the freeform is a bit more of an experiment using the Extrude SOP and Skin SOP. To see it's inner workings, navigate to .../kantanMapper/project/allShapes/item*.
Lock Handle - Locks and unlocks the gridwarp handles of the quad and the key handles of the freeform shape.
Transformation can be applied to single or multiple shapes. When using the fields or buttons, the middle mouse wheel can be used to increase or decrease the current value.
Scale - Change the scale of the selected shapes around the selected pivot.
Rotate - Change the rotation of the selected shapes around the selected pivot.
Translate - Move the selected shapes in tx and ty.
Pivot - Pick the pivot to apply the transform around.
Free Pivot - If "Free" is selected in Pivot, change the position of the pivot point.
The available Tools depend on the selected shape.
Rows / Cols - Change the number of rows and columns in the quad. Warning: this will reset the Gridwarp. To remove a row or column without loosing the previously applied deform, select the row or column when in grid warp mode.
Warping - Change the warping mode of the quad. Options are:
- Bezier: The grid can be warped with keys and handles.
- Linear: only the grid points can be transformed and are connected linearly.
Mapping - Choose how a texture is mapped onto the quad:
Reset Keystone - Reset the transformation on the corner points of the quad.
Reset Warp - Reset the transformation on all grid points of the quad.
Detail - change the resolution of the edges between keys on the freeform shape.
An Operator Family that creates, composites and modifies images, and reads/writes images and movies to/from files and the network. TOPs run on the graphics card's GPU.
A built-in panel in TouchDesigner that contains a library of components and media that can be dragged-dropped into a TouchDesigner network.