# vtk-u3dexporter
[](https://github.com/ClinicalGraphics/VTKU3DExporter/actions/workflows/build_wheels.yml)
[](https://pypi.python.org/pypi/vtk-u3dexporter)
[](https://opensource.org/licenses/Apache-2.0)
`vtk-u3dexporter` is a VTK module for exporting a VTK 3D scene to the U3D file format, which can be embedded into PDF files.
It is available as both C++ class and a Python package.
## Installation
You can install `vtk-u3dexporter` via pip:
```sh
pip install vtk-u3dexporter
```
## Usage
Here is a brief example of how to use `vtk-u3dexporter` to export a simple cube scene:
```python
import os
import vtk
from vtk import vtkU3DExporter
# Define the cube source
cube = vtk.vtkCubeSource()
# Define the cube mapper
cubeMapper = vtk.vtkPolyDataMapper()
cubeMapper.SetInputConnection(cube.GetOutputPort())
# Define the cube actor
cubeActor = vtk.vtkActor()
cubeActor.SetMapper(cubeMapper)
# Define the render window and renderer
renderWindow = vtk.vtkRenderWindow()
renderWindow.OffScreenRenderingOn()
renderer = vtk.vtkRenderer()
renderWindow.AddRenderer(renderer)
# Add the cube to the renderer
renderer.AddActor(cubeActor)
# Automatically reset the camera
renderer.ResetCamera()
# Define the output file name, which will have the ".u3d" extension appended automatically
filePath = "cube"
# Export to U3D
u3dExporter = vtkU3DExporter.vtkU3DExporter()
u3dExporter.SetFileName(filePath)
u3dExporter.SetInput(renderWindow)
u3dExporter.Write()
# Check that the file exists
assert os.path.exists(f"{filePath}.u3d")
```
In this example, we create a simple cube scene using VTK, add it to a renderer, and then export it to U3D format using `vtk-u3dexporter`. We then verify that the output file exists.
## License
`vtk-u3dexporter` is distributed under the Apache License 2.0. Please see the [LICENSE][LICENSE] file for details.
[LICENSE]: https://github.com/ClinicalGraphics/VTKU3DExporter/blob/main/LICENSE
## Resources
* [VTK website](https://docs.vtk.org)
* [U3D file format specification](https://www.ecma-international.org/publications-and-standards/standards/ecma-363/)
Raw data
{
"_id": null,
"home_page": "https://github.com/ClinicalGraphics/VTKU3DExporter",
"name": "vtk-u3dexporter",
"maintainer": "",
"docs_url": null,
"requires_python": "",
"maintainer_email": "",
"keywords": "",
"author": "Jean-Christophe Fillion-Robin",
"author_email": "",
"download_url": "",
"platform": null,
"description": "# vtk-u3dexporter\n\n[](https://github.com/ClinicalGraphics/VTKU3DExporter/actions/workflows/build_wheels.yml)\n[](https://pypi.python.org/pypi/vtk-u3dexporter)\n[](https://opensource.org/licenses/Apache-2.0)\n\n`vtk-u3dexporter` is a VTK module for exporting a VTK 3D scene to the U3D file format, which can be embedded into PDF files.\n\nIt is available as both C++ class and a Python package.\n\n## Installation\n\nYou can install `vtk-u3dexporter` via pip:\n\n```sh\npip install vtk-u3dexporter\n```\n\n## Usage\n\nHere is a brief example of how to use `vtk-u3dexporter` to export a simple cube scene:\n\n```python\nimport os\nimport vtk\nfrom vtk import vtkU3DExporter\n\n# Define the cube source\ncube = vtk.vtkCubeSource()\n\n# Define the cube mapper\ncubeMapper = vtk.vtkPolyDataMapper()\ncubeMapper.SetInputConnection(cube.GetOutputPort())\n\n# Define the cube actor\ncubeActor = vtk.vtkActor()\ncubeActor.SetMapper(cubeMapper)\n\n# Define the render window and renderer\nrenderWindow = vtk.vtkRenderWindow()\nrenderWindow.OffScreenRenderingOn()\nrenderer = vtk.vtkRenderer()\nrenderWindow.AddRenderer(renderer)\n\n# Add the cube to the renderer\nrenderer.AddActor(cubeActor)\n\n# Automatically reset the camera\nrenderer.ResetCamera()\n\n# Define the output file name, which will have the \".u3d\" extension appended automatically\nfilePath = \"cube\"\n\n# Export to U3D\nu3dExporter = vtkU3DExporter.vtkU3DExporter()\nu3dExporter.SetFileName(filePath)\nu3dExporter.SetInput(renderWindow)\nu3dExporter.Write()\n\n# Check that the file exists\nassert os.path.exists(f\"{filePath}.u3d\")\n```\n\nIn this example, we create a simple cube scene using VTK, add it to a renderer, and then export it to U3D format using `vtk-u3dexporter`. We then verify that the output file exists.\n\n## License\n\n`vtk-u3dexporter` is distributed under the Apache License 2.0. Please see the [LICENSE][LICENSE] file for details.\n\n[LICENSE]: https://github.com/ClinicalGraphics/VTKU3DExporter/blob/main/LICENSE\n\n## Resources\n\n* [VTK website](https://docs.vtk.org)\n* [U3D file format specification](https://www.ecma-international.org/publications-and-standards/standards/ecma-363/)\n",
"bugtrack_url": null,
"license": "Apache Software License",
"summary": "General-purpose features that may be integrated into VTK library in the future.",
"version": "0.3.0",
"project_urls": {
"Bug Reports": "https://github.com/ClinicalGraphics/VTKU3DExporter/issues",
"Homepage": "https://github.com/ClinicalGraphics/VTKU3DExporter",
"Source": "https://github.com/ClinicalGraphics/VTKU3DExporter/"
},
"split_keywords": [],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "0d9420ab353c18e175167beedeb68409ae419976eef0792753eab21d1aeac74c",
"md5": "6879c8473b88a2082f1968b96d7d759d",
"sha256": "8ed6a726f5db0f9e257a447dd903f25077fbc4aaca2cb4e0a915fc80cb88efb1"
},
"downloads": -1,
"filename": "vtk_u3dexporter-0.3.0-cp310-cp310-macosx_10_10_x86_64.whl",
"has_sig": false,
"md5_digest": "6879c8473b88a2082f1968b96d7d759d",
"packagetype": "bdist_wheel",
"python_version": "cp310",
"requires_python": null,
"size": 1450818,
"upload_time": "2023-09-04T12:31:40",
"upload_time_iso_8601": "2023-09-04T12:31:40.189456Z",
"url": "https://files.pythonhosted.org/packages/0d/94/20ab353c18e175167beedeb68409ae419976eef0792753eab21d1aeac74c/vtk_u3dexporter-0.3.0-cp310-cp310-macosx_10_10_x86_64.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "02e0ace7276084f63be4e97113c6d5a1279efe765c5d5ccfe3d6ac92d94c54bc",
"md5": "3a3820a493ea167f2d903bd7dc3d34a2",
"sha256": "7033ecdb2af77da37087ae6288532cd1e274500f210ece148454707d064c838b"
},
"downloads": -1,
"filename": "vtk_u3dexporter-0.3.0-cp310-cp310-macosx_11_0_arm64.whl",
"has_sig": false,
"md5_digest": "3a3820a493ea167f2d903bd7dc3d34a2",
"packagetype": "bdist_wheel",
"python_version": "cp310",
"requires_python": null,
"size": 1348907,
"upload_time": "2023-09-04T12:31:42",
"upload_time_iso_8601": "2023-09-04T12:31:42.339398Z",
"url": "https://files.pythonhosted.org/packages/02/e0/ace7276084f63be4e97113c6d5a1279efe765c5d5ccfe3d6ac92d94c54bc/vtk_u3dexporter-0.3.0-cp310-cp310-macosx_11_0_arm64.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "1b31f7fc1b567d3191ecdad1d50782cc05e143db51543c5081c3013336b8be17",
"md5": "da3e2b4b7aa7c64bd084022d60b747eb",
"sha256": "e9fdd0b5abe0ef4447179fbca053f521b0622443690be53d045462794a69c36a"
},
"downloads": -1,
"filename": "vtk_u3dexporter-0.3.0-cp310-cp310-manylinux_2_17_x86_64.manylinux2014_x86_64.whl",
"has_sig": false,
"md5_digest": "da3e2b4b7aa7c64bd084022d60b747eb",
"packagetype": "bdist_wheel",
"python_version": "cp310",
"requires_python": null,
"size": 1983359,
"upload_time": "2023-09-04T12:31:44",
"upload_time_iso_8601": "2023-09-04T12:31:44.532096Z",
"url": "https://files.pythonhosted.org/packages/1b/31/f7fc1b567d3191ecdad1d50782cc05e143db51543c5081c3013336b8be17/vtk_u3dexporter-0.3.0-cp310-cp310-manylinux_2_17_x86_64.manylinux2014_x86_64.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "b81f3387fd1e726355187752943f0e733c6cb4dc2522c0828ea890a0da1957cc",
"md5": "933e65c182df3baf64606a83e305369a",
"sha256": "f93260de115c5b19d0cebe957ebe6d194c06c5a1031fc7bca5e34cff66c019f4"
},
"downloads": -1,
"filename": "vtk_u3dexporter-0.3.0-cp310-cp310-win_amd64.whl",
"has_sig": false,
"md5_digest": "933e65c182df3baf64606a83e305369a",
"packagetype": "bdist_wheel",
"python_version": "cp310",
"requires_python": null,
"size": 1123031,
"upload_time": "2023-09-04T12:31:46",
"upload_time_iso_8601": "2023-09-04T12:31:46.242737Z",
"url": "https://files.pythonhosted.org/packages/b8/1f/3387fd1e726355187752943f0e733c6cb4dc2522c0828ea890a0da1957cc/vtk_u3dexporter-0.3.0-cp310-cp310-win_amd64.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "e9ee47aa5f29c62288af9e0404c686d0150ed98fe12484fb2237f785d3ac4a96",
"md5": "f44f1f56fa31a3adf921f946ea74e20a",
"sha256": "65e11a51cb06808645f0da75819db67d698ecd76e7d059258d352f5b4d044c82"
},
"downloads": -1,
"filename": "vtk_u3dexporter-0.3.0-cp311-cp311-macosx_10_10_x86_64.whl",
"has_sig": false,
"md5_digest": "f44f1f56fa31a3adf921f946ea74e20a",
"packagetype": "bdist_wheel",
"python_version": "cp311",
"requires_python": null,
"size": 1450817,
"upload_time": "2023-09-04T12:31:47",
"upload_time_iso_8601": "2023-09-04T12:31:47.783118Z",
"url": "https://files.pythonhosted.org/packages/e9/ee/47aa5f29c62288af9e0404c686d0150ed98fe12484fb2237f785d3ac4a96/vtk_u3dexporter-0.3.0-cp311-cp311-macosx_10_10_x86_64.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "9636f20cfb5054dccbb4d1536cc9b1dc92bdc482e5aa128303757457c7fd51c6",
"md5": "694f73ccf2960c08070203dda0d6d563",
"sha256": "d9f1ba2b38402bd3ec83f8f11a2a643b7028e159bcdb8eaf347e231318a0a650"
},
"downloads": -1,
"filename": "vtk_u3dexporter-0.3.0-cp311-cp311-macosx_11_0_arm64.whl",
"has_sig": false,
"md5_digest": "694f73ccf2960c08070203dda0d6d563",
"packagetype": "bdist_wheel",
"python_version": "cp311",
"requires_python": null,
"size": 1348916,
"upload_time": "2023-09-04T12:31:49",
"upload_time_iso_8601": "2023-09-04T12:31:49.231400Z",
"url": "https://files.pythonhosted.org/packages/96/36/f20cfb5054dccbb4d1536cc9b1dc92bdc482e5aa128303757457c7fd51c6/vtk_u3dexporter-0.3.0-cp311-cp311-macosx_11_0_arm64.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "e224d54c9f4fd0f1bf787caa6e8e0b326e7420c649227b17c7321c51125660b6",
"md5": "70b03431982cb055f0127e2ae96a03ad",
"sha256": "c595cb5ea4757dd4e5991555b48c04a116810281929e9dddd3dd0dc505b4b2bf"
},
"downloads": -1,
"filename": "vtk_u3dexporter-0.3.0-cp311-cp311-manylinux_2_17_x86_64.manylinux2014_x86_64.whl",
"has_sig": false,
"md5_digest": "70b03431982cb055f0127e2ae96a03ad",
"packagetype": "bdist_wheel",
"python_version": "cp311",
"requires_python": null,
"size": 1983359,
"upload_time": "2023-09-04T12:31:51",
"upload_time_iso_8601": "2023-09-04T12:31:51.101785Z",
"url": "https://files.pythonhosted.org/packages/e2/24/d54c9f4fd0f1bf787caa6e8e0b326e7420c649227b17c7321c51125660b6/vtk_u3dexporter-0.3.0-cp311-cp311-manylinux_2_17_x86_64.manylinux2014_x86_64.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "c21caabb4b5468b4ac0eb04afcd4c3586e0bc50c06065610c9bb298814ac134e",
"md5": "353ce0f9af8551238fd63be2f8e5105f",
"sha256": "7bda25a6b44cf1a41952aa2f051d4ff69e39ab799833c5f597abf8daea0b870a"
},
"downloads": -1,
"filename": "vtk_u3dexporter-0.3.0-cp311-cp311-win_amd64.whl",
"has_sig": false,
"md5_digest": "353ce0f9af8551238fd63be2f8e5105f",
"packagetype": "bdist_wheel",
"python_version": "cp311",
"requires_python": null,
"size": 1123017,
"upload_time": "2023-09-04T12:31:53",
"upload_time_iso_8601": "2023-09-04T12:31:53.489600Z",
"url": "https://files.pythonhosted.org/packages/c2/1c/aabb4b5468b4ac0eb04afcd4c3586e0bc50c06065610c9bb298814ac134e/vtk_u3dexporter-0.3.0-cp311-cp311-win_amd64.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "cb31292015719b1fe6dd33360d72a5ca64424c2e316a7a12a2a9c6c319a30eee",
"md5": "5bb7e4835a4cd7ef46229c4b45fdbe73",
"sha256": "6912ae81df73afcbf0ab62ecaf709ce457b00e442c055b5ea7745d34e9797c7f"
},
"downloads": -1,
"filename": "vtk_u3dexporter-0.3.0-cp38-cp38-macosx_10_10_x86_64.whl",
"has_sig": false,
"md5_digest": "5bb7e4835a4cd7ef46229c4b45fdbe73",
"packagetype": "bdist_wheel",
"python_version": "cp38",
"requires_python": null,
"size": 1450798,
"upload_time": "2023-09-04T12:31:55",
"upload_time_iso_8601": "2023-09-04T12:31:55.359169Z",
"url": "https://files.pythonhosted.org/packages/cb/31/292015719b1fe6dd33360d72a5ca64424c2e316a7a12a2a9c6c319a30eee/vtk_u3dexporter-0.3.0-cp38-cp38-macosx_10_10_x86_64.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "fdaf8c5fa1be388fe8f7b1e36553bf18dca2d77aefbcd270149a35f54ab89e31",
"md5": "0d1f23bc2a93b9ae4011fdec590ee987",
"sha256": "4059913364a07f5c3bbdea3e060a97b082ac8b86f383fcc75fb3925683f0dada"
},
"downloads": -1,
"filename": "vtk_u3dexporter-0.3.0-cp38-cp38-manylinux_2_17_x86_64.manylinux2014_x86_64.whl",
"has_sig": false,
"md5_digest": "0d1f23bc2a93b9ae4011fdec590ee987",
"packagetype": "bdist_wheel",
"python_version": "cp38",
"requires_python": null,
"size": 1983344,
"upload_time": "2023-09-04T12:31:57",
"upload_time_iso_8601": "2023-09-04T12:31:57.235764Z",
"url": "https://files.pythonhosted.org/packages/fd/af/8c5fa1be388fe8f7b1e36553bf18dca2d77aefbcd270149a35f54ab89e31/vtk_u3dexporter-0.3.0-cp38-cp38-manylinux_2_17_x86_64.manylinux2014_x86_64.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "e115e8a606ec2519ed77cf9288523384eb4eb3f6196c06d2d829288be22cbda1",
"md5": "d447cf8e4833b55e98ff5349dd22fb92",
"sha256": "b2210e93e8ff71b84ec57e074f00abd7ce8baee60f0e0c54a931becc94905408"
},
"downloads": -1,
"filename": "vtk_u3dexporter-0.3.0-cp38-cp38-win_amd64.whl",
"has_sig": false,
"md5_digest": "d447cf8e4833b55e98ff5349dd22fb92",
"packagetype": "bdist_wheel",
"python_version": "cp38",
"requires_python": null,
"size": 1123334,
"upload_time": "2023-09-04T12:31:58",
"upload_time_iso_8601": "2023-09-04T12:31:58.718118Z",
"url": "https://files.pythonhosted.org/packages/e1/15/e8a606ec2519ed77cf9288523384eb4eb3f6196c06d2d829288be22cbda1/vtk_u3dexporter-0.3.0-cp38-cp38-win_amd64.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "3281d644372646021db999f36839016c63ee7d9356ee5d20d9279f871ecfcc6a",
"md5": "99bab93a4907467e55f2dd6de85db13e",
"sha256": "23b3d0d601b56d65bc8921ba9441f86d98c8ce4c62968184bc04310599dfa683"
},
"downloads": -1,
"filename": "vtk_u3dexporter-0.3.0-cp39-cp39-macosx_10_10_x86_64.whl",
"has_sig": false,
"md5_digest": "99bab93a4907467e55f2dd6de85db13e",
"packagetype": "bdist_wheel",
"python_version": "cp39",
"requires_python": null,
"size": 1450815,
"upload_time": "2023-09-04T12:32:01",
"upload_time_iso_8601": "2023-09-04T12:32:01.091779Z",
"url": "https://files.pythonhosted.org/packages/32/81/d644372646021db999f36839016c63ee7d9356ee5d20d9279f871ecfcc6a/vtk_u3dexporter-0.3.0-cp39-cp39-macosx_10_10_x86_64.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "64f3530190382dddc06d7c5fa360294927f93b1c23f65138cd64c277accf0c68",
"md5": "5ed8fc3b25209de8b6f0747be5181809",
"sha256": "97524ae0be4898471db9298640b2b51216c73fd42e32ed6bb93d65aa8502d74d"
},
"downloads": -1,
"filename": "vtk_u3dexporter-0.3.0-cp39-cp39-macosx_11_0_arm64.whl",
"has_sig": false,
"md5_digest": "5ed8fc3b25209de8b6f0747be5181809",
"packagetype": "bdist_wheel",
"python_version": "cp39",
"requires_python": null,
"size": 1348940,
"upload_time": "2023-09-04T12:32:02",
"upload_time_iso_8601": "2023-09-04T12:32:02.909069Z",
"url": "https://files.pythonhosted.org/packages/64/f3/530190382dddc06d7c5fa360294927f93b1c23f65138cd64c277accf0c68/vtk_u3dexporter-0.3.0-cp39-cp39-macosx_11_0_arm64.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "3a6003cb3607d73219b4cb99a525823c51cf132fba966efb11bca982d83c6f98",
"md5": "69f5812597c83c5bc337fec76479536e",
"sha256": "f5ae0d01d6fb3b9d490453f60488d0f41fc07281f355743a184e904e0258fc07"
},
"downloads": -1,
"filename": "vtk_u3dexporter-0.3.0-cp39-cp39-manylinux_2_17_x86_64.manylinux2014_x86_64.whl",
"has_sig": false,
"md5_digest": "69f5812597c83c5bc337fec76479536e",
"packagetype": "bdist_wheel",
"python_version": "cp39",
"requires_python": null,
"size": 1983359,
"upload_time": "2023-09-04T12:32:05",
"upload_time_iso_8601": "2023-09-04T12:32:05.310843Z",
"url": "https://files.pythonhosted.org/packages/3a/60/03cb3607d73219b4cb99a525823c51cf132fba966efb11bca982d83c6f98/vtk_u3dexporter-0.3.0-cp39-cp39-manylinux_2_17_x86_64.manylinux2014_x86_64.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "e26b79efbd7f64c9887cc73b1099f5f7313aa83ba81c2e30708da7158677ae85",
"md5": "71a2c9afb6950c63cacd25ac74def5c2",
"sha256": "ee2b2cd2f4f1c6d17948ae14890e8ecb7647d1d92ed4b91e248c9642ae2def17"
},
"downloads": -1,
"filename": "vtk_u3dexporter-0.3.0-cp39-cp39-win_amd64.whl",
"has_sig": false,
"md5_digest": "71a2c9afb6950c63cacd25ac74def5c2",
"packagetype": "bdist_wheel",
"python_version": "cp39",
"requires_python": null,
"size": 1123024,
"upload_time": "2023-09-04T12:32:07",
"upload_time_iso_8601": "2023-09-04T12:32:07.407462Z",
"url": "https://files.pythonhosted.org/packages/e2/6b/79efbd7f64c9887cc73b1099f5f7313aa83ba81c2e30708da7158677ae85/vtk_u3dexporter-0.3.0-cp39-cp39-win_amd64.whl",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2023-09-04 12:31:40",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "ClinicalGraphics",
"github_project": "VTKU3DExporter",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"lcname": "vtk-u3dexporter"
}
JSON
