├── Pictures ├── pic5_NX_run_code.png ├── pic4_NX_message_box.png ├── pic1_NX_developer_tab.png ├── pic2_NX_userinterface.png ├── pic6_NX_Journal_Manager.png ├── pic6_NX_information_window.png └── pic3_NX_change_language_python.png ├── Examples ├── ex0001.py ├── ex0002.py └── ex0003.py ├── .gitignore ├── README.md └── LICENSE /Pictures/pic5_NX_run_code.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/Foadsf/NXOpen_Python_tutorials/HEAD/Pictures/pic5_NX_run_code.png -------------------------------------------------------------------------------- /Pictures/pic4_NX_message_box.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/Foadsf/NXOpen_Python_tutorials/HEAD/Pictures/pic4_NX_message_box.png -------------------------------------------------------------------------------- /Pictures/pic1_NX_developer_tab.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/Foadsf/NXOpen_Python_tutorials/HEAD/Pictures/pic1_NX_developer_tab.png -------------------------------------------------------------------------------- /Pictures/pic2_NX_userinterface.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/Foadsf/NXOpen_Python_tutorials/HEAD/Pictures/pic2_NX_userinterface.png -------------------------------------------------------------------------------- /Pictures/pic6_NX_Journal_Manager.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/Foadsf/NXOpen_Python_tutorials/HEAD/Pictures/pic6_NX_Journal_Manager.png -------------------------------------------------------------------------------- /Pictures/pic6_NX_information_window.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/Foadsf/NXOpen_Python_tutorials/HEAD/Pictures/pic6_NX_information_window.png -------------------------------------------------------------------------------- /Pictures/pic3_NX_change_language_python.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/Foadsf/NXOpen_Python_tutorials/HEAD/Pictures/pic3_NX_change_language_python.png -------------------------------------------------------------------------------- /Examples/ex0001.py: -------------------------------------------------------------------------------- 1 | # ex0001.py 2 | import NXOpen.UF 3 | 4 | def main(): 5 | NXOpen.UF.UFSession.GetUFSession().Ui.DisplayMessage("Hello World!", 1) 6 | 7 | if __name__ == '__main__': 8 | main() -------------------------------------------------------------------------------- /Examples/ex0002.py: -------------------------------------------------------------------------------- 1 | # ex0002.py 2 | import NXOpen 3 | 4 | def main(): 5 | listing_window = NXOpen.Session.GetSession().ListingWindow 6 | 7 | listing_window.Open() 8 | listing_window.WriteFullline("Hello world!") 9 | listing_window.Close() 10 | 11 | if __name__ == '__main__': 12 | main() -------------------------------------------------------------------------------- /Examples/ex0003.py: -------------------------------------------------------------------------------- 1 | # ex0003.py 2 | 3 | import NXOpen 4 | import NXOpen.Features 5 | 6 | def cylinder_builder(session=NXOpen.Session.GetSession(), work_part=NXOpen.Session.GetSession().Parts.Work, height=100, diameter=50): 7 | mark_id = session.SetUndoMark(NXOpen.Session.MarkVisibility.Visible, "Cylinder") 8 | cylinder = work_part.Features.CreateCylinderBuilder(NXOpen.Features.Feature.Null) 9 | cylinder.Diameter.SetFormula(str(diameter)) 10 | cylinder.Height.SetFormula(str(height)) 11 | nx_object = cylinder.Commit() 12 | return nx_object, mark_id 13 | 14 | def main(): 15 | 16 | cylinder_builder(height=40, diameter=100) 17 | 18 | if __name__ == '__main__': 19 | main() -------------------------------------------------------------------------------- /.gitignore: -------------------------------------------------------------------------------- 1 | # Byte-compiled / optimized / DLL files 2 | __pycache__/ 3 | *.py[cod] 4 | *$py.class 5 | 6 | # C extensions 7 | *.so 8 | 9 | # Distribution / packaging 10 | .Python 11 | build/ 12 | develop-eggs/ 13 | dist/ 14 | downloads/ 15 | eggs/ 16 | .eggs/ 17 | lib/ 18 | lib64/ 19 | parts/ 20 | sdist/ 21 | var/ 22 | wheels/ 23 | pip-wheel-metadata/ 24 | share/python-wheels/ 25 | *.egg-info/ 26 | .installed.cfg 27 | *.egg 28 | MANIFEST 29 | 30 | # PyInstaller 31 | # Usually these files are written by a python script from a template 32 | # before PyInstaller builds the exe, so as to inject date/other infos into it. 33 | *.manifest 34 | *.spec 35 | 36 | # Installer logs 37 | pip-log.txt 38 | pip-delete-this-directory.txt 39 | 40 | # Unit test / coverage reports 41 | htmlcov/ 42 | .tox/ 43 | .nox/ 44 | .coverage 45 | .coverage.* 46 | .cache 47 | nosetests.xml 48 | coverage.xml 49 | *.cover 50 | *.py,cover 51 | .hypothesis/ 52 | .pytest_cache/ 53 | 54 | # Translations 55 | *.mo 56 | *.pot 57 | 58 | # Django stuff: 59 | *.log 60 | local_settings.py 61 | db.sqlite3 62 | db.sqlite3-journal 63 | 64 | # Flask stuff: 65 | instance/ 66 | .webassets-cache 67 | 68 | # Scrapy stuff: 69 | .scrapy 70 | 71 | # Sphinx documentation 72 | docs/_build/ 73 | 74 | # PyBuilder 75 | target/ 76 | 77 | # Jupyter Notebook 78 | .ipynb_checkpoints 79 | 80 | # IPython 81 | profile_default/ 82 | ipython_config.py 83 | 84 | # pyenv 85 | .python-version 86 | 87 | # pipenv 88 | # According to pypa/pipenv#598, it is recommended to include Pipfile.lock in version control. 89 | # However, in case of collaboration, if having platform-specific dependencies or dependencies 90 | # having no cross-platform support, pipenv may install dependencies that don't work, or not 91 | # install all needed dependencies. 92 | #Pipfile.lock 93 | 94 | # PEP 582; used by e.g. github.com/David-OConnor/pyflow 95 | __pypackages__/ 96 | 97 | # Celery stuff 98 | celerybeat-schedule 99 | celerybeat.pid 100 | 101 | # SageMath parsed files 102 | *.sage.py 103 | 104 | # Environments 105 | .env 106 | .venv 107 | env/ 108 | venv/ 109 | ENV/ 110 | env.bak/ 111 | venv.bak/ 112 | 113 | # Spyder project settings 114 | .spyderproject 115 | .spyproject 116 | 117 | # Rope project settings 118 | .ropeproject 119 | 120 | # mkdocs documentation 121 | /site 122 | 123 | # mypy 124 | .mypy_cache/ 125 | .dmypy.json 126 | dmypy.json 127 | 128 | # Pyre type checker 129 | .pyre/ 130 | -------------------------------------------------------------------------------- /README.md: -------------------------------------------------------------------------------- 1 | # NXOpen Python tutorials 2 | a collection of NXOpen Python tutorials 3 | 4 | 5 | ## Tutorials: 6 | 7 | ### First steps: 8 | 9 | To start with NX Python programming, you need to prepare your NX settings. The first step is to find the `Developer` tab at the top NX ribbon: 10 | 11 | 12 | 13 | 
 14 |   

 15 |     
 16 |     
