Welcome to ButtleOFX’s documentation!¶

Contents:

buttleofx¶

buttleofx package¶

Subpackages¶

buttleofx.core package¶

Subpackages¶

buttleofx.core.graph package¶

Subpackages¶

buttleofx.core.graph.connection package¶

Submodules¶

buttleofx.core.graph.connection.connection module¶

buttleofx.core.graph.connection.idClip module¶

Module contents¶

buttleofx.core.graph.node package¶

Submodules¶

buttleofx.core.graph.node.node module¶

Module contents¶

Submodules¶

buttleofx.core.graph.graph module¶

Module contents¶

buttleofx.core.params package¶

Submodules¶

buttleofx.core.params.param module¶

buttleofx.core.params.paramBoolean module¶

buttleofx.core.params.paramChoice module¶

buttleofx.core.params.paramDouble module¶

buttleofx.core.params.paramDouble2D module¶

buttleofx.core.params.paramDouble3D module¶

buttleofx.core.params.paramGroup module¶

buttleofx.core.params.paramInt module¶

buttleofx.core.params.paramInt2D module¶

buttleofx.core.params.paramInt3D module¶

buttleofx.core.params.paramPage module¶

buttleofx.core.params.paramPushButton module¶

buttleofx.core.params.paramRGB module¶

buttleofx.core.params.paramRGBA module¶

buttleofx.core.params.paramString module¶

Module contents¶

buttleofx.core.undo_redo package¶

Subpackages¶

buttleofx.core.undo_redo.commands package¶

Subpackages¶

buttleofx.core.undo_redo.commands.connection package¶

Submodules¶

buttleofx.core.undo_redo.commands.connection.cmdCreateConnection module¶

buttleofx.core.undo_redo.commands.connection.cmdDeleteConnection module¶

Module contents¶

buttleofx.core.undo_redo.commands.node package¶

Submodules¶

buttleofx.core.undo_redo.commands.node.cmdCreateNode module¶

buttleofx.core.undo_redo.commands.node.cmdCreateReaderNode module¶

buttleofx.core.undo_redo.commands.node.cmdDeleteNodes module¶

buttleofx.core.undo_redo.commands.node.cmdSetCoord module¶

class buttleofx.core.undo_redo.commands.node.cmdSetCoord.CmdSetCoord(graphTarget, nodeTargetName, newCoord)[source]¶

Bases: buttleofx.core.undo_redo.manageTools.undoableCommand.UndoableCommand

Command that moves a node. Attributes : - graphTarget - nodeTargetName : the name of the target node wich will be changed by the movement - newCoord : the coordinate wich will be mofidy in the target - coordOld : the old coordinate of the target node, which will be used for reset the

target in case of undo command

doCmd()[source]¶: Executes the movement of the node.

getLabel()[source]¶

redoCmd()[source]¶: Redoes the movement of the node. Just calls the doCmd() function.

undoCmd()[source]¶: Undoes the movement of the node. The target node is reset with the old coordinates.

Module contents¶

buttleofx.core.undo_redo.commands.params package¶

Submodules¶

buttleofx.core.undo_redo.commands.params.cmdSetParamBoolean module¶

buttleofx.core.undo_redo.commands.params.cmdSetParamChoice module¶

buttleofx.core.undo_redo.commands.params.cmdSetParamDouble module¶

buttleofx.core.undo_redo.commands.params.cmdSetParamInt module¶

buttleofx.core.undo_redo.commands.params.cmdSetParamND module¶

buttleofx.core.undo_redo.commands.params.cmdSetParamString module¶

Module contents¶

buttleofx.core.undo_redo.manageTools package¶

Submodules¶

buttleofx.core.undo_redo.manageTools.commandManager module¶

class buttleofx.core.undo_redo.manageTools.commandManager.CommandManager[source]¶

Bases: quickmamba.patterns.singleton.Singleton

Manages a list of commands.

active = False¶

canRedo()[source]¶: Retrieves a Boolean indicating whether a command can be redone.

canUndo()[source]¶: Retrieves a Boolean indicating whether a command can be undone.

clean()[source]¶: Clears this command manager by emptying its list of commands.

cleanIndex = 0¶

commands = []¶

count()[source]¶: Gets the number of commands in the CommandManager.

countRedo()[source]¶: Gets the number of redo commands in the CommandManager.

countUndo()[source]¶: Gets the number of undo commands in the CommandManager.

getCleanIndex()[source]¶: Gets the clean index of the CommandManager.

getCommands()[source]¶: Gets the list of commands of the CommandManager.

getIndex()[source]¶: Gets the index of the lastest command in the CommandManager.

getRedoLimit()[source]¶: Gets the redo limit of the CommandManager.

getUndoLimit()[source]¶: Gets the undo limit of the CommandManager.

graphHadChanged()[source]¶: Indicates to ButtleData that a command just had been done. This function will update the property graphCanBeSaved of ButtleData and will change the display of the “Save Graph” icon.

index = 0¶

