# _OCP CAD Viewer_ for VS Code
_OCP CAD Viewer_ for VS Code is an extension to show [CadQuery](https://github.com/cadquery/cadquery) and [build123d](https://github.com/gumyr/build123d) objects in VS Code via the [three-cad-viewer](https://github.com/bernhard-42/three-cad-viewer) viewer component.
## Installation
### Prerequisites
- A fairly recent version of Microsoft VS Code, e.g. 1.85.0 or newer
- The [Python extension](https://marketplace.visualstudio.com/items?itemName=ms-python.python) installed in VS Code
- Necessary tools:
- `python` and `pip` available in the Python enviroment that will be used for CAD development
- The command `git` needs to be available
- On a Silicon Apple computer the command `mamba` needs to be available. You might want to consider using [Mambaforge](https://github.com/conda-forge/miniforge#mambaforge).
**Notes**:
- To use OCP CAD Viewer, start VS Code from the commandline in the Python environment you want to use or select the right Python interpreter in VS Code first. **OCP CAD Viewer depends on VS Code using the right Python interpreter** (i.e. mamba / conda / pyenv / poetry / ... environment).
- For VSCodium, the extension is not available in the VS code market place. You need to download the the vsix file from the [release folder](https://github.com/bernhard-42/vscode-ocp-cad-viewer/releases) and install it manually.
- Currently, on a Silicon Mac (ARM CPU), _OCP_ and _CadQuery_ can only be installed via `mamba`, see 3. below.
### Installation
1. Open the VS Code Marketplace, and search and install _OCP CAD Viewer 2.6.1_.
Afterwards the OCP viewer is available in the VS Code sidebar:
2. Clicking on it shows the OCP CAD Viewer UI with the viewer manager and the library manager:
You have 3 options:
- Prepare _OCP CAD Viewer_ for working with [build123d](https://github.com/gumyr/build123d): Presse the _Quickstart build123d_ button.
This will install _OCP_, _build123d_, _ipykernel_ (_jupyter_client_), _ocp_tessellate_ and _ocp_vscode_ via `pip` (except for Apple Silicon machines that require `mamba` and will also install _cadquery_)
- Prepare _OCP CAD Viewer_ for working with [CadQuery](https://github.com/cadquery/cadquery): Presse the _Quickstart CadQuery_ button.
This will install _OCP_, _CadQuery_, _ipykernel_ (_jupyter_client_), _ocp_tessellate_ and _ocp_vscode_ via `pip` (except for Apple Silicon machines that require `mamba`)
- Ignore the quick starts and use the "Library Manager" to install the libraries. Doing so, _OCP CAD Viewer_ let's you select whether to use `pip`, `mamba`, `conda` or `poetry`. Install the needed library by pressing the down-arrow behind the library name (hover over the library name to see the button) in the "Library Manager" section of the _OCP CAD Viewer_ sidebar. For more details, see [here](./docs/install.md)
The Quickstarts will also
- (optionally) install the the [Jupyter extension for VS Code from Microsoft](https://marketplace.visualstudio.com/items?itemName=ms-toolsai.jupyter)
- start the OCP viewer
- create a demo file in a temporary folder to quickly see a simple usage example
3. On Silicon Macs (ARM CPU)
- Install Miniforge
- Option 1: Download and install from the [Miniforge](https://github.com/conda-forge/miniforge?tab=readme-ov-file#download) github page
- Option 2: Use `homebrew`: `brew install miniforge`
- Initialize your shell for `mamba`: `mamba init $(basename "$SHELL")`
- Create an environment, e.g named `code_cad` with Python 3.10: `mamba create -n code_cad python=3.10`
- Activate the environment: `mamba activate code_cad`
- Start VS Code from your working folder: `code .`
- Install the Python extension in VS Code
- Continue with 1. above
**Note:** Do not use the _OCP CAD Viewer_ logo to verify your _OCP CAD Viewer_ settings! The logo overwrites all your settings in VS Code with its own settings to always look the same on each instance. Use a simple own model for checking your conmfiguration
## Usage
### Running code using Jupyter
- Start the _OCP CAD Viewer_ by pressing the box-arrow button in the "Viewer Manager" section of the _OCP CAD Viewer_ sidebar (hover over the `ocp_vscode` entry to see the button).
- Import ocp_vscode and the CAD library by using the paste button behing the library names in the "Viewer Manager" section
- Use the usual Run menu to run the code
### Debugging code with visual debugging
After each step, the debugger checks all variables in `locals()` for being CAD objects and displays them with their variable name.
Note:
- Check that `OCP:on` is visible in the status bar
- It also shows planes, locations and axis, so name your contexts
- It remembers camera position and unselected variables in the tree
- during debugging, `show` and `show_object` are disabled. They interfere with the visual debugging
### Library Manager
You can also use "Library Manager" in the _OCP CAD Viewer_ sidebar to manage the Python libraries for _build123d_, _cadquery_, _ipython_ and _ocp_tessellate_ (Presse the down-arrow when hovering over a library name to install/upgrade it)
### Extra topics
- [Quickstart experience on Windows](docs/quickstart.md)
- [Use Jupyter to execute code](docs/run.md)
- [Debug code with visual debugging](docs/debug.md)
- [Measure mode](docs/measure.md)
- [Use the `show` command](docs/show.md)
- [Use the `show_object` command](docs/show_object.md)
- [Use the `set_viewer_config` command](docs/set_viewer_config.md)
- [Download examples for build123d or cadquery](docs/examples.md)
- [Use the build123d snippets](docs/snippets.md)
## Standalone mode
Standalone mode allows to use OCP CAD Viewer without VS Code: `python -m ocp_vscode`. This will start a Flask server and the viewer can be reached under `http://127.0.0.1/viewer`. All client side feature of the VS Code variant (i.e. `show*` features) should be available (including measurement mode) except visual debugging (see above) which relies on VS Code.
Use `python -m ocp_vscode --help` to understand the command line args:
```
Usage: python -m ocp_vscode [OPTIONS]
Options:
--create_configfile Create the configlie .ocpvscode_standalone in
the home directory
--host TEXT The host to start OCP CAD with
--port INTEGER The port to start OCP CAD with
--debug Show debugging information
--timeit Show timing information
--tree_width TEXT OCP CAD Viewer navigation tree width
(default: 240)
--no_glass Do not use glass mode with transparent
navigation tree
--theme TEXT Use theme 'light' or 'dark' (default:
'light')
--no_tools Do not show toolbar
--tree_width INTEGER Width of the CAD navigation tree (default:
240)
--control TEXT Use control mode 'orbit'or 'trackball'
--up TEXT Provides up direction, 'Z', 'Y' or 'L'
(legacy) (default: Z)
--rotate_speed INTEGER Rotation speed (default: 1)
--zoom_speed INTEGER Zoom speed (default: 1)
--pan_speed INTEGER Pan speed (default: 1)
--axes Show axes
--axes0 Show axes at the origin (0, 0, 0)
--black_edges Show edges in black
--grid_xy Show grid on XY plane
--grid_yz Show grid on YZ plane
--grid_xz Show grid on XZ plane
--center_grid Show grid planes crossing at center of object
or global origin(default: False)
--collapse INTEGER leaves: collapse all leaf nodes, all:
collapse all nodes, none: expand all nodes,
root: expand root only (default: leaves)
--perspective Use perspective camera
--ticks INTEGER Default number of ticks (default: 10)
--transparent Show objects transparent
--default_opacity FLOAT Default opacity for transparent objects
(default: 0.5)
--explode Turn explode mode on
--angular_tolerance FLOAT Angular tolerance for tessellation algorithm
(default: 0.2)
--deviation FLOAT Deviation of for tessellation algorithm
(default: 0.1)
--default_color TEXT Default shape color, CSS3 color names are
allowed (default: #e8b024)
--default_edgecolor TEXT Default color of the edges of shapes, CSS3
color names are allowed (default: #707070)
--default_thickedgecolor TEXT Default color of lines, CSS3 color names are
allowed (default: MediumOrchid)
--default_facecolor TEXT Default color of faces, CSS3 color names are
allowed (default: Violet)
--default_vertexcolor TEXT Default color of vertices, CSS3 color names
are allowed (default: MediumOrchid)
--ambient_intensity INTEGER Intensity of ambient light (default: 1.00)
--direct_intensity FLOAT Intensity of direct light (default: 1.10)
--metalness FLOAT Metalness property of material (default:
0.30)
--roughness FLOAT Roughness property of material (default:
0.65)
--help Show this message and exit.
```
## Best practices
- Use the **Jupyter extension** for a more interactive experience. This allows to have one cell (separated by `# %%`) at the beginning to import all libraries
```python
# %%
from build123d import *
from ocp_vscode import *
# %%
b = Box(1,2,3)
show(b)
# %%
```
and then only execute the code in the cell you are currently working on repeatedly.
- The **config system** of OCP CAD Viewer
There are 3 levels:
- Workspace configuration (part of the VS Code settings, you can access them e.g. via the gear symbol in OCP CAD Viewer's "Viewer Manager" when you hover over the label "VIEWER MANAGER" to see the button)
- Defaults set with the command `set_defaults` per Python file
- Parameters in `show` or `show_object` per command
`set_defaults` overrides the Workspace settings and parameters in `show` and `show_config` override the other two.
Note that not all parameters are available in the global Workspace config, since they don't make sense globally (e.g. `helper_scale` which depends on the size of the boundary box of the currently shown object)
A common setup would be
```python
# %%
from build123d import *
import cadquery as cq
from ocp_vscode import *
set_port(3939)
set_defaults(reset_camera=False, helper_scale=5)
# %%
...
```
Explanation
- The first block imports build123d and CadQuery (omit what you are not interested in).
- The second block imports all commands for OCP CAD Viewer. `set_port` is only needed when you have more than one viewer open and can be omitted for the first viewer)
- The third block as an example sets helper_scale and reset_camera as defaults. Then every show_object or show command will respect it as the default
- Debugging build123d with `show_all` and the **visual debugger**
- If you name your contexts (including `Location` contexts), the visual debugger will show the CAD objects assigned to the context.
- Use `show_all` to show all cad objects in the current scope (`locals()`) of the Python interpreter (btw. the visual debugger uses `show_all` at each step)
```python
# %%
from build123d import *
set_defaults(helper_scale=1, transparent=True)
with BuildPart() as bp:
with PolarLocations(3,8) as locs:
Box(1,1,1)
show_all()
# %%
```
- **Keep camera orientation** of an object with `reset_camera`
Sometimes it is helpful to keep the orientation of an object across code changes. This is what `reset_camera` does:
- `reset_camera=Camera.Center` will keep position and rotation, but ignore panning. This means the new object will be repositioned to the center (most robust approach)
- `reset_camera=Camera.KEEP` will keep position, rotation and panning. However, panning can be problematic. When the next object to be shown is much larger or smaller and the object before was panned, it can happen that nothing is visible (the new object at the pan location is outside of the viewer frustum). OCP CAD Viewer checks whether the bounding box of an object is 2x smaller or larger than the one of the last shown object. If so, it falls back to `Camera.CENTER`. A notification is written to the OCP CAD Viewer output panel.
- `reset_camera=Camera.RESET` will ensure that position, rotation and panning will be reset to the initial default
## Development
Testing:
Native tessellator can be set via `NATIVE_TESSELLATOR=1`and Python tessellator via `NATIVE_TESSELLATOR=0`.
When `OCP_VSCODE_PYTEST=1` is set, `show` will not send the tessellated results to the viewer, but return it to the caller for inspection.
A full test cycle consist of:
```bash
NATIVE_TESSELLATOR=0 OCP_VSCODE_PYTEST=1 pytest -v -s pytests/
NATIVE_TESSELLATOR=1 OCP_VSCODE_PYTEST=1 pytest -v -s pytests/
```
## Troubleshooting
- **CAD Models almost always are invisible in the OCP viewer window**
```bash
three-cad-viewer.esm.js:20276 THREE.WebGLProgram: Shader Error 0 - VALIDATE_STATUS false
Material Name:
Material Type: LineBasicMaterial
Program Info Log: Program binary could not be loaded. Binary is not compatible with current driver/hardware combination. Driver build date Mar 19 2024. Please check build information of source that generated the binary.
Location of variable pc_fragColor conflicts with another variable.
```
VS Code internal browser that renders the viewer component uses a cache for code and other artifacts. This includes WebGL artefacts like compiled shaders. It can happen that e.g. due to a graphic driver update the compiled version in the cache does not fit to the new driver. Then this error message appears.
**Solution:** [Delete the VS Code browser cache on Linux](https://bobbyhadz.com/blog/vscode-clear-cache) (go to the section for your operating system)
## Changes
v2.6.1
Fixes:
- Standalone viewer can listen to other IP addresses of the machine than 127.0.0.1
- `show` now uses port 3939 as default when no port could be detected and a service listens to 3939
- Fixed a bug in ocp-tessellate for cadquery wires ([#116](https://github.com/bernhard-42/vscode-ocp-cad-viewer/issues/116))
- Fixed a bug in backend for measures that prevented faces being inspected ([#115](https://github.com/bernhard-42/vscode-ocp-cad-viewer/issues/115))
- Fixed a bug that shifted the orientation too high for the logo screen
v2.6.0
New features
- Standalone mode without VS Code: `python -m ocp_vscode`. This will start a Flask server and the viewer can be reached under `http://127.0.0.1/viewer`.
Fixes:
- Fix that `show_all` doesn't ignore `_123` and similar variable names
Raw data
{
"_id": null,
"home_page": null,
"name": "ocp-vscode",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.9",
"maintainer_email": null,
"keywords": "3d models, 3d printing, 3d viewing, 3d, brep, cad, cadquery, opencscade, python",
"author": null,
"author_email": "Bernhard Walter <b_walter@arcor.de>",
"download_url": "https://files.pythonhosted.org/packages/e8/9b/5f8886b50751c36d932bb2a8c35bd8525296d97e681e93d6c477408f6cb7/ocp_vscode-2.6.1.tar.gz",
"platform": null,
"description": "# _OCP CAD Viewer_ for VS Code\n\n_OCP CAD Viewer_ for VS Code is an extension to show [CadQuery](https://github.com/cadquery/cadquery) and [build123d](https://github.com/gumyr/build123d) objects in VS Code via the [three-cad-viewer](https://github.com/bernhard-42/three-cad-viewer) viewer component.\n\n## Installation\n\n### Prerequisites\n\n- A fairly recent version of Microsoft VS Code, e.g. 1.85.0 or newer\n- The [Python extension](https://marketplace.visualstudio.com/items?itemName=ms-python.python) installed in VS Code\n- Necessary tools:\n - `python` and `pip` available in the Python enviroment that will be used for CAD development\n - The command `git` needs to be available\n - On a Silicon Apple computer the command `mamba` needs to be available. You might want to consider using [Mambaforge](https://github.com/conda-forge/miniforge#mambaforge).\n\n**Notes**:\n\n- To use OCP CAD Viewer, start VS Code from the commandline in the Python environment you want to use or select the right Python interpreter in VS Code first. **OCP CAD Viewer depends on VS Code using the right Python interpreter** (i.e. mamba / conda / pyenv / poetry / ... environment).\n- For VSCodium, the extension is not available in the VS code market place. You need to download the the vsix file from the [release folder](https://github.com/bernhard-42/vscode-ocp-cad-viewer/releases) and install it manually.\n- Currently, on a Silicon Mac (ARM CPU), _OCP_ and _CadQuery_ can only be installed via `mamba`, see 3. below.\n\n### Installation\n\n1. Open the VS Code Marketplace, and search and install _OCP CAD Viewer 2.6.1_.\n\n Afterwards the OCP viewer is available in the VS Code sidebar:\n\n \n\n2. Clicking on it shows the OCP CAD Viewer UI with the viewer manager and the library manager:\n\n \n\n You have 3 options:\n\n - Prepare _OCP CAD Viewer_ for working with [build123d](https://github.com/gumyr/build123d): Presse the _Quickstart build123d_ button.\n\n This will install _OCP_, _build123d_, _ipykernel_ (_jupyter_client_), _ocp_tessellate_ and _ocp_vscode_ via `pip` (except for Apple Silicon machines that require `mamba` and will also install _cadquery_)\n\n \n\n - Prepare _OCP CAD Viewer_ for working with [CadQuery](https://github.com/cadquery/cadquery): Presse the _Quickstart CadQuery_ button.\n\n This will install _OCP_, _CadQuery_, _ipykernel_ (_jupyter_client_), _ocp_tessellate_ and _ocp_vscode_ via `pip` (except for Apple Silicon machines that require `mamba`)\n\n \n\n - Ignore the quick starts and use the \"Library Manager\" to install the libraries. Doing so, _OCP CAD Viewer_ let's you select whether to use `pip`, `mamba`, `conda` or `poetry`. Install the needed library by pressing the down-arrow behind the library name (hover over the library name to see the button) in the \"Library Manager\" section of the _OCP CAD Viewer_ sidebar. For more details, see [here](./docs/install.md)\n\n The Quickstarts will also\n\n - (optionally) install the the [Jupyter extension for VS Code from Microsoft](https://marketplace.visualstudio.com/items?itemName=ms-toolsai.jupyter)\n - start the OCP viewer\n - create a demo file in a temporary folder to quickly see a simple usage example\n\n3. On Silicon Macs (ARM CPU)\n\n - Install Miniforge\n - Option 1: Download and install from the [Miniforge](https://github.com/conda-forge/miniforge?tab=readme-ov-file#download) github page\n - Option 2: Use `homebrew`: `brew install miniforge`\n - Initialize your shell for `mamba`: `mamba init $(basename \"$SHELL\")`\n - Create an environment, e.g named `code_cad` with Python 3.10: `mamba create -n code_cad python=3.10`\n - Activate the environment: `mamba activate code_cad`\n - Start VS Code from your working folder: `code .`\n - Install the Python extension in VS Code\n - Continue with 1. above\n\n**Note:** Do not use the _OCP CAD Viewer_ logo to verify your _OCP CAD Viewer_ settings! The logo overwrites all your settings in VS Code with its own settings to always look the same on each instance. Use a simple own model for checking your conmfiguration\n\n## Usage\n\n### Running code using Jupyter\n\n- Start the _OCP CAD Viewer_ by pressing the box-arrow button in the \"Viewer Manager\" section of the _OCP CAD Viewer_ sidebar (hover over the `ocp_vscode` entry to see the button).\n- Import ocp_vscode and the CAD library by using the paste button behing the library names in the \"Viewer Manager\" section\n- Use the usual Run menu to run the code\n\n\n\n### Debugging code with visual debugging\n\nAfter each step, the debugger checks all variables in `locals()` for being CAD objects and displays them with their variable name.\nNote:\n\n- Check that `OCP:on` is visible in the status bar\n- It also shows planes, locations and axis, so name your contexts\n- It remembers camera position and unselected variables in the tree\n- during debugging, `show` and `show_object` are disabled. They interfere with the visual debugging\n\n\n\n### Library Manager\n\nYou can also use \"Library Manager\" in the _OCP CAD Viewer_ sidebar to manage the Python libraries for _build123d_, _cadquery_, _ipython_ and _ocp_tessellate_ (Presse the down-arrow when hovering over a library name to install/upgrade it)\n\n### Extra topics\n\n- [Quickstart experience on Windows](docs/quickstart.md)\n- [Use Jupyter to execute code](docs/run.md)\n- [Debug code with visual debugging](docs/debug.md)\n- [Measure mode](docs/measure.md)\n- [Use the `show` command](docs/show.md)\n- [Use the `show_object` command](docs/show_object.md)\n- [Use the `set_viewer_config` command](docs/set_viewer_config.md)\n- [Download examples for build123d or cadquery](docs/examples.md)\n- [Use the build123d snippets](docs/snippets.md)\n\n## Standalone mode\n\nStandalone mode allows to use OCP CAD Viewer without VS Code: `python -m ocp_vscode`. This will start a Flask server and the viewer can be reached under `http://127.0.0.1/viewer`. All client side feature of the VS Code variant (i.e. `show*` features) should be available (including measurement mode) except visual debugging (see above) which relies on VS Code.\n\nUse `python -m ocp_vscode --help` to understand the command line args:\n```\nUsage: python -m ocp_vscode [OPTIONS]\n\nOptions:\n --create_configfile Create the configlie .ocpvscode_standalone in\n the home directory\n --host TEXT The host to start OCP CAD with\n --port INTEGER The port to start OCP CAD with\n --debug Show debugging information\n --timeit Show timing information\n --tree_width TEXT OCP CAD Viewer navigation tree width\n (default: 240)\n --no_glass Do not use glass mode with transparent\n navigation tree\n --theme TEXT Use theme 'light' or 'dark' (default:\n 'light')\n --no_tools Do not show toolbar\n --tree_width INTEGER Width of the CAD navigation tree (default:\n 240)\n --control TEXT Use control mode 'orbit'or 'trackball'\n --up TEXT Provides up direction, 'Z', 'Y' or 'L'\n (legacy) (default: Z)\n --rotate_speed INTEGER Rotation speed (default: 1)\n --zoom_speed INTEGER Zoom speed (default: 1)\n --pan_speed INTEGER Pan speed (default: 1)\n --axes Show axes\n --axes0 Show axes at the origin (0, 0, 0)\n --black_edges Show edges in black\n --grid_xy Show grid on XY plane\n --grid_yz Show grid on YZ plane\n --grid_xz Show grid on XZ plane\n --center_grid Show grid planes crossing at center of object\n or global origin(default: False)\n --collapse INTEGER leaves: collapse all leaf nodes, all:\n collapse all nodes, none: expand all nodes,\n root: expand root only (default: leaves)\n --perspective Use perspective camera\n --ticks INTEGER Default number of ticks (default: 10)\n --transparent Show objects transparent\n --default_opacity FLOAT Default opacity for transparent objects\n (default: 0.5)\n --explode Turn explode mode on\n --angular_tolerance FLOAT Angular tolerance for tessellation algorithm\n (default: 0.2)\n --deviation FLOAT Deviation of for tessellation algorithm\n (default: 0.1)\n --default_color TEXT Default shape color, CSS3 color names are\n allowed (default: #e8b024)\n --default_edgecolor TEXT Default color of the edges of shapes, CSS3\n color names are allowed (default: #707070)\n --default_thickedgecolor TEXT Default color of lines, CSS3 color names are\n allowed (default: MediumOrchid)\n --default_facecolor TEXT Default color of faces, CSS3 color names are\n allowed (default: Violet)\n --default_vertexcolor TEXT Default color of vertices, CSS3 color names\n are allowed (default: MediumOrchid)\n --ambient_intensity INTEGER Intensity of ambient light (default: 1.00)\n --direct_intensity FLOAT Intensity of direct light (default: 1.10)\n --metalness FLOAT Metalness property of material (default:\n 0.30)\n --roughness FLOAT Roughness property of material (default:\n 0.65)\n --help Show this message and exit.\n```\n\n## Best practices\n\n- Use the **Jupyter extension** for a more interactive experience. This allows to have one cell (separated by `# %%`) at the beginning to import all libraries\n\n ```python\n # %%\n from build123d import *\n from ocp_vscode import *\n\n # %%\n b = Box(1,2,3)\n show(b)\n # %%\n ```\n\n and then only execute the code in the cell you are currently working on repeatedly.\n\n- The **config system** of OCP CAD Viewer\n\n There are 3 levels:\n\n - Workspace configuration (part of the VS Code settings, you can access them e.g. via the gear symbol in OCP CAD Viewer's \"Viewer Manager\" when you hover over the label \"VIEWER MANAGER\" to see the button)\n - Defaults set with the command `set_defaults` per Python file\n - Parameters in `show` or `show_object` per command\n\n `set_defaults` overrides the Workspace settings and parameters in `show` and `show_config` override the other two.\n\n Note that not all parameters are available in the global Workspace config, since they don't make sense globally (e.g. `helper_scale` which depends on the size of the boundary box of the currently shown object)\n\n A common setup would be\n\n ```python\n # %%\n from build123d import *\n import cadquery as cq\n\n from ocp_vscode import *\n set_port(3939)\n\n set_defaults(reset_camera=False, helper_scale=5)\n\n # %%\n ...\n ```\n\n Explanation\n\n - The first block imports build123d and CadQuery (omit what you are not interested in).\n - The second block imports all commands for OCP CAD Viewer. `set_port` is only needed when you have more than one viewer open and can be omitted for the first viewer)\n - The third block as an example sets helper_scale and reset_camera as defaults. Then every show_object or show command will respect it as the default\n\n- Debugging build123d with `show_all` and the **visual debugger**\n\n - If you name your contexts (including `Location` contexts), the visual debugger will show the CAD objects assigned to the context.\n\n - Use `show_all` to show all cad objects in the current scope (`locals()`) of the Python interpreter (btw. the visual debugger uses `show_all` at each step)\n\n ```python\n # %%\n from build123d import *\n set_defaults(helper_scale=1, transparent=True)\n\n with BuildPart() as bp:\n with PolarLocations(3,8) as locs:\n Box(1,1,1)\n\n show_all()\n # %%\n ```\n\n \n\n- **Keep camera orientation** of an object with `reset_camera`\n\n Sometimes it is helpful to keep the orientation of an object across code changes. This is what `reset_camera` does:\n\n - `reset_camera=Camera.Center` will keep position and rotation, but ignore panning. This means the new object will be repositioned to the center (most robust approach)\n - `reset_camera=Camera.KEEP` will keep position, rotation and panning. However, panning can be problematic. When the next object to be shown is much larger or smaller and the object before was panned, it can happen that nothing is visible (the new object at the pan location is outside of the viewer frustum). OCP CAD Viewer checks whether the bounding box of an object is 2x smaller or larger than the one of the last shown object. If so, it falls back to `Camera.CENTER`. A notification is written to the OCP CAD Viewer output panel.\n - `reset_camera=Camera.RESET` will ensure that position, rotation and panning will be reset to the initial default\n\n## Development\n\nTesting:\n\nNative tessellator can be set via `NATIVE_TESSELLATOR=1`and Python tessellator via `NATIVE_TESSELLATOR=0`.\n\nWhen `OCP_VSCODE_PYTEST=1` is set, `show` will not send the tessellated results to the viewer, but return it to the caller for inspection.\n\nA full test cycle consist of:\n\n```bash\nNATIVE_TESSELLATOR=0 OCP_VSCODE_PYTEST=1 pytest -v -s pytests/\nNATIVE_TESSELLATOR=1 OCP_VSCODE_PYTEST=1 pytest -v -s pytests/\n```\n\n## Troubleshooting\n\n- **CAD Models almost always are invisible in the OCP viewer window**\n\n ```bash\n three-cad-viewer.esm.js:20276 THREE.WebGLProgram: Shader Error 0 - VALIDATE_STATUS false\n\n Material Name:\n Material Type: LineBasicMaterial\n\n Program Info Log: Program binary could not be loaded. Binary is not compatible with current driver/hardware combination. Driver build date Mar 19 2024. Please check build information of source that generated the binary.\n Location of variable pc_fragColor conflicts with another variable.\n ```\n\n VS Code internal browser that renders the viewer component uses a cache for code and other artifacts. This includes WebGL artefacts like compiled shaders. It can happen that e.g. due to a graphic driver update the compiled version in the cache does not fit to the new driver. Then this error message appears.\n\n **Solution:** [Delete the VS Code browser cache on Linux](https://bobbyhadz.com/blog/vscode-clear-cache) (go to the section for your operating system)\n\n## Changes\n\nv2.6.1\n\nFixes:\n\n- Standalone viewer can listen to other IP addresses of the machine than 127.0.0.1\n- `show` now uses port 3939 as default when no port could be detected and a service listens to 3939\n- Fixed a bug in ocp-tessellate for cadquery wires ([#116](https://github.com/bernhard-42/vscode-ocp-cad-viewer/issues/116))\n- Fixed a bug in backend for measures that prevented faces being inspected ([#115](https://github.com/bernhard-42/vscode-ocp-cad-viewer/issues/115))\n- Fixed a bug that shifted the orientation too high for the logo screen\n\nv2.6.0\n\nNew features\n\n- Standalone mode without VS Code: `python -m ocp_vscode`. This will start a Flask server and the viewer can be reached under `http://127.0.0.1/viewer`.\n\nFixes:\n\n- Fix that `show_all` doesn't ignore `_123` and similar variable names\n",
"bugtrack_url": null,
"license": "Apache-2.0",
"summary": "OCP CAD Viewer for VSCode",
"version": "2.6.1",
"project_urls": {
"Bug Tracker": "https://github.com/bernhard-42/vscode-ocp-cad-viewer/issues",
"Homepage": "https://github.com/bernhard-42/vscode-ocp-cad-viewer"
},
"split_keywords": [
"3d models",
" 3d printing",
" 3d viewing",
" 3d",
" brep",
" cad",
" cadquery",
" opencscade",
" python"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "3a4160d158f628b0cec63afb45dbdd2c3a62d4b79df35869174dc9a2f7363eca",
"md5": "e801d734f1eabbec23f63c97a11ca882",
"sha256": "98f997fecae2668205f9ddaab416acba9e65816e848baa6552f73be09c448a2a"
},
"downloads": -1,
"filename": "ocp_vscode-2.6.1-py3-none-any.whl",
"has_sig": false,
"md5_digest": "e801d734f1eabbec23f63c97a11ca882",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.9",
"size": 472798,
"upload_time": "2024-11-04T19:49:44",
"upload_time_iso_8601": "2024-11-04T19:49:44.082617Z",
"url": "https://files.pythonhosted.org/packages/3a/41/60d158f628b0cec63afb45dbdd2c3a62d4b79df35869174dc9a2f7363eca/ocp_vscode-2.6.1-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "e89b5f8886b50751c36d932bb2a8c35bd8525296d97e681e93d6c477408f6cb7",
"md5": "43d2341d4ab0886cd213122a48ab1609",
"sha256": "9e11aa89f6e60733846e553df4e347c19b82c8ca84912c43ce844af426daae7e"
},
"downloads": -1,
"filename": "ocp_vscode-2.6.1.tar.gz",
"has_sig": false,
"md5_digest": "43d2341d4ab0886cd213122a48ab1609",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.9",
"size": 471516,
"upload_time": "2024-11-04T19:49:46",
"upload_time_iso_8601": "2024-11-04T19:49:46.749714Z",
"url": "https://files.pythonhosted.org/packages/e8/9b/5f8886b50751c36d932bb2a8c35bd8525296d97e681e93d6c477408f6cb7/ocp_vscode-2.6.1.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-11-04 19:49:46",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "bernhard-42",
"github_project": "vscode-ocp-cad-viewer",
"travis_ci": false,
"coveralls": false,
"github_actions": false,
"lcname": "ocp-vscode"
}
JSON
