Content Creation Tutorial (Python 3)

Owned by DEVOPS
Oct 05, 2021
2 min read

Name

Location

Content Creation<Vortex Studio Installation Folder>\tutorials\Python\Vortex\PycontentCreation\ContentCreation.py

This tutorial provide an example to create content with code. It is the python 3 equivalent of the C++ Content Creation Tutorial

Is this tutorial, a rover is built and is connected to a joystick.

It showcases the following

  • Assembly Document
    • Parts and collision geometry creation
    • Assembling with constraint
    • Material on the wheels.
  • Mechanism Document
    • Adds controls of the Assembly via
      • VHL Interface
      • Joystick
      • Python script
      • Connection Container
    • Configuration
      • Add an option to have a "Turbo mode" to the rover
  • Scene Document
    • Instantiate 9 Rovers in a 3x3 grid
    • Activate the Turbo configuration for some rovers
    • Adds Configuration to control the amount of rover visible in the scene.
    • The scene has no terrain. It's up to the user to add one by mimicking the steps in the C++ tutorials or by adding it's own terrain in the editor. 


See Vortex Studio SDK - Creating Content for more details

See Integrating Vortex Studio using Python 3 for more details about using Python.

Using the tutorial

  1. The code is fully documented explaining each steps.
    1. For more detail, call the script with argument --help
  2. Set up the Python Environment in the Terminal for the execution of the script:
    1. Open a terminal to the location of the ContentCreation.py file
    2. set TOOLKIT_DIR=C:\CM Labs\Vortex Studio Installation Location
      set PYTHONPATH=%TOOLKIT_DIR%;%TOOLKIT_DIR%\bin;%PYTHONPATH%

      Note

      Make sure to change the first command line instruction's path accordingly to your own installation folder's path

  3. Run the script with the following arguments:
    1. --destinationFolder <folder> : this is the folder where to save the scene, mechanism and assembly documents
    2. --pythonScriptPath <path>: This is the python script path used by the rover controller. It is located at <Vortex Studio Installation Folder>\Resources\ExContentCreation\controller.py
  4. In the destination folder, you will have the vortex files created by the script.
    1. Open them in the editor to try them.
  5. To go into detail, debug the script and follow the code execution step by step.