Convenience method to get the currently set Application Stylesheet.
By default it checks the currently active theme in Mari's Preferences / Misc Tab / Style.
So even though usually a theme change requires a Mari Restart, using this method you
already get the full application stylesheet that will be applied after the Mari restart.

You can use this to rapid test your dialogs during development with different styles.

If you provide the custom_theme argument you can also test different styles without having to switch them
via Mari's Preferences. E.g. custom_theme="Mari Default" will show you the vanilla style sheet,
"Extension Pack Steel" will show you the EP Steel Theme etc.



custom_theme (str or None):  Optional. Defaults to None. A Theme to get the stylesheet for.

prefix_with_qdialog (bool):  Optional. Defaults to True. If True, prefixes all Q... widget selectors with
                             "QDialog " so when applied to your Dialog, it takes precedence over the
                             application stylesheet


(str):               A CSS Stylesheet


ValueError:          Raises a Value Error if the specified color name doesn't exist in the Appearance.conf file

EP6R3

EP6R3

Method to figure out what UI theme is currently active in Mari.
This is done by checking the existence of the DefaultStyleSheet.qss in the Mari User Settings.

Valid returns are:
- Mari Default
- Extension Pack Steel
- Extension Pack Steel (Desaturated)

Themes can be switched in Mari's Preferences Misc Tab.


(string):        A string description of the theme that is currently active.

EP6R3

EP6R3

Returns a Widget Color defined in the Mari "Appearance.conf" file which can be either
found in the Mari User Settings ..

- C:/Users/../.mari/TheFoundry

or in the Mari Install Directory.

- C:/Program Files/Mari../Bundle/Media/Settings



color_name (str): A valid Widget Color name found in the Appearance.conf file

fallback_color_name (str): Optional. A second Color Name to look for if the first one doesn't exist.
                           You can also specify a rgba() or hex (#) color directly


(str):               A color string like rgba(255,255,255,255)


ValueError:          Raises a Value Error if the specified color name doesn't exist in the Appearance.conf file

EP6R3

EP6R3

Returns True or False depending on if the current theme is based on Mari's Default stylesheet (True)
or Extension Pack's Custom Stylesheets (False)

As Users can configure their own stylesheet via the Preferences, it is sometimes important to know
what the original theme was that was modified (e.g. to se widget sizes)


(bool):        True if the current theme is or is based on Mari's Default stylesheet.

EP6R3

EP6R3

Launches a dialog to customize the Mari Appearance

EP6R3

EP6R3

Applies a custom Image Manger Style in Mari 7.5 and above

EP6R4

EP6R4

Pauses or unpauses any Dialog Triggering (e.g. the Style Editor)
when the UI Theme Preference is changed

state (bool): True to Pause, False to Unpause


EP6R3

EP6R3

Archives the current project WHILE the project is open.


path (string):        the target path (e.g. c:/temp/archive.mra)

EP6R1

EP6R1

EP DEPRECATION WARNING:

This method is deprecated and will be removed in a future version of Extension Pack.

Sets the ArchiveUpToDate Metadata on a Project


cur_project (mari.project):       a mari.Project

outOfDate (bool):                 Sets the 'Out of Date' Metadata to True of False


EP6R1

EP6R1

Adds information about Archive Status to Project Tooltip

EP DEPRECATION WARNING:

This method is deprecated and will be removed in a future version of Extension Pack.



UUID (string):                 The UUID of the project to process


EP6R1

EP6R1

Returns True if autosave has been Paused, False otherwise


(bool):            True if autosave has been Paused, False otherwise


EP6R3

EP6R3

Pauses or unpauses autosave


state (bool):            True if autosave should be paused, False if it should be unpaused


EP6R3

EP6R3

EP DEPRECATION WARNING:

This method is deprecated since Modo Baking was removed from Mari 8 onwards

Refreshes the QComboBox inside the Modo Bake Palette
to reload Modo Bake Presets from all available locations
including locations set by the Environment Variable
MARI_MODO_BAKE_PRESETS

launch the Substance Baker Bridge UI

EP6R1

EP6R1

Baking of Bake Points or Multi Channel Bake Points across geo versions


node (mari.MultiChannelBakePointNode | mari.BakePointNode):  Optional. A node to bake. Otherwise selection


EP6R3

EP6R3

Bakes all selected Bake Points in the Nodegraph

EP6R1

EP6R1

Checks the given multi channel bake point node's downstream connections (spanning
nodegraphs e.g. also works inside groups) for channel nodes.

Any stream with a connected channel node will be enabled, any stream without disabled.

Mari does this usually automatically when you create a new MCBP and attach it to a
network however this function allows you to trigger it manually.


node (mari.MultiChannelBakePoint):           Optional. The Node to optimize. 
                                             If None (default), the current Node
                                             selection will be used


EP6R3

EP6R3

Removes all Bake Point Bakes from your Project

EP6R3

EP6R3

Baking of all out of date or unbaked Bake Points or Multi Channel Bake Points across geo versions,
in a hierarchical manner


EP6R3

EP6R3

From the currently selected node upstream, refresh all bake points that are empty or out of date including in groups

EP6R1

EP6R1

EP DEPRECATION WARNING:

This method is deprecated and will be removed in the future
`
Sets the "use Bake" checkbox in selected bake points to on or off


bool (bool):           True/False

EP6R1

EP6R1

Creates a timer object that can be used to time operations.

Use as follows:

timer = createTimer()
timer.start()
print(timer.end())



timerObject:              a class for controlling a timer

------------------------------------------------------------------------------------------



timer.start():             starts a timer
timer.end():               completes the previously started timer.
                           Returns a tuple (convertedTime,timeInSeconds)

------------------------------------------------------------------------------------------

EP6R2

EP6R2

Samples the average Viewport FPS.
The average is defined by the number of wedges


wedgeCount (int):         The number of iterations to run.
                          Defaults to 100000

ident (string):           Optional Identifier to store the FPS Count under.
                          Extension Pack uses this option to associate measured FPS
                          to preference combinations


(float):                  Returns the average FPS on the canvas


EP6R2

EP6R2

Returns the total and free GPU memory.
On Windows the free GPU Memory is the currently free memory, on linux
if "subtract_mari_usage" argument is True, Mari's own memory usage is re-added to the free memory.
This does not work on Windows.


subtract_mari_usage (bool):       LINUX ONLY. Factors out Mari's own Memory Usage in the returned free Memory


(list):                           [Total Memory in MB, Free Memory in MB]

EP6R3

EP6R3

Returns the total and free RAM memory.


(list):                           [Total Memory in MB, Free Memory in MB]

EP6R3

EP6R3

Gets the set dynamic brushsize for a given tool to a state (on/off)
If no tool argument is given, the current tool is used.



tool (mari.Tool):     The Tool object e.g. mari.tools.currentTool()
                        If no tool is given, the current tool is used.


bool:                 True if it is on, False if it is off

EP6R3

EP6R3

Sets the dynamic brushsize for a given tool to a state (on/off)
If no tool argument is given, the current tool is used.



state (bool):         True or False to de/activate dynamic brushsize

tool (mari.Tool):     The Tool object e.g. mari.tools.currentTool()
                        If no tool is given, the current tool is used.


None:

EP6R3

EP6R3

Toggles the dynamic brushsize for a given tool on if it is off,
and off if it is on.
If no tool argument is given, the current tool is used.


tool (mari.Tool):     The Tool object e.g. mari.tools.currentTool()
                        If no tool is given, the current tool is used.

None:

EP6R3

EP6R3

Toggles the Steady Stroke Brush Option on and off
When toggling on, the last used Mode is restored.
Modes are stores per Tool

EP6R1

EP6R1

Utility Function to setup the dynamic brushsize system
on Mari Startup

Switch the active tab to the Ortho View

EP6R1

EP6R1

Switch the active tab to the Perspective View

EP6R1

EP6R1

Switch the active tab to the Split View

EP6R1

EP6R1

Switch the active tab to the UV View

EP6R1

EP6R1

Unproject Channel to Image Manager tool

EP6R1

EP6R1

Unproject Layer to Image Manager tool

EP6R1

EP6R1

Unproject View to Image Manager tool

EP6R1

EP6R1

Returns a mari.channel from a mari.ChannelNode


geo (mari.geoEntity):            The geo to look for a channel

channelNode (mari.ChannelNode):    The channelNode


mari.Channel or None:            Returns a Mari Channel or None if nothing is found


EP6R1

EP6R1

EP DEPRECATION WARNING:

This method is deprecated and will be removed in a future version

Create a new Channel with the UDIM Size Configuration
stored via channel_template_get

EP6R1

EP6R1

Duplicate selected channel with all sharing intact

EP6R1

EP6R1

Duplicates a Node Network such as a channel while cleaning up and rebuilding shared connections in the graph.
Please be aware the same method exists in the Nodegraph Class


geo (mari.geoEntity):                     Geo, inputNode lives on

inputNode (mari.Node):                   The node which to use as a base to duplicate the network
                                         (upstream connections). Should be a channel node but doesn't have
                                         to be

inputNodeNodeGraph (mari.Nodegraph):     The Nodegraph the input Node belongs to

StopAfterRadioNodes (bool):              If true (default value) connections upstream of a radio node will
                                         not be duplicated and the original Radio Node Connection is
                                         maintained if the first node upstream of a radio has connections
                                         to other channels.

RenameChannelIncremental (bool):         If true (default value) and the inputNode is a Channel, the
                                         resulting duplicated channel will be renamed incrementally (1,2,3 etc.)

RenameChannel (bool):                    If RenameChannelIncremental=False and RenameChannel=True, and the inputNode
                                         is a channel, the resulting duplicate channel will be renamed with the name
                                         specified under newChannelName

newChannelName (string):                 if RenameChannel=True and the inputNode is a channel, the resulting
                                         duplicate Channel will be renamed with this name

offsetX,offsetY (int):                   The offsetX and offsetY specify the offset of the duplicated nodes
                                         from their original nodegraph position


mari.Node():                             Returns the new Node with intact connections




EP6R1

EP6R1

Selects the corresponding Nodes of a Channel in the Nodegraph and focuses the view on it



stopAfterRadios (boolean):               If True, only nodes up to and including a radio node will be selected and focused.
                                         Radio Node Connections will not be included. Default = False


EP6R1

EP6R1

Selects the corresponding Node of a Channel in the Nodegraph and focuses the view on it

EP6R1

EP6R1

Lock all Channels

EP6R1

EP6R1

Lock a Channel

EP6R1

EP6R1

EP DEPRECATION WARNING:

This method is deprecated and will be removed in a future version

Sets the currently selected Channel to the UDIM resolutions
stored via channel_template_get.
geo and channel can optionally be supplied as arguments


geo (mari.geoEntity):          Pass in the Geometry the Channel lives on. If None (default) the selected object is used

channel (mari.Channel):        Pass in the Channel to get the resolution off. If None (default) the selected channel is used

EP6R1

EP6R1

EP DEPRECATION WARNING:

This method is deprecated and will be removed in a future version

Samples the currently selected Channel and stores its resolutions per UDIM.
geo and channel can optionally be supplied as arguments


geo (mari.geoEntity):          Pass in the Geometry the Channel lives on. If None (default) the selected object is used

channel (mari.Channel):        Pass in the Channel to get the resolution off. If None (default) the selected channel is used

EP6R1

EP6R1

Syncs the channel selection between objects


sourceObject (mari.geo):     optional object to specify the source channel to sync with

targetObject (mari.geo):     optional target object to sync the channel selection on. If None, all objects are synced

channelName (string):        optional Channel Name to sync all objects with.


EP6R1

EP6R1

unlock all channels

EP6R1

EP6R1

Unlock a channel

EP6R1

EP6R1

Create Channels from a selected Node

EP6R1

EP6R1

Launch Pack Channel UI

EP6R1

EP6R1

Launches Duplicate/Flatten Channel Dialog

EP6R1

EP6R1

Launches the "Add Channel Layer" UI

EP6R1

EP6R1

Launches the "Add Channel Mask" UI

EP6R1

EP6R1

Launches the "Add grouped Channel Mask" UI

EP6R1

EP6R1

Compares if Shelf Content is the latest and installs any new ones


progressDialog (obj):            This allows you to pass in a progress dialog to be used.
                                 If this is None it will spawn its own progress Dialog but otherwise
                                 use the given one. This is to avoid progress Dialogs randomly open
                                 and closing on EP Startup, when several things will be installed


success (bool):                  Returns true if the checking process finished. It always returns True
                                 and the return is just a method to have sequential processes running via
                                 "if true" check.

progressDialog (obj):            Returns the Progress Dialog used by this process. This can be exactly
                                 the same progress dialog that was passed in via the Args or the new one
                                 created by the process




EP6R1

EP6R1

Will install content to the Mari shelf under an "Environment Group"

1) Mari HDRIs will be installed in appropriate directories
2) Substance Painter common Install Locations will be checked and if found,
added to the Environment Image Path Preferences in Preferences / Paths
3) Additional HDRIs will be installed from any folder specified in Preferences / Paths / Environment


progressDialog (obj):            This allows you to pass in a progress dialog to be used.
                                 If this is None it will spawn its own progress Dialog but otherwise
                                 use the given one. This is to avoid progress Dialogs randomly open
                                 and closing on EP Startup, when several things will be installed


success (bool):                  Returns true if the checking process finished. It always returns True
                                 and the return is just a method to have sequential processes running via
                                 "if true" check.

progressDialog (obj):            Returns the Progress Dialog used by this process. This can be exactly
                                 the same progress dialog that was passed in via the Args or the new one
                                 created by the process


EP6R1

EP6R1

Installs standard empty material presets to a new shelf.
This method is also called directly from the Mari Preferences when checking and unchecking
Material Presets. In these cases "closeDialogAfter" is set to True



closeDialogAfter (bool):         If true the Progress Dialog that will spawn will be force closed and not passed onto other dialogs


success (bool):                  Returns true if the checking process finished. It always returns True
                                 and the return is just a method to have sequential processes running via
                                 "if true" check.

progressDialog (obj):            Returns the Progress Dialog used by this process. Please be aware of the
                                 closeDialogAfter Argument, as the progress dialog might have been closed by
                                 that argument and therefore None is returned


EP6R1

EP6R1

Check if Renderman for Mari is installed


(bool)            True if Renderman for Mari is installed


EP6R1

EP6R1

a signal connection when the image size dropdown in an image note gets triggered


target_directory (str | None):               An optional path to write the stubs to.
                                                if not given will write to Extension Pack install
                                                /Tools/Pythonstubs
include_docstrings (bool):                      If True, the docstrings will be included in the stubs.



EP6R4

EP2027

Launches Dialog to search through Mari Actions

EP6R1

EP6R1

Launches Dialog to search through available classes and methods

EP6R1

EP6R1

Launches Dialog to search through Mari Menu Paths

EP6R1

EP6R1

A simple dialog accepting Drag and Drop events and returning the Mime Type

EP6R1

EP6R1

"
Opens a dialog to allow you to record node animations.
Animations are recorded and played on the currently selected node.
Allows to state different node states and when playing, it will transition between the different
node attribute states by animating the node metadata.

The Tool is not meant for creating node animations for production. It's primarily purpose is to
be able to produce different states of node outputs for marketing purposes

EP2027

EP2027

Launches Dialog to search through available node paths. Requires open Project

EP6R1

EP6R1

Returns the Layer (mari.Layer) that was below
the last Drag & Drop Action to the Layerstack containing text/plain mime data
This is the positional Reference Layer that can be used
to set the position of a new layer object in the Target Layerstack


mari.Layer:       A Mari Layer Object

EP6R1

EP6R1

Returns the last Layerstack (mari.Layerstack) that was the target
of the last Drag & Drop Action containing text/plain mime data


mari.Layerstack:       A Mari Layerstack Object

EP6R1

EP6R1

Returns the Nodegraph (mari.Nodegraph()) that was the target
of the last Drag & Drop Action containing text/plain mime data


mari.NodeGraph:       A Mari Nodegraph Object

EP6R1

EP6R1

Returns the node graph position coordinates
from the last drag & drop action to the Nodegraph Palette
containing text/plain mime data


QPointF:              X and Y Position in the Nodegraph

EP6R1

EP6R1

Resets/removes all saved data from the last dropactions.
This means the other methods of this class e.g. getLastLayerStackRefLayer()
will return None.

EP6R1

EP6R1

Registers Extension Pack Callbacks for Drag and Drop
Mari 4.7 and higher only

EP6R1

EP6R1

Returns Extension Pack's global Exception Handler that is attached to
sys.excepthook.

Whenever an exception occurs there are two class' internal signals emitted:

_exception_caught_log(str)
_exception_caught_raw(exc_type, exc_value, exc_traceback)

You can use the class to attach other uses to those signals.

The  _exception_caught_log() signal is containing the log message that gets
written to Extension Pack's own Log Files under /Mari/Logs/, while the
_exception_caught_raw() contains the unaltered data from sys.excepthook

Please note, that Extension Pack's Exception Handler is set up in a way that it
still calls previous methods that were attached to sys.excepthook before Extension Pack
attached its own.

Whenever Extension pack's Exception handler gets triggered the previous Exception handler gets
called as well via

self.old_excepthook(exc_type, exc_value, exc_traceback)

If you want to completely prevent Extension Pack from registering its own excepthook, you can
set the Environment Variable MARI_EP_PREVENT_EXCEPTION_LOGGING. This will stop Extension Pack
from modifying sys.excepthook on startup.

None:

class UncaughtHook(QtCore.QObject):   The Extension Pack Exception Handler Class

_exception_caught_log(str):             The signal used by the Exception Handler Class to 
                                        write Messages to Extension pack's own log

_exception_caught_raw(o,o,o):           The signal forwards the original data from sys.excepthook 
                                        e.g. exc_type, exc_value, exc_traceback

EP6R2

EP6R2

Logs an error to extension packs own error logs
This can be used to log "hidden exceptions" or unusual application behavior

message (str):            Error Message

EP6R3

EP6R3

Runs the last Export from Export Custom Channel Selection

EP6R1

EP6R1

Launches Export Custom Channel Selection Dialog with the
"Flattened" Checkbox turned off

EP6R1

EP6R1

Launches Export Custom Channel Selection Dialog with the
"Flattened" Checkbox turned on

EP6R1

EP6R1

Sets the Checkbox for how "Export Last" is to deal
with Selected Patch Export - using the original selection
or the current one

EP6R1

EP6R1

Launches the Mask Preset Setup UI
scanning the nodelist for ports that can be setup.
This is the system used to auto setup Smart Masks.


nodelist (list):                      a list [] of mari.Node Objects

ReplaceExisting (bool):               if the tool is executed with Replace Existing, it will replace existing connections
                                      on a preset. Otherwise it will only create new connections on empty node ports

ForceConnectionDialog (bool):         Usually a Connection Dialog won't be shown if the Tool finds all necessary channels
                                      in your Project. Running it with ForceConnetionDialog=True will always show the
                                      connection dialog

parent:                               The parent for the dialog. If left at None the parent will be the mari main window


EP6R1

EP6R1

Launches the Mask Preset Setup Preferences UI.
This is the system used to auto setup Smart Masks.


EP6R1

EP6R1

Launches the Mask Preset Setup UI
This is the system used to auto setup Smart Masks.
In the Baking mode it doesn't require a node but shows Curvature Baking options
so users can create the frequently used channels without already having a preset


parent:                                The parent for the dialog. If left at None the parent will be the mari main window




EP6R1

EP6R1

Launches the Mask Preset Setup UI
scanning the nodelist for ports that can be setup.
This is the system used to auto setup Smart Masks.

In the refresh mode all ports are considered even if they already have something
attached


nodelist (list):                       a list [] of mari.Node Objects

parent:                                The parent for the dialog. If left at None the parent will be the mari main window



EP6R1

EP6R1

Launches the Mask Preset Setup UI
with the current Node Selection as processing base
This is the system used to auto setup Smart Masks.



ReplaceExisting (bool):                if the tool is executed with Replace Existing, it will replace existing connections
                                       on a preset. Otherwise it will only create new connections on empty node ports

ForceConnectionDialog (bool):          Usually a Connection Dialog won't be shown if the Tool finds all necessary channels
                                       in your Project. Running it with ForceConnetionDialog=True will always show the
                                       connection dialog

parent:                                The parent for the dialog. If left at None the parent will be the mari main window


EP6R1

EP6R1

Opens a webbrowser to the Foundry Support Portal

EP6R1

EP6R1

Creates a Project with the Smart Mask Icon Geo and some Bakes

EP6R1

EP6R1

Opens the Mari Log File

EP6R1

EP6R1

Opens the Mari User Settings Folder

EP6R1

EP6R1

Launch Extension Pack Online Help

EP6R1

EP6R1

Launch Extension Pack Local Py API Help

EP6R1

EP6R1

Launch the Release Notes

EP6R1

EP6R1

Generates a on-the fly overview of the current shortcut mappings as html
and opens the page in a browser

EP6R3

EP6R3

Launch Youtube Extension Pack Tutorials

EP6R1

EP6R1

Opens an email form to report an Extension Pack Issue

EP6R1

EP6R1

The documentation editor runs over the documentation
and builds accordion style menus as well as replacing
header colors

Accordions are built based on the following syntax within the Online help.

The ids are used to generate unique items within the page that the stylesheet
can react to.

Example of an accordion with 2 tabs:
#--[ACC-START,UNIQUE_ID1,UNIQUE_ID2,Label]--#
#--[ACC,UNIQUE_ID1,UNIQUE_ID2,Label]--#
#--[ACC-END]--#

Example of an accordion with two tabs,expanded by default.
#--[ACC-START-EXPANDED,UNIQUE_ID1,UNIQUE_ID2,Label]--#
#--[ACC-EXPANDED,UNIQUE_ID1,UNIQUE_ID2,Label]--#
#--[ACC-END]--#


noDialog (bool):              if True, the process runs with default settings


EP6R1

EP6R1

returns the local python help path

string


EP6R1

EP6R1

Builds  an HTML Documentation of the Extension Pack Classes and Method


TargetFolder (string):                 The Target Folder to build the HTML Help in.
                                       If left empty ('') the HTML Docs will be built under
                                       Extension Packs /Tools/Help Folder

CustomMarkerTargetUrl (string):        When building all of the HTML help within a single HTML page
                                       the HTML Builder will add markers to each class and a link list
                                       of classes linking to those markers at the top of the page.
                                       The CustomMarkerTargetUrl is the Filename of the HTML Page
                                       so the Anchor linking works (e.g )

OnePagePerClass (bool):                If true, a single HTML page per class will be created.
                                       If False (Default), then all classes will be documented within a single page
                                       with a table of content at the top of the page.

Introduced:

EP6R1

Modified:

EP6R1

Saves project and clears the history after a dialog asking to confirm

EP6R1

EP6R1

closes any active macro in case the history recording has been interrupted due to a bug

EP6R1

EP6R1

Force closes any open hotbox instance

None:

EP6R3

EP6R3

Returns the currently open Hotbox Instance

HotboxInstance or None:         Gives the currently open Hotbox Instance.

EP6R1

EP6R1

General Method to launch a hotbox


path (str):                        The Path to the Hotbox Configuration Folder

SubmenuBackLink (str):             The Path to the Hotbox Configuration Folder the Submenu should link back to

force (bool):                      Force Open a new Instance of the Hotbox

resetPosition (bool):             Reset the Cursor Position (Hotbox Center on Launch) to cursor position

parent_widget (QWidget | None):   Optional. The widget to parent the Hotbox to

isNodeContextMenu (bool):          If True, the hotbox will be treated as a node
                                   context menu. Node Context Menu appear over a node
                                   if CTRL+SPACE is pressed in the Nodegraph.
                                   The boolean flag ignores the cursor position and
                                   places the menu over the selected node.
                                   The size of the menu is dynamically adjusted based
                                   on nodegraph zoom level


EP6R1

EP6R3

Launches the Hotbox Designer UI

EP6R1

EP6R1

Installs Extension Pack Hotboxes into the Hotbox Folder
if they don't exist yet/are the same version

EP6R1

EP6R1

Sets up Extension Pack Hotboxes on Mari startup
in a way that I am removing pre existing mari hotkeys for certain actions
if they are mapped

EP6R1

EP6R1

Sets up existing User Hotboxes on Mari startup

EP6R1

EP6R1

Copies the contents of the legacy Image Notes folder (pre Mari 8)
into the new UserData/ImageNotes location within the project

EP2027

EP2027

Creates a new visual note in the currently active graph


customPosition (QPoint):      A custom position to create the node at. Otherwise
                              the nodegraph center of the active graph tab


node (mari.Node):             Returns the newly created Note or None

EP6R1

EP6R1

Retrieves the image path from a visual Note


node (mari.Node):             the node to get the image path from


(string):                     the image path

EP6R1

EP6R1

Returns the image size of a given image on disc


imagePath (string):           path to an image on disk


(int),(int):                  Returns two integers (width,height) or None,None if path not found


EP6R1

EP6R1

Returns the last created Visual Note.
This can be useful since certain actions internally create a new stickyNote


(mari.Node):               Returns a Mari Sticky Note or None


EP6R1

EP6R1

Returns the path to the directory where image notes are saved.
The path is within the current project directory


(string):                     Path to snapshot directory

EP6R1

EP6R1

Set a visual Note from an chosen file from disc.
If the action is performed with a sticky note selected and forceNewNote is False (Default)
the selected sticky note will be modified.
Otherwise a new sticky note will be created

if a filePath argument is given that path will be used,
otherwise a file dialog will be shown



filePath (string):                    An optional file path. If given no dialog will be shown

initialScale (string):                A percentage as a string to set the new scale factor to.
                                      Valid strings are:
                                      '5%' '10%' '20%' '30%' '40%''50%' '60%' '70%' '80%' '90%' '100%''110%'
                                      '120%''130%''140%''150%''160%''170%''180%''190%''200%'
                                      Defaults to 100%

forceNewNote (bool):                  Optional argument if to force a new Note at all times.
                                      Defaults to False. If False a new note will only be created if no
                                      existing visual Note is selected. Otherwise the existing one will be replaced.

customPosition (QPointf):              An optional custom position for the node. This might be required
because
the function internally replaces the original node.
                                      While the original node position should be maintained, sometimes you might
                                      want to specify a new position.
                                      Default to None,which in turn will use the center of the current nodegraph tab

colorizeImge (bool):                  If True, allows you to colorize the Image before use. Defaults to False.
                                      Colorization will be done within the Mari Project. E.g. if you supply an imagePath
                                      in a Location outside of the Mari Project Cache, the file will be copied over to the
                                      project and then colorized. The original file remains unchanged.

color (list):                         The color values to use when colorizeImage Parameter is true. Defaults to [255,255,255]

blendMode (string):                   The Blend Mode to use when colorizing an Image.
                                      Available option are "Multiply","Soft Light","Screen","Overlay".
                                      Defaults to "Multiply"

stickyNoteToReplace (mari.Node):      If forceNewNote is False and a node is provided on this argument, the given node
                                      will be replaced with a new image note


(mari.Node):                          Returns a StickyNote



EP6R1

EP6R1

Creates a visual note for given nodes by attaching a viewer to nodes
and placing the note directly next to the given node

If the graph and nodelist argument are None, then the currently open
graph tab and the selected nodes within it are used.


graph (mari.NodeGraph):             A optional Mari Nodegraph to work with. Defaults to None.
                                    If this is None, the currently open Nodegraph is used

nodelist (list):                    A list of nodes to process. Defaults to None.
                                    If this is None, the selected Nodes of the currently open
                                    Nodegraph are used.
                                    The nodes of the given Nodelist need to be part of the
                                    give graph (graph argument)



EP6R1

EP6R1

Creates a visual Note from the current viewport
If the action is performed with a sticky note selected
the selected sticky note will be modified.
Otherwise a new sticky note will be created



scaleFactor (string):                 A percentage as a string to set the default scale factor to.
                                      Valid strings are:
                                      '5%' '10%' '20%' '30%' '40%''50%' '60%' '70%' '80%' '90%' '100%''110%'
                                      '120%''130%''140%''150%''160%''170%''180%''190%''200%'
                                      Defaults to 100%


(mari.Node):                          Returns a StickyNote



EP6R1

EP6R1

Returns True if the given Node is a visualNote


node (mari.Node):             the node to test


(bool):                       True if the Node is a visualNote


EP6R1

EP6R1

Relinks a path of a given visual note to the current projects
Visual Note Folder. If the file does not exist inside the folder
it will be copied.


(mari.Node):                  a mari Node of type Sticky Note

EP6R1

EP6R1

will remove all visual Notes from the given Graph
If the Graph Argument is None (default),
the currently active Graph Tab will be considered


graph (mari.Nodegraph):       The mari.nodegraph to apply the action to.
                              Defaults to None, in which case the currently active
                              graph tab will be considered.

silent (bool):                if true, no warning dialog will be shown


EP6R1

EP2027 (fixed support for silent mode)

Sets an image onto a sticky note.


stickyNote (mari.Node):       A Mari Sticky Note

imagePath (string):           Path to an image file

sizeX    (int):               An optional initial width for the image

sizeY    (int):               An optional initial height for the image


(bool):                       Returns True if the action was successful

EP6R1

EP6R1

Replace the current stickyNotes image path with a new one


node (mari.Node):             a mari sticky note

newPath (string):             a path to an image on disc

original_path (string):       Optional. The Original Path is the Path an image was import from on disc.
                              This acts like a fallback if the main path inside the Project no longer exists.
                              Added in EP 6R3. Defaults to None.

EP6R1

EP6R3

Updates the given nodes core image size setting in the  html attribute


node (mari.Node):             a mari sticky note

newWidth (int):               the new width of the image

newHeight (int):              the new height of the image

customPosition (QPointF):      An optional custom position for the node. This might be required because
                              the function internally replaces the original node.
                              While the original node position should be maintained, sometimes you might
                              want to specify a new position.
                              Default to None.


mari.Node:                    Returns a sticky Note


EP6R1

EP2027 (fixed support for custom position)

Updates a visual Notes "Scale Factor" Setting.
Please note, this internally creates a new instance of the stickyNote which
replaces the old given node


node (mari.Node):             a mari sticky Note

newFactorPercent (string):    A percentage as a string to set the new scale factor to.
                              Valid strings are:
                              '5%' '10%' '20%' '30%' '40%''50%' '60%' '70%' '80%' '90%' '100%''110%'
                              '120%''130%''140%''150%''160%''170%''180%''190%''200%'

customPosition (QPoint):      An optional custom position for the node. This might be required because
                              the function internally replaces the original node.
                              While the original node position should be maintained, sometimes you might
                              want to specify a new position.
                              Default to None.


(mari.Node):                  Returns a StickyNote


EP6R1

EP6R1

Closes any Icon Shelf running in the Background


EP6R1

EP6R1

Opens a snapshot dialog showing the current view and allowing
cropping and default scale factor

EP6R1

EP6R1

Opens the icon shelf

EP6R1

EP6R1

Closes any currently active instance of the Icon Shelf
then resets the size and position to default


EP6R1

EP6R1

Opens the Sticker Designer in the Nodegraph


EP6R3

EP6R3

a signal connection when the image size dropdown in an image note gets triggered


name (string):               A Metadata Name

value (variant):             Metadata Value

node (mari.Node):            The Mari Node that needs updating


EP6R1

EP6R1

If the main image does not exist we check the original import path of the image
and transfer it onto the node


node (mari.Node):     A EP Image Note

EP6R3

EP6R3

Sets the Auto Reloading on selected images in the image manager
to on

If no images are selected, the selected Mari Image Manager Group is queried for images.
Image Manager Groups were introduced in Mari 7.5

EP6R1

EP6R4

Creates an Image Folder, and any of its parent folders that are missing.

Image Folders are an Extension Pack layer on top of Mari's Image Groups: a
nestable tree in the Image Manager sidebar. The folder an image lives on is
stored as metadata on the image, so it travels with the project.


path (str):                   The folder path to create, e.g. "/Mari/Materials".
                              Leading and trailing slashes are optional.


str:                          The created folder path, or None if it could not be
                              created (the root itself, or a path nested under a
                              folder that cannot hold children)

EP2027

EP2027

Moves a whole Mari Image Group onto an Image Folder.

Image Groups were introduced in Mari 7.5.


imageGroupName (str):         The name of the Image Group to move

path (str):                   The target folder path


int:                          The number of images that were moved

EP2027

EP2027

Moves the given images onto an Image Folder, creating the folder if needed.

Image Groups are atomic: if any of the given images belongs to a Mari Image
Group, every other member of that group is moved with it, so a group is never
split across two folders.


imageList (list):             A list of mari.Image objects to move

path (str):                   The target folder path. The root is coerced to
                              "/Unassigned", which is a holding area rather
                              than a location.


int:                          The number of images that were moved, including
                              any pulled in as group members

EP2027

EP2027

Checks if an Image is used in the project by comparing the Image Path
in the Image Manager to Image Path Metadata on all nodes in project

EP6R1

EP6R1

Returns the Image Folder currently selected in the sidebar.


str:                          The selected folder path, or None if the Image Folder
                              sidebar is not currently installed

EP2027

EP2027

Sets the "Auto Reload" Checkbox on all images in the Image Manager to "Off"

This is an action called from the Right Mouse Click Menu of the
Image Manager / Auto Reload Menu


EP6R1

EP6R1

Sets the Auto Reloading on selected images in the image manager
to off

If no images are selected, the selected Mari Image Manager Group is queried for images.
Image Manager Groups were introduced in Mari 7.5

EP6R1

EP6R4

EP DEPRECATION WARNING:

This method will be deprecated in a future version.
Replace with
toggleRemoveUnused(mode: bool | None = None, images: list[mari.Image] | None = None) -> None

Disables the IsReferenceImage Checkbox on selected images

If no images are selected, the selected Mari Image Manager Group is queried for images.
Image Manager Groups were introduced in Mari 7.5

EP6R1

EP2027

Enables the "Auto Reload" behavior on loaded Images Manager Images


imageList (list):        an optional list of images to limit the auto reload metadata addition to


EP6R1

EP6R1

EP DEPRECATION WARNING:

This method will be deprecated in a future version.
Replace with
toggleRemoveUnused(mode: bool | None = None, images: list[mari.Image] | None =None) -> None

Enables the IsReferenceImage Checkbox on selected images

If no images are selected, the selected Mari Image Manager Group is queried for images.
Image Manager Groups were introduced in Mari 7.5

EP6R1

EP2027

Checks if a given filepath is already imported into the Image Manager with optional checks for
raw and scalar mode


filePath (str):                                path to an image file

is_raw (bool):                                 Optional. If the files colorspace config should be RAW

is_scalar (bool):                              Optional. If the files colorspace config should be Scalar


mari.Image:                                   Returns the mari.Image Object or None if not found


EP6R3

EP6R3

Returns the Image Folder each of the given images lives on.

The result holds one entry per image, in the order they were given, so an
image and its folder line up by index. Use set() on the result for the
distinct folders a selection spans, or dict(zip(imageList, result)) to map
each image to its own.

Images that were never assigned to a folder report "/Unassigned".


imageList (list):             A list of mari.Image objects to query


list:                         A list of folder paths, one per image, in the
                              same order as imageList

EP2027

EP2027

Returns whether an Image Folder has any folders nested under it.


path (str):                   The folder path to query


bool:                         True if at least one folder sits underneath it

EP2027

EP2027

Returns whether an Image Folder is expanded in the sidebar.

The state is stored with the project, so this answers correctly even when the
Image Manager has not been opened yet.


path (str):                   The folder path to query


bool:                         True if the folder is expanded

EP2027

EP2027

Returns the drag data the Image Manager creates when an Image Group is dragged out of it

Use it to start a drag of an Image Group from your own tool: the Node Graph, the
Layer Stack and the canvas then take the drop exactly as if the group had been
dragged out of the Image Manager.


groupName (str):    Name of the Image Group

QtCore.QMimeData: The drag data, ready to be handed to a QDrag

EP2027

EP2027

Returns if the Image Manager redraw is currently being paused

bool: True while a pauseImageManagerRefresh(True) is active

EP2027

EP2027

Returns the images assigned to an Image Folder.


path (str):                   The folder path to query

recursive (bool):             Optional. If True, images on child folders are
                              included as well. Defaults to False, which matches
                              what the sidebar shows.


list:                         A list of mari.Image objects

EP2027

EP2027

Returns a list of all mari.Image Objects currently in use anywhere in the project (any node)



list:                                   Returns a list of mari.Image Objects


EP6R3

EP6R3

Returns every Image Folder in the project, in display order.


list:                         A list of folder paths, e.g. ["/Unassigned", "/Mari"]

EP2027

EP2027

Opens the last selected image in the application provided


applicationExecutable (str):    A path to an executable application


EP6R1

EP6R1

Opens the last selected image in the default application
associated with the image format

EP6R1

EP6R1

Opens the last selected image in your OS Filebrowser

EP6R1

EP6R1

Pauses the Image Manager redraw  while a script rearranges its images

Important:
Always unpause again, including when a script hits an error on the way -
a paused Image Manager stays frozen until something unpauses it:

mari.ExtensionPack.imageManager.pauseImageManagerRefresh(True)
try:
image = mari.images.open(path)
image.setImageGroup('My Group')
finally:
mari.ExtensionPack.imageManager.pauseImageManagerRefresh(False)


paused (bool):      True pauses the Image Manager redraw
                    False lets it draw again and redraws it once

EP2027

EP2027

Imports an SVG file into the Image Manager, rasterized at a given
size


filePath (str):                                path to a .svg file on disc

colorSpaceConfig (mari.ColorspaceConfig):      The Colorspace Config File to use for opening

size (tuple):                                  A tuple defining width and height of the final
                                              rasterized vector image


mari.Image:                                   Returns the mari.Image Object added to the Image Manager


EP6R2

EP6R2

Redraws the Image Manager, picking up anything that changed about its images

The Image Manager only re-reads the images when the user touches the palette,
so anything added or changed from a script - a new image, a new group, new
metadata on one - can sit there looking out of date until they click into it.
Call this after making such a change to have it show up straight away.

Please note this only has an effect in Mari 7.5 and above and only if the
Image Manager Style in Prefs/Misc/UI Style is set to Extension Pack

EP2027

EP2027

Reloads a given image Object.
Returns the image object


imageObject:      the mari.image object to reload


mari.Image:        the new image object

EP6R1

EP6R1

Reloads selected images in the image manager from disc and updates
their occurrences inside of the project (tiled, triplanar etc.)


svgMode (bool):       Optional. If True and the selected File originates from a 
                      .svg file (as detected by metadata "svgSourceFile"
                      a dialog will spawn to be able to change the resolution
                      of the rasterized image. If False (default) the svg file
                      will be reloaded at previous resolution.
                      Argument Has no effect on other file formats.

EP6R1

EP6R2

Reloads selected images in the image manager from disc and updates
their occurrences inside of the project (tiled, triplanar etc.).
If the selected file originates from an SVG File a dialog will prompt for the new resolution

EP6R2

EP6R2

Deletes every Image Folder in the project.

All images are moved to "/Unassigned"; nothing is removed from the project.


int:                          The number of images that were moved to "/Unassigned"

EP2027

EP2027

Deletes every Image Folder that holds no images.

A folder only counts as empty when nothing in its whole subtree holds an image,
so a parent is never removed out from under a child that is still in use.


list:                         The folder paths that were removed, shallowest first

EP2027

EP2027

Removes any empty Groups from the Image Manager

Mari 7.5 and above only.


EP6R3

EP6R3

EP DEPRECATION WARNING:

This method will be deprecated in a future version.
Mari 7.5 removes Image Manager Tabs as a feature and replaces it with Groups

Removes any empty Categories/Tabs from the Image Manager


EP6R3

EP6R3

Deletes an Image Folder and everything nested under it.

Any images held by the deleted folders are moved to "/Unassigned" rather than
removed from the project. "/Unassigned" itself cannot be deleted.


path (str):                   The folder path to delete


int:                          The number of images that were moved to "/Unassigned"

EP2027

EP2027

EP DEPRECATION WARNING:

This method will be deprecated in a future version.
Mari 7.5 removes Image Manager Tabs as a feature and replaces it with Groups

Removes all User created Image Manager Tabs

EP6R1

EP6R1

Returns the selected Image Manager Group


strict (bool):      When True, only a selected group counts - 
                    selecting an image inside an expanded group returns None 
                    instead of that group. 
                    Defaults to False, which will return the Group Name even if the group
                    itself is not selected

str: The name of the selected Image Manager Group or None if no group is selected

EP6R4

EP2027 - added "strict" arg

Sets the Auto Reloading on selected images in the image manager
to on or off

If no images are selected, the selected Mari Image Manager Group is queried for images.
Image Manager Groups were introduced in Mari 7.5


mode (bool):           True/False to enable/disable the Auto Reload

EP6R1

EP6R4

Selects an Image Folder in the sidebar, which filters the image grid to it.

A folder nested under a collapsed parent has no row to select, so every ancestor
is expanded on the way down to it.


path (str):                   The folder path to select. "/" selects the root,
                              which shows every image.


bool:                         True if the sidebar ended up on that folder. False if
                              the folder does not exist, or if the sidebar is not
                              currently installed.

EP2027

EP2027

Sets a custom Color on a Image Manager group

Please note this only has an effect in Mari 7.5 and above and only of the
Image Manager Style in Prefs/Misc/UI Style is set to Extension Pack


group_name (str):      Group name to change the color on
color (str):          Color as hex (#RRGGBB), rgb(r,g,b), or rgba(r,g,b,a)

EP6R4

EP6R4

Sets a custom Color on a Image Manager group based on an icon.
It samples the center color of the icon which is useful to give a group color based on eg a material thumbnail

Please note this only has an effect in Mari 7.5 and above and only of the
Image Manager Style in Prefs/Misc/UI Style is set to Extension Pack


group_name (str):                                The name of the group to change
icon_path (str):                                 The path to the icon to set

EP6R4

EP6R4

Sets a custom Icon on a Image Manager group

Please note this only has an effect in Mari 7.5 and above and only of the
Image Manager Style in Prefs/Misc/UI Style is set to Extension Pack


group_name (str):                                The name of the group to change

icon_path (str):                                 The path to the icon to set

color_code (str):                                Optional. A color code to set the group to.
                                                 Color as hex (#RRGGBB), rgb(r,g,b), or rgba(r,g,b,a)
                                                 Defaults to None.

EP6R4

EP6R4

Sets a custom Icon on a Image Manager group based on the currently selected Image.
If the image is inside a group, that group's icon will be set to the image's icon.

Please note this only has an effect in Mari 7.5 and above and only of the
Image Manager Style in Prefs/Misc/UI Style is set to Extension Pack

EP6R4

EP6R4

Expands or collapses an Image Folder in the sidebar.


path (str):                   The folder path to expand or collapse

expanded (bool):              Optional. True to expand (default), False to collapse


bool:                         True if the folder exists

EP2027

EP2027

Toggles images to be included/excluded in the "Remove Unused Images" evaluation.
This can be used to prevent reference images you would like to keep from being removed
even though they aren't in use anywhere inside your project.

With multiple selected images in the image manager the mode wins with the most items e.g.
if you have 10 images selected and 6 are already marked as excluded while 4 aren't, the function
will set all 10 images to "not excluded" as "exclude" has the most CURRENT matches.

if you wish to deliberately set a mode, you can use the optional mode argument:
mode=True will set all images to be excluded from removal, False will set all images to be included in the
removal process



Args:
mode  :                     Optional. If True, all selected images will be excluded from removal
(bool | None)               If False they will be all included in the removal process||.
Defaults to None. None determines first how many items are already
being excluded. If more items are marked as excluded, "Excluded" will be
                              the current state for all images and the function will set all to "not excluded"

images:                     Optional. A list of images to set the mode for. If None (default) the
(list[mari.Image] | None)   current selection of images or image groups is used


Returns:
None

EP2027

EP2027

Uses the currently selected image as the brushtip on the current tool

EP6R1

EP6R1

Launch UI to configure Applications to open images in

EP6R1

EP6R1

Export the selected images in the image manager to a folder


fromSelectedImageGroup (bool):                If True, only images in the currently selected Image Manager
                                              Group will be exported. If False (default), any selected 
                                              images will be exported. Image Manager Groups are available 
                                              from Mari 7.5v1 onwards.


EP6R1

EP6R4

Opens a color picker dialog allowing you a custom ID color for an image group

EP6R4

EP6R4

Opens a file browser dialog allowing you select an image file to use as a thumbnail for an image group

EP6R4

EP6R4

Opens a SVG Rasterization Dialog


filePath (str):                a path to a svg file
originalImage (mari.image):    a mari image object to replace (optional, defaults to None)
noCancel (bool):               if True, the Cancel Button in the SVG Loader is disabled


mari.Image:                   a rasterized Mari Image Object

EP6R2

EP6R2

Returns True if a custom image manager skin is applied, False otherwise


bool: True if a custom image manager skin is applied, False otherwise

EP6R4

EP6R4

Darkens or brightens an Image

pathImageIconOrPixmap (str,QImage,QIcon or QPixmap): A object to darken or brighten

factor (int):                Determines if to brighten or darken the image.Defaults to 100, which means
                             no change. Values above 100 darken, values below 100 brighten

desaturate (bool):           Defaults to False. If True, the input image is desaturated first.

return_QImage (bool):        By default the same format as the pathImageIconOrPixmap input
                             is returned. However if this argument is a string (path), then
                             by default a pixmap is returned unless the return_QImage is set to True.

varying:                     By default the same object type is returned as the input argument
                             pathImageIconOrPixmap. However if this argument is a string (path)
                             then by default a pixmap is returned unless the return_QImage Argument
                             is set to True


EP6R3

EP6R3

Returns a desaturated QPixmap object from a Input QPixmap object

original_pixmap (QPixmap): The original QPixmap object

QPixmap:                  The desaturated QPixmap

EP6R3

EP6R3

Returns a desaturated QImage object from a Input QImage object

original_qimage (QImage): The original QImage object

QImage:                    The desaturated QImage

EP6R3

EP6R3

Returns a QIcon from an Extension Pack Image located in its resources/icon folder

icon_name (str):        The filename of the icon with or without an extension. If no extension is given
                        the filename is case-insensitive.

scaledTo (list):        [width, height] to scale the icon to. Optional. Leave at default None to ignore

stateAware (bool):      If True, the Icon is aware of checked and unchecked states and will desaturate when
                        unchecked. Defaults to False

QIcon:                 The resulting QIcon

EP6R3

EP6R3

Returns a QPixmap from an Extension Pack Image located in its resources/icon folder

icon_name (str):        The filename of the icon with or without an extension. If no extension is given
                        the filename is case-insensitive.

scaledTo (list):        [width, height] to scale the icon to. Optional. Leave at default None to ignore


QPixmap:                 The resulting pixmap

EP6R3

EP6R3

Returns a QIcon from an Image located in the mari icon folder

icon_name (str):        The filename of the icon with or without an extension. If no extension is given
                        the filename is case-insensitive.

scaledTo (list):        [width, height] to scale the icon to. Optional. Leave at default None to ignore

stateAware (bool):      If True, the Icon is aware of checked and unchecked states and will desaturate when
                        unchecked. Defaults to False

QIcon:                 The resulting QIcon

EP6R3

EP6R3

Returns a QPixmap from an Image located in the mari icon folder

icon_name (str):        The filename of the icon with or without an extension. If no extension is given
                        the filename is case-insensitive.

scaledTo (list):        [width, height] to scale the icon to. Optional. Leave at default None to ignore


QPixmap:                 The resulting pixmap

EP6R3

EP6R3

The Add Mask Tools in Extension Pack are replacements for the existing Mari Add Mask functionality

Reveal All
Hide All
From Alpha
From Selection
From Selection Group

They act identical to the default Mari functionality in most cases however the Add Mask Tools
will no longer be disabled/greyed out when a mask or mask stack already exists on the layer

When executed on a layer with a pre-existing mask, the mask will be removed and a new one added
depending on the tool executed

When executed on a layer with a pre-existing mask stack, the mask stack will be removed and a new one added
depending on the tool executed


mode (str):    available options are "reveal","hide","from Alpha","from Selection","from Selection Group"


EP6R1

EP6R1

Executes layer Clone & Merge

EP6R1

EP6R1

Extension Pack Version of standard Mari Layer Convert to Paintable
Supports multi selection and channel layers

EP6R1

EP6R1

Copies selected Layer Attributes to a Clipboard

EP6R1

EP6R1

Executes "Copy with Shared Connections"
Shared Layers will always be relinked to their original source,
including in Mask Stacks
Pasted Channel Layers will be relinked to the original channel,
without unnecessary channel duplication

EP6R1

EP6R1

The following are used to find layerselections no matter where in the Mari Interface
(Floating Palettes, Mask Stacks etc.)

This is to support a) Layered Shader Stacks b) deeply nested stacks (maskstack,adjustment stacks),
as well as cases where users are working in pinned or docked channels without it being the current channel


includeAdjustmentStacks (bool):      Determines if to include this StackType into the search

includeMaskStacks (bool):            Determines if to include this StackType into the search

includeGroupLayers (bool):           Determines if to include this StackType into the search

includeChannelLayers (bool):         Determines if to include this StackType into the search

silentFail (bool):                   If true, no warnings are returned if nothing is found


curGeo:                             The current Geo or NONE

curChannel:                         The current Channel or NONE

curStack:                           The current Layerstack (NOT the same necessary as the channel) or NONE

curLayer:                           The 'current' layer as in the current paint target or NONE

curSelList:                         A list of all selected layers or NONE


EP6R1

EP6R1

Standard Mari Layer COPY Action,however since extension pack
moves the action in the UI it is declared here again

EP6R1

EP6R1

Standard Mari Layer CUT Action,however since extension pack
moves the action in the UI it is declared here again

EP6R1

EP6R1

Standard Mari Layer PASTE Action,however since extension pack
moves the action in the UI it is declared here again

EP6R1

EP6R1

Returns a list of Mari Nodes from the current Layer Selection


list[mari.Node]:                             a list of mari.Node Objects

EP2027

EP2027

paste Layer Attributes onto selected layer from  a Clipboard

EP6R1

EP6R1

Executes "Paste with Shared Connections"
Shared Layers will always be relinked to their original source,
including in Mask Stacks
Pasted Channel Layers will be relinked to the original channel,
without unnecessary channel duplication

EP6R1

EP6R1

toggles the locking of selected layers

EP6R1

EP6R1

toggles the visibility of selected layers

EP6R1

EP6R1

toggles the locking of unselected layers

EP6R1

EP6R1

toggles the visibility of unselected layers

EP6R1

EP6R1

Dialog Call.
Allows you to swap out any Layer type for another Layer type.
If possible, settings are transferred between nodes

EP6R1

EP6R1

Load an mws layout file from a given path.


Path (string):             The Path to a mws layout file or folder where a mws layout file is located.

LayoutName (string):       Optional Argument. The Layout File Name without extension.
                           This is required if the Folder the file sits in is named differently then the Layout file


EP6R1

EP6R1

Restore the Mar Default Layout

EP6R1

EP6R1

Saves a layout to the folder specified in Mari Preferences / Path / Layout Tab.
Also adds the layout to View / Saved Layouts Menu


layoutName (string):         The name of the layout

Description (string):        An Optional Description. Defaults to ""


(string):                    Returns a cleaned Layoutname, that has been sanitized from invalid characters

EP6R1

EP6R1

Sets the Layout Folder in the Preference.
This is the location where layouts are loaded from.


path (string):            A path where Layouts should be stored


bool:                     True if path could be set

EP6R1

EP6R1

Set the Preference Window Corner Dock Areas to a value

EP6R1

EP6R1

Set the Preference Window Corner Dock Areas to a value

EP6R1

EP6R1

Set the Preference Window Corner Dock Areas to a value

EP6R1

EP6R1

Set the Preference Window Corner Dock Areas to a value

EP6R1

EP6R1

Set the Preference Window Corner Dock Areas to a value

EP6R1

EP6R1

Set the Preference Window Corner Dock Areas to a value

EP6R1

EP6R1

Export a Layout to Disc via a File Dialog

EP6R1

EP6R1

Import a Layout from Disc via a fileDialog

EP6R1

EP6R1

Open the Layout Manager UI

EP6R1

EP6R1

Open a dialog to specify a name and description for a layout.
The Layout gets saved into the location specified in Mari Preferences / Path / Layout


EP6R1

EP6R1

Utility method returning the current mws layout info
which can be useful to find edge cases where EP utility functions such as "findNodegraphTabwidget"
are not working

str:          Returns a string, representing the contents of a mws layout file

EP6R3

EP6R3

Re-adds custom UI Elements previously added by EP on Startup
(View / extPack_layoutChange)

This can be useful if for example a layout change is called, which by default
will remove custom widgets added by Extension Pack

EP6R1

EP6R1

Restores all previously saved layouts to Menu
View / Saved Layouts. This is called on Mari Open

EP6R1

EP6R1

Rotates the Environment Light.
Mode is either "slow","medium" or "fast"
The multiplier is usually 1 or -1 to rotate clockwise or
counterclockwise


mode (string):        The mode determines the rotation angles per step as defined in the Mari Preferences
                      Options are "slow","medium","fast"

multiplier (int):     The Multiplier defines the direction of rotation .. clock wise or counter-clockwise.
                      Usual settings are 1 for clockwise, -1 for counter clockwise


EP6R1

EP6R1

Rotate all lights by the given angle


angle (int)     angle to rotate by

EP6R1

EP6R1

Ingests the currently selected image manager group (its images) into the given layers
By default this will use your selected layers and selected image group in the image manager.


layerlist (list):               List of mari.Layer (optional). If None, selection is used

imagegroup (str):              Name of Mari Image Group (optional). if None, selection is used

EP6R4

EP6R4

Ingests the currently selected image manager image group into the given node

By default this will use your selected node and selected image group in the image manager.
However you can overwrite this via arguments


nodelist (list):                List of mari.Nodes (optional). If None, selection is used

imagegroup (str):              Name of Mari Image Group (optional). if None, selection is used

EP6R4

EP6R4

Ingests the currently selected image manager images into the active layer


layerlist (list):               List of mari.Layer (optional). If None, selection is used

imagelist (list):               List of mari.Images (optional). if None, selection is used

groupAware (bool):              Optional. Defaults to False. If True and imagelist is None, 
                                the function will first check for selected Image Manager Groups and derive
images from that selection. Image Manager Groups are only available in Mari 7.5
and above

EP6R1

EP6R4

Ingests the currently selected image manager images into the active node

By default this will use your selected node and selected images in the image manager.
However you can overwrite this via arguments


nodelist (list):                List of mari.Nodes (optional). If None, selection is used

imagelist (list):               List of mari.Images (optional). If None, selection is used

groupAware (bool):              Optional. Defaults to False. If True and imagelist is None, 
                                the function will first check for selected Image Manager Groups and derive
images from that selection. Image Manager Groups are only available in Mari 7.5
and above

EP6R1

EP6R4

A wrapper around the standard mari material ingester.
All it does is turn the ingester into a mari action to be able
to get its action.triggered() signal

EP6R1

EP6R1

Returns the Translation,Scale and Rotation Values from a given Matrix


matrix (mari.Matrix):            a Mari Transform Matrix


Tuple:                            a tuple comprised of 3 sets of:
                                  ( Scale X, Scale Y, Scale Z)
                                  ( Angle X, Angle Y, Angle Z)
                                  ( Translation X, Translation Y, Translation Z)

EP6R3

EP6R3

Returns the Rotation Values from a given Matrix


matrix (mari.Matrix):            a Mari Transform Matrix


list:                            a list of 3 values corresponding to X,Y and Z

EP6R3

EP6R3

Returns the Scale Values from a given Matrix


matrix (mari.Matrix):          a Mari Transform Matrix


list:                         a list of 3 values corresponding to X,Y and Z

EP6R3

EP6R3

Returns the Translation Values from a given Matrix


matrix (mari.Matrix):            a Mari Transform Matrix


list:                            a list of 3 values corresponding to X,Y and Z

EP6R3

EP6R3

Return the Inverse Matrix

matrix (list, 16 items):            A transform matrix (4x4) as a list

Matrix (4x4):                       A inverted Transform Matrix

EP6R3

EP6R3

EP DEPRECATION WARNING:

This method will be deprecated in a future version.
Use toScaleEulerAnglesTranslationMatrix() instead

Creates a 4x4 Matrix from given Vectors



rotation  (List):              A list of 3 values XYZ

translate (List):              A list of 3 values XYZ

scale     (List):              A list of 3 values XYZ


List:                         a list of 16 items that can be fed into a mari.Matrix

EP6R1

EP6R1

Convert Object Space XYZ Values for scale, angles and translation to World Space Matrix

world_scale (list):            List of 3 floats, X, Y, Z, representing scale in world space
world_angles (list):           List of 3 floats, X, Y, Z, representing rotation in world space
world_translation (list):      List of 3 floats, X, Y, Z, representing translation in world space

Matrix (4x4):                  A World Space Transform Matrix

EP6R3

EP6R3

This method is a stable workaround for mari's buggy

- geoEntity.setTransform(matrix, clockframe)
- locatorEntity.setTransform(matrix, clockframe)

methods. When using mari's native methods the object receives updated transforms however the next time
the user interacts with the Object outside of python via the "Transform Selected Object" Tools, the
Python changes are discarded.
The reason for this is that the setTransform() methods do not update metadata on the active object related
to the Viewport Gizmo:

The following Metadata exists:

LocatorScale
LocatorTranslation
LocatorRotation

Each one of those accepts a string version of a custom matrix, e.g. LocatorScale needs to be given a pure Scale
Matrix.

This method first runs a regular setTransform() with the provided transform_matrix, then handles the metadata.


obj (mari.geoEntity or locator):          The Mari Geo or Locator to apply transforms to
transform_matrix (Matrix):                The Full 4x4 Transformation Matrix to apply to the Object
clock_frame (int):                        Optional. Frame to apply Transform to. Defaults to 0

None:

EP6R3

EP6R3

Returns a Euler angle Matrix from given Scale X,Y,Z Values


values (tuple):                  a tuple (x,y,z)


mari.Matrix:                     A Matrix

EP6R3

EP6R3

Returns a 4x4 Transform Matrix


scale (tuple):                            a tuple (x,y,z) for scale values
angles (tuple):                           a tuple (x,y,z) for rotation values
translation (tuple):                       a tuple (x,y,z) for translation values


mari.Matrix:                               A Matrix

EP6R3

EP6R3

Returns a Scale Matrix from given Scale X,Y,Z Values


values (tuple):                  a tuple (x,y,z)


mari.Matrix:                      A Matrix

EP6R3

EP6R3

Returns a Translation Matrix from given Scale X,Y,Z Values


values (list):              a list [x,y,z]


mari.Matrix:                  A Matrix

EP6R3

EP6R3

Convert Worldspace XYZ Values for scale, angles and translation to Object Space

world_scale (list):            List of 3 floats, X, Y, Z, representing scale in world space
world_angles (list):           List of 3 floats, X, Y, Z, representing rotation in world space
world_translation (list):      List of 3 floats, X, Y, Z, representing translation in world space

object_scale (list):            List of 3 floats, X, Y, Z, representing scale in object space
object_angles (list):           List of 3 floats, X, Y, Z, representing rotation in object space
object_translation (list):      List of 3 floats, X, Y, Z, representing translation in object space

EP6R3

EP6R3

Returns a Dictionary of Channels [UUID:CHANNEL]
that a given node belongs to


node_to_find (mari.Node):                 A Node (mari.Node) you want to determine which channel(s) are using it

geo (mari.geoEntity):                     Which Object in your scene you want to check for channels

excludeChannelLayer (bool):               If true only Channels will be returned that use the node in their own channel stream
                                          but not as part of a 'channel layer' stream


{dict}:                                   Returns a Dictionary of Channels with key= ChannelUUID, value=ChannelObject



EP6R1

EP6R1

will connect the currently selected node to the previous selected node
Repeated execution of the command will cycle the connection through the
inputs of the currently selected node


overwriteExistingConnections (bool):       Determines if the connection overwrites existing connections
                                           from other nodes. If True, the previous node will replace
                                           the existing node connection on a port, if false, it will
                                           find the first empty input port to connect to

EP6R1

EP6R1

Copies Input and Output Connections from the Source Node to the Target Node



nodeToCopyFrom (mari.Node):               The source node from which to copy connections

nodeToCopyTo (mari.Node):                 The target node to which to copy connections

RemoveSourceNode (bool):                  If to remove the source Node after copying. Defaults to False



None:


EP6R1

EP6R1

Convenience method to get the current node selection.
Returns the first selected node or all selected nodes of the current nodegraph


returnFirstSelectedNode (bool):       if True, only the first selected node is returned


(list):                               The list of selected Nodes if returnFirstSelectedNode is False
(mari.Node):                          The first selected Node if returnFirstSelectedNode is True and a Node is selected
                                      None if no node is selected.


EP6R1

EP6R1

Disconnects all node connections feeding into the given nodes.
If no nodes are specified in the argument, the selected nodes are used instead


nodelist (list):                          Optional. A List of Mari Nodes to run the command on.
                                          Defaults to None. If None, the selected Nodes will be used instead

EP6R1

EP6R1

Disconnects all node connections feeding out of the  given nodes.
If no nodes are specified in the argument, the selected nodes are used instead


nodelist (list):                            Optional. A List of Mari Nodes to run the command on.
                                          Defaults to None. If None, the selected Nodes will be used instead

EP6R1

EP6R1

Returns the Nodes that are connected to the Output of the supplied Node
With Skip Dots turned on, the return will contain the node connected to a dotNode
if there is one inbetween

Please note as of Mari 4.5 there is additional standard Python API mari.node().outputNodes()
that may be better suited for the task in some cases



graph (mari.nodeGraph):                   The Graph to search in

node_to_find (mari.Node):                 The node you want to check for, which other nodes are connected to
                                          its output(s)

skipDots  (bool):                        If to ignore dot nodes as output and proceed to next node

specificOutput (string):                 If to check a Specific Output Port Name of node_to_find


(list):                                   A list of pairs ([mari.Node,Output Port Node is connected to on node_to_find)


EP6R1

EP6R1

Given a Target Node (and the nodeGraph it lives in) this will return all Nodes
that are connected to the targetNode + optionally targetNode again as well.


targetNode (mari.Node):                             The Node you want to find all connected nodes for

nodeGraph (mari.nodeGraph):                         The Nodegraph the targetNode lives in

GroupContentMode (str):                             If "Include Group Node Contents" all Nodes inside of Graph Groups will be returned as well.
                                                    Otherwise just the nodes from the target Node Nodegraph will be returned

returnBakePointUpstream (bool):                     If "False" nodes upstream from bake points will only be returned if the bake point
                                                    is disabled or does not useBake(). If "True" all nodes upstream of Bakepoints will be returned

includeTargetNode (bool):                           If "True" the given targetNode will be includes in the returned list

GraphGroup_TraverseConnectedOutputOnly (bool):      If 'True' and GroupContentMode = Include Group Node Content, 
                                                    only group content will be evaluated that is connected to an output that
                                                    is part of the topological sorting of the main input node given to the function

MainGraph_TraverseStreamOnly (bool):                If 'True' the given Nodegraph will only return upstream nodes that are part of the
                                                    specified StartStream. The StartStream will only be evaluated from the first MultiChannel
                                                    Node onwards, before that all upstream nodes are included

IncludeGraphGroupNode (bool):                       If True Graph Group Nodes are included in the returned Node List. Otherwise only the
                                                    CONTENTS of the Graph Group Nodes are returned (given that groupContentMode is set to
                                                    'Include Group Node Contents')
                                                    
                                                    If IncludeGraphGroupNode is False and includeMaterials is True, normal GraphGroups
                                                    are not returned while material multiChannels nodes are returned.

IncludeMaterials (bool):                            If True Material MultiChannelNodes are included. This will include Materials even if
                                                    IncludeGraphGroupNode is off

StartStram (string or None):                        Optionally, you can provide a stream name to evaluate along. You should have
                                                    GraphGroup_TraverseConnectedOutputOnly turned on for this


(list):                                             A list of nodes (mari.Node)



EP6R1

EP6R1

Returns a list of all nodes connected to the given targetNode downstream (to the right)

targetNode (mari.Node):      The Node to query

includeTargetNode (bool):    Optional. Defaults to False
                             If True, the given Target Node will be part of the
                             returned list

traverse_groups (bool):      Optional. Defaults to True.
                             If True, the connections are tracked even if it exits
                             a subgraph meaning that if you give it a node inside
                             a group as targetNode, you will even get connected nodes
                             outside that groupnode



(list):                       Returns a list of mari.Nodes


EP6R3

EP6R4

Returns a list of Material Stream Names the given (multi channel)node is connected to via
channel nodes.

E.g. if a Material's Streams "Base" and "Rgh" are connected to channel nodes (e.g. DIF
and Roughness), and all other material outputs are not connected to channels, the returned
list will be ["Base", "Rgh']


node (mari.Node):                    The Node to test for a stream


(list):                             List of stream names


TypeError:                          Raised if the given node is not a MultiChannel Node


EP6R3

EP6R3

Returns the Node Category of a Node, as it is listed in the UI


node:                            A Node Object (mari.Node)


(string):                        Returns the Node Category as a String


EP6R1

EP6R1

If the given inputNode is part of a node stream that has multiChannel Nodes,
this method will return the Material Stream Name this Node is part of. E.g. 'Base Color', 'Metallic' etc.
This can the be used in other methods to filter nodestreams based on stream name e.g. in
mari.ExtensionPack.nodegraph.getNodesonStream()


graph (mari.NodeGraph):                   The Graph the inputNode belongs to

inputNode (mari.Node):                    The Node to test for a stream name


(bool):                                     Returns True if the Node is part of a Material Stream, False if not

(string):                                   Returns the Stream Name if Node os part of a Material Stream, 'None' (as string) if not


EP6R1

EP6R1

Returns the Node Position as a list and a string


graph:                        The nodegraph the node belongs to (mari.NodeGraph)

node:                         A Node Object (mari.Node)


(list):                       Returns a list with the coordinates [x,y]


EP6R1

EP6R1

Returns the pretty Name of a Node, as it is listed in the UI


node:                            A Node Object (mari.Node)


(string):                        Returns a String


EP6R1

EP6R1

A wrapper method around mari.node.inputNode() to deal with differences
between mari versions.
The method will return pairs of [inputNode,outputPortOnInputNode] for mari 4.5
and above and [inputNode,''] for versions below mari 4.5


node:                         The node to check for connections on (mari.Node)

port:                         The Input Port Name to check for connections (string)


(list):                       Returns a list with the pair [inputNode, outputPortOnInputNode]


EP6R1

EP6R1

Moves Nodes to a specific position


graph:                        The nodegraph the node belongs to (mari.NodeGraph)

nodes:                        A list of mari nodes

positionList:                 A list of coordinates [x,y]


(list):                       Returns a list of mari.Nodes


EP6R1

EP6R1

Wrapper for differences in node name functions between Mari 4.x and Mari 4.8


node (mari.Node):                         The Node to get the name from


(string):                                 The Node name


EP6R1

EP6R1

Reload Paint and Images will work on the current Nodegraph's Node Selection. It will
a) reload Paint Nodes with Images according the per-Image-in-Imageset Path
b) reload any image manager nodes used in selected nodes
c) re-export and reload Bake Point Image Data



silent (bool):         if silent is True, no message boxes will appear asking to confirm. Defaults is False


EP6R1

EP6R1

Save the given Nodes Node Attributes to a File
Similar to what is in the Nodegraph Class, but this one can use a given node instead of a selection


selectedNode (mari.Node):              A Mari Node


EP6R1

EP6R1

A wrapper method around mari.node.setInputNode() to deal with differences between mari versions.
The method allows the same code for both Mari 4.5+ and below
On mari 4.5+ this supports multiOutput Nodes, below it doesn't so the OutputPortName is ignored then.


node:                           The node to connect something to (mari.Node)

portname:                       The Input Port Name to connect something to (string)

NodeToConnect:                  The Node to Connect to the Port

OutputPortName:                 The OutputPort of the NodetoConnect to connect to


None:


EP6R1

EP6R1

Apply a saved set of Node Attributes the given Node
Similar to what is in the Nodegraph Class, but this one can use a given node instead of a selection


selectedNode (mari.Node):               A Mari Node


EP6R1

EP6R1

Wrapper for differences in node name functions between Mari 4.x and Mari 4.8




node (mari.Node):                         The Node to set a new name on

newName (string):                         The new Node name


None:


EP6R1

EP6R1

Smart rename Nodes. Renames node based on upstream connection


graph (mari.Nodegraph):               A mari Nodegraph object

node (mari.Node):                     Node to rename


EP6R1

EP6R1

Align nodes horizontally Bottom
Requires Mari 4.7 or higher



nodelist (list):                                   A list of Mari Nodes. If not provided defaults to selected nodes

defaultToSelection (bool):                         If true and nodelist is empty, the graph selection will be used

streamBased (bool):                                If true (default), nodes will be aligned based on their node streams.
                                                   This means nodes of a stream will align to the bottom position of the node 
                                                   with the highest Y coordinate in your selection, that shares the same neighbouring nodes.

preventAnimation (bool):                           If true, nodes will directly jump to a position instead of having animated movement


None:


EP6R1

EP6R1

Align nodes horizontally top
Requires Mari 4.7 or higher



nodelist (list):                                   A list of Mari Nodes. If not provided defaults to selected nodes

defaultToSelection (bool):                         If true and nodelist is empty, the graph selection will be used

streamBased (bool):                                If true (default), nodes will be aligned based on their node streams.
                                                   This means nodes of a stream will align to the top position of the node 
                                                   with the highest Y coordinate in your selection, that shares the same neighbouring nodes.

preventAnimation (bool):                           If true, nodes will directly jump to a position instead of having animated movement


None:


EP6R1

EP6R1

Align nodes vertically left
Requires Mari 4.7 or higher


nodelist (list):                                   A list of Mari Nodes. If not provided defaults to selected nodes

defaultToSelection (bool):                         If true and nodelist is empty, the graph selection will be used

streamBased (bool):                                If true (default), nodes are aligned per node stream.
                                                   Separate streams (e.g. one node each) align to their neighbouring 
                                                   node's port, as if only that node were selected, instead of 
                                                   aligning to each other.

preventAnimation (bool):                           If true, nodes will directly jump to a position instead of having animated movement


None:


EP6R1

EP2027

Align nodes vertically right
Requires Mari 4.7 or higher



nodelist (list):                                   A list of Mari Nodes. If not provided defaults to selected nodes

defaultToSelection (bool):                         If true and nodelist is empty, the graph selection will be used

streamBased (bool):                                If true (default), nodes are aligned per node stream.
                                                   Separate streams (e.g. one node each) align to their neighbouring 
                                                   node's port, as if only that node were selected, instead of 
                                                   aligning to each other.

preventAnimation (bool):                           If true, nodes will directly jump to a position instead of having animated movement


None:


EP6R1

EP2027

Given a list of nodes, the method will determine the farthest left and right node position
and distribute the other nodes of the list inbetween evenly


nodelist (list):                                     A List of Mari Nodes


EP6R1

EP6R1

Given a list of nodes, the method will determine the highest and lowest node position
and distribute the other nodes of the list inbetween evenly


nodelist (list):                                     A List of Mari Nodes


EP6R1

EP6R1

Using the list of currently selected nodes, the method will determine the farthest left and right node position
and distribute the other nodes of the list inbetween evenly


EP6R1

EP6R1

Using the list of currently selected nodes, the method will determine the highest and lowest node position
and distribute the other nodes of the list inbetween evenly



EP6R1

EP6R1

Distribute Nodes horizontally with a given Distance between Nodes starting from the first node on the left


nodelist (list):                                   A List of Mari Nodes. If 'None' is handed in, it uses the current selection

specificXDistance (float/int):                     The distance between nodes

backDropOffsetLimit (bool):                        when true, nodes will now be allowed to go outside of their parent backdrop


(bool):                                            Returns if the node distance was artificially constrained by the backdropOffsetLimit


EP6R1

EP6R1

Distribute Nodes vertically with a given Distance between Nodes starting from the first node at the top



nodelist (list):                                    A List of Mari Nodes. If 'None' is handed in, it uses the current selection

specificYDistance (float/int):                      The distance between nodes

backDropOffsetLimit (bool):                         when true, nodes will now be allowed to go outside of their parent backdrop



(bool):                                             Returns true if the node distance was artificially constrained by the backdropOffsetLimit


EP6R1

EP6R1

This method is a modification of Mari's own nodegraph.autoLayoutNodes() method.
It works either with the given arguments or without them, in which case
the currently open Nodegraph and its selected nodes are used.

When a single node is selected and layoutNodes is called, Mari's own
autoLayoutNodes() is called with the selected Node as its root.

If multiple nodes are selected only the selected nodes will be laid out,
which is the main difference to mari's autoLayout, which always lays out the
entire connected stream


graph (mari.Nodegraph):                           Optional argument to give a parent nodegraph. Defaults to None

nodelist (list of mari.Nodes):                    Optional argument to give a list of nodes to operate on.
                                                  If the nodelist is empty but the graph argument is not None,
                                                  the selected nodes in the given graph are used.
                                                  If the list is not empty, the given nodes need to be part of
                                                  the given graph given as argument.
                                                  
                                                  If both graph and nodelist args are not given, the method will always
                                                  run on the currently open graph and its selected nodes


EP6R1

EP6R1

Opens a UI to distribute nodes

EP6R1

EP6R1

Cycle backwards through the available node graph bookmark nodes in the current graph

EP6R1

EP6R1

Cycle forward through the available node graph bookmark nodes in the current graph

EP6R1

EP6R1

jump to the next downstream node (based on current node selection) that matches
either the typeIDtoFind or a special customSearch parameter.
If a customSearch is defined, this supersedes the typeIDtoFind


typeIDToFind (string):           A Type ID to find (node.typeID()). Nodes of the same type count,
                                 all versions of it included (e.g. "_V2"), not other types that
                                 merely start the same

customSearch (string):           If a custom search is defined,this supersedes any typeIDToFind.
                                 Possible custom searches are:
                                 "paint","bakePoint","geoChannel","groupNode","channelNode","shader","material"


EP6R1

EP2027 (same type only, no longer any type starting with typeIDToFind)

jump to the next downstream node in the stream that is matching
the current noe selection type

EP6R1

EP6R1

Jumps to the connected Node of the currently selected node input
If a node has multiple inputs a dialog will show

EP6R1

EP6R1

Jumps to the connected Node of the currently selected node output
If multiple Nodes are connected to the Output a dialog will show

EP6R1

EP6R1

jump to the next upstream node (based on current node selection) that matches
either the typeIDtoFind or a special customSearch parameter.
If a customSearch is defined, this supersedes the typeIDtoFind


typeIDToFind (string):           A Type ID to find (node.typeID()). Nodes of the same type count,
                                 all versions of it included (e.g. "_V2"), not other types that
                                 merely start the same

customSearch (string):           If a custom search is defined,this supersedes any typeIDToFind.
                                 Possible custom searches are:
                                 "paint","bakePoint","geoChannel","groupNode","channelNode","shader","material"


EP6R1

EP2027 (same type only, no longer any type starting with typeIDToFind)

jump to the next upstream node in the stream that is matching
the current noe selection type

EP6R1

EP6R1

Focuses your Nodegraph on connected Nodes from the currently selected Radio Node or
Radio Transmitter Node. This method is also available inside the main radioNodes() class

EP6R1

EP6R1

Launches the "Jump to Bookmark" UI

EP6R1

EP6R1

removes all connections previously made to enable single click node properties

EP6R1

EP6R1

Returns true if the Auto Property Loading on single selection has been paused


bool:                         True if the Auto Loading of Node Properties on selection
                              has been paused

EP6R1

EP6R1

a method called on Mari Project startup to create signal connections for one-click
node properties changing.
The method will connect to all Nodegraphs in the Project.

Only has an effect if Preference /Node Graph/Node Properties/SingleClickPropertiesLoading
is True


EP6R1

EP6R1

Generates a signal connection from nodegraph.nodeSelectionChanged()
to updateNodePropertiesOnSelection() for a newly added  Geometry

Only has an effect if Preference /Node Graph/Node Properties/SingleClickPropertiesLoading
is True



EP6R1

EP6R1

Pauses or unpauses the automatic loading of Node Properties
on single click on a node.
This only has an effect if in the Mari preferences / Nodegraph Tab
the Node Properties on Single Click Pref is checked



mode (bool):                  If True, the automatic updating of Node Properties is paused.
                              Defaults to False.


EP6R1

EP6R1

Updates the Node Properties based on the current node selection.
This method is usually called by the nodegraph.nodeSelectionChanged() signal.



force (bool):                 if true, the node properties get updated even if they are paused via the api.
                              If the Node Properties Palette is hidden, nothing happens

forceOpenPalette (bool):      if true, the node properties palette gets forced open

EP6R1

EP6R1v2

Moves the body of the Node Properties Palette into an overlay panel
that is parented to the Node Graph, comparable to the way Houdini
floats its Parameter pane over the Network Editor.

While attached, the Node Properties Palette displays a
"Reattach to Palette" button.


bool:                 True if the Node Properties were attached

EP2027

EP2027

Moves the Node Properties out of the Node Graph overlay and back
into the Node Properties Palette


bool:                 True if the Node Properties were moved back

EP2027

EP2027

Returns True while the Node Properties live in the Node Graph
overlay instead of in their own Palette


bool:                 True if the Node Properties are attached

EP2027

EP2027

Reparents the Node Properties overlay if Mari swapped the Node Graph
presentation underneath it, for example when the Node Graph gets
maximized into a different container.

Has no effect while the Node Properties live in their own Palette.


bool:                 True if the overlay was reparented

EP2027

EP2027

Attaches the Node Properties to the Node Graph as an overlay panel,
or moves them back into their Palette if they are already attached.

This is the method the "Properties" button at the top of the
Node Graph triggers.


bool:                 True if the state was changed

EP2027

EP2027

Reverts a previously modified Node Style back to Mari default


inputNodeList (if of mari.Node):                   The Nodes to revert

EP6R1

EP6R1

Allows you to change the style of a Node, e.g. the color, shape and pixmap icon.
The method works by writing a new node instance and removing the old one.
Certain Node Types are not supported such as Paint Nodes and Bake Point Nodes.


inputNodeList(list of mari.Node):         The Nodes to change the Style on

setColor(bool):                           Boolean to define if to change the color

setShape(bool):                           Boolean to define if to change the shape

setPixmap(bool):                          Boolean to define if to change the icon

topColor (string):                        If setColor is True, this defines the top color of the node.
                                          Colors are set in 0-1 range per channel e.g. "1.0,0.0,0.0,1.0"

bottomColor (string):                     If setColor is True, this defines the bottom color of the node.
                                          Colors are set in 0-1 range per channel e.g. "1.0,0.0,0.0,1.0"

nodeShape(int):                           if setShape arg is True, this defines the shape of the node.
                                          At the time of writing this Mari supported 8 shape types.
                                          Therefore valid integers are 0-7 (again at the time of documenting this)

pixMapPath(string):                       A path to an icon file (png or svg) if setPixmap is True


EP6R1

EP6R1

Direct action to launch the Nodestyle UI Hotbox

EP6R1

EP6R1

Creates dot nodes automatically for the input ports of the selected nodes.
Several rules determine if or where the dot nodes are placed


graph (mari.Nodegraph) (optional):            The Mari Nodegraph to process auto-dot nodes in.
                                              Defaults to None, in which case the currently open Graph
                                              is used.

nodelist (list of mari.Nodes) (optional):     A list of mari nodes to process Inputs for Auto-dots.
                                              Defaults to None in which case the selected nodes of the 
                                              current graph are used.
                                              If a list is supplied, a graph also needs to be supplied with
                                              the graph argument.


EP6R3

EP6R3

Creates a Black and White Mask from the current viewport selection as a Paint Node.
The Resolution can be set in a popup dialog.

The new paint node will be created in the currently active graph tab and created at cursor position

(mari.PaintNode):         Returns the newly created Mari Paint Node

EP6R3

EP6R3

Creates a AB Compare Mask node and hooks it up to the selection

EP6R3

EP6R3

Creates a Height Blend node and hooks it up to the selection

EP6R1

EP6R1

Creates a Multi Channel Merge Node if the selected Nodes contain Materials
or a regular Merge Node otherwise

EP6R1

EP6R1

Creates a sticky Note and adds all non-default values from a node
to it, then places the sticky note under the source node.

Repeatedly executing it on a node that already has a sticky note,
will update the existing sticky note.

If no changes are made in a node, existing sticky notes will be deleted.

While you can supply a nodelist as an argument, if just executed by default,
it will use the current node selection in the currently open graph tab.


graph (mari.Nodegraph):           Optional. The graph the nodes in the nodelist belong to.
                                  if None which is the default, the currently open graph is used

nodelist (list of mari.Nodes):    Optional. A list of nodes. If None (default), the currently
                                  selected nodes in the graph (other arg) are used.

EP6R2

EP6R2

Removes a Node Context Menu from a specific Node Type
Node Context Menus appear when a node is selected and CTRL is pressed.



nodeTypeID (str):         a valid Mari Node typeID, class name or tagname that should
                          have its context menu removed.



bool:                    Returns True if the nodeTypeID was deregistered.
                         Returns False if the nodeTypeID didn't exist


EP6R3

EP6R3

Ensures that the given node (regardless if merge node or multi channel) has its Blend Mode Colorspace
disabled


node (mari.Node):              the node to modify the setting on

EP6R3

EP6R3

Extracts the contents of a Mari node file to disk.

Unpacks a material (.mma), node graph (.mna) or procedural (.mpc) export
into the given folder.


path_to_file (string):        A path to a .mma, .mna or .mpc file

output_folder (string):       The folder to write the extracted files into
                              (created if it does not exist)


string:                       The output folder the files were written to

EP2027

EP2027

Returns a dictionary containing {NodeTypeID : [Path to Context Menu, class instance}.
Node Context Menus appear when a node is selected and CTRL is pressed.


dict:                     A dictionary of registered Node Context Menus against 
                          node.typeIDs, classes or tags



EP6R3

EP6R3

Finds every image the given nodes use. For each image it lists
which of the nodes use it and in which attributes.

With recursive on, pass the top level nodes only (e.g. geo.nodeGraph().nodeList()).
and it will scan group nodes as well


nodes (list):                  A list of mari.Node objects

recursive (bool):              True to also check the nodes inside of any group nodes given


dict:                          {mari.Image: {mari.Node: [attribute names]}}
                               Empty if none of the nodes use an image

EP2027

EP2027

Returns if the Node Manager keeps a node type out of the Nodegraph and Layerstack menus.

The answer is what the Node Manager is set to right now. A change applied in the Node
Manager shows here straight away, Mari itself only picks it up with the next restart.
A node type the Node Manager doesn't know about is not hidden.


nodeId (str):                  The node type ID, the  in the node's XML

Returns:

bool:                          True if the node type is hidden

Introduced:

EP2027

Modified:

EP2027

Finds every node in the given node graph that uses the given image,
together with the names of the attributes the image is set in.

To search the whole project, call it for each geo's node graph:

for geo in mari.geo.list():
usage = mari.ExtensionPack.nodeUtilities.nodesUsingImage(image, geo.nodeGraph(), True)


image (mari.Image):            The image to look for

nodeGraph (mari.NodeGraph):    The node graph to search, e.g. geo.nodeGraph()

recursive (bool):              True to also search the nodes inside of group nodes


dict:                          {mari.Node: [attribute names]} e.g. {node: ['TileImageA','TileImageB']}
                               Empty if no node uses the image

EP2027

EP2027

Returns a list of Node Pretty Names ("DefaultName" from their XML).
Each Node has at least one Attribute that accepts an Image.

This is a MANUALLY authored list. It is not assembled automatically.
use registerNodeWithImageAttribute() to add to it.



list[str]:                       a list of node names e.g. ['Axis Projection',  ... ]

EP2027

EP2027

Disconnects or reconnects MultiChannel Node Connections based on assigned channels to a shader.
With any node upstream from a shader selected, the tool will detect the shader, then check what ports
a channel is assigned to.
Any port that has no channel assigned will be added to an exclusion list, any port with a channel node
to an inclusion list.

Multi Channel Nodes (Materials, Multi Channel Merge, Multi Channel Bake Points) of the same shader model
as the shader will then be processed and have any connection severed that is on the exclusion list, while
any non-existent connection that is part of the inclusion list will be rebuild


nodelist (list of mari.Node):         Optional. A list of shader nodes to use as base for optimization.
                                      If not provided, the currently selected shader will be used


EP6R3

EP6R3