Samples

2025-02-09T14:02:09+00:00

Samples

Several sample scripts are provided below to illustrate some of the most common methods of extending Daz Studio and to help get you started developing your own scripts. These samples are provided for use under the CC Attribution 3.0 Unported license. All works derived from these samples must adhere to the terms of the license.

Each script in the samples section provides a linked title above the body of the script. Clicking this title will prompt you to choose a location and a file name to save the sample to. The saved file will include a copyright/license statement and the URL for the page that the sample came from near the top.

General

Timing

Single-Shot Timeout - Creates a single-shot timer that executes a function when that timer reaches its predefined duration.
Wait For Background Progress - Demonstrates how to 'pause' a script while the background progress is active.

General Interface

Simple Input Dialog - Displays an input widget within a simple dialog that has the standard button layout found throughout the application, and reacts according to whether the user accepts or cancels.
Simple Image Dialog - Displays an image within a standard dialog.
Simple Composite Image Dialog - Displays a composite image within a standard dialog.
Simple Image Map Dialog - Displays an image that allows detecting interaction with pixels, a standard dialog.
Simple Popup Menu Dialog - Displays a button with a popup menu within a standard dialog.
Simple Text Browser Dialog - Displays a text browser within a simple dialog that has a slightly modified version of the standard buttons found on dialogs throughout the application.

widget_test - Tests various aspects of the various widget types.

Progress - Causes a modal progress dialog to be displayed and report progress.
Background Progress - Causes the background_progress indicator to be displayed in the Status Bar and report progress.

Dock Area Toggle - Toggles the minimized state of dock areas.

Display Document - Dynamically locates a document in a mapped content directory and then prompts the OS to perform its default handling of the file.

Copy UI from Channel - Copies the interface of another channel (i.e., General Release, Public Build, Publishing Build, Private Build, Dev Build) to the channel of the executing build.

Specific Interface

Set Content Library Container - Sets the active path/container in the Content Library pane.
Create Asset Links - Recursively creates Daz Studio JSON Link (*.djl) files for assets in the selected container (i.e., product, category, etc.) in the Content Library pane.
Mark Selected Assets As New - Marks the selected assets in the Content Library pane as 'new' (untouched).

Environment Backdrop Dialog - Causes the Environment pane to be shown; if docked or shown the pane is shown in place, otherwise the pane is shown in a non-modal dialog.

Active Viewport DrawStyle - Sets the DrawStyle on the active Viewport.

Screen Size FHD - Repositions and resizes the (non-maximized) Main Window of the application to Full HD (FHD) dimensions (see Graphics Display Resolution).

Face Transfer Settings - Displays/Edits the application settings supported by the Face Transfer (WIP) pane for overriding which assets to load (per supported figure generation/gender) when a figure is not selected, when applying a Material(s) Preset, and/or during a save operation.

Education/Assistance

Guide Pages - An overview of the concept behind Guide Pages, and the folder/files used to implement the concept.
Tip Pages - An overview of the concept behind Tip Pages, and the folder/files used to implement the concept.
Lesson Strips - An overview of the concept behind the Lesson Strips, and the folder/files used to implement the concept.
Interactive Lessons - An overview of the Interactive Lesson concept.

Metadata

Stores

Add Store Id - Adds a StoreId to the database so that metadata that defines a product associated with that StoreId can be imported and ultimately show up within the database driven content views.
Remove Store Id - Removes a StoreId from the database.
Store Info - Lists information about the StoreIds in the database.

Products

List Products - Lists products in the database.
List Products Used - Lists products in the database used by an object in the scene.
List Product Files - Lists the relative paths of files in a product.

Get Store Product Data - Retrieves information about a product in the Daz 3D store.

Compatibility Bases

List Compatibility Bases - Lists compatibility bases in the database.

File Input/Output

Save Filters

Save Filter Settings - Allows you to inspect the script accessible settings of each save filter.

