-
Notifications
You must be signed in to change notification settings - Fork 13
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
USD visOption pass through and manual #196
Merged
Merged
Changes from all commits
Commits
Show all changes
2 commits
Select commit
Hold shift + click to select a range
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -15,6 +15,7 @@ User Manual | |
combining | ||
comparing | ||
analysing | ||
rendering | ||
|
||
|
||
Indices and tables | ||
|
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,40 @@ | ||
.. _rendering: | ||
|
||
================== | ||
Rendering Geometry | ||
================== | ||
|
||
There are many reasons to render geometry beyond the VTK based | ||
pyg44omety viewer. Potential targets are 3D asset packages (e.g. | ||
blender, houdini), games engines (unreal engine, unity). A common | ||
format is Universal Scene Description (USD). USD can be loaded in | ||
many packages and so a dedicated UDS converter/viewer is available | ||
in pyg4ometry. For example to load and convert a file to USD | ||
|
||
.. code-block:: python | ||
:linenos: | ||
|
||
r = pyg4ometry.gdml.Reader("lht.gdml") | ||
l = r.getRegistry().getWorldVolume() | ||
v = pyg4ometry.visualisation.UsdViewer("lht.usd") | ||
v.traverseHierarchy(l) | ||
v.save() | ||
|
||
This will write a file called lht.gdml which can be viewed in | ||
a USD viewer like usdview. USD has a preview shader. The settings | ||
can set via the `VisualisationOptions` stored in logical volumes | ||
(`visOption`), so for example | ||
|
||
.. code-block:: python | ||
:linenos: | ||
|
||
r = pyg4ometry.gdml.Reader("lht.gdml") | ||
reg = r.getRegistry() | ||
reg.logicalVolumeDict["vCalorimeter"].visOptions.colour = [1, 0, 0] | ||
v = pyg4ometry.visualisation.UsdViewer("lht.usd") | ||
v.traverseHierarchy(reg.getWorldVolume()) | ||
v.save() | ||
|
||
`visOptions.color` and `visOptions.alpha` are passed though to the | ||
USD shader. There are many more options for shading in USD which can | ||
be accessed via `visOptions.usdOptions` |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
This should be
visOptions.colour
instead ofvisOptions.color
?I think this would be important to fix in the docs, to not confuse users after the next release (it already is confusing enough that pyg4ometry uses colour and USD uses ...Color)
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Fixed.