Module mset

duplicate(name: str = '') -> SceneObject

Duplicates the object, optionally assigning it a new name. Returns the new object.

destroy()

Destroys the object and removes it from the scene.

getChildren() -> List[SceneObject]

Returns a list of all immediate children of the object.

findInChildren(searchStr: str) -> SceneObject

Finds and returns an object with a name matching 'searchStr', parented under this object. The search recursively checks all child objects.

setKeyframe(lerp: str = '', property: str = '')

Sets a keyframe on this object with the assigned interpolation function ("linear", "step", "spline", or "splineBreak"). This setting defaults to editor's default. If no property string is specified, all object properties will be keyframed.

getBounds() -> List[List[float]]

Gets the bounds of this object, or None if it doesn't have any. Formatted as [min_xyz, max_xyz]

name: str The name of the object.

parent: SceneObject The parent of the object.

visible: bool Controls object viewport visibility.

locked: bool Controls the locking of object settings in the user interface.

collapsed: bool Controls the display of the object's children in the outline view.

uid: int The unique identifier of this scene object.

renderImages()

Render all enabled images in this render object.

renderVideos()

Render all enabled videos in this render object.

images: RenderOutputOptions Output configuration for image outputs.

videos: RenderOutputOptions Output configuration for video outputs.

options: RenderOptions Render settings for Full Composite configurations of Toolbag.

cameras: List[mset.RenderCamera] Cameras configured to render with Toolbag.

renderPasses: List[mset.RenderPass] Cameras configured to render with Toolbag.

"drawWireframe": type Enables the rendering of mesh wireframes.

wireframeColor: List[float] Wireframe color as an RGBA array.

shadowQuality: str Shadow quality. Valid values are 'Low', 'High', and 'Mega'.

"rasterUseShadowCascades": type Use cascaded shadow maps for directional lights. This can provide better resolution distribution over larger scenes.

"shadowCascadeDistance": type A bias value for how distance the furthest shadow cascade is from the camera.

"shadowBias": type A bias value for how distance the furthest shadow cascade is from the camera.

"occludeAmbient": type Whether screen space ambient occlusion should occlude ambient light in raster rendering.

"occludeDiffuse": type Whether screen space ambient occlusion should occlude diffuse light in raster rendering.

"occludeSpecular": type Whether screen space ambient occlusion should occlude specular light in raster rendering.

"occlusionStrength": type Whether screen space ambient occlusion should occlude ambient light in raster rendering.

"occlusionSize": type The radius size for occlusion. Can be any number > 0.0.

occlusionMode: str Occlusion mode. Valid values are 'Disabled', 'Screen', 'Raytraced'.

occlusionColor: List[float] The color of the ambient occlusion.

"useReflections": type Whether screen space reflections should be enabled.

"reflectDiffuse": type Whether screen space reflections should be enabled.

"reflectionIntensity": type The level of brightness the reflections have.

"reflectionDiffuseIntensity": type The level of brightness the diffuse reflections have.

"reflectionDiffuseDistance": type The distance diffuse reflections should be allowed to propigate.

renderer: str Whether real time ray tracing is enabled.

"rayTraceCaustics": type Caustics quality when ray tracing.

"rayTraceAdvancedSampling": type Whether advanced sampling is enabled. Reduces noise in scenes with many lights. Has moderate impact on render time and viewport performance.

"rayTraceBounces": type The maximum number of bounces a ray can perform.

"rayTraceTransmissionBounces": type The maximum number of transmission bounces a ray can perform.

"rayTraceDirectRadianceClamp": type The maximum direct brightness allowed when ray tracing. Useful to reduce fireflies.

"rayTraceIndirectRadianceClamp": type The maximum indirect brightness allowed when ray tracing. Useful to reduce fireflies.

"rayTraceDiffuseIntensity": type The base intensity of diffuse interactions. Can be scaled for a more stylistic look.

"rayTraceReflectionIntensity": type The base intensity of reflection interactions. Can be scaled for a more stylistic look.

"rayTraceSampleAccumulation": type The number of samples total allowed to be traced in the viewport each frame.

"rayTraceDenoiseTemporal": type Enables temporal mode for denoising.

rayTraceDenoiseMode: str The current denoising mode. Can be 'off', 'cpu', or 'gpu'.

rayTraceDenoiseQuality: str The current level of denoising quality. Can be 'low', 'medium', or 'high'.

rayTraceDenoiseStrength: float The current level of denoising quality. Is a value between 0.0 and 1.0.

rayTraceVolumetricFogAnisotropy: float The current level of volumetric anisotropy. Is a value between -1.0 and 1.0.

"wireframeCull": type Cull backfaces when rendering wireframes.

"albedoEnergyConservation": type Albedo is energy converving. Applies to the albedo and specular render passes.

"depthDither": type Whether dithering is enabled when rendering depth passes.

"positionDither": type Whether dithering is enabled when rendering position passes.

normalSpace: str The normal space to render when using a Normal render pass. Valid values are 'tangent', 'object', and 'view'.

normalFlipX: bool Whether to flip normal outputs along the X axis.

normalFlipY: bool Whether to flip normal outputs along the Y axis.

normalFlipZ: bool Whether to flip normal outputs along the Z axis.

positionNormalization: str The normal view to render when using a Position render pass. Valid values are 'Bounding Sphere', 'Bounding Box', and 'Disabled'.

depthNormalization: str The normal view to render when using a Depth render pass. Valid values are 'Bounding Sphere', 'Bounding Box', and 'Disabled'.

fogSkyIllumination: float Influence of sky illumination on fog. Is a value between 0.0 and 1.0.

fogLightIllumination: float Influence of light illumination on fog. Is a value between 0.0 and 10.0.

"watermarkEnabled": type Whether the Marmoset watermark is enabled.

"watermarkDark": type Determines if the Marmoset watermark is set to dark mode.

"watermarkColored": type Determines if the Marmoset watermark is set to colored mode.

"watermarkSize": type Size of the watermark relative to the render's minimum side.

watermarkPosition: List[float] The position of the watermark. [0,0] coresponds to top left, and [1,1] corresponds to bottom right.

outputPath: str This output directory.

format: str The output format for this export. can be 'JPEG', 'PNG', 'TGA', 'PSD', 'PSD (16-bit)', 'EXR (16-bit)', 'EXR (32-bit)', 'DDS (16-bit)', 'DDS (32-bit)', 'PFM (32-bit)', 'MP4 Lossless' on MacOS or 'AVI Lossless' on Windows, 'MPEG4', or 'Auto'.

width: int The width of this output.

height: int The height of this output.

samples: int The number of samples used for this output.

compressionQuality: int The level of compression for compressed video file formats like avi. Can be between 0 and 100. Does not apply to image exports.

transparency: bool Whether this output should be transparent or not.

overwrite: bool Whether this output should overwrite the file by the same name.