Save Filter Template Save - Demonstrates how to save the settings of a save filter to a JSON file.
Save Filter Template Apply - Demonstrates how to read recorded settings for a save filter from a JSON file and use them to control saving from that save filter.
Save Filter Template Batch - Demonstrates how to read recorded settings for a save filter from a JSON file and use them to batch control saving from that save filter.

Save a Scene - Saves a Scene... via script.
Save a Scene Subset - Saves a Scene Subset... via script, with or without displaying its output settings dialog.
Save a Hierarchical Material(s) Preset - Saves a Hierarchical Material(s) Preset... via script, with or without displaying its output settings dialog.
Save a Hierarchical Pose Preset - Saves a dzhierarchicalposeassetfilteraction via script, with or without displaying its output settings dialog.
Save a Wearable(s) Preset - Saves a Wearable(s) Preset... via script, with or without displaying its output settings dialog.
Save a Character Preset - Saves a Character Preset... via script, with or without displaying its output settings dialog.
Save a Properties Preset - Saves a Properties Preset... via script, with or without displaying its output settings dialog.
Save a Shaping Preset - Saves a Shaping Preset... via script, with or without displaying its output settings dialog.
Save a Pose Preset - Saves a Pose Preset... via script, with or without displaying its output settings dialog.
Save a Material(s) Preset - Saves a Material(s) Preset... via script, with or without displaying its output settings dialog.
Save a Shader Preset - Saves a Shader Preset... via script, with or without displaying its output settings dialog.
Save a Camera(s) Preset - Saves a Camera(s) Preset... via script, with or without displaying its output settings dialog.
Save a Light(s) Preset - Saves a Light(s) Preset... via script, with or without displaying its output settings dialog.
Save a Render Settings Preset - Saves a Render Settings Preset... via script.
Save a Simulation Settings Preset - Saves a dzsimulationsettingsassetfilteraction via script.
Save a D-Former(s) Preset - Saves a D-Former(s) Preset... via script, with or without displaying its output settings dialog.
Save a Layered Image(s) Preset - Saves a Layered Image(s) Preset... via script, with or without displaying its output settings dialog.

Support Assets

Save Scene Asset(s) - Saves a Scene Asset(s)... via script, with or without displaying its output settings dialog.
Save Figure/Prop Assets - Saves a Figure/Prop Assets... via script, with or without displaying its output settings dialog.
Save Morph Asset(s) - Saves a Morph Asset(s)... via script, with or without displaying its output settings dialog.
Save UV Asset(s) - Saves a UV Asset(s)... via script, with or without displaying its output settings dialog.
Save Shader Definition Asset - Saves a Shader Definition Asset... via script, with or without displaying its output settings dialog.

Extract Figure/Prop Asset Base Data - Extracts values for the “Base Data Folder” fields in the Figure/Prop output settings dialog from a node.

Importers

Importer Settings - Allows you to inspect the script accessible settings of each importer.

Silent OBJ Import - Imports a Wavefront Object (*.obj), without displaying the importer settings dialog.
Silent FBX Import - Imports an Autodesk FBX file, without displaying the importer settings dialog.

Silent OBJ Morph Loader Import - Uses the Wavefront Object (*.obj) importer to provide options for loading a directory full of morph targets and control the Morph Loader Pro plugin without displaying the its option dialog.

Exporters

Exporter Settings - Allows you to inspect the script accessible settings of each exporter.

Silent OBJ Export - Exports a Wavefront Object (*.obj), without displaying the exporter settings dialog.
Silent FBX Export - Exports an Autodesk FBX file, without displaying the exporter settings dialog.

Export TriAx to Poser - Exports a TriAx Weight Mapped figure (e.g., Genesis) to Poser 9 and/or Pro 2012, without displaying the settings dialog for the Poser Character (*.cr2) exporter or the Wavefront Object (*.obj) exporter.

Conversion

