Viewer

The View module API can be used to render scenes, generating offline screenshots (see following snippet), or create interactive viewers (see Python UI).

Python
C#

direction = geom.Point3(0, 0, -1) # front
viewer = view.createViewer(resolution, resolution)
gpu_scene = view.createGPUScene(occurrence, show_edges)
view.addGPUScene(gpu_scene, viewer)
view.fitCamera(direction, type, fov, viewer, [occurrence])
if show_edges:
    view.setViewerProperty("ShowEdges", "True", viewer)
if show_lines:
    view.setViewerProperty("ShowLines", "False", viewer)
view.takeScreenshot(path, viewer)
view.destroyViewer(viewer)
view.destroyGPUScene(gpu_scene)

uint viewer = pxz.View.CreateViewer(resolution, resolution);
uint gpuScene = pxz.View.CreateGPUScene(occurrence, showEdges);
pxz.View.AddGPUScene(gpuScene, viewer);
pxz.View.FitCamera(direction, type, fov, viewer, new OccurrenceList(new uint[] { occurrence }));
pxz.View.SetViewerProperty("ShowEdges", showEdges ? "True" : "False", viewer);
pxz.View.SetViewerProperty("ShowLines", showLines ? "True" : "False", viewer);
pxz.View.TakeScreenshot(path, viewer);
pxz.View.DestroyViewer(viewer);
pxz.View.DestroyGPUScene(gpuScene);

Viewer properties

Viewer properties can be get/set using view.getViewerProperty and view.setViewerProperty.

Property	Type	Description
OcclusionCullingEnabled	Boolean
DepthReprojectionEnabled	Boolean
ReprojectionResolutionDivision	Int
SelectionOverlayEnabled	Boolean
ShowPolygons	Boolean
ShowEdges	Boolean
ShowPatches	Boolean
ShowBReps	Boolean
ShowLines	Boolean
ShowPoints	Boolean
UseVertexColor	Boolean
UseNormalMaps	Boolean
InvertVisibility	Boolean
UpdateHLODs	Boolean
HLODErrorPixelCount	Int
BackFaceCulling	Enum: - 0 - 1 - 2
LineWidth	Real
WireframeWidth	Real
PointSize	Real
WireframeColor	Color
NonManifoldColor	Color
EdgeBorderColor	Color
PointColor	Color
LineColor	Color
PatchBorderColor	Color
UseUVAsPosition	Boolean
UVChannel	Enum: - 0 - 1
RenderComposited	Boolean
RenderAlbedoOpacity	Boolean
RenderMetallicRoughnessAOMeta	Boolean
RenderNormal	Boolean
RenderEmissive	Boolean
RenderObjectIdPrimitiveId	Boolean
RenderUVs	Boolean
RenderSSAO	Boolean
UseSSAO	Boolean
BlurSSAO	Boolean
BlurSize	Int
SSAORadius	Real
SSAOAmplitude	Real
UseFXAA	Boolean
ExplodeCenter	Point3
ExplodeFactor	Point3
Environment	FilePath
CubeMapSize	Int
PrefilterMapSize	Int
IrradianceMapSize	Int
Exposure	Coeff
ShowBackground	Boolean
BackgroundColor	ColorAlpha
CubemapRotation	BoundedInteger
BlurMap	BoundedInteger
EnableToneMaping	Boolean
UseEnvironmentMap	Boolean
AmbientColor	Color	AmbientColor will be used only if useEnvironmentMap=False
UsePose	Boolean
ShadowsEnabled	Boolean
ShadowMapResolution	Int
ShadowCulling	Enum: - 0 - 1
DepthBias	Real
UsePCF	Boolean
ComputeLastAABB	Boolean