ChangeComparer_Python.py

#Author - Adam Nagy
#Description - An AddIn that enables the user to keep a snapshot of 
# the current state of the model then compare it to a later state
# of the model

import adsk.core, adsk.fusion, traceback, os
# WebPageDirectory path, where we'll store the images and the html page
wpd = os.path.dirname(os.path.realpath(__file__)) + '/resources/webpage'
snapshotCamera = None

def getCamera():
    app = adsk.core.Application.get()
    vp = app.activeViewport
    return vp.camera     

def restoreCamera(camera):
    app = adsk.core.Application.get()
    vp = app.activeViewport
    vp.camera = camera    

# save the current view of the model    
def saveImage(fileName):
    app = adsk.core.Application.get()
    vp = app.activeViewport
    ret = app.activeViewport.saveAsImageFile(fileName, vp.width, vp.height)      
    ui = app.userInterface
    
    global snapshotCamera
    snapshotCamera = vp.camera

    if not ret:
        ui.messageBox('Could not save image')
    
# open the html page that will show the two recorded images    
def showWebPage():
    # show our html file with the content of the two 
    # image files and you can switch between them   
    import webbrowser
    webbrowser.open_new('file://' + wpd + '/comparer.html')    
 
# global set of event handlers to keep them referenced for the duration of the command
handlers = []
isSavingSnapshot = True
commandId = 'ComparerCmd'
workspaceToUse = 'FusionSolidEnvironment'
panelToUse = 'InspectPanel'

# some utility functions
def commandDefinitionById(id):
    app = adsk.core.Application.get()
    ui = app.userInterface
    if not id:
        ui.messageBox('commandDefinition id is not specified')
        return None
    commandDefinitions_ = ui.commandDefinitions
    commandDefinition_ = commandDefinitions_.itemById(id)
    return commandDefinition_

def commandControlByIdForPanel(id):
    global workspaceToUse
    global panelToUse
    app = adsk.core.Application.get()
    ui = app.userInterface
    if not id:
        ui.messageBox('commandControl id is not specified')
        return None
    workspaces_ = ui.workspaces
    modelingWorkspace_ = workspaces_.itemById(workspaceToUse)
    toolbarPanels_ = modelingWorkspace_.toolbarPanels
    toolbarPanel_ = toolbarPanels_.itemById(panelToUse)
    toolbarControls_ = toolbarPanel_.controls
    toolbarControl_ = toolbarControls_.itemById(id)
    return toolbarControl_

def destroyObject(uiObj, objToDelete):
    if uiObj and objToDelete:
        if objToDelete.isValid:
            objToDelete.deleteMe()
        else:
            uiObj.messageBox('objToDelete is not a valid object')   

def addCommandToPanel(panel, commandId, commandName, commandDescription, commandResources, onCommandCreated):
    app = adsk.core.Application.get()
    ui = app.userInterface    
    commandDefinitions_ = ui.commandDefinitions
    
    toolbarControlsPanel_ = panel.controls
    toolbarControlPanel_ = toolbarControlsPanel_.itemById(commandId)
    if not toolbarControlPanel_:
        commandDefinitionPanel_ = commandDefinitions_.itemById(commandId)
        if not commandDefinitionPanel_:
            commandDefinitionPanel_ = commandDefinitions_.addButtonDefinition(commandId, commandName, commandName, commandResources)
            commandDefinitionPanel_.tooltipDescription = commandDescription
        
        commandDefinitionPanel_.commandCreated.add(onCommandCreated)
        
        # keep the handler referenced beyond this function
        handlers.append(onCommandCreated)
        toolbarControlPanel_ = toolbarControlsPanel_.addCommand(commandDefinitionPanel_, commandId)
        toolbarControlPanel_.isVisible = True  

def getControlAndDefinition(commandId, objects):
    commandControl_ = commandControlByIdForPanel(commandId)
    if commandControl_:
        objects.append(commandControl_)

    commandDefinition_ = commandDefinitionById(commandId)
    if commandDefinition_:
        objects.append(commandDefinition_)

# the main function that is called when our addin is loaded
def run(context):
    ui = None
    try:
        app = adsk.core.Application.get()
        ui  = app.userInterface
        
        # command properties
        saveCommandName = 'Save Snapshot For Comparison'
        saveCommandDescription = 'Saves a snapshot of the current model state so that ' \
        'we can compare to it later'
        saveCommandResources = './resources/comparer'
        viewCommandName = 'Compare To Snapshot'
        viewCommandDescription = 'Saves a snapshot of the current model state and opens ' \
        'a web page where you can compare it to the previously saved state'

        # our command
        class CommandExecuteHandler(adsk.core.CommandEventHandler):
            def __init__(self):
                super().__init__()
            def notify(self, args):
                global isSavingSnapshot
                try:
                    # are we saving a snapshot ...
                    if isSavingSnapshot:
                        # save view snapshot as previous.png
                        # this will also store the current camera
                        # in snapshotCamera global variable
                        saveImage(wpd + '/previous.png')
    
                        # update the command text
                        saveCommand = commandDefinitionById(commandId)
                        saveCommand.controlDefinition.name = viewCommandName
                        saveCommand.tooltip = viewCommandName
                        saveCommand.tooltipDescription = viewCommandDescription
                        
                        isSavingSnapshot = False
                    # ... or showing the difference to the previously saved snapshot    
                    else:                     
                        camera = getCamera()    
                        restoreCamera(snapshotCamera)    
                        saveImage(wpd + '/current.png')
                        restoreCamera(camera)
                    
                        # now open the webpage that shows our two images
                        showWebPage()
                        
                        # update the command text
                        saveCommand = commandDefinitionById(commandId)
                        saveCommand.controlDefinition.name = saveCommandName
                        saveCommand.tooltip = saveCommandName
                        saveCommand.tooltipDescription = saveCommandDescription
                        
                        isSavingSnapshot = True
                except:
                    if ui:
                        ui.messageBox('command executed failed:\n{}'.format(traceback.format_exc()))

        class CommandCreatedEventHandler(adsk.core.CommandCreatedEventHandler):
            def __init__(self):
                super().__init__() 
            def notify(self, args):
                try:
                    cmd = args.command
                    onExecute = CommandExecuteHandler()
                    cmd.execute.add(onExecute)

                    # keep the handler referenced beyond this function
                    handlers.append(onExecute)
                except:
                    if ui:
                        ui.messageBox('Panel command created failed:\n{}'.format(traceback.format_exc()))                
        
        # add our command on "Inspect" panel in "Modeling" workspace
        global workspaceToUse
        global panelToUse
        workspaces_ = ui.workspaces
        modelingWorkspace_ = workspaces_.itemById(workspaceToUse)
        toolbarPanels_ = modelingWorkspace_.toolbarPanels
        # add the new command under the fifth panel / "Inspect"
        toolbarPanel_ = toolbarPanels_.itemById(panelToUse) 
        addCommandToPanel(toolbarPanel_, commandId, saveCommandName, saveCommandDescription, saveCommandResources, CommandCreatedEventHandler())
    except:
        if ui:
            ui.messageBox('Failed:\n{}'.format(traceback.format_exc()))

def stop(context):
    ui = None
    try:
        app = adsk.core.Application.get()
        ui  = app.userInterface
        
        objArray = []
        
        getControlAndDefinition(commandId, objArray)
            
        for obj in objArray:
            destroyObject(ui, obj)
    except:
        if ui:
            ui.messageBox('Failed:\n{}'.format(traceback.format_exc()))