DSA Converter - Converts ascii scripts (*.dsa) to their binary (*.dsb) or encrypted (*.dse) counterpart.

Locating

File Listing - Recursively lists the files in a folder.
List Relative Paths - Lists the relative paths of files across mapped content directories.
File Find - Find the absolute path of a content file using a relative path.

Copying

File Copying - Recursively lists files in a folder (e.g., Figure Metrics configuration files, part of the Measure Metrics product) and recursively copies them to another folder.

Directory Mapping

Save Mapped Paths - Produces another script that will clear any currently mapped content directories and subsequently set the mapped content directories to those that were mapped at the time the script was saved.

Install Manager Config (from DAZ Studio) - Parses information from an .ini file, converts it into a JSON object, provides a dialog that allows a user to select options that modify the data, and then converts the data back into its original form as it writes it back to the .ini file.
Install Manager Config (to DAZ Studio) - Parses information from an .ini file, converts it into a JSON object, provides a dialog that allows a user to select options for importing the data, and then modify the application settings to incorporate the data.

Actions

Action Accelerators - Lists the keyboard accelerators (aka “shortcuts”) for all known actions in a modal dialog.
Find Action Classname - Finds the classname of an action using its label.
Action Trigger - Demonstrates how to trigger an action, with and without settings to control the behavior of the action.

Create Custom Action - Creates a custom action and adds it to a menu.

Action Menu Submenu - Creates a hierarchical submenu with a specified path if it does not exist, or finds a submenu at a specified path if it does exist, and positions the submenu within the parent menu immediately below a specified action or menu.

View Tools

Find View Tool Classname - Finds the classname of a view tool using its label.
Set Universal View Tool Coordinate Space - Sets the active view tool to a Universal tool and sets the coordinate space for the tool.
Toggle Universal View Tool Snapping - Toggles snapping on a Universal tool.

Elements

Remove Prefixed Data - A script that walks the scene looking for data (in the form of nodes, properties, and element data items), and removes them.

Post-Load Data Items

post_load_file_data_item_add - Stores data on an element and causes a file to be loaded after that element has been loaded.

Post-Load Script Data Item Add - A script that stores data on an element in the scene, which when re-loaded causes a script to be executed, and uses settings embedded in the data item to control how.
Post-Load Script Data Item Read - A companion script to the script above that executes after the element has been loaded and uses settings embedded in the data item to control its execution.

Post-Load View Proxy Create - A script that creates proxy nodes in the scene for each of the predefined view cameras, creates several properties on the proxy nodes that correspond with properties on the view cameras and links the properties on the view cameras to the corresponding properties on the proxy nodes. The script also embeds post-load data on each proxy node which causes a script to be executed after that node has been loaded into the scene in order to re-establish the links between the properties which are not otherwise saved.
Post-Load View Proxy Link Properties - A companion script to the script above that executes when a proxy node has been loaded and uses settings embedded in the post-load data item to re-establish links between its properties and the corresponding properties on the corresponding view camera.

Post-Load Material Proxy Create - A script that creates proxy properties on a node for a given set of properties on a surface and links the properties on the surface to the corresponding properties on the node, so that the surface properties can be animated. The script also embeds post-load data on the node which causes a script to be executed after that node has been loaded into the scene in order to re-establish the links between the properties which are not otherwise saved.
Post-Load Material Proxy Link Properties - A companion script to the script above that executes when a node has been loaded and uses settings embedded in the post-load data item to re-establish links between proxy properties on the node and the corresponding properties on the surface.

Post-Load Callbacks

Nodes

Create Node - Creates a node in the scene.

Create Instance - Creates an Instance of the primary selected object in the scene.
Create Instance Group - Creates an Instance Group of the primary selected Instance in the scene and any Instance siblings with the same target and mode.

Create Geometry Shell - Creates a Geometry Shell of the primary selected object in the scene and sets the offset distance of the Push Modifier that is automatically added.

Convert Figure to Props - Converts a complete figure into a collection of props, without any exporting/importing.

