PinTool

Description

PinTool is a lightweight tool that helps you to fit a 3D-object into a scene. It can be used for precise positioning of still objects or even for simple object tracking. If you need a complete geometry tracking tool, check out our GeoTracker.

With PinTool, to manipulate a 3D-model, you simply drag control points on its surface (pins) to their correct position in the frame.

What's New in Beta v6.2

• minor undo/redo logic fix;
• pins storing format changed. Warning: pins from old scripts may fail to load. Other information won't be lost.

What’s New in Beta v5.3

• Fixed pin-tooling models that are close to the camera.

What’s New in Beta v5.1 and v5.2

• Minor fixes in clearing and camera exporting.

What’s New in Beta v5.0

• Changed node type: PinTool is geo node now. PinTool's output can be used directly and results can be viewed in 3D in the native way.
• Default camera: connecting default camera node is no longer reqired for positioning as well as camera focal length estimation. Now an internal default camera, which can be easily exported, is used.
• Minor interface changes.

What’s New in Beta v4.0

• Focal length estimation: allows to estimate camera’s focal length by object positioning.
• Lit wireframe: improves visual perception of object in 2D by illuminating it’s wireframe.
• New pinning mode: provides an alternative mode for object positioning that doesn’t spring pins back.
• Minor quality and performance improvements.

What’s New in v1.2

• Camera export: the result of positioning with PinTool may be exported not only as a TransformGeo but also as a Camera moving around the object, which is treated as static. For example, it may be used for alignment of multiple cameras around a supporting object.
• PinTool (as well as GeoTracker and OpticalFlow) is compatible with glibc 2.12 and can be run on all Linux system on which The Foundry Nuke can be run.
• New button called Center Geo has been added to PinTool’s toolbar. This button places the geometry in 3D to the center camera’s viewing frustum. This is a convenient way to begin object positioning.

Quick Reference Guide

PinTool has three inputs:

• src — an undistorted shot.
• geo — a model of the object you want to fit.
• cam — a camera for this shot. Typically, it’s obtained from Nuke CameraTracker. For static shots, this can be any camera with parameters similar to your shooting camera.

To add a pin, simply click anywhere on the model’s surface. Now, you can drag the pin to its correct position. To delete the pin, right-click on it. By moving a number of pins, you can reconcile the projection of the 3D-model and the real object it represents on the shot. With PinTool, positioning of a complex model is performed in just few clicks.

This position is right up to the scale of the object. So, to find the exact 3D coordinates of your model, you need to adjust the scale slider. When you drag it on the frame with a keyframe, nothing will be changed in a viewer but transformation matrix will.

For still objects, you can jump to any other frame and adjust model’s scale. When you change the scale, your model will shift along camera’s cone in the frame where the model was initially adjusted.

For moving objects, you need to change a scale in 3D mode and choose the most realistic one. Typically, to position your model, you can use some other objects in the scene as a binding (e.g., the ground plane). You can add as many keyframes to pins as you want. But scale of object is fixed.

If you are done with model positioning, you can create the TransformGeo or the Camera node by pressing the Export button.

Download & Install

PinTool is a part of the KeenTools bundle (together with GeoTracker, ReadRiggedGeo and OpticalFlow). It has single installer for all included plugins. Archives contain three installers (separately for Nuke 8, Nuke 9 and Nuke 10) as well as compiled plugins for manual installation.