isActive()[source]¶: Tests if the CommandManager is active.

isClean()[source]¶: Tests if the list of commands is empty.

push(newCommand)[source]¶: Executes a new undoable command (add command to the stack ?)

redo()[source]¶: Redoes the last undone command.

redoLimit = 10¶

savedGraphIndex = 0¶

setActive(active=True)[source]¶: Sets the CommandManager activity (true to false, or false to true).

setRedoLimit(limit)[source]¶: Sets the redo limit of the CommandManager.

setSavedGraphIndex(index)[source]¶: Sets the index where the graph was when last saved, and indicates to buttleData that something changed (useful for the display of the “Save Graph” icon)

setUndoLimit(limit)[source]¶: Sets the undo limit of the CommandManager.

undo()[source]¶: Undoes the last command.

undoLimit = 10¶

buttleofx.core.undo_redo.manageTools.groupUndoableCommands module¶

class buttleofx.core.undo_redo.manageTools.groupUndoableCommands.GroupUndoableCommands(commands, label)[source]¶

Bases: object

Group of objects saved in the Command Manager.

doCmd()[source]¶: Executes the user request (the group of functions). Returns nothing, maybe need to be improved in the future (list of return value of each command?).

getLabel()[source]¶: Return what does the command undo/redo

groupUndoableCommands = []¶

redoCmd()[source]¶: Undoes the operations performed by undoCmd method.

undoCmd()[source]¶: Executes the user request (Ctrl Z) (undo a group of commands).

buttleofx.core.undo_redo.manageTools.undoableCommand module¶

class buttleofx.core.undo_redo.manageTools.undoableCommand.UndoableCommand[source]¶

Bases: object

Object saved in the Command Manager.

doCmd()[source]¶: Executes the user request (the true function)

getLabel()[source]¶: Return what does the command undo/redo

redoCmd()[source]¶: Undoes the operation performed by undoCmd method (Ctrl Y)

undoCmd()[source]¶: Executes the user request (Ctrl Z)

Module contents¶

buttleofx.core.undo_redo.tests package¶

Subpackages¶

buttleofx.core.undo_redo.tests.Vec2d package¶

Subpackages¶

buttleofx.core.undo_redo.tests.Vec2d.commands package¶

Submodules¶

buttleofx.core.undo_redo.tests.Vec2d.commands.cmdAdditionVec2d module¶

buttleofx.core.undo_redo.tests.Vec2d.commands.cmdChangeVec2d module¶

class buttleofx.core.undo_redo.tests.Vec2d.commands.cmdChangeVec2d.CmdChangeVec2d(vec2d_target, new_x, new_y)[source]¶

Bases: object

Command which enable us to change the coordinates of a Vector2d

doCmd()[source]¶: Executes the vector’s change

redoCmd()[source]¶: Redoes the vector’s change

undoCmd()[source]¶: Undoes the vector’s change

Module contents¶

Submodules¶

buttleofx.core.undo_redo.tests.Vec2d.vec2d module¶

class buttleofx.core.undo_redo.tests.Vec2d.vec2d.Vec2d(x, y)[source]¶

Bases: object

Vector with 2 dimensions : x y

getX()[source]¶: Gets the x coordinate

getY()[source]¶: Gets the y coordinate

setX(new_x)[source]¶: Sets the x coordinate

setY(new_y)[source]¶: Sets the y coordinate

Module contents¶

Submodules¶

buttleofx.core.undo_redo.tests.testUndoManager module¶

Module contents¶

buttleofx.data package¶

Submodules¶

buttleofx.data.buttleData module¶

buttleofx.data.finder module¶

buttleofx.data.tuttleTools module¶

Module contents¶

buttleofx.event package¶

Submodules¶

buttleofx.event.buttleEvent module¶

Module contents¶

buttleofx.gui package¶

Subpackages¶

buttleofx.gui.browser package¶

Submodules¶

buttleofx.gui.browser.fileModelBrowser module¶

buttleofx.gui.browser.main module¶

buttleofx.gui.browser.sequenceWrapper module¶

Module contents¶

buttleofx.gui.browser_v2 package¶

Subpackages¶

buttleofx.gui.browser_v2.actions package¶

Subpackages¶

buttleofx.gui.browser_v2.actions.concreteActions package¶

Submodules¶

buttleofx.gui.browser_v2.actions.concreteActions.copy module¶

buttleofx.gui.browser_v2.actions.concreteActions.create module¶

buttleofx.gui.browser_v2.actions.concreteActions.delete module¶

buttleofx.gui.browser_v2.actions.concreteActions.move module¶

buttleofx.gui.browser_v2.actions.concreteActions.rename module¶

Module contents¶

Submodules¶

buttleofx.gui.browser_v2.actions.actionInterface module¶

buttleofx.gui.browser_v2.actions.actionManager module¶

buttleofx.gui.browser_v2.actions.actionWrapper module¶

buttleofx.gui.browser_v2.actions.browserAction module¶

buttleofx.gui.browser_v2.actions.worker module¶