Fig.1 - Find or activate the Developer tab.

 17 |   
                  
 18 |
19 | 20 | if the tab does not exists already, right-click on the top ribbon and find the `Developer` tab and activate it. 21 | 22 | One great way to develop or learn NX Python programming is to record macros while using the GUI. By default, NX saves macros in Visual Basic. To change that to Python, you need to go to `File > Preferences > User Interface`: 23 | 24 | 
 25 |   

 26 |     
 27 |     
Fig.2 - Go to the User Interface Preference panel.

 28 |   
                  
 29 |
30 | 31 | or press "Ctrl + 2" keyboard shortcut. Then in the `User Interface Preferences` change the `Journal Language` to Python: 32 | 33 | 34 | 35 | 
 36 |   

 37 |     
 38 |     
Fig.3 - Change the Journal Language to Python.

 39 |   
                  
 40 |
41 | 42 | 43 | ### Hello world! 44 | 45 | Let's start with a very simple "Hello World!" example where a Message window will show a text message (i.e., `string`). 46 | 47 | ```Python 48 | #ex0001.py 49 | import NXOpen.UF 50 | 51 | def main(): 52 | NXOpen.UF.UFSession.GetUFSession().Ui.DisplayMessage("Hello World!", 1) 53 | 54 | if __name__ == '__main__': 55 | main() 56 | ``` 57 | 58 | to run the code you need to go to the `Developer` tab and find the `Play` button: 59 | 60 | 
 61 |   

 62 |     
 63 |     
