User Guide Cancel

Spot Colors | Substance 3D Automation ToolKit

Last updated on Oct 13, 2023

Substance 3D home
Home
Command Line Tools
1. Command Line overview
2. sbsbaker
3. sbscooker
4. sbsmtools
  1. sbsmtools overview
  2. sbsmtools command line options
5. sbsmutator
6. sbsrender
7. sbsupdater
  1. sbsupdater overview
  2. sbsupdater command line options
Pysbs - Python API
1. Pysbs - Python API overview
2. Getting started
3. General topics
4. Examples
5. API Content
  1. API Content overview
  2. Substance definitions
    1. Common interfaces
    2. compnode
    3. context projectmgr
    4. graph
    5. mdl
    6. modelgraphindex
    7. params
    8. projectmgrdoc
    9. sbsarchive
    10. sbscommon
      1. connections
      2. gui
      3. nodes
      4. values
    11. sbspreset
    12. sbsproject
    13. substance
  3. Libraries
    1. sbsenum
    2. sbslibrary
    3. sbsbakerslibrary
    4. Helpers
      1. sbscleaner
      2. sbsexporter
      3. sbsgenerator
      4. sbsparser
      5. sbswriter
      6. qtclasses
        
        qtclasses overview
        
        qtvariantreader
        
        qtvariantwriter
      7. psdparser
      8. sbsimpactmanager
      9. batchtools
      10. autograph
        
        ag_functions
        
        ag_layout
        
        ag_types
      11. info_mesh_parser
      12. sbsbaker_info_handlers
      13. sbsrender_render_handlers
      14. output_handlers
      15. spotcolorinfo_handler
      16. thumbnail
      17. batchtools overview
    5. Execution context
      1. context
      2. functions
    6. API Change log
Samples
Setup and Getting Started
Integrations
1. Substance Maya toolset
  1. Substance Maya Toolset overview
  2. Installing
  3. Launching
  4. Baking
  5. Changelog
Changelog overview

Spot Colors

Spot colors with spotcolorinfo ¶

From the 11.1 version Substance Designer and SAT introduced spot colors concept. Spot colors allows users to pick color from color books, like Pantone. In this version several Pantone books are shipped with SD and SAT but it’s also possible to add your own Spot colors books. :link to spotcolors SD doc:

SAT 11.1 has a Spot colors utility batchtool, spotcolorinfo(.exe). This batchtool allows users to get various information for a given Spot color or a color name from a book. It’s split into three sub command:

spotcolorinfo from-names get information from a color and its book name
spotcolorinfo from-ids get information from Spot color ID and a book ID
spotcolorinfo list get a Spot color info list from a book name

Some examples with the color PANTONE Cool Gray 4 U from the book PANTONE solid uncoated:

# --book-color-name  value must be under form <bookname>|<colorname> 
~$ spotcolorinfo from-names --book-color-name "PANTONE solid uncoated|PANTONE Cool Gray 4 U" 
{ 
    "PANTONE solid uncoated|PANTONE Cool Gray 4 U": { 
        "bookid": 3005, 
        "bookname": "PANTONE solid uncoated", 
        "colorengine": "legacy", 
        "colorid": "  CG4U", 
        "colormodel": 0, 
        "colorname": "PANTONE Cool Gray 4 U", 
        "rgba": [ 
            0.7144664525985718, 
            0.7144691944122314, 
            0.714465856552124, 
            1 
        ] 
    } 
} 
 
# --spotcolor  value must be under form <bookid>|<colorid>, colorid is always composed of 6 chars (spaces matters) 
~$ spotcolorinfo from-ids --spotcolor "3005|  CG4U" 
{ 
    "PANTONE solid uncoated|PANTONE Cool Gray 4 U": { 
        "bookid": 3005, 
        "bookname": "PANTONE solid uncoated", 
        "colorengine": "legacy", 
        "colorid": "  CG4U", 
        "colormodel": 0, 
        "colorname": "PANTONE Cool Gray 4 U", 
        "rgba": [ 
            0.7144664525985718, 
            0.7144691944122314, 
            0.714465856552124, 
            1 
        ] 
    } 
} 
 
~$ spotcolorinfo list --book-name "PANTONE solid uncoated" 
{ 
"PANTONE solid uncoated|PANTONE 100 U": { 
    "bookid": 3005, 
    "bookname": "PANTONE solid uncoated", 
    "colorengine": "legacy", 
    "colorid": "  100U", 
    "colormodel": 0, 
    "colorname": "PANTONE 100 U", 
    "rgba": [ 
        0.9859546422958374, 
        0.9317296743392944, 
        0.468885213136673, 
        1 
    ] 
}, 
"PANTONE solid uncoated|PANTONE 101 U": { 
    "bookid": 3005, 
    "bookname": "PANTONE solid uncoated", 
    "colorengine": "legacy", 
    "colorid": "  101U", 
    "colormodel": 0, 
    "colorname": "PANTONE 101 U", 
    "rgba": [ 
        0.9922541975975037, 
        0.9378421306610107, 
        0.4005987346172333, 
        1 
    ] 
} 
...

For each commands, the flag –colorbooks can be used to precise another books collection directory.

It’s also possible to used an ACE color profile to get corresponding Spot color info.

~$ spotcolorinfo from-names --ace --ace-render-intent saturation --ace-working-space srgb --book-color-name "PANTONE solid uncoated|PANTONE Cool Gray 4 U" 
{ 
    "PANTONE solid uncoated|PANTONE Cool Gray 4 U": { 
        "acesettings": { 
            "renderintent": "saturation", 
            "workspace": "srgb" 
        }, 
        "bookid": 3005, 
        "bookname": "PANTONE solid uncoated", 
        "colorengine": "ace", 
        "colorid": "  CG4U", 
        "colormodel": 0, 
        "colorname": "PANTONE Cool Gray 4 U", 
        "rgba": [ 
            0.719413161277771, 
            0.7131832242012024, 
            0.7109392285346985, 
            1 
        ] 
    } 
}

Spot colors with PySBS ¶

PySBS fully supports Spot color, it wraps the spotcolorinfo command line to manipulate Spot color transparently.

Set Compnode’s parameter with Spot color value:

node = graph.getAllFiltersOfKind(sbsenum.FilterEnum.UNIFORM) 
node.setParameterSpotColorValueFromNames("outputcolor", "PANTONE solid uncoated", "PANTONE Cool Gray 4 U") 
node.setParameterSpotColorValueFromIds("outputcolor", "3005", "  CG4U")

Set Graph’s input parameter with Spot color value:

input_param = graph.addInputParameter("spotcolor", sbsenum.WidgetEnum.COLOR_FLOAT4) 
input_param.setSpotColorFromNames('PANTONE solid uncoated', 'PANTONE Cool Gray 4 U') 
input_param.setSpotColorValueFromIds("3005", "  CG4U")

For each set Spot color a SBSParamSpotColorInfo is created as the parameter value, this value can be get:

# compnode 
param = node.getDefinedParameters()[0] 
spotcolorparam = param.getSpotColorInfo() 
info = spotcolorparam.getInfo() 
or_info_as_dict = spotcolorparam.getInfoAsDict() 
 
#graph input param 
param = node.getParameterValue 
input_param = graph.getInputParameter("spotcolor") 
spotcolorparam = in_param.getSpotColorInfo() 
info = spotcolorparam.getInfo() 
or_info_as_dict = spotcolorparam.getInfoAsDict()

SBSParamSpotColorInfo

Adobe

Get help faster and easier

New user?