settings

Global settings.

# Axes title defaults
xtitle = 'x'
ytitle = 'y'
ztitle = 'z'

# Scale magnification of the screenshot (must be an integer)
screeshotScale = 1
screenshotTransparentBackground = False

# Sometimes setting this to True gives better results
screeshotLargeImage = False

# Recompute vertex and cell normals
computeNormals = None

# Automatically reset the range of the active scalars
autoResetScalarRange = True

# Default style is TrackBallCamera
interactorStyle = None

# Allow to interact with scene during interactor.Start() execution
allowInteraction = True

# Flag-style label options
flagDelay    = 0.0       # popup delay in milliseconds
flagFont     = "Courier" # font type ("Arial", "Courier", "Times")
flagFontSize = 18
flagAngle    = 0
flagBold     = False
flagItalic   = True
flagShadow   = False
flagColor    = 'k'
flagJustification = 0
flagBackgroundColor = 'w'

# Show a gray frame margin in multirendering windows
showRendererFrame = True
rendererFrameColor = None

# In multirendering mode set the position of the horizontal of vertical splitting [0,1]
windowSplittingPosition = None

# Use tex, matplotlib latex compiler
usetex = False

# Qt embedding
usingQt = False

# OpenVR rendering
useOpenVR = False

# On some vtk versions/platforms points are redered as ugly squares
renderPointsAsSpheres = True

# Wrap lines in tubes
renderLinesAsTubes = False

# Smoothing options
pointSmoothing = False
lineSmoothing = False
polygonSmoothing = False

# Remove hidden lines when in wireframe mode
hiddenLineRemoval = False

# For (Un)Structured and RectilinearGrid: show internal edges not only outline
visibleGridEdges = False

# Turn on/off the automatic repositioning of lights as the camera moves.
lightFollowsCamera = False

# Turn on/off rendering of translucent material with depth peeling technique.
useDepthPeeling = False
alphaBitPlanes  = True  # options only active if useDepthPeeling=True
multiSamples    = 0     # force to not pick a framebuffer with a multisample buffer
maxNumberOfPeels= 8     # maximum number of rendering passes
occlusionRatio  = 0.0   # occlusion ratio, 0 = exact image.

# Use a polygon/edges offset to possibly resolve conflicts in rendering
usePolygonOffset    = False
polygonOffsetFactor = 0.1
polygonOffsetUnits  = 0.1

# Interpolate scalars to render them smoothly
interpolateScalarsBeforeMapping = True

# Turn on/off nvidia FXAA anti-aliasing, if supported.
useFXAA = None          # either True or False. None sets the system default

# Set parallel projection On or Off (place camera to infinity, no perspective effects)
useParallelProjection = False

# Path to Voro++ library, http://math.lbl.gov/voro++
voro_path = '/usr/local/bin'

Usage example:

from vtkplotter import *

settings.useParallelProjection = True

Cube().color('green').show()

embedWindow

vtkplotter.settings.embedWindow(backend='k3d', verbose=True)[source]

Use this function to control whether the rendering window is inside the jupyter notebook or as an independent external window