Node FaceGroup Map - Reveals the face group on a mesh that is associated with a given node; used to provide node selection in the viewport using the geometry for the object.

Adjust Rigging to Shape - Adjusts the positions of a figure's bones based on the difference between the default shape and the current shape.
Node Origin Center - Adjusts the origin of a node to the center of its local bounding box.

Node Align - Adjusts the positions of nodes in the scene in order to align them according to settings that correspond to those found on the Align (WIP) pane.

Node Visibility Toggle - Demonstrates the toggling of a setting (in this case, visibility) on selected nodes.

Materials

Deep Copy - Performs a “deep copy” of one material to another.
Select by Tag - Selects materials that have a particular tag.

Properties

Node Properties - Allows you to access all properties associated with a given node.
Node Property Presentations - Allows you to change colors used by all properties associated with a given node.
Node Property Sliders - Dynamically creates sliders for specific properties associated with a given node.
ERC Freeze - 'Freezes' (links) the current state of numeric properties on a node (or multiple nodes) to a controller property.

Material Properties - Allows you to access all properties associated with a given material.
Texture Modifier - Creates texture modifiers for material properties with images that cause the color of those images to toggle between normal/inverted.

set_property_groups - Arranges specific properties into groups.

Geometry

Geometry Info - Prints geometry information for the selected node.

generate_cube - Generates a geometric cube, demonstrating use of the geometry pipeline.
Generate Cylinder - Generates a geometric cylinder, demonstrating use of the geometry pipeline.
generate_cone - Generates a geometric cone, demonstrating use of the geometry pipeline.
Generate Sphere - Generates a geometric sphere, demonstrating use of the geometry pipeline.
generate_torus - Generates a geometric torus, demonstrating use of the geometry pipeline.
Generate Plane - Generates a geometric plane, demonstrating use of the geometry pipeline.

Generate Polyline Wireframe - Generates polylines for each (selected) edge of a mesh, demonstrating use of the geometry pipeline.
Generate Polyline Dynamic Surface AddOn - Generates polylines between 2 selected vertices of a mesh, demonstrating use of the geometry pipeline.

Geometry Triangulate - Converts geometry constructed of quadrilaterals into geometry constructed of adjacent triangles (both visually and in order of facet indices).
Geometry Detriangulate - Converts geometry constructed of adjacent triangles (both visually and in order of facet indices) into geometry constructed of quadrilaterals.

Modifiers

spawn_morph - Creates a morph target from the current state of the (base) mesh.

list_empty_morphs - Lists the morph targets that have no direct affect on the mesh.

unload_unused_morphs - Unloads the morph targets that are not currently in use.

Images

Create Layered Image Backdrop - Creates a layered image and assigns it to the scene backdrop.

Animating

Scene Time - Demonstrates fundamental calculations for working with time in Daz Studio.

Simulating

Simulation Settings - Find Property - Allows you to retrieve a property displayed in the Simulation Settings pane, for the active simulation engine, using its name so that you can then modify its value.

Simulate Selected Group - Performs a custom simulation where the only participants are the selected nodes in the scene (and if a group node, all child nodes of the group).

Rendering

General

Render Settings - Find Property - Allows you to retrieve a property displayed in the Render Settings pane, for the active renderer, using its name so that you can then modify its value.

Render To RIB - “Renders” to a RenderMan® Interface Bytestream (RIB) file.
Render To Backdrop - Renders to an image that is immediately set as the backdrop.
Render To Viewport - Renders to the viewport.
Render To Asset Icon - Renders to the icon for the asset(s) selected in the Content Library pane.
Render DrawStyle - Performs a hardware render using a named DrawStyle; i.e., “Hidden Line.”

Render Post-Process - Performs a post-processing operation on a render after it has been saved to file.

Calculate Field of View (FOV) - Calculates the FOV of the camera for the active viewport.

NVIDIA Iray

