sbsbakerslibrary module

Content included in sbsbakers module:

• sbsbakersenum module: Definition of all the enumeration used by the baking parameters
  • BakerEnum
  • BakingStructureTagEnum
  • ConverterParamEnum
  • SceneSelectionModeEnum
  • BakerAOAttenuationEnum
  • BakerAOQualityEnum
  • BakerBakingTypeEnum
  • BakerColorGeneratorEnum
  • BakerColorModeEnum
  • BakerColorSourceEnum
  • BakerCurvatureAlgoEnum
  • BakerDistributionEnum
  • BakerFilteringModeEnum
  • BakerFromMeshDistanceWithEnum
  • BakerFromMeshMatchEnum
  • BakerFromMeshSubSamplingEnum
  • BakerInputDirectionEnum
  • BakerMapTypeEnum
  • BakerNormalOrientationEnum
  • BakerOutputFormatEnum
  • BakerPositionAxisEnum
  • BakerPositionModeEnum
  • BakerPositionNormalizationEnum
  • BakerResourceMethodEnum
  • BakerUVSetEnum
• sbsbakersdictionaries module: List of dictionaries related to the bakers
  • getBakerOutputFormatEnum()
  • getBakerOutputFormatName()
  • getBakingStructureTagEnum()
  • getBakingStructureTagName()
  • getConverterParamEnum()
  • getConverterParamName()
  • getDefaultFromCommon()
• sbsbakingparameters module: Definition of the BakingParameters object
  • BakingParameters
    • BakingParameters.addBaker()
    • BakingParameters.addHighDefinitionMeshFromFile()
    • BakingParameters.addHighDefinitionMeshFromResource()
    • BakingParameters.computeUniqueIdentifier()
    • BakingParameters.fromSBSTree()
    • BakingParameters.getBaker()
    • BakingParameters.getNbBakers()
    • BakingParameters.getParameter()
    • BakingParameters.getParameterValue()
    • BakingParameters.getSubMeshColor()
    • BakingParameters.getSubMeshColorHexa()
    • BakingParameters.getSubMeshSelection()
    • BakingParameters.isSubMeshSelected()
    • BakingParameters.moveDownBaker()
    • BakingParameters.moveUpBaker()
    • BakingParameters.removeBaker()
    • BakingParameters.selectBaker()
    • BakingParameters.setFileParameterValueFromPath()
    • BakingParameters.setFileParameterValueFromResource()
    • BakingParameters.setParameterValue()
    • BakingParameters.setSubMeshColorHexa()
    • BakingParameters.setSubMeshSelection()
    • BakingParameters.toSBSOptionList()
• sbsscenedata module: Definition of the SubMeshColor and SubMeshSelection object
  • SubMeshColor
    • SubMeshColor.fromSBSTree()
    • SubMeshColor.getColorHexa()
    • SubMeshColor.setColorHexa()
    • SubMeshColor.toSBSOptionList()
  • SubMeshSelection
    • SubMeshSelection.fromSBSTree()
    • SubMeshSelection.toSBSOptionList()
• sbsbakersdef module (not exposed): Bakers definition
• sbsbakersdefaultprops module (not exposed): Definition of the bakers default properties
• sbsbakingconverterparam module (not exposed): Definition of the BakingConverterParam and BakingGlobalParam objects
  • BakingParam
    • BakingParam.getType()
    • BakingParam.getValue()
    • BakingParam.getValueStr()
    • BakingParam.setValue()
    • BakingParam.isAResourceParam()
    • BakingParam.fromSBSTree()
    • BakingParam.toSBSOptionList()
  • BakingConverterParam
    • BakingConverterParam.toSBSOptionList()
  • BakingGlobalParam
    • BakingGlobalParam.fromSBSTree()
    • BakingGlobalParam.toSBSOptionList()
• sbsbakingconverter module (not exposed): Definition of the BakingConverter object
  • BakingConverter
    • BakingConverter.fromSBSTree()
    • BakingConverter.getAllParameters()
    • BakingConverter.getOverrideState()
    • BakingConverter.getParameter()
    • BakingConverter.getParameterValue()
    • BakingConverter.moveDown()
    • BakingConverter.moveUp()
    • BakingConverter.resetDefaultProperty()
    • BakingConverter.setFileParameterValueFromPath()
    • BakingConverter.setFileParameterValueFromPreviousBaker()
    • BakingConverter.setFileParameterValueFromResource()
    • BakingConverter.setGlobalParams()
    • BakingConverter.setParameterValue()
    • BakingConverter.setSelected()
    • BakingConverter.toSBSOptionList()
    • BakingConverter.updateDefaultProperties()
    • BakingConverter.updateDefaultProperty()