Fig.4 - Find the Play button.

 64 |   
                  
 65 |
66 | 67 | In the `Journal Manager` panel you can `Browse` to find and run the code: 68 | 69 | 70 | 71 | 
 72 |   

 73 |     
 74 |     
Fig.5 - Find the Play button.

 75 |   
                  
 76 |
77 | 78 | The result will be as the picture below: 79 | 80 | 
 81 |   

 82 |     
 83 |     
Fig.6 - Message box window.

 84 |   
                  
 85 |
86 | 87 | 88 | 89 | The message box window is good for alerting users of specific issues. However, the texts are not searchable or selectable. Alternatively, we could use: 90 | 91 | 92 | ```Python 93 | #ex0002.py 94 | import NXOpen 95 | 96 | def main(): 97 | listing_window = NXOpen.Session.GetSession().ListingWindow 98 | 99 | listing_window.Open() 100 | listing_window.WriteFullline("Hello world!") 101 | listing_window.Close() 102 | 103 | if __name__ == '__main__': 104 | main() 105 | ``` 106 | 107 | and the result must be 108 | 109 | 
110 |   

111 |     
112 |     
Fig.6 - Information box window.

113 |   
                  
114 |
115 | -------------------------------------------------------------------------------- /LICENSE: -------------------------------------------------------------------------------- 1 | Creative Commons Legal Code 2 | 3 | CC0 1.0 Universal 4 | 5 | CREATIVE COMMONS CORPORATION IS NOT A LAW FIRM AND DOES NOT PROVIDE 6 | LEGAL SERVICES. DISTRIBUTION OF THIS DOCUMENT DOES NOT CREATE AN 7 | ATTORNEY-CLIENT RELATIONSHIP. CREATIVE COMMONS PROVIDES THIS 8 | INFORMATION ON AN "AS-IS" BASIS. CREATIVE COMMONS MAKES NO WARRANTIES 9 | REGARDING THE USE OF THIS DOCUMENT OR THE INFORMATION OR WORKS 10 | PROVIDED HEREUNDER, AND DISCLAIMS LIABILITY FOR DAMAGES RESULTING FROM 11 | THE USE OF THIS DOCUMENT OR THE INFORMATION OR WORKS PROVIDED 12 | HEREUNDER. 13 | 14 | Statement of Purpose 15 | 16 | The laws of most jurisdictions throughout the world automatically confer 17 | exclusive Copyright and Related Rights (defined below) upon the creator 18 | and subsequent owner(s) (each and all, an "owner") of an original work of 19 | authorship and/or a database (each, a "Work"). 20 | 21 | Certain owners wish to permanently relinquish those rights to a Work for 22 | the purpose of contributing to a commons of creative, cultural and 23 | scientific works ("Commons") that the public can reliably and without fear 24 | of later claims of infringement build upon, modify, incorporate in other 25 | works, reuse and redistribute as freely as possible in any form whatsoever 26 | and for any purposes, including without limitation commercial purposes. 27 | These owners may contribute to the Commons to promote the ideal of a free 28 | culture and the further production of creative, cultural and scientific 29 | works, or to gain reputation or greater distribution for their Work in 30 | part through the use and efforts of others. 31 | 32 | For these and/or other purposes and motivations, and without any 33 | expectation of additional consideration or compensation, the person 34 | associating CC0 with a Work (the "Affirmer"), to the extent that he or she 35 | is an owner of Copyright and Related Rights in the Work, voluntarily 36 | elects to apply CC0 to the Work and publicly distribute the Work under its 37 | terms, with knowledge of his or her Copyright and Related Rights in the 38 | Work and the meaning and intended legal effect of CC0 on those rights. 39 | 40 | 1. Copyright and Related Rights. A Work made available under CC0 may be 41 | protected by copyright and related or neighboring rights ("Copyright and 42 | Related Rights"). Copyright and Related Rights include, but are not 43 | limited to, the following: 44 | 45 | i. the right to reproduce, adapt, distribute, perform, display, 46 | communicate, and translate a Work; 47 | ii. moral rights retained by the original author(s) and/or performer(s); 48 | iii. publicity and privacy rights pertaining to a person's image or 49 | likeness depicted in a Work; 50 | iv. rights protecting against unfair competition in regards to a Work, 51 | subject to the limitations in paragraph 4(a), below; 52 | v. rights protecting the extraction, dissemination, use and reuse of data 53 | in a Work; 54 | vi. database rights (such as those arising under Directive 96/9/EC of the 55 | European Parliament and of the Council of 11 March 1996 on the legal 56 | protection of databases, and under any national implementation 57 | thereof, including any amended or successor version of such 58 | directive); and 59 | vii. other similar, equivalent or corresponding rights throughout the 60 | world based on applicable law or treaty, and any national 61 | implementations thereof. 62 | 63 | 2. Waiver. To the greatest extent permitted by, but not in contravention 64 | of, applicable law, Affirmer hereby overtly, fully, permanently, 65 | irrevocably and unconditionally waives, abandons, and surrenders all of 66 | Affirmer's Copyright and Related Rights and associated claims and causes 67 | of action, whether now known or unknown (including existing as well as 68 | future claims and causes of action), in the Work (i) in all territories 69 | worldwide, (ii) for the maximum duration provided by applicable law or 70 | treaty (including future time extensions), (iii) in any current or future 71 | medium and for any number of copies, and (iv) for any purpose whatsoever, 72 | including without limitation commercial, advertising or promotional 73 | purposes (the "Waiver"). Affirmer makes the Waiver for the benefit of each 74 | member of the public at large and to the detriment of Affirmer's heirs and 75 | successors, fully intending that such Waiver shall not be subject to 76 | revocation, rescission, cancellation, termination, or any other legal or 77 | equitable action to disrupt the quiet enjoyment of the Work by the public 78 | as contemplated by Affirmer's express Statement of Purpose. 79 | 80 | 3. Public License Fallback. Should any part of the Waiver for any reason 81 | be judged legally invalid or ineffective under applicable law, then the 82 | Waiver shall be preserved to the maximum extent permitted taking into 83 | account Affirmer's express Statement of Purpose. In addition, to the 84 | extent the Waiver is so judged Affirmer hereby grants to each affected 85 | person a royalty-free, non transferable, non sublicensable, non exclusive, 86 | irrevocable and unconditional license to exercise Affirmer's Copyright and 87 | Related Rights in the Work (i) in all territories worldwide, (ii) for the 88 | maximum duration provided by applicable law or treaty (including future 89 | time extensions), (iii) in any current or future medium and for any number 90 | of copies, and (iv) for any purpose whatsoever, including without 91 | limitation commercial, advertising or promotional purposes (the 92 | "License"). The License shall be deemed effective as of the date CC0 was 93 | applied by Affirmer to the Work. Should any part of the License for any 94 | reason be judged legally invalid or ineffective under applicable law, such 95 | partial invalidity or ineffectiveness shall not invalidate the remainder 96 | of the License, and in such case Affirmer hereby affirms that he or she 97 | will not (i) exercise any of his or her remaining Copyright and Related 98 | Rights in the Work or (ii) assert any associated claims and causes of 99 | action with respect to the Work, in either case contrary to Affirmer's 100 | express Statement of Purpose. 101 | 102 | 4. Limitations and Disclaimers. 103 | 104 | a. No trademark or patent rights held by Affirmer are waived, abandoned, 105 | surrendered, licensed or otherwise affected by this document. 106 | b. Affirmer offers the Work as-is and makes no representations or 107 | warranties of any kind concerning the Work, express, implied, 108 | statutory or otherwise, including without limitation warranties of 109 | title, merchantability, fitness for a particular purpose, non 110 | infringement, or the absence of latent or other defects, accuracy, or 111 | the present or absence of errors, whether or not discoverable, all to 112 | the greatest extent permissible under applicable law. 113 | c. Affirmer disclaims responsibility for clearing rights of other persons 114 | that may apply to the Work or any use thereof, including without 115 | limitation any person's Copyright and Related Rights in the Work. 116 | Further, Affirmer disclaims responsibility for obtaining any necessary 117 | consents, permissions or other rights required for any use of the 118 | Work. 119 | d. Affirmer understands and acknowledges that Creative Commons is not a 120 | party to this document and has no duty or obligation with respect to 121 | this CC0 or use of the Work. 122 | --------------------------------------------------------------------------------