On this page
KeyShot for NX Plugin
Version 1.4 (Released April 10th 2024)
These installation notes are specific to the latest version of the KeyShot for NX plugin unless otherwise mentioned. For questions about other versions, please contact https://www.keyshot.com/support/.
Specifications
The KeyShot for NX plugin requirements are as follows:
- KeyShot Pro Subscription/ KeyShot Enterprise
- KeyShot NX Subscription
- Siemens NX 1855 or newer
- Windows 10 and later
Plugins for previous versions of KeyShot are available here.
Supported Features
- LiveLinking
- Optionally update only selected parts
- Support for NURBS
- Maintain hierarchy of objects created in scene tree
Requirements
1. When using KeyShot Pro Subscription you need the NX Add-on to use the Plugin.
2. KeyShot Enterprise is required to install the KeyShot for NX plugin on Floating. If you are using a KeyShot Floating version, you will need to install both a floating license manager and the KeyShot for NX plugin. The instructions below assume that the license server has been installed and licensed.
3. The KeyShot for NX plugin also requires the Product Vision Translator component from NX. This option is available in the NX installer as “PVTRANS”. The plugin will fail to export to KeyShot without it. For more information about the Product Vision Translator, please contact Siemens support.
Installation
Subscription
1. After downloading, double-click the installer (.exe) file. Follow the prompts and click Finish.
2. Inside KeyShot go to Help > Activate License and follow the the flow until you reach the list of active licenses.
3. Click Add Module and enter your activation code.
4. “KeyShot 11″ should be visible automatically in the NX Ribbon.
5. If the KeyShot plugin is not visible, refer to Troubleshooting item #1 below.
Enterprise
1. After downloading, double-click the installer (.exe) file. Follow the prompts and click Finish.
2. Open NX.
3. Floating license only: When prompted, enter the address of the license server. If it is unknown contact your system administrator.
4. “KeyShot 11″ should be visible automatically in the NX Ribbon.
5. If the KeyShot plugin is not visible, refer to Troubleshooting item #1 below.
KeyShot Plugin Menu
Render
To render your NX scene in KeyShot, simply hit the Render command in the KeyShot tab. The 3D data will be transferred from NX to KeyShot.
Update
Click the KeyShot button while both your NX session and the existing KeyShot scene is open to update any changes on your model. Pausing your KeyShot scene will disable the ability to update your scene while working in NX.
Update with manual selection
If automatic updating fails use “Update with Manual Selection” to push over individual parts. When the dialog pops up, select which parts you want to be transferred by clicking them in the list, or by selecting them in the main view.
You may also choose a new value for tessellation quality if you want finer control of the quality of your individual parts.
Note that Update With Manual Selection will push the selected parts as well as any changed parts to KeyShot.
Plugin Settings
You can adjust the following options in Settings:
Tessellation quality
This slider controls the density of your mesh within KeyShot. Larger values mean a denser mesh (and larger file sizes). It is recommended to keep this value between .2 and .5 for most uses, with the default value of .2 being a good starting point.
Separate materials
When this is checked, parts in NX that share the same color will not be linked in KeyShot. When this box is unchecked, all parts in NX that share the same color will import into KeyShot with a linked material.
Include NURBS
This checkbox will import your NURBS data into KeyShot. This allows you to render at a higher fidelity but is often much slower than tessellated data. If geometry is overly faceted try adjusting tessellation before relying on NURBS rendering.
How To Use The Plugin
You can now use the KeyShot plugin to send 3D data from your current NX session into KeyShot. Full assembly and part structure will be maintained.
1. Open your assembly/part in NX.
2. Click Render to launch KeyShot. The 3D data will be transferred from NX to KeyShot. Part color assignments will match in KeyShot.
3. To Update any changes made in NX, click Update while your KeyShot scene is open. All materials, textures, labels, animations, transformations, cameras, and lighting in the scene will be maintained.
Note
To use automatic updates, parts in your assemblies must use the “Model” reference set. If they use “Empty” or “Entire part”, updates will not be detected. If using the “Model” reference set is impossible, use the Manual Update functionality as described above.
Troubleshooting
1. If you do not see the plugin, or if you received an error during the installation, you will have to manually add it to your custom_dirs.dat file. This file is typically located in the “menus” folder under the NX installation directory. For instance:
C:\Program Files\Siemens\NX XX\UGII\menus
Once you have located the file, open it with a standard text editor such as notepad.exe. Write the installation directory you chose for the plugin during installation at the end of this file. If “custom_dirs.dat” does not exist, you can create it before inserting the plugin path.
2. Colors are via the owning part, not through the assembly structure. When adjusting the Object Display settings, make sure that “Apply Changes to Owning Part” is checked.
Uninstall
Go to Control Panel > Programs and Features look for the KeyShot Plugin > Right-Click > Uninstall