Warnung
Headless Scripting ist eine experimentelle Funktion.
Headless Scripting ist eine Pro-Funktion und nur mit KeyShot 9.3 oder neuer verfügbar.
Diese Seite beschreibt die verschiedenen Funktionen, Klassen und Konstanten, die beim Ausführen von KeyShot im Headless-Modus verfügbar gemacht werden. Beachten Sie, dass derzeit nur eine Teilmenge der Scriptingfunktionen in KeyShot über Headless Scripting verwendet werden kann.
Headless Verwendung
Für die Verwendung von Headless Scripting auf Mac verwenden Sie die folgende Anwendung:
keyshot -headless [options] [scene path] -script <script path> [script arguments]
Diese Anwendung wird aus Gründen der Abwärtskompatibilität auch unter Windows noch verwendet.
Für die Verwendung von stdin (standard input) und stdout (standard output) auf Windows verwenden Sie die neue KeyShot Headless Anwendung:
keyshot_headless -headless [options] [scene path] -script <script path> [script arguments]
Sie können beispielsweise das stdout verwenden, um das Skript mithilfe des redirect Operators “>” oder “>>” in eine Datei auszugeben.
Die Anwendung würde dann folgendermaßen aussehen:
keyshot_headless -headless -script <script path> [script arguments] > logfile.txt
Optionen
Sie können die Optionen durch folgende Eingabe öffnen keyshot -help -headless
Dies zeigt Ihnen Folgendes in Ihrem Terminal:
-xlic <external license folder>
-floating_license_server <FlexLM server>
Anmerkung
Dem Server muss “@” vorangestellt werden, wenn der Standardport verwendet wird, und “Port @”, wenn nicht.
-floating_feature <FlexLM feature> (<NR cores>)
Aktzeptierte FlexLM Features:
- keyshot2 (Pro)
- keyshot_enterprise
- keyshot_network_rendering (NR, checks out all cores if is not specified)
-generateconfig [no cloud] [no auto-update] [FlexLM server] [FlexLM feature]
Generiert eine Konfigurationsdatei im KeyShot-Ressourcenordner. Unabhängig von Headless: KeyShot Cloud ist deaktiviert, wenn [no cloud] ‘1’ ist, und die Überprüfung der automatischen Aktualisierung ist deaktiviert, wenn [no auto-update] ‘1’ ist.
-progress
Schreibt den Renderfortschritt auf stdout, d.h. ‘Rendering: xxx.x%’.
Lokal konfigurierte Node-locked oder Floating Lizenzen in der Einstellungsdatei werden automatisch verwendet, wenn keine Argumente angegeben werden, um sie zu überschreiben.
Headless Scripting Dokumentation
Unten finden Sie eine Liste der Funktionen, Klassen und Konstanten, die im Headless-Modus verfügbar sind. Die vollständige Dokumentation hierzu finden Sie hier als Teil der KeyShot Scripting-Dokumentation.
Funktionen
- lux.applyMaterialMapping()
- lux.clearGeometry()
- lux.deleteMaterial()
- lux.enablePerformanceMode()
- lux.encodeVideo()
- lux.exportFile()
- lux.getAnimationFrame()
- lux.getAnimationInfo()
- lux.getAnimationTime()
- lux.getCamera()
- lux.getCameraDirection()
- lux.getCameraDistance()
- lux.getCameraLookAt()
- lux.getCameraPosition()
- lux.getCameraUp()
- lux.getCameras()
- lux.getExternalFiles()
- lux.getKeyShotVersion()
- lux.getLibraryBackplates()
- lux.getLibraryEnvironments()
- lux.getLibraryMaterials()
- lux.getLibraryTextures()
- lux.getMaterialMapping()
- lux.getMaterialTemplates()
- lux.getMetaData()
- lux.getModelSets()
- lux.getOS()
- lux.getObjectMaterial()
- lux.getObjects()
- lux.getRenderEngine()
- lux.getRenderLayers()
- lux.getRenderOptions()
- lux.getSceneInfo()
- lux.getSceneTree()
- lux.getSphericalCamera()
- lux.hasContents()
- lux.importMaterials()
- lux.isCameraUnsaved()
- lux.isHeadless()
- lux.isPaused()
- lux.isPerformanceModeEnabled()
- lux.isSceneChanged()
- lux.loadMaterials()
- lux.newCamera()
- lux.newModelSet()
- lux.openFile()
- lux.pause()
- lux.prettyPrint()
- lux.removeCamera()
- lux.removeModelSet()
- lux.renderImage()
- lux.saveCamera()
- lux.setAnimationFrame()
- lux.setAnimationTime()
- lux.setCamera()
- lux.setCameraDirection()
- lux.setCameraDistance()
- lux.setCameraLookAt()
- lux.setCameraPosition()
- lux.setCameraUp()
- lux.setMaterialTemplate()
- lux.setModelSets()
- lux.setObjectMaterial()
- lux.setRenderEngine()
- lux.setSphericalCamera()
- lux.setStandardView()
- lux.sync()
- lux.unpause()
Klassen
- lux.RenderOptions
- lux.SceneNode
- luxmath.Matrix
- luxmath.Vector
Konstante
- lux.EXPORT_3MF
- lux.EXPORT_BAKING
- lux.EXPORT_FBX
- lux.EXPORT_GLTF
- lux.EXPORT_OBJ
- lux.EXPORT_OUTPUT_GEOMETRY_SHADERS
- lux.EXPORT_OUTPUT_TEXTURES
- lux.EXPORT_SINGLE_COLOR
- lux.EXPORT_STL
- lux.EXPORT_SUB_DIV_ADAPTIVE
- lux.EXPORT_SUB_DIV_EDGE_LENGTH
- lux.EXPORT_SUB_DIV_NORMAL
- lux.EXPORT_SUB_DIV_POLYCOUNT
- lux.EXPORT_USD
- lux.EXPORT_VERTEX_COLOR
- lux.NODE_TYPE_ANIMATION
- lux.NODE_TYPE_GROUP
- lux.NODE_TYPE_MODEL
- lux.NODE_TYPE_MODEL_SET
- lux.NODE_TYPE_OBJECT
- lux.RENDER_ENGINE_INTERIOR
- lux.RENDER_ENGINE_INTERIOR_GPU
- lux.RENDER_ENGINE_PRODUCT
- lux.RENDER_ENGINE_PRODUCT_GPU
- lux.RENDER_MODE_ADVANCED
- lux.RENDER_MODE_SAMPLES
- lux.RENDER_MODE_TIME
- lux.RENDER_OUTPUT_EXR
- lux.RENDER_OUTPUT_JPEG
- lux.RENDER_OUTPUT_PNG
- lux.RENDER_OUTPUT_PSD16
- lux.RENDER_OUTPUT_PSD32
- lux.RENDER_OUTPUT_PSD8
- lux.RENDER_OUTPUT_TIFF32
- lux.RENDER_OUTPUT_TIFF8