License Summary
* License is annual.
* There are 3 types of license available:
* Commercial. Commercial license is the standard licensing option for organizations and business entities. Licenses are purchased by the company and can be used by any person within this organization;
* Personal. Personal license is an option for private individuals who purchase a license with their own funds, and solely for their own use. Personal licenses are not to be purchased by companies;
* Educational. Educational license can only be used for educational purposes.
* Commercial use allowed for commercial and personal licenses without any royalties.
* Cannot modify source-code for any purpose (cannot create derivative works).
* All nodes from KeenTools bundle are under the same license.
* Parts of the software are provided under separate licenses, as follows:
* Assimp under the terms of a 3-clause BSD license http://www.assimp.org/main_license.html
* Boost under the Boost Software License http://www.boost.org/LICENSE_1_0.txt
* OpenCV under the terms of a 3-clause BSD license http://opencv.org/license.html
* GLM under the Happy Bunny License and the MIT License https://glm.g-truc.net/copying.txt
* NLopt with the LGPL portions removed under the MIT License https://github.com/stevengj/nlopt/blob/master/COPYRIGHT
* Catch under the Boost Software License https://github.com/philsquared/Catch/blob/master/LICENSE.txt
* Crypto++ under the Boost Software License https://www.cryptopp.com/License.txt
* miniz released into the public domain http://unlicense.org
KeenTools - Terms and conditions
1. Preamble: This Agreement governs the relationship between You (a legal entity for Commercial, a private individual for Personal or an individual student or an instructor for Educational license), (hereinafter: Licensee) and KeenTools (hereinafter: Licensor). This Agreement sets the terms, rights, restrictions and obligations on using a node from KeenTools bundle (hereinafter: The Software) created and owned by Licensor, as detailed herein.
2. License Grant: Licensor hereby grants Licensee a Non-assignable & non-transferable, Annual, Commercial (for Commercial and Personal licenses), Without the rights to create derivative works, Non-exclusive license, all with accordance with the terms set forth and other legal restrictions set forth in 3rd party software used while running Software.
1. Limited: Licensee may use Software for the purpose of:
1. Installing and running Software on Licensee’s computer device and on any operating system supported by the Product;
2. Publishing Software’s output to Licensee and 3rd Parties;
3. Distribute verbatim copies of Software’s output.
1. Annual: This license allows the Licensee to use The Software for one year, and entitle the Licensee to download all updates to The Software.
2. Non Assignable & Non-Transferable: Licensee may not assign or transfer his rights and duties under this license.
3. Licensee may not: rent, lease, reproduce, modify, adapt, use The Software for any commercial purposes (for Educational license), create derivative works of, distribute, sell, sublicense or transfer The Software, or provide access to The Software to a third party as well as reverse-engineer, decompile, disassemble, modify, or translate The Software, or make any attempt to discover the source code of The Software;
4. Commercial, Royalty Free: Licensee may use The Software under Commercial or Personal licenses for any purpose, including paid-services, without any royalties;
5. License is available: to individual students and instructors for Educational license, to private individuals purchasing with their own funds for Personal license and to any legal entity (companies and organizations, including non-profit and government) for Commercial license.
3. Term & Termination: The Term of this license shall be until terminated. Licensor may terminate this Agreement, including Licensee’s license in the case where Licensee :
1. became insolvent or otherwise entered into any liquidation process; or
2. exported The Software to any jurisdiction where licensor may not enforce his rights under this agreements in; or
3. Licensee was in breach of any of this terms and conditions and such breach was not cured, immediately upon notification; or
4. Licensee in breach of any of the terms of clause 2 to this license; or
5. Licensee otherwise entered into any arrangement which caused Licensor to be unable to enforce his rights under this License.
4. Payment: In consideration of the License granted under clause 2, Licensee shall pay Licensor a fee, via Credit-Card, PayPal or any other mean which Licensor may deem adequate. Failure to perform payment shall construe as material breach of this Agreement. License can only be billed to a legal entity for Commercial License and to a private individual for a personal license. Personal licenses cannot be purchased or reimbursed by companies;
5. Upgrades, Updates and Fixes: Licensor may provide Licensee, from time to time, with Upgrades, Updates or Fixes, as detailed herein and according to his sole discretion. Licensee hereby warrants to keep The Software up-to-date and install all relevant Updates and Fixes. Licensor shall provide any Upgrade, Update or Fix free of charge; however, nothing in this Agreement shall require Licensor to provide Upgrades, Updates or Fixes.
1. Upgrades: for the purpose of this license, an Upgrade shall be a material amendment in The Software, which contains new features and or major performance improvements and shall be marked as a new version number. For example, should Licensee purchase The Software under version 1.X.X, an upgrade shall commence under number 2.0.0.
2. Updates: for the purpose of this license, an update shall be a minor amendment in The Software, which may contain new features or minor improvements and shall be marked as a new sub-version number. For example, should Licensee purchase The Software under version 1.1.X, an upgrade shall commence under number 1.2.0.
3. Fix: for the purpose of this license, a fix shall be a minor amendment in The Software, intended to remove bugs or alter minor features which impair the The Software's functionality. A fix shall be marked as a new sub-sub-version number. For example, should Licensee purchase Software under version 1.1.1, an upgrade shall commence under number 1.1.2.
6. Support: Software is provided under an AS-IS basis and without any support, updates or maintenance. Nothing in this Agreement shall require Licensor to provide Licensee with support or fixes to any bug, failure, mis-performance or other defect in The Software.
1. Bug Notification: Licensee may provide Licensor of details regarding any bug, defect or failure in The Software promptly and with no delay from such event; Licensee shall comply with Licensor's request for information regarding bugs, defects or failures and furnish him with information, screenshots and try to reproduce such bugs, defects or failures.
2. Feature Request: Licensee may request additional features in Software, provided, however, that (i) Licensee shall waive any claim or right in such feature should feature be developed by Licensor; (ii) Licensee shall be prohibited from developing the feature, or disclose such feature request, or feature, to any 3rd party directly competing with Licensor or any 3rd party which may be, following the development of such feature, in direct competition with Licensor; (iii) Licensee warrants that feature does not infringe any 3rd party patent, trademark, trade-secret or any other intellectual property right; and (iv) Licensee developed, envisioned or created the feature solely by himself.
7. Liability: To the extent permitted under Law, The Software is provided under an AS-IS basis. Licensor shall never, and without any limit, be liable for any damage, cost, expense or any other payment incurred by Licensee as a result of Software’s actions, failure, bugs and/or any other interaction between The Software and Licensee’s end-equipment, computers, other software or any 3rd party, end-equipment, computer or services. Moreover, Licensor shall never be liable for any defect in source code written by Licensee when relying on The Software or using The Software’s source code.
8. Warranty:
1. Intellectual Property: Licensor hereby warrants that The Software does not violate or infringe any 3rd party claims in regards to intellectual property, patents and/or trademarks and that to the best of its knowledge no legal action has been taken against it for any infringement or violation of any 3rd party intellectual property rights.
2. No-Warranty: The Software is provided without any warranty; Licensor hereby disclaims any warranty that The Software shall be error free, without defects or code which may cause damage to Licensee’s computers or to Licensee, and that Software shall be functional. Licensee shall be solely liable to any damage, defect or loss incurred as a result of operating software and undertake the risks contained in running The Software on Licensee’s computer device[s].
3. Prior Inspection: Licensee hereby states that he inspected The Software thoroughly and found it satisfactory and adequate to his needs, that it does not interfere with his regular operation and that it does meet the standards and scope of his computer systems and architecture. Licensee found that The Software interacts with his development, website and server environment and that it does not infringe any of End User License Agreement of any software Licensee may use in performing his services. Licensee hereby waives any claims regarding The Software's incompatibility, performance, results and features, and warrants that he inspected the The Software.
9. No Refunds: Licensee warrants that he inspected The Software according to clause 7(c) and that it is adequate to his needs. Accordingly, as The Software is intangible goods, Licensee shall not be, ever, entitled to any refund, rebate, compensation or restitution for any reason whatsoever, even if The Software contains material flaws.
10. Indemnification: Licensee hereby warrants to hold Licensor harmless and indemnify Licensor for any lawsuit brought against it in regards to Licensee’s use of The Software in means that violate, breach or otherwise circumvent this license, Licensor's intellectual property rights or Licensor's title in The Software. Licensor shall promptly notify Licensee in case of such legal action and request Licensee’s consent prior to any settlement in relation to such lawsuit or claim.
11. Governing Law, Jurisdiction: Licensee hereby agrees not to initiate class-action lawsuits against Licensor in relation to this license and to compensate Licensor for any legal fees, cost or attorney fees should any claim brought by Licensee against Licensor be denied, in part or in full.

For exceptions or modifications to this Agreement, please contact KeenTools at:
[email protected] or https://keentools.io