- Substance 3D home
- Home
- Command Line Tools
- Command Line overview
- sbsbaker
- sbscooker
- sbsmtools
- sbsmutator
- sbsrender
- sbsupdater
- Command Line overview
- Pysbs - Python API
- Pysbs - Python API overview
- Getting started
- General topics
- Examples
- API Content
- API Content overview
- Substance definitions
- Common interfaces
- compnode
- context projectmgr
- graph
- mdl
- modelgraphindex
- modelannotationnames
- modelgraph
- modelgraphgenerator
- modelgraphimplementation
- modelnodenames
- modeloperand
- modulegraphindex
- moduleannotation
- moduleconnection
- modulegraph
- modulegraphgenerator
- modulegraphimplementation
- modulegraphlibrary
- modulegraphregister
- modulenode
- modulenodeimplementation
- modulenodeinstance
- moduleoperand
- moduleoutputbridging
- moduleparaminput
- params
- projectmgrdoc
- sbsarchive
- sbscommon
- sbspreset
- sbsproject
- substance
- Libraries
- sbsenum
- sbslibrary
- sbsbakerslibrary
- Helpers
- Execution context
- API Change log
- Samples
- Setup and Getting Started
- Integrations
- Substance Maya toolset
- Changelog overview
batchtools
Content included in batchtools package:
batchtools.batchtools.sbsbaker_ambient_occlusion(*pargs, **kwargs)
Launch process sbsbaker ambient-occlusion
..
The call is done by subprocess.Popen
from the standard library. This function accepts the same keyword arguments. The other possible keywords arguments correspond to the possible options to give to sbsbaker ambient-occlusion
, with dashes -
replaced with underscores _
and with the leading --
or -
removed. Run sbsbaker ambient-occlusion --help
to see the list of possible options.
Parameters: |
|
---|---|
Returns: | The popen object used to call the command |
batchtools.batchtools.sbsbaker_ambient_occlusion_from_mesh(*pargs, **kwargs)
Launch process sbsbaker ambient-occlusion-from-mesh
with given positional arguments and options.
The call is done by subprocess.Popen
from the standard library. This function accepts the same keyword arguments. The other possible keywords arguments correspond to the possible options to give to sbsbaker ambient-occlusion-from-mesh
, with dashes -
replaced with underscores _
and with the leading --
or -
removed. Run sbsbaker ambient-occlusion-from-mesh --help
to see the list of possible options.
Parameters: |
|
---|---|
Returns: | The popen object used to call the command |
batchtools.batchtools.sbsbaker_bent_normal_from_mesh(*pargs, **kwargs)
Launch process sbsbaker bent-normal-from-mesh
with given positional arguments and options.
The call is done by subprocess.Popen
from the standard library. This function accepts the same keyword arguments. The other possible keywords arguments correspond to the possible options to give to sbsbaker bent-normal-from-mesh
, with dashes -
replaced with underscores _
and with the leading --
or -
removed. Run sbsbaker bent-normal-from-mesh --help
to see the list of possible options.
Parameters: |
|
---|---|
Returns: | The popen object used to call the command |
batchtools.batchtools.sbsbaker_color_from_mesh(*pargs, **kwargs)
Launch process sbsbaker color-from-mesh
with given positional arguments and options.
The call is done by subprocess.Popen
from the standard library. This function accepts the same keyword arguments. The other possible keywords arguments correspond to the possible options to give to sbsbaker color-from-mesh
, with dashes -
replaced with underscores _
and with the leading --
or -
removed. Run sbsbaker color-from-mesh --help
to see the list of possible options.
Parameters: |
|
---|---|
Returns: | The popen object used to call the command |
batchtools.batchtools.sbsbaker_curvature(*pargs, **kwargs)
Launch process sbsbaker curvature
with given positional arguments and options.
The call is done by subprocess.Popen
from the standard library. This function accepts the same keyword arguments. The other possible keywords arguments correspond to the possible options to give to sbsbaker curvature
, with dashes -
replaced with underscores _
and with the leading --
or -
removed. Run sbsbaker curvature --help
to see the list of possible options.
Parameters: |
|
---|---|
Returns: | The popen object used to call the command |
batchtools.batchtools.sbsbaker_curvature_from_mesh(*pargs, **kwargs)
Launch process sbsbaker curvature-from-mesh
with given positional arguments and options.
The call is done by subprocess.Popen
from the standard library. This function accepts the same keyword arguments. The other possible keywords arguments correspond to the possible options to give to sbsbaker curvature-from-mesh
, with dashes -
replaced with underscores _
and with the leading --
or -
removed. Run sbsbaker curvature-from-mesh --help
to see the list of possible options.
Parameters: |
|
---|---|
Returns: | The popen object used to call the command |
batchtools.batchtools.sbsbaker_height_from_mesh(*pargs, **kwargs)
Launch process sbsbaker height-from-mesh
with given positional arguments and options.
The call is done by subprocess.Popen
from the standard library. This function accepts the same keyword arguments. The other possible keywords arguments correspond to the possible options to give to sbsbaker height-from-mesh
, with dashes -
replaced with underscores _
and with the leading --
or -
removed. Run sbsbaker height-from-mesh --help
to see the list of possible options.
Parameters: |
|
---|---|
Returns: | The popen object used to call the command |
batchtools.batchtools.sbsbaker_info(*pargs, **kwargs)
Launch process sbsbaker info
with given positional arguments and options.
The call is done by subprocess.Popen
from the standard library. This function accepts the same keyword arguments. The other possible keywords arguments correspond to the possible options to give to sbsbaker info
, with dashes -
replaced with underscores _
and with the leading --
or -
removed. Run sbsbaker info --help
to see the list of possible options.
Parameters: |
|
---|---|
Returns: | The popen object used to call the command or SbsBakerInfoOutputHandler if output_handler=True |
batchtools.batchtools.sbsbaker_info_get_mesh_info(meshPath)
Get the list of materials, entities, and number of UV set of the given mesh and return them as a triplet.
Parameters: | meshPath (str) – Path of the mesh to inspect |
---|---|
Returns: | A triplet: [materials],[entities],nb_of_uvset |
batchtools.batchtools.sbsbaker_normal_from_mesh(*pargs, **kwargs)
Launch process sbsbaker normal-from-mesh
with given positional arguments and options.
The call is done by subprocess.Popen
from the standard library. This function accepts the same keyword arguments. The other possible keywords arguments correspond to the possible options to give to sbsbaker normal-from-mesh
, with dashes -
replaced with underscores _
and with the leading --
or -
removed. Run sbsbaker normal-from-mesh --help
to see the list of possible options.
Parameters: |
|
---|---|
Returns: | The popen object used to call the command |
batchtools.batchtools.sbsbaker_normal_world_space(*pargs, **kwargs)
Launch process sbsbaker normal-world-space
with given positional arguments and options.
The call is done by subprocess.Popen
from the standard library. This function accepts the same keyword arguments. The other possible keywords arguments correspond to the possible options to give to sbsbaker normal-world-space
, with dashes -
replaced with underscores _
and with the leading --
or -
removed. Run sbsbaker normal-world-space --help
to see the list of possible options.
Parameters: |
|
---|---|
Returns: | The popen object used to call the command |
batchtools.batchtools.sbsbaker_opacity_mask_from_mesh(*pargs, **kwargs)
Launch process sbsbaker opacity-mask-from-mesh
with given positional arguments and options.
The call is done by subprocess.Popen
from the standard library. This function accepts the same keyword arguments. The other possible keywords arguments correspond to the possible options to give to sbsbaker opacity-mask-from-mesh
, with dashes -
replaced with underscores _
and with the leading --
or -
removed. Run sbsbaker opacity-mask-from-mesh --help
to see the list of possible options.
Parameters: |
|
---|---|
Returns: | The popen object used to call the command |
batchtools.batchtools.sbsbaker_position(*pargs, **kwargs)
Launch process sbsbaker position
with given positional arguments and options.
The call is done by subprocess.Popen
from the standard library. This function accepts the same keyword arguments. The other possible keywords arguments correspond to the possible options to give to sbsbaker position
, with dashes -
replaced with underscores _
and with the leading --
or -
removed. Run sbsbaker position --help
to see the list of possible options.
Parameters: |
|
---|---|
Returns: | The popen object used to call the command |
batchtools.batchtools.sbsbaker_position_from_mesh(*pargs, **kwargs)
Launch process sbsbaker position-from-mesh
with given positional arguments and options.
The call is done by subprocess.Popen
from the standard library. This function accepts the same keyword arguments. The other possible keywords arguments correspond to the possible options to give to sbsbaker position-from-mesh
, with dashes -
replaced with underscores _
and with the leading --
or -
removed. Run sbsbaker position-from-mesh --help
to see the list of possible options.
Parameters: |
|
---|---|
Returns: | The popen object used to call the command |
batchtools.batchtools.sbsbaker_run(*pargs, **kwargs)
Launch process sbsbaker run
with given positional arguments and options.
The call is done by subprocess.Popen
from the standard library. This function accepts the same keyword arguments. The other possible keywords arguments correspond to the possible options to give to sbsbaker run
, with dashes -
replaced with underscores _
and with the leading --
or -
removed. Run sbsbaker run --help
to see the list of possible options.
Parameters: |
|
---|---|
Returns: | The popen object used to call the command |
batchtools.batchtools.sbsbaker_texture_from_mesh(*pargs, **kwargs)
Launch process sbsbaker texture-from-mesh
with given positional arguments and options.
The call is done by subprocess.Popen
from the standard library. This function accepts the same keyword arguments. The other possible keywords arguments correspond to the possible options to give to sbsbaker texture-from-mesh
, with dashes -
replaced with underscores _
and with the leading --
or -
removed. Run sbsbaker texture-from-mesh --help
to see the list of possible options.
Parameters: |
|
---|---|
Returns: | The popen object used to call the command |
batchtools.batchtools.sbsbaker_thickness_from_mesh(*pargs, **kwargs)
Launch process sbsbaker thickness-from-mesh
with given positional arguments and options.
The call is done by subprocess.Popen
from the standard library. This function accepts the same keyword arguments. The other possible keywords arguments correspond to the possible options to give to sbsbaker thickness-from-mesh
, with dashes -
replaced with underscores _
and with the leading --
or -
removed. Run sbsbaker thickness-from-mesh --help
to see the list of possible options.
Parameters: |
|
---|---|
Returns: | The popen object used to call the command |
batchtools.batchtools.sbsbaker_uv_map(*pargs, **kwargs)
Launch process sbsbaker uv-map
with given positional arguments and options.
The call is done by subprocess.Popen
from the standard library. This function accepts the same keyword arguments. The other possible keywords arguments correspond to the possible options to give to sbsbaker uv-map
, with dashes -
replaced with underscores _
and with the leading --
or -
removed. Run sbsbaker uv-map --help
to see the list of possible options.
Parameters: |
|
---|---|
Returns: | The popen object used to call the command |
batchtools.batchtools.sbsbaker_world_space_direction(*pargs, **kwargs)
Launch process sbsbaker world-space-direction
with given positional arguments and options.
The call is done by subprocess.Popen
from the standard library. This function accepts the same keyword arguments. The other possible keywords arguments correspond to the possible options to give to sbsbaker world-space-direction
, with dashes -
replaced with underscores _
and with the leading --
or -
removed. Run sbsbaker world-space-direction --help
to see the list of possible options.
Parameters: |
|
---|---|
Returns: | The popen object used to call the command |
batchtools.batchtools.sbscooker(*pargs, **kwargs)
Launch process sbscooker
with given positional arguments and options.
The call is done by subprocess.Popen
from the standard library. This function accepts the same keyword arguments. The other possible keywords arguments correspond to the possible options to give to sbscooker
, with dashes -
replaced with underscores _
and with the leading --
or -
removed. Run sbscooker --help-advanced
to see the list of possible options.
Parameters: |
|
---|---|
Returns: | The popen object used to call the command |
batchtools.batchtools.sbsmtools_export(*pargs, **kwargs)
Launch process sbsmtools export
with given positional arguments and options.
The call is done by subprocess.Popen
from the standard library. This function accepts the same keyword arguments. The other possible keywords arguments correspond to the possible options to give to sbsmtools export
, with dashes -
replaced with underscores _
and with the leading --
or -
removed. Run sbsrender info --help
to see the list of possible options.
Parameters: |
|
---|---|
Returns: | The popen object used to call the command |
batchtools.batchtools.sbsmutator_edit(*pargs, **kwargs)
Launch process sbsmutator edit
with given positional arguments and options.
The call is done by subprocess.Popen
from the standard library. This function accepts the same keyword arguments. The other possible keywords arguments correspond to the possible options to give to sbsmutator edit
, with dashes -
replaced with underscores _
and with the leading --
or -
removed. Run sbsmutator edit --help
to see the list of possible options.
Parameters: |
|
---|---|
Returns: | The popen object used to call the command |
batchtools.batchtools.sbsmutator_export(*pargs, **kwargs)
Launch process sbsmutator export
with given positional arguments and options.
The call is done by subprocess.Popen
from the standard library. This function accepts the same keyword arguments. The other possible keywords arguments correspond to the possible options to give to sbsmutator export
, with dashes -
replaced with underscores _
and with the leading --
or -
removed. Run sbsmutator export --help
to see the list of possible options.
Parameters: |
|
---|---|
Returns: | The popen object used to call the command |
batchtools.batchtools.sbsmutator_info(*pargs, **kwargs)
Launch process sbsmutator info
with given positional arguments and options.
The call is done by subprocess.Popen
from the standard library. This function accepts the same keyword arguments. The other possible keywords arguments correspond to the possible options to give to sbsmutator info
, with dashes -
replaced with underscores _
and with the leading --
or -
removed. Run sbsmutator info --help
to see the list of possible options.
Parameters: |
|
---|---|
Returns: | The popen object used to call the command |
batchtools.batchtools.sbsmutator_instantiate(*pargs, **kwargs)
Launch process sbsmutator instantiate
with given positional arguments and options.
The call is done by subprocess.Popen
from the standard library. This function accepts the same keyword arguments. The other possible keywords arguments correspond to the possible options to give to sbsmutator instantiate
, with dashes -
replaced with underscores _
and with the leading --
or -
removed. Run sbsmutator instantiate --help
to see the list of possible options.
Parameters: |
|
---|---|
Returns: | The popen object used to call the command |
batchtools.batchtools.sbsrender_info(*pargs, **kwargs)
Launch process sbsrender info
with given positional arguments and options.
The call is done by subprocess.Popen
from the standard library. This function accepts the same keyword arguments. The other possible keywords arguments correspond to the possible options to give to sbsrender info
, with dashes -
replaced with underscores _
and with the leading --
or -
removed. Run sbsrender info --help
to see the list of possible options.
Parameters: |
|
---|---|
Returns: | The popen object used to call the command |
batchtools.batchtools.sbsrender_render(*pargs, **kwargs)
Launch process sbsrender render
with given positional arguments and options.
The call is done by subprocess.Popen
from the standard library. This function accepts the same keyword arguments. The other possible keywords arguments correspond to the possible options to give to sbsrender render
, with dashes -
replaced with underscores _
and with the leading --
or -
removed. Run sbsrender render --help
to see the list of possible options.
Parameters: |
|
---|---|
Returns: | The popen object used to call the command or SbsRenderOutputHandler if output_handler=True |
batchtools.batchtools.sbsrender_render_animate(input_sbsar, start=0, end=100, output_name=None, fps=24, animated_parameters=(), cmds_output_stream=None, multi_proc=0, **kwargs)
Renders an image sequence from an sbsar input using sbsrender. It takes a start frame, an end frame and frames per second. The sbsrender command line tool will be run once for each frame.
By default the $time will be generated for each frame based on start, end and fps. It is possible to set sbsrender arguments as global frame parameters.
The animated_parameters can be used to tweak other sbsar parameters than $time This argument allow to pass a list of pairs of parameter names and functions taking frame and fps as parameters. e.g: animated_parameters=[(“input”, compute_input)] the value named “input” will be set to the result of calling compute_input(frame, fps). A lambda can also be used be used, e.g: animated_parameters=[(“input”, lambda frame, fps: frame / fps)] Multiple values can be animated by supplying a list of parameters and functions, e.g: animated_parameters=[(“input”, lambda frame, fps: frame / fps), (“other”, a_python_def(frame, fps))]
If setting multi_proc to a non-zero value the rendering will be multi processed in the specified number of processes executing the rendering sequentially frame by frame.
By providing a path to the argument cmds_output_path the sbsrender will not be executed but all command lines will be written in the file. So it possible for instance to dispatch theses command line through a render farm.
Parameters: |
|
---|---|
Returns: | bool, true if all frames succeeded, otherwise false |
batchtools.batchtools.sbsupdater(*pargs, **kwargs)
Launch process sbsupdater
with given positional arguments and options.
The call is done by subprocess.Popen
from the standard library. This function accepts the same keyword arguments. The other possible keywords arguments correspond to the possible options to give to sbsupdater
, with dashes -
replaced with underscores _
and with the leading --
or -
removed. Run sbsupdater --help
to see the list of possible options.
Parameters: |
|
---|---|
Returns: | The popen object used to call the command |
batchtools.batchtools.spotcolorinfo_from_ids(*pargs, **kwargs)
Launch process spotcolorinfo from-ids
with given positional arguments and options.
The call is done by subprocess.Popen
from the standard library. This function accepts the same keyword arguments. The other possible keywords arguments correspond to the possible options to give to sbsrender render
, with dashes -
replaced with underscores _
and with the leading --
or -
removed. Run sbsrender render --help
to see the list of possible options.
Parameters: |
|
---|---|
Returns: | The popen object used to call the command or SpotColorInfoOutputHandler if output_handler=True |
batchtools.batchtools.spotcolorinfo_from_names(*pargs, **kwargs)
Launch process spotcolorinfo from-names
with given positional arguments and options.
The call is done by subprocess.Popen
from the standard library. This function accepts the same keyword arguments. The other possible keywords arguments correspond to the possible options to give to sbsrender render
, with dashes -
replaced with underscores _
and with the leading --
or -
removed. Run sbsrender render --help
to see the list of possible options.
Parameters: |
|
---|---|
Returns: | The popen object used to call the command or SpotColorInfoOutputHandler if output_handler=True |
batchtools.batchtools.spotcolorinfo_list(*pargs, **kwargs)
Launch process spotcolorinfo list
with given positional arguments and options.
The call is done by subprocess.Popen
from the standard library. This function accepts the same keyword arguments. The other possible keywords arguments correspond to the possible options to give to sbsrender render
, with dashes -
replaced with underscores _
and with the leading --
or -
removed. Run sbsrender render --help
to see the list of possible options.
Parameters: |
|
---|---|
Returns: | The popen object used to call the command or SpotColorInfoOutputHandler if output_handler=True |