Module sbsbakerslibrary provides the libraries of Bakers and their parameters that are defined in the modules sbsbakersdef and sbsbakingparameters.

• Libraries:

  • __library_Bakers: the library of Bakers, identified by BakerEnum:

    __library_Bakers = {
        sbsbakersenum.BakerEnum.AMBIENT_OCCLUSION             : sbsbakersdef.baker_AMBIENT_OCCLUSION               ,
        sbsbakersenum.BakerEnum.AMBIENT_OCCLUSION_FROM_MESH   : sbsbakersdef.baker_AMBIENT_OCCLUSION_FROM_MESH     ,
        sbsbakersenum.BakerEnum.BENT_NORMALS_FROM_MESH        : sbsbakersdef.baker_BENT_NORMALS_FROM_MESH          ,
        sbsbakersenum.BakerEnum.COLOR_MAP_FROM_MESH           : sbsbakersdef.baker_COLOR_MAP_FROM_MESH             ,
        sbsbakersenum.BakerEnum.CONVERT_UV_TO_SVG             : sbsbakersdef.baker_CONVERT_UV_TO_SVG               ,
        sbsbakersenum.BakerEnum.CURVATURE                     : sbsbakersdef.baker_CURVATURE                       ,
        sbsbakersenum.BakerEnum.CURVATURE_MAP_FROM_MESH       : sbsbakersdef.baker_CURVATURE_MAP_FROM_MESH         ,
        sbsbakersenum.BakerEnum.HEIGHT_MAP_FROM_MESH          : sbsbakersdef.baker_HEIGHT_MAP_FROM_MESH            ,
        sbsbakersenum.BakerEnum.NORMAL_MAP_FROM_MESH          : sbsbakersdef.baker_NORMAL_MAP_FROM_MESH            ,
        sbsbakersenum.BakerEnum.OPACITY_MASK_FROM_MESH        : sbsbakersdef.baker_OPACITY_MASK_FROM_MESH          ,
        sbsbakersenum.BakerEnum.POSITION                      : sbsbakersdef.baker_POSITION                        ,
        sbsbakersenum.BakerEnum.POSITION_MAP_FROM_MESH        : sbsbakersdef.baker_POSITION_MAP_FROM_MESH          ,
        sbsbakersenum.BakerEnum.THICKNESS_MAP_FROM_MESH       : sbsbakersdef.baker_THICKNESS_MAP_FROM_MESH         ,
        sbsbakersenum.BakerEnum.TRANSFERRED_TEXTURE_FROM_MESH : sbsbakersdef.baker_TRANSFERRED_TEXTURE_FROM_MESH   ,
        sbsbakersenum.BakerEnum.WORLD_SPACE_DIRECTION         : sbsbakersdef.baker_WORLD_SPACE_DIRECTION           ,
        sbsbakersenum.BakerEnum.WORLD_SPACE_NORMALS           : sbsbakersdef.baker_WORLD_SPACE_NORMALS
    }
    

sbsbakers.sbsbakerslibrary.getBakerDefaultIdentifier(aBaker)

Get the default string identifier of the given baker (from its ConverterID or identifier)

Parameters:

aBaker (BakerEnum or str (ConverterID or identifier)) – baker identifier

Returns:

the default identifier as a string

sbsbakers.sbsbakerslibrary.getBakerDefinition(aBaker)

Get the definition of the given baker identifier (from its ConverterID or identifier)

Parameters:

aBaker (BakerEnum or str (ConverterID or identifier)) – baker identifier

Returns:

a BakingConverter object if found, None otherwise

sbsbakers.sbsbakerslibrary.getBakerEnum(aBakerID)

Get the enum value of the given baker (from its ConverterID or identifier)

Parameters:

aBakerID (str) – baker ConverterID (ex: ‘BakerMeshConverterGLMapBakerManager.Curvature’) or identifier (ex: ‘Curvature [2]’)

Returns:

the baker as a BakerEnum