rayTraceDenoiseMode: str The current denoising mode for this output. Can be 'off', 'cpu', or 'gpu'.

rayTraceDenoiseQuality: str The current level of denoising quality for this output. Can be 'low', 'medium', or 'high'.

rayTraceDenoiseStrength: float The level of contribution the denoiser should have on the final output. Can be any float between 0.0 and 1.0.

enabled: bool If this render pass is enabled when exporting images/videos.

renderPass: str The render pass to be executed when rendering images/videos.

enabled: bool If this camera is enabled when exporting images/videos.

camera: CameraObject The reference to this camera object.

path: str The file path to the backdrop image.

alpha: float The transparency of the backdrop image.

useAlpha: bool Specifies whether or not to use the image's alpha channel.

centerPivot()

Centers the pivot point of this object to its bounding box.

position: List[float] The position of the object, as a list of 3 floats.

rotation: List[float] The rotation of the object, as a list of 3 floats.

scale: List[float] The scale of the object, as a list of 3 floats.

pivot: List[float] The pivot of the object, as a list of 3 floats.

lightType: str The type of the light (valid values are 'directional', 'spot', 'omni'

color: List[float] The color of the light.

useTemperature: bool Enables the use of color temperature on this light source.

temperature: float The black body color temperature of the light. This value is in degrees Kelvin, in the range 1,000 to 10,000. This setting only takes effect when enabled (see useTemperature).

brightness: float The brightness of the light.

lengthX: float The length along the X axis of the light source.

lengthY: float The length along the Y axis of the light source.

width: float The radius of the light source.

spotAngle: float The spot angle, in degrees, for use by spot lights only.

spotSharpness: float The sharpness of the spotlight shape, for use by spot lights only.

spotVignette: float The degree of spotlight vignette, for use by spot lights only.

castShadows: bool Enables the casting of shadows by the light.

visibleShape: bool Makes the light source shape visible in final renders.

gelPath: str Path of image to mask light shape.

gelTile: float Tiling scalar for the gel texture.

castLensFlare: bool Determines whether or not this light casts lens flare.

lensFlareStrength: float Sets the lens flare strength of the light.

useLimitsInViewport: bool Enables use of camera motion limits in the viewport.

panLimit: str Limits the panning to either the Y-axis or completly (valid values are: 'Off', 'YAxis', 'Locked').

nearLimitEnabled: bool Enables the near orbit distance limit.

nearLimit: float The near orbit limit distance.

farLimitEnabled: bool Enables the far orbit distance limit.

farLimit: float The far orbit limit distance.

pitchLimitEnabled: bool Enables the pitch angle limit.

pitchLimitMin: float The minimum pitch angle, in degrees.

pitchLimitMax: float The maximum pitch angle, in degrees.

yawLimitEnabled: bool Enables the yaw angle limit.

yawLimitMin: float The minimum yaw limit angle, in degrees.

yawLimitMax: float The maximum yaw limit angle, in degrees.

yawLimitOffset: float The offset of the yaw limit angle, in degrees.

safeFrameEnabled: bool Displays the safe frame in the viewport.

safeFrameOpacity: float Opacity of the safe frame display.

dofMode: int Specifies the depth of field mode: 0 = off, 1 = post effect, 2 = ray traced.

dofEnabled: bool Enables the depth of field effect. This is a legacy variable, consider using 'dofMode' instead.

dofFocusDistance: float Focal distance of the depth of field.

dofStop: float F-stop value for controlling depth of field. Smaller values are blurrier.

dofAnamorphicRatio: float Anamorphic lens ratio for horizontal distortion of depth of field.

dofAperture: str Path of the aperture shape texture file.

dofApertureRotation: float Rotation of the aperture shape texture.

distortionBarrel: float Strength of the barrel distortion effect.

distortionChromaticAberration: float Strength of the chromatic aberration effect.

distortionCARed: float Strength of the chromatic aberration in the red component.

distortionCAGreen: float Strength of the chromatic aberration in the green component.

distortionCABlue: float Strength of the chromatic aberration in the blue component.

lensFlareStrength: float Sets the intensity of the lens flare effect.

lensFlareCoating: float Adds coating to the entire lens system, causing lens flare more apparent.

lensFlareSize: float Sets the size of the individual flares or "ghosts".

motionBlurEnable: bool Toggles motion blur effect for final render animations and stills.

motionBlurEnableLoopingAnimation: bool Toggles last frame to wrap back to the first frame for future frame accumulation.

motionBlurShutterSpeed: float Determine the intensity or length of the blur. Usually the shutter speed on a camera is represented in fractions of a second, ie: 1/60, 1/120, 1/250, etc.

motionBlurSamples: unsigned int Control the quality of the motion blur/how smooth the blur is.

toneMappingMode: str Tone mapping mode (allowed values are: 'linear', 'reinhard', 'hejl', 'aces', 'agx')

exposure: float Exposure multiplier.

contrast: float Contrast multiplier.

contrastCenter: float A value above which color values are brightened, and below which color values are darkened to achive the contrast effect.

saturation: float Adjusts the intensity of color saturation (default is 1.0).

sharpen: float Strength of the edge sharpening effect.

sharpenLimit: float A numerical limit on the stength of the edge sharpening effect.

bloomBrightness: float Brightness multiplier for the bloom effect.

bloomSize: float Size scalar for the bloom effect.

vignetteStrength: float Strength multiplier for the vignette effect.

vignetteSoftness: float Softness scalar for the vignette effect.

filmGrainMode: str Sets the style of grain. (allowed values are: 'Off', 'Film', 'Digital')

filmGrainPreview: bool Toggles randomized preview of the grain effect.

filmGrainIntensity: float Sets the strength of the grain effect.

filmGrainTilingMode: str Sets the texture or coarseness of the grain effect. (allowed values are: 'Fine', 'Medium', 'Coarse')

filmGrainDirtIntensity: float Sets the overall opacity of the scratches and stains.

filmGrainDirtDensity: float Controls the amount scratches and stains visible in each frame.

filmGrainDirtSize: float Controls the size of scratches and stains.

highlights: float Adjusts the intensity of the highlights. Range: [-1, 1]

shadows: float Adjusts the intensity of the shadows. Range: [-1, 1]

midtones: float Adjusts the intensity of the midtones. Range: [-1, 1]

clarity: float Adjusts the intensity of the clarity. Range: [-1, 1]

loadPostEffect(path: str)

Load a camera post effect from a file.

savePostEffect(path: str)

Save a camera post effect to a file.

mode: str The mode of this camera, can be 'perspective' or 'orthographic'.

fov: float The vertical field of view of the camera, in degrees.

orbitRadius: float The radius about which the camera orbits. This value won't move the camera directly, but affects orbit behavior when the camera view is rotated.

orthoScale: float The scale of this camera in orthographic mode. Measured in scene units.

focalLength: float The focal length of the camera, in mm.

nearPlaneScale: float A scalar for adjusting the automatic near clipping plane. Lower values will bring the clipping closer to the camera, but can result in unstable depth for the rest of the scene.

limits: CameraLimits The camera limits settings.

lens: CameraLens The camera lens settings.

postEffect: CameraPostEffect The camera post effect settings.

skyShadow: bool Enables receiving shadow from the sky light (ray tracing only).

indirectShadow: bool Enables receiving shadow from the sky light (ray tracing only).

edgeFade: bool Enables a fading of shadow opacity towards the edges of the shadow catcher plane.

fadeRadius: float Radius of the edge fade effect.

fadeFalloff: float Falloff of the edge fade effect.

fadeTexturePath: str File path of the fade texture, which is used to control the shadow fade pattern.

textureChannel: str The active channel in the fade texture (must be one of: 'R', 'G', 'B', 'A').

opacity: float The opacity of the shadow catcher.

roughness: float Specifies the maximum roughness value.

roughnessTexturePath: str The texture used to specify surface roughness. White corresponds to a rough surface while black corresponds to smooth surfaces.

roughnessTextureChannel: str Determines the channel of the texture from which to read roughness content (must be one of: 'R', 'G', 'B', 'A').

invertRoughness: bool Inverts the output of the roughness shader. Useful for loading gloss maps in place of roughness maps.

specularIntensity: float Sets the intensity of the specular reflections.

specularFresnel: float Sets the intensity of the Fresnel effect, or how reflective surfaces are at grazing angles.

specularTexturePath: str The texture that will be used to set the color and intensity of the specular reflections.

specularTextureChannel: str Determines the channel of the texture from which to read specular content (must be one of: 'R', 'G', 'B', 'A').

computeProcedural()

importImage(path: str)

Imports an image to use for this skybox.

loadSky(path: str)

Loads a .tbsky file in place of the current sky.

saveSky(path: str)

Saves the current sky to the specified file path as a .tbsky archive.

renderPreview(width: int, height: int) -> Image

Renders the sky background, in latitude-longitude format, to a preview image. Returns an Image instance.

clearLightChildren()

Clears all light children of this skybox.

brightness: float The brightness of the skybox.

rotation: float The current rotation angle of the skybox.

backgroundBrightness: float The brightness of the skybox background.

blur: float The amount of blurring for the background.

mode: str The background mode. Can be 'color', 'sky', 'blurred sky', or 'ambient sky'.

backgroundColor: List[float] The background color when rendering with the skybox mode set to 'color'.

childLightBrightness: float The brightness of child lights on this skybox object.

time: float Time of day, in hours, generally from 0 to 24, although values outside this range will also work. Only applies to procedural skies.

day: int Day of year, from 1 to 365. Only applies to procedural skies.

timeZone: int Time zone, specified in hours offset from UTC. Only applies to procedural skies.

latitude: float Degrees latitude on earth, from -90 south to 90 north. Only applies to procedural skies.

longitude: float Degrees longitude on earth, from -180 west to 180 east. Only applies to procedural skies.

turbidity: float A value from 0 to 1 which controls the particulate density in the atmosphere. Only applies to procedural skies.

sunBrightness: float Scales the apparent brightness of the sun, relative to the sky. A value of 1 is most realistic. Only applies to procedural skies.

sunScale: float Scales the apparent size of the sun. A value of 1 is most realistic. Only applies to procedural skies.

groundColorNear: vec Color of the ground plane near the scene. Only applies to procedural skies.

groundColorFar: vec Color of the ground plane near the horizon. Only applies to procedural skies.

saturation: float Color intensity of the sun and sky. Only applies to procedural skies.

whiteBalance: float Color temperature shift of the sun and sky. Only applies to procedural skies.

tint: float Color balance shift of the sun and sky, complementary to white balance. Only applies to procedural skies.

color: List[float] The color of the fog effect, as a list of 3 floats for RGB color.

density: float The density of the fog effect.

opacity: float The maximum opacity of the fog effect.

enabled: bool Enables the active motion of the turntable object.

spinRate: float The rate at which the turntable object rotates, in degrees per second.

triangles: List[float] Mesh triangle indices, as a list of int groups of 3 ( e.g. [0,1,2, 1,3,2] )

polygons: List[int] Mesh polygon groups, as a list of int groups of 2, start and count ( e.g. [0,2, 1,2] )

vertices: List[float] Mesh vertex positions, as a list of float groups of 3 ( e.g. [x,y,z, x,y,z] )

uvs: List[float] Mesh texture coordinates as a list of float groups of 2 ( e.g. [u,v, u,v] )

secondaryUVs: List[float] Mesh secondary texture coordinates, as a list of float groups of 2 ( e.g. [u,v, u,v] )

colors: List[float] Mesh colors, as a list of float groups of 4 ( e.g. [r,g,b,a, r,g,b,a] )

normals: List[float] Mesh normals, as a list of float groups of 3 ( e.g. [x,y,z, x,y,z] )

tangents: List[float] Mesh tangents, as a list of float groups of 3 ( e.g. [x,y,z, x,y,z] )

bitangents: List[float] Mesh bitangents, as a list of float groups of 3 ( e.g. [x,y,z, x,y,z] )

addSubmesh(name: str, material: Material = None, startIndex: int = 0, indexCount: int = -1)

Adds and returns a SubMeshObject to the MeshObject, rendering the specified range of indices. name: Name of the SubMeshObject material: The Material assigned to the submesh. startIndex: The index of the first vertex of the submesh. indexCount: The number of indices following 'startIndex', or -1 to cover all remaining indices in the mesh.

castShadows: bool Enables casting of shadows from the mesh.

cullBackFaces: bool Enables the culling of back faces during render.

tangentSpace: str Mesh tangent space for normal mapping. This must be one of the following values: 'Custom' 'Marmoset', 'Mikk', 'Maya', '3D Studio Max', 'Unity'

fixMirroredTangents: bool Fix tangent issues that arise with mirrored UVs in certain tangent spaces.

mesh: Mesh The mesh containing vertex data.

subdivisionEnabled: bool If subdivisions are enabled or not.

subdivisionLevel: bool If this object isn't visible to the camera. Useful for emissive surfaces you may want hidden.

subdivisionMode: str The method used for subdivision. Can be 'Catmull-Clark', 'Regular', or 'PN Triangles'.

subdivisionSharpenCorners: bool If corners should be sharp when subdividing. Helps keep the shape of your mesh with catmull-clark subdivisions.

subdivisionSmoothing: float The level of smoothing that should be done with PN Triangle subdivision.

subdivisionWireframeMode: str How wireframes should look with subdivisions. Can be 'Isolines' or 'Polygons'.

subdivisionGeometryReduction: str The level of geometry decimation that should be done while subdividing. Helps with real time performance.

invisibleToCamera: bool If this object isn't visible to the camera. Useful for emissive surfaces you may want hidden.

startIndex: int The first index of the submesh.

indexCount: int The index count of the submesh.

material: Material The material assigned to the submesh.

addColor(color: List[float], position: float, weight: float)

Adds a color to this gradient.

setColor(index: int, color: List[float], weight: float)

Sets a given color of this gradient.

getColor(index: int) -> Tuple[List[float], float]

Gets a color of this gradient.

getColorCount() -> int

Gets the number of colors this gradient has.

reset()

Resets this gradient to a default configuration (black to white).

setLevel(color: str, black: float, gamma: float, white: float, outputBlack: float, outputWhite: float)

Configures this level.

getHandle(color: str) -> List[float]

Gets the settings for this level.

reset()

Resets this level to a default configuration.

addHandle(x: float, y: float)

Add a point to this spline.

setHandle(index: int, x: float, y: float)

Edit a point on this spline.

getHandle(index: int) -> List[float]

Get the positional data of a given spline index.

getHandleCount() -> int

Get the number of points on this spline.

reset()

Resets this spline to a default configuration.

projectionMethod: str The projection method of this projector (uv, triplanar, positional, brush, or planar).

tiling: List[float] The tiling configuration of this projector.

clamp: bool If clamping is enabled for UVs or not.

uvRotation: float Rotation of UVs in the W axis.

edgeFade: float The amount of edge fading. Used in triplanar projection to blend edges.

normalWeight: float The amount of normal fading. Used in triplanar projection to blend normals.

position: List[float] A list of 3 floats (x, y, z) describing the position of this projector.

scale: List[float] A list of 3 floats (x, y, z) describing the scale of this projector.

rotation: List[float] A list of 3 floats (x, y, z) describing the rotation of this projector.

transform: List[float] A list of 16 floats describing the transform matrix of this projector.

reset()

Resets this map with the default base color/contrst.

texture: Texture The texture that corresponds to this map, or None if none exists.

mode: str The mode of this map, can be either 'texture' or 'material'

contrast: float The level of contrast for this map.

color: List[int] The base color of this map.

invert: bool Determines if contrast/color have been flipped.

The Mask project map of this surface.

The Normal project map of this surface.

The Albedo project map of this surface.

The Specular project map of this surface.

The Gloss project map of this surface.

The Roughness project map of this surface.

The Metalness project map of this surface.

The Ambient Occlusion project map of this surface.

The Cavity project map of this surface.

The Transparency project map of this surface.

The Gloss project map of this surface.

The Bump project map of this surface.

The Emissive project map of this surface.

The Scatter project map of this surface.

The Transmission Mask project map of this surface.

The Anisotropic Direction project map of this surface.

The Fuzz project map of this surface.

The Sheen project map of this surface.

The Sheen (Roughness) project map of this surface.

addContentChild(contentType: str) -> TextureProjectLayer

Add a content child to the current layer.

addMaskChild(maskType: str) -> TextureProjectLayer

Add a mask child to the current layer.

getBlendMode(projectMap: str)

Gets the blend mode of this layer for a given project map.

setBlendMode(projectMap: str, mode: str)

Sets the blend mode of this layer for a given project map.

duplicate() -> TextureProjectLayer

Duplcates this layer in this painter project. Returns duplicated layer.

remove()

Removes this layer from this painter project.

moveUp()

Moves this layer up it's parent list in the painter project.

moveDown()

Moves this layer down it's parent list in the painter project.

isDescendantOfMask()

Checks if this layer is a descendant of a mask layer for this painter project.

isCarveGroup()

Checks if this layer is a carve group.

isCarveGroupRegularMask()

Checks if this layer is a carve group regular mask.

importStroke(filename: str)

clearContent()

maps: TextureProjectLayerMaps The per map settings of this layer.

name: str The name of this layer.

visible: bool The visibility of this layer.

opacity: float The transparency of this layer.

maskColor: float The mask color of this layer. Works similar to opacity, but for the mask tree.

uid: int The unique identifier of this layer.

activeProjectMaps: List[str] The active project maps for this layer.

parent: TextureProjectLayer The parent of this layer.

contentChildren: List[TextureProjectLayer] This layers content children.

maskChildren: List[TextureProjectLayer] This layers mask children.

suffix: str The suffix appended to the output name of this map.

format: str The extension type for this output map. Can be one of the following: 'PNG', 'TGA', 'JPG', 'PSD'

sRGB: bool Whether this map is exported with sRGB encoding.

bitrate: int The bitrate for this output map. Can be 8 or 16. PNG supports 8/16 bit, TGA supports 8 bit, JPG supports 8 bit, PSD supports 8/16 bit

type: str The type of output map. Can be one of the following: 'RGB', 'RGB+A', 'RGBA', 'R+G+B', 'R+G+B+A', 'Grayscale'.

r: str The project map type for the R output channel.

g: str The project map type for the G output channel.

b: str The project map type for the B output channel.

a: str The project map type for the A output channel.

rgb: str The project map type for the RGB output channels.

addLinkedMaterial(mat: Material)

Add a linked material to this texture project.

addDefaultProjectMaps()

Convenience function, adds the default set of project maps (PBR Metalness + Normals, Occlusion, Bump) to this texture project.

addProjectMap(name: str)

Add a project map to this texture project.

removeProjectMap(name: str)

Add a project map to this texture project.

getAllProjectMaps() -> List[str]

Gets all project maps from this texture project to get/set any settings it might have.

getProjectMapFormat(name: str) -> str

Get the format of a given texture project map.

setProjectMapFormat(name: str, format: str)

Set the format of a given texture project map. Can be one of the following: 'RGB 8-bit (sRGB)', 'RGB 8-bit (Linear)', 'RGB 16-bit (sRGB)', 'RGB 16-bit (Linear)', 'Grayscale 8-bit (sRGB)', 'Grayscale 8-bit (Linear)', 'Grayscale 16-bit (sRGB)', 'Grayscale 16-bit (Linear)'

setInputMap(name: str, tex: Union[Texture, str])

Sets an input map to this texture project to be used as base information during texture generation.

getInputMap(name: str) -> Texture

Sets an input map to this texture project to be used as base information during texture generation.

getOutputMapCount() -> int

Get the number of project maps in this texture project.

getOutputMap(index: int) -> TextureProjectOutputMap

Get an output map coresponding to this index or name for this texture project.

addOutputMap(suffix: str, type: str, format: str, bitrate: int, rgb: str, a: str) -> TextureProjectOutputMap

Add and configure an output map for this texture project. For parameter info, see TextureProjectOutputMap.

removeOutputMap(index: Union[int, TextureProjectOutputMap])

Remove an output map for this texture project.

exportOutputMap(index: int)

Exports a single output map given a zero-based index.

exportOutputMapTiles(index: int, baseName: str, tiles:List[int], tilesCount: int)

Exports a single output map given a zero-based index.

exportAllOutputMaps()

Convenience function that exports all output maps for this painter project according to your export settings.

addLayer(layerType: str) -> TextureProjectLayer

Add a layer to the top of this texture project.

getSelectedLayers() -> List[TextureProjectLayer]

Get a list of all selected layers in this texture project.

findLayerByName(layerType: str) -> TextureProjectLayer

Finds and returns a layer by name, if multiple layers share the same name, the first one that matches will be returned.

getAllLayers() -> List[TextureProjectLayer]

Get a list of all layers in this texture project.

getActiveLayer() -> TextureProjectLayer

Gets the currently active layer selected in this texture project.

getAllLayerTypes() -> List[str]

Get all types of layers that can be created in a texture project.

recomposite()

Rerender this texture project. Useful if you're having trouble seeing changes in your texture renders.

generateExportAsset(index: int) -> Image

Generates an output map asset image given an zero-based index.

projectWidth: int The width in pixels of the texture project working resolution.

projectHeight: int The height in pixels of the texture project working resolution.

viewportUndersample: int Resolution undersampling scale (viewport res = full res / undersampling). Meant to improve viewport performance at the cost of quality. Does not affect final output.

previewUndersample: int Resolution undersampling scale. (preview res = full res / undersampling). Improves performance at the cost of quality when actively editing or painting on a layer. Does not affect final output.

viewportQuality: str The quality of the viewport, can be either 'Full' or 'Fast'.

paddingSize: int UV padding size in pixels.

useBumpAsDetailNormals: bool Use bump channel as detail normals.

bumpDetailWeight: float The amount that bump maps contribute to normal details.

useHeightAsParallax: bool Use height map in paralax subroutine with materials.

useThicknessAsScatter: bool Use tickness as scatter subroutine with materials.

reflectionWorkflow: str The current reflection workflow. Can be either 'metalness' or 'specular'

metalnessThresholdCenter: float The center region where materials are defined as non-metal vs metal.

metalnessThresholdRange: float The range of values that are interpolated between non-metal and metal.

outputPath: str The directory of the texture project exports. For the file name itself, see outputPathBaseName.

outputPathBaseName: str The base file name of the texture project exports. Suffixes are appended to this string upon export. For example, if the base name is 'output', an albedo map is written as 'output_albedo'. Files are written to the directory specified by 'outputPath'.

outputWidth: int The width in pixels of exported texture project textures.

outputHeight: int The height in pixels of exported texture project textures.

resetSuffix()

Resets the current map suffix to its default.

suffix: str The output suffix of the current Baker Map.

enabled: bool Whether or not this Baker Map should render when baking.

normalization: str The method by which you normalize position data.

flipX: bool Determines whether the normal map's X channel will be flipped.

flipY: bool Determines whether the normal map's Y channel will be flipped.

flipZ: bool Determines whether the normal map's Z channel will be flipped.

dither: bool Determines whether this map output will be dithered.

dither: bool Determines whether this map output will be dithered.

innerDistance: float Inner height map distance from the low poly mesh, in world units. This value maps to black in the height map.

outerDistance: float Outer height map distance from the low poly mesh, in world units. This value maps to white in the height map.

strength: float Determines the strength of the curvature output.

dither: bool Determines whether this map output will be dithered.

rayCount: int The number of rays used for thickness baking.

dither: bool Determines whether this map output will be dithered.

rayCount: int The number of rays used for Bent Normal baking.

dither: bool Determines whether this map output will be dithered.

flipX: bool Determines whether the normal map's X channel will be flipped.

flipY: bool Determines whether the normal map's Y channel will be flipped.

flipZ: bool Determines whether the normal map's Z channel will be flipped.

searchDistance: float The maximum distance rays can go. 0 defaults to infinity.

ignoreGroups: bool Determines whether bake groups will be ignored when baking bent normals.

rayCount: int The number of rays used for AO baking.

dither: bool Determines whether this map output will be dithered.

floor: float The amount of floor occlusion.

floorOcclusion: float Determines whether an artificial floor plane will be used for ambient occlusion baking.

ignoreGroups: bool Determines whether bake groups will be ignored when baking ambient occlusion.

twoSided: bool Determines whether the ambient occlusion baking will also use back faces.

cosineWeight: float Weights from -1 to 1, increasing values result in more 'cavity' shadows.

searchDistance: float The maximum distance rays can go. 0 defaults to infinity.

enableSVGUVIsland: bool Enables the exporting of an SVG version of the UV Island map.

lineThickness: float The thickness of the UV wireframe lines.

vertexRadius: float The radius of each vertex of the UV wireframe.

wireframeColor: List[float] Wireframe color as an RGB array.

bake()

Bakes with the current configuration.

bakePSD()

Bakes with the current configuration, into a single layered PSD file.

importModel(path: str)

Imports a model file via the Baker's quick loader. path: string path to model file

addGroup(name: str)

Adds a BakeGroup to the BakerObject. name: The Name of the BakeGroup returns: The BakeGroup

savePreset(name: str)

saves the current configuration of the BakerObject. name: The Name of the Preset

loadPreset(name: str)

loads a given preset for the BakerObject. name: The Name of the Preset

getTextureSetCount() -> int

Gets the number of texture sets in the current BakerObject. returns: integer number of texture sets.

getTextureSetName(i: int) -> str

Gets the name of a given texture set. i: The index of the Texture Set you want returns: the string name of the texture set.

getTextureSetEnabled(i: int) -> bool

Gets the enabled status of a texture set. i: The index of the texture set you want returns: True if the texture set is enabled False if not.

setTextureSetEnabled(i: int, enabled: bool)

Sets whether or the texture set specified is enabled or disabled. i: The index of the Texture Set you want enabled: if the texture set should bake or not.

getTextureSetWidth(i: int) -> int

Gets the width of a texture set. i: The index of the texture set you want returns: Width of texture set.

setTextureSetWidth(i: int, width: int)

Sets the width of a given texture set. i: The index of the Texture Set you want width: your desired width of the texture set.

getTextureSetHeight(i: int) -> int

Gets the height of a texture set. i: The index of the texture set you want returns: Height of the texture set.

setTextureSetHeight(i: int, height: int)

Sets the height of a given texture set. i: The index of the Texture Set you want height: your desired height of the texture set.

getUDIMTileCount() -> int

Gets the number of UDIM tiles in the current Baker. returns: integer number of UDIM tiles

getUDIMTileName(i: int) -> str

Gets the name of a given UDIM tile. i: The index of the UDIM tile you want returns: the string name of the UDIM tile.

getUDIMTileEnabled(i: int) -> bool

Gets the enabled status of a UDIM tile. i: The index of the UDIM tile you want returns: True if the UDIM tile is enabled False if not.

setUDIMTileEnabled(i: int, enabled: bool)

Sets whether or the UDIM tile specified is enabled or disabled. i: The index of the UDIM tile you want enabled: if the UDIM tile should bake or not.

getUDIMTileWidth(i: int) -> int

Gets the width of a UDIM tile. i: The index of the UDIM tile you want returns: Width of UDIM tile.

setUDIMTileWidth(i: int, width: int)

Sets the width of a given UDIM tile. i: The index of the UDIM tile you want width: your desired width of the UDIM tile.

getUDIMTileHeight(i: int) -> int

Gets the height of a UDIM tile. i: The index of the UDIM tile you want returns: Height of the UDIM tile.

setUDIMTileHeight(i: int, height: int)

Sets the height of a given UDIM tile. i: The index of the UDIM tile you want height: your desired height of the UDIM tile.

getAllMaps() -> List[BakerMap]

Gets a list of all baker maps. returns: A list of all baker map handles

getMap(name: str) -> BakerMap

Gets a baker map handle. name: The Name of the Map you want returns: A handle to the Baker Output Map

applyPreviewMaterial()

Applys a preview material on all baker low poly mesh objects.

linkTextureProject(proj: TextureProjectObject) -> None

Links a texture project to this baker. The textureset parameter may be an empty string if the bake project doesn't use texture sets.

"outputPath": str The file path where the baked textures will be stored.

outputBits: int Bit depth of the output format; must be one of the following values: 8, 16, 32.

outputSamples: int Sample count of the bake output.

edgePadding: str Edge padding amount. Must be one of the following values: 'None', 'Moderate', 'Extreme'.

"edgePaddingSize": float Edge padding size in pixels.

"outputSoften": float Determines how much the baked result will be softened; must be between 0.0 and 1.0.

"useHiddenMeshes": bool Determines whether hidden meshes will be used when baking.

"ignoreTransforms": bool Determines whether transforms on meshes will be used when baking.

"smoothCage": bool Determines whether the cage mesh will use smooth vertex normals, ignoring any hard edges.

"ignoreBackfaces": bool Determines whether back sides of faces will be ignored when baking.

"fixMirroredTangents": bool Fixes mirrored tangents, use this setting if you're seeing artifacts in your normal map bakes from your tangent space.

tileMode: int Baker tile mode for outputs (Single, Multiple, UDIM)

outputWidth: int The width in pixels of the baked textures.

outputHeight: int The height in pixels of the baked textures.

estimateOffset()

Estimates the Cage Offsets.

"minOffset": float The minimum offset of the cage mask.

"maxOffset": float The maximum offset of the cage mask.

"excludeWhenIgnoringGroups": bool Whether this target will be used when ignoring groups in cone based ray passes (AO, Bent Normals).

"cageAlpha": float The opacity of the cage.

getSubroutine(subroutine: str) -> MaterialSubroutine

Returns the subroutine in a given slot, specified by string name in the UI. See also setSubroutine().

setSubroutine(subroutine: str, shader: str)

Assigns a shader type to a given subroutine. Both parameters are string names. 'shader' must be a valid shader name, and 'subroutine' must be one of: 'subdivision', 'displacement', 'surface', 'microsurface', 'albedo', 'diffusion', 'reflectivity', 'reflection', 'clearcoat reflection', 'clearcoat microsurface', 'clearcoat reflectivity', 'occlusion', 'emissive', 'transparency', 'texture'.

getGroup() -> str

Returns the string name of the group the material is assigned to or an empty string, if the material is in no group.

setGroup(name: str)

Assigns the material to a new or existing group. Use '' to assign the material to no group.

duplicate(name: str = '') -> Material

Duplicates the Material, optionally assigning it a name. If no name is specified, one will be automatically generated. Returns the new material.

destroy()

Destroys the Material and removes it from the scene.

assign(object: SceneObject, includeChildren: bool = True)

Assigns the material to a scene object. If 'includeChildren' is true, this material will also be applied to the children of the object.

getAssignedObjects() -> List[SceneObject]

Returns a list of all scene objects to which this material is assigned.

exportFile(path: str)

Exports this material to the path specified.

renderPreview(width: int, height: int)

Renders the material, applied to a sample mesh, to a preview image. Returns an Image instance.

setKeyframe(lerp: str)

Sets a keyframe on this object with the assigned interpolation function ("linear", "step", "spline", or "splineBreak"). This setting defaults to editor's default.

name: Material The name of the Material. Please note that Materials must have unique names in Toolbag scenes.

displacement: MaterialSubroutine The MaterialSubroutine currently assigned to the Displacement Slot

surface: MaterialSubroutine The MaterialSubroutine currently assigned to the Surface Slot

microsurface: MaterialSubroutine The MaterialSubroutine currently assigned to the Microsurface Slot

albedo: MaterialSubroutine The MaterialSubroutine currently assigned to the Albedo Slot

diffusion: MaterialSubroutine The MaterialSubroutine currently assigned to the Diffusion Slot

transmission: MaterialSubroutine The MaterialSubroutine currently assigned to the Transmission Slot

reflectivity: MaterialSubroutine The MaterialSubroutine currently assigned to the Reflectivity Slot

reflection: MaterialSubroutine The MaterialSubroutine currently assigned to the Reflection Slot

clearCoatReflection: MaterialSubroutine The MaterialSubroutine currently assigned to the Clear Coat Reflection Slot

clearCoatMicrosurface: MaterialSubroutine The MaterialSubroutine currently assigned to the Clear Coat Microsurface Slot

clearcoatReflectivity: MaterialSubroutine The MaterialSubroutine currently assigned to the Clear Coat Reflectivity Slot

occlusion: MaterialSubroutine The MaterialSubroutine currently assigned to the Occlusion Slot

emission: MaterialSubroutine The MaterialSubroutine currently assigned to the Emission Slot

transparency: MaterialSubroutine The MaterialSubroutine currently assigned to the Transparency Slot

texture: MaterialSubroutine The MaterialSubroutine used for texture parameters

getFieldNames() -> List[str]

Returns a list of all field names of the subroutine.

setField(name: str, value: Union[int, float, str, Texture])

Sets the value of a field. Texture fields may be set by either passing a string path or a Texture instance.

getField(name: str) -> Union[None, int, float, str, Texture]

Returns the value of a field.

name: str The name of the current shader attached to this subroutine.

renderPreview(width: int, height: int, name = '')

Renders a preview of the texture, at the given resolution, with an optional name specifying the numberof frames for use in brushes / animations (eg. myname_4x.mpic). Returns an Image instance.

path: str The file path of the texture. Note: You cannot set the path of a Texture, only get it.

sRGB: bool Determines whether the texture is sampled in sRGB color space.

useMipmaps: bool Determines whether mipmaps are used on the texture.

useFiltering: bool Determines whether the texture is filtered bilinearly (smooth) or by nearest neighbor (pixelated).

anisotropicFiltering: bool Sets the degree of anisotropic filtering applied to this texture.

wrapping: str Sets the type of texture wrapping applied to this texture.

getPixelFormat() -> str

Returns the current pixel format, or -1 if the image is invalid. See convertPixelFormat() for a list of format values.

convertPixelFormat(format: str)

Converts the image to the specified format. Some formats of interest: BGRA8: "PIXEL_FORMAT_BGRA8", RGBA16: "PIXEL_FORMAT_RGBA16", RGBA_FLOAT16: "PIXEL_FORMAT_RGBA_FLOAT16", RGBA_FLOAT32: "PIXEL_FORMAT_RGBA_FLOAT32", RGB10_A2: "PIXEL_FORMAT_RGB10_A2", R8: "PIXEL_FORMAT_R8", R16: "PIXEL_FORMAT_R16", RG8: "PIXEL_FORMAT_RG8", RG16: "PIXEL_FORMAT_RG16", R_FLOAT16: "PIXEL_FORMAT_R_FLOAT16", RG_FLOAT16: "PIXEL_FORMAT_RG_FLOAT16", R_FLOAT32: "PIXEL_FORMAT_R_FLOAT32", RG_FLOAT32: "PIXEL_FORMAT_RG_FLOAT32", R11G11B10_FLOAT: "PIXEL_FORMAT_R11G11B10_FLOAT"

compressBCn(mode: int)

Encodes the image in a GPU-friendly block-compressed format. Currently supported modes are 4, 5, 6, and 7. Source images must be in an 8bit-per-channel color mode (such as BGRA8 or R8), except for mode 6, which requires a floating point color format. BC4 (mode=4) encodes grayscale in 4 bits per pixel. BC5 (mode=5) encodes two color channels in 8 bits per pixel. This is often useful for normal maps. BC6H(mode=6) encodes HDR RGB color in 8 bits per pixel. This is useful for high dynamic range images, such as backgrounds or panoramas. BC7 (mode=7) encodes RGB color and an alpha channel in 8 bits per pixel.

generateMipmaps(sRGB: bool = False)

Generates mipmaps for the image. Can optionally account for sRGB color space.

linearTosRGB()

Converts the color space of this image from Linear to sRGB.

sRGBToLinear()

Converts the color space of this image from sRGB to Linear.

flipVertical()

Vertically flips an image. Some pixel formats, such as BC7, may not be flippable.

writeOut(path: str)

Writes the image contents to a file on disk. The file format is determined by the file extension.

createTexture(sRGB: bool = True)

Creates a Texture object from the image contents, ready for GPU use.

duplicate()

Creates a duplicate of this image.

path: str Path to a model file. If this path is altered, a new model will be loaded in place of the old one.

getTime() -> float

Returns the current animation time, in seconds.

setTime(time: float)

Sets the current animation time, in seconds. This time may be rounded to the nearest frame.

getFrameRate() -> int

Returns the scene's animation frame rate, in frames per second.

resample(frameRate: int)

Alters the animation timeline's frame rate, in frames per second. This will resample existing keyframes to fit the new frame rate, and alter the appropriate frame counts.

play()

Activates animation playback.

pause()

Stops animation playback.

currentFrame: int Current animation frame. This value must be within the valid range of 0 to totalFrames.

totalFrames: int Total frame count for the animation. This value must be greater than zero.

selectionStart: int The first frame of the selected time range. Must be less than totalFrames and greater than zero.

selectionEnd: int The last frame of the selected time range. Must be less than totalFrames and greater than zero.

playbackSpeed: float The current playback speed. This value controls the apparent speed of playback in the viewport, but does not affect exported animation length.

addAsset(desc: Dict)

Add an asset to your current library distribution. You must supply a dictionary with the following keys: { name: str, author: str, link: str, tags: str, type: str, path: str }.Tags are comma separated, and type must be one of the following:'Materials', 'Skies', 'Textures', 'Smart Materials', 'Smart Masks', 'Brushes'.

updateLocalAssets()

Updates all local assets.

removeAsset(name: str)

Remove an asset from your current library distribution.

waitForTransactions()

Wait for all the downloads to complete.

resetContents()

Resets the contents of the library.

resetUserContents()

Resets the contents of the user library.

"unsavedChangesPrompts": type If enabled, you will be prompted to save any unsaved work when closing a scene.

"browseForMissingFiles": type Displays prompts to locate missing external files, such as textures and animations, during scene loads.

"browseForMissingMeshes": type Displays prompts to locate missing external meshes during scene loads.

"autoTextureReload": type Changed textures will be automatically reloaded when Toolbag regains focus.

"updateCheck": type Determines whether or not you will be prompted to install new updates. If enabled, Toolbag will check for new versions every time it opens.

"updateCheckAllowBeta": type Toolbag will check for and update to the latest beta builds when they are available. Enable this if you want to test out the latest features under development. Take care; beta builds may have bugs. Restart Toolbag for this setting to take effect.

"displayTooltips": type Disabling this would remove these helpful little boxes. Pro-moves only.

"tabletCompatibilityMode": type Enables enhanced tablet compatibility. This setting can sometimes solve issues with tablet input, and disables some mouse features.

"defaultWatermark": type Determines whether or not the "Rendered in Marmoset Toolbag" watermark is enabled when creating a new scene.

defaultTangentMethod: str Sets the tangent space that will be applied to meshes when imported. Choose the application that you most frequently use to bake normal maps. Allowed values are 'Marmoset', 'Mikk', 'Maya' and '3DS Max'.

defaultTangentHandedness: str Newly created bake and texture projects will default to this tangent space handedness. Allowed values are 'Right-Handed' and 'Left-Handed'.

defaultSceneUnit: str Determines which unit system to use for new scenes. This setting should match the unit setting in your 3D modeling application. Allowed values are 'mm', 'cm', 'm', 'km', 'in', 'ft', 'yd' and 'mi'.

rayTraceBackend: str Selects a ray tracing engine for rendering and baking. "Accelerated" attempts to provide the best performance and makes use of new GPU features such as NVIDIA's RTX. "Generic" works on all GPUs but is not as fast. Changing this setting requires an app restart. Allowed values are 'Generic' and 'DXR' (if supported).

"importModelsAsReferences": type Model files will import as file references instead of simply grouped objects. This allows for quick in-place model reloading. Note that disabling this feature will prevent animated meshes from being imported.

"importAbcWithMaterials": type Model files will import along with any available material definitions, including textures and other parameters where available.

"importFbxWithMaterials": type Model files will import along with any available material definitions, including textures and other parameters where available.

"importObjWithMaterials": type Model files will import along with any available material definitions, including textures and other parameters where available.

"importPlyWithMaterials": type Model files will import along with any available material definitions, including textures and other parameters where available.

"importStlWithMaterials": type Model files will import along with any available material definitions, including textures and other parameters where available.

"importUsdWithMaterials": type Model files will import along with any available material definitions, including textures and other parameters where available.

"import8mlWithMaterials": type Model files will import along with any available material definitions, including textures and other parameters where available.

"autoModelReload": type Model files will be automatically reloaded when Toolbag regains focus. This only applies to external model references; models not imported as references will not reload.

"outputDirectory": type Sets the default directory where rendered images are saved when creating a new scene.

sceneStartPref: str Selects whether, on startup, Toolbag will open a blank scene, the last opened scene, or the template scene. Allowed values are 'Empty', 'Last Opened' and 'Template'.

newScenePref: str Determines whether new scenes are empty or created from the template scene. Allowed values are 'Empty' and 'Template'.

"rememberDimensions": type If enabled, the Toolbag window will load with the same position and size as it was when last closed.

"undoVerificationCheck": type Runs an extra integrity check on the scene when an action is undone or redone. Also displays diagnostic data in the performance window.

tabletBackend: str The default backend when using a digitizer, defaults to the latest available to your operating system. Allowed values are 'Windows Pointer' and 'WinTab'.

libraryLocalPath: str Path where first party library content is stored.

libraryUserPath: str Path where user third party library content is stored.

"libraryAutoUpdate": type Automatically update assets when a new version is available.

"autoSaves": type Automatically save a backup of your scene to the autosave folder at the specified time interval.

autoSaveDuration: float Determines how often autosaving occurs in minutes.

"autoSaveMaxCount": type Determines the maximum number of autosaves to keep for a given scene. Older autosaves will be deleted when this value is exceeded. Using a value of 0 will retain all files.

autoSaveFolderSize: float Maximum amount of space the autosave folder can use. Older autosaves will be deleted when total size of the folder exceeds this value.

autoSaveUnits: str Determines whether the Maximum Autosave Folder Size is set in 'GBs' or 'MBs'.

"autoSaveLocation": type Determines the folder that backups are saved in.

"autoSaveRelativeToMaster": type Creates autosave files in the same folder as your current scene. The Max Saves and Max Autosave Folder Size settings do not apply when this is option enabled.

addReturn()

Adds a line return to the window, placing all following elements on the next line.

addSpace(width: float)

Adds a space of fixed width to the window, placing all following elements after it.

addStretchSpace()

Adds a stretchable space to the Window, placing all following elements after it at the end of the current line.

clearElements()

Removes all elements from the window.

addElement(child: UIControl)

Adds a child control to the Window.

getElements() -> List[UIControl]

Returns a list of all contained controls.

close()

Closes the current window.

title: str The title of the Window

visible: bool True if the Window is visible.

width: float The width of the Window in screen pixels.

height: float The height of the Window in screen pixels.

containedControl: UIWindow The control contained by the scrollbox object, to which other elements may be added.

title: str The text title of the drawer.

onOpenClose: Callable[[], None] A callable, called when opening/closing the drawer.

containedControl: mset.Control The control contained by the drawer object, to which other elements may be added.

open: bool The current open/closed state of the drawer.

title: str The text title of the color picker.

color: List[float] The color of the color picker.

addItem(item: str)

Adds an item with the label specified to the ListBox.

clearItems()

Removes all items from this ListBox.

selectItemByName(name: str)

Selects the item that matches the name specified.

selectNone()

Select no item on the list.

title: str The text title of the ListBox.

selectedItem: int The currently selected item in the ListBox.

onSelect: Callable[[], None] A callable, called when selecting an item in the ListBox.

onMenuOpen: Callable[[], None] A callable, called when opening the ListBox.

setIcon(icon: str)

Lets you set an image as the button icon.

setIconPadding(left: float = 0, right: float = 0, top: float = 0, bottom: float = 0)

Lets you set an image as the button icon.

text: str The text label of the button.

lit: bool If the button has a highlighted frame.

frameless: bool If the button has a frame.

onClick: Callable[[], None] A callable, called when the button is clicked.

onChange: Callable[[], None] A callable, called when the text is changed.

onCancel: Callable[[], None] A callable, called when text editing is canceled.

width: float The width of the control.

value: str The contents of the text field.

value: int The numerical value of the text field.

value: float The numerical value of the text field.

onChange: Callable[[], None] A callable, called when the tracked value changes.

width: float The width of the control.

value: float The value of the slider.

min: float The minimum of the slider range.

max: float The maximum of the slider range.

logScale: float The logarithmic exponent scale of the slider.

logScaleCenter: float The center of the logarithmic scale of the slider.

value: int The value of the slider.

min: int The minimum value of the slider range.

max: int The maximum value of the slider range.

logScale: int The logarithmic exponent of the slider.

logScaleCenter: int The center of the logarithmic scale of the slider.

value: bool The boolean value of the CheckBox.

label: str The text label of the CheckBox.

onChange: Callable[[], None] A callable, called when the CheckBox value is changed.

setMonospaced(monospaced: bool)

Changes this label to a monospaced font.

text: str The text of the label.

fixedWidth: float The desired fixed width of the label.

onSceneLoaded: Callable[[], None] This Callback will run when a new scene is loaded.

onSceneChanged: Callable[[], None] This Callback will run when the scene is changed (e.g. by moving an object).

onRegainFocus: Callable[[], None] This Callback will run when the application regains focus. This can be useful for plugins that need to refresh files or make other checks when the user switches to Toolbag.

onPeriodicUpdate: Callable[[], None] This Callback will run periodically: a few times per second. This can be useful for plugins that need to refresh external files or make frequent polling checks. Since this callback is run frequently, care should be taken to keep the average execution time low, or poor performance could result.

onShutdownPlugin: Callable[[], None] This Callback will run immediately before the plugin is shut down.

Property of a layer.

projection: Any A property of a layer.

Property of a layer.

projection: Any A property of a layer.

px: int A property of a layer.

spline: Any A property of a layer.

amount: float A property of a layer.

radius: float A property of a layer.

source: int A property of a layer.

contrast: float A property of a layer.

contrastCenter: float A property of a layer.

intensity: float A property of a layer.

invert: bool A property of a layer.

contrast: float A property of a layer.

contrastCenter: float A property of a layer.

intensity: float A property of a layer.

invert: bool A property of a layer.

brightness: float A property of a layer.

contrast: float A property of a layer.

creviceContrast: float A property of a layer.

creviceIntensity: float A property of a layer.

creviceThickness: float A property of a layer.

directionContrast: float A property of a layer.

directionIntensity: float A property of a layer.

grungeContrast: float A property of a layer.

grungeIntensity: float A property of a layer.

grungeRotation: float A property of a layer.

grungeScale: float A property of a layer.

invert: bool A property of a layer.

occlusionContrast: float A property of a layer.

occlusionIntensity: float A property of a layer.

sharpness: float A property of a layer.

contrast: float A property of a layer.

contrastCenter: float A property of a layer.

intensity: float A property of a layer.

invert: bool A property of a layer.

sharpness: float A property of a layer.

contrast: float A property of a layer.

contrastCenter: float A property of a layer.

intensity: float A property of a layer.

invert: bool A property of a layer.

sharpness: float A property of a layer.