Render Iray Server - Sends a snapshot of the scene to Iray Server.

Scripted (3Delight) Renderer

Scripted Renderer Definition File List - Lists the definition files displayed in the Render Script property menu(s) of the Scripted Renderer.

Scripted Renderer Settings - Changes the active renderer to DzScriptedRenderer and then sets the definition file for it.
Scripted Renderer Save Preset - Generates a script based “Preset” for DzScriptedRenderer, based on the current definition file and property values.

scripted_renderer_load - Prepares the DzScriptedRenderer for rendering operations.
scripted_renderer_pass - Controls the rendering process for the DzScriptedRenderer.

Custom Shaders

Presets

constant_shader_preset - The source for a Shader Preset that applies a DzShaderMaterial definition (below) for the standard RenderMan Constant Surface Shader. The file is as written by the SaveFilter at File > Save As > Deprecated > Shader Preset (.ds*)....

Material Definitions

constant_material_definition - The source for a material definition script, a support file required by the Shader Preset sample linked above, that builds the DzRSLShader objects that interface with a shader.
example_material_definition - The source for an example material definition script, showing shader object creation.

Shader Definitions

constant_shader_definition - The source for a shader definition script, a support file required by the Material Definition sample linked above, that builds the properties accessible to users, in the UI, via the Surface tab.
example_shader_definition - The source for an example shader definition script, showing property creation for passing tokens to the shader and alternatively for use in setting attributes via the rendertime script(s).

Shaders

constant_surface_shader - The RenderMan Shading Language (RSL) source for the standard RenderMan Constant Surface Shader.

Render-Time

default_rendertime_script - The source for a render time script, a support file required by the sample linked above, that sets object attributes.

Core Functionality

point_at - Mimicks the Point At functionality, via the context menu for the Viewport, in Daz Studio.
move_to_floor - Mimicks the Move To Floor functionality in Daz Studio.
Aim Camera - Mimicks the Aim at Selection functionality in Daz Studio.
Frame Camera - Mimicks the Frame Selection functionality in Daz Studio.

Plugins

Plugins Load Config - Sets whether or not specific plugins should load when the application starts.

Tools

Calculator - The source for a calculator, written completely using DAZ Script' intrinsic types.

Utilities

Version Conversion - Converts a Daz Studio version string into its 32 and 64 bit hexadecimal and decimal values.

Remote Operation

Sub Script - Remotely executes another script, passing in predefined arguments to control the operation of the target script.

Symmetrize - No Dialog - Remotely executes the Symmetrize script, silently, by passing in predefined arguments to control the operation of the script without displaying its dialog.

Bake To Transforms - No Dialog - Remotely executes the Bake To Transforms script, silently, by passing in predefined arguments to control the operation of the script without displaying its dialog.

Figure Metrics - No Dialog - Remotely executes the Figure Metrics script, included as part of the Measure Metrics product, by passing in predefined arguments to control the operation of the script without displaying its dialog.

Extract Data From Products Used - Remotely executes the List Products Used script, and optionally the Zip Compress Each script, silently, by passing in predefined arguments to control the operation of the script and extracts data.

Documentation Center public:software:dazstudio:4:referenceguide:scripting:api_reference:samples

Samples

Samples

General

Timing

General Interface

Specific Interface

Education/Assistance

Metadata

Stores

Products

Categories

Compatibility Bases

File Input/Output

Save Filters

Support Assets

Importers

Exporters

Conversion

Locating

Copying

Archives

Directory Mapping

Actions

View Tools

Elements

Post-Load Data Items

Post-Load Callbacks

Nodes

Materials

Properties

Geometry

Modifiers

Images

Animating

Simulating

Rendering

General

NVIDIA Iray

Scripted (3Delight) Renderer

Custom Shaders

Presets

Material Definitions

Shader Definitions

Shaders

Render-Time

Core Functionality

Plugins

Tools

Utilities

Remote Operation