class buttleofx.gui.browser_v2.actions.worker.Worker(queue, inProgress, done, notify)[source]¶

Bases: threading.Thread

Specific class for ActionManager. Can’t be used somewhere else. It’s not generic. Object used to execute actions with multi-threading.

static destroy()[source]¶

executeTask()[source]¶

getIndexFromList(list, idItem)[source]¶

isDestroyed = False¶

isWaiting = False¶

lockInProgress = <_thread.lock object>¶

static lockWhileWaiting()[source]¶

run()[source]¶

static wait()[source]¶

static work()[source]¶

Module contents¶

Submodules¶

buttleofx.gui.browser_v2.browserItem module¶

buttleofx.gui.browser_v2.browserModel module¶

buttleofx.gui.browser_v2.browserSortOn module¶

buttleofx.gui.browser_v2.browserTree module¶

buttleofx.gui.browser_v2.main module¶

buttleofx.gui.browser_v2.sequenceWrapper module¶

buttleofx.gui.browser_v2.standaloneUtils module¶

buttleofx.gui.browser_v2.threadWrapper module¶

Module contents¶

buttleofx.gui.graph package¶

Subpackages¶

buttleofx.gui.graph.connection package¶

Submodules¶

buttleofx.gui.graph.connection.clipWrapper module¶

buttleofx.gui.graph.connection.connectionWrapper module¶

Module contents¶

buttleofx.gui.graph.node package¶

Submodules¶

buttleofx.gui.graph.node.nodeWrapper module¶

Module contents¶

Submodules¶

buttleofx.gui.graph.graphWrapper module¶

buttleofx.gui.graph.main module¶

Module contents¶

buttleofx.gui.paramEditor package¶

Subpackages¶

buttleofx.gui.paramEditor.ColorPicker package¶

Submodules¶

buttleofx.gui.paramEditor.ColorPicker.main module¶

Module contents¶

buttleofx.gui.paramEditor.wrappers package¶

Submodules¶

buttleofx.gui.paramEditor.wrappers.booleanWrapper module¶

buttleofx.gui.paramEditor.wrappers.choiceWrapper module¶

buttleofx.gui.paramEditor.wrappers.double2DWrapper module¶

buttleofx.gui.paramEditor.wrappers.double3DWrapper module¶

buttleofx.gui.paramEditor.wrappers.doubleWrapper module¶

buttleofx.gui.paramEditor.wrappers.groupWrapper module¶

buttleofx.gui.paramEditor.wrappers.int2DWrapper module¶

buttleofx.gui.paramEditor.wrappers.int3DWrapper module¶

buttleofx.gui.paramEditor.wrappers.intWrapper module¶

buttleofx.gui.paramEditor.wrappers.pageWrapper module¶

buttleofx.gui.paramEditor.wrappers.paramEditorWrapper module¶

buttleofx.gui.paramEditor.wrappers.paramWrapper module¶

buttleofx.gui.paramEditor.wrappers.pushButtonWrapper module¶

buttleofx.gui.paramEditor.wrappers.rgbWrapper module¶

buttleofx.gui.paramEditor.wrappers.rgbaWrapper module¶

buttleofx.gui.paramEditor.wrappers.stringWrapper module¶

Module contents¶

Submodules¶

buttleofx.gui.paramEditor.main module¶

Module contents¶

buttleofx.gui.plugin package¶

Submodules¶

buttleofx.gui.plugin.pluginWrapper module¶

Module contents¶

buttleofx.gui.shortcut package¶

Submodules¶

buttleofx.gui.shortcut.shortcut module¶

Module contents¶

buttleofx.gui.viewer package¶

Submodules¶

buttleofx.gui.viewer.timerPlayer module¶

Module contents¶

buttleofx.gui.viewerGL package¶

Submodules¶

buttleofx.gui.viewerGL.glviewport module¶

buttleofx.gui.viewerGL.glviewport_pil module¶

buttleofx.gui.viewerGL.glviewport_tuttleofx module¶

buttleofx.gui.viewerGL.main module¶

buttleofx.gui.viewerGL.tuttleOverlayInteract module¶

Module contents¶

Welcome to ButtleOFX’s documentation!¶

buttleofx¶

buttleofx package¶

Subpackages¶

buttleofx.core package¶

Subpackages¶

Module contents¶

buttleofx.data package¶

Submodules¶

buttleofx.data.buttleData module¶

buttleofx.data.finder module¶

buttleofx.data.tuttleTools module¶

Module contents¶

buttleofx.event package¶

Submodules¶

buttleofx.event.buttleEvent module¶

Module contents¶

buttleofx.gui package¶

Subpackages¶

Module contents¶

buttleofx.manager package¶

Submodules¶

buttleofx.manager.buttleManager module¶

buttleofx.manager.connectionManager module¶

buttleofx.manager.nodeManager module¶

buttleofx.manager.viewerManager module¶

Module contents¶

Submodules¶

buttleofx.main module¶

Module contents¶

Indices and tables¶