python/api1/mathTableControl.py

#-
# ==========================================================================
# Copyright (C) 1995 - 2006 Autodesk, Inc. and/or its licensors.  All
# rights reserved.
#
# The coded instructions, statements, computer programs, and/or related
# material (collectively the "Data") in these files contain unpublished
# information proprietary to Autodesk, Inc. ("Autodesk") and/or its
# licensors, which is protected by U.S. and Canadian federal copyright
# law and by international treaties.
#
# The Data is provided for use exclusively by You. You have the right
# to use, modify, and incorporate this Data into other products for
# purposes authorized by the Autodesk software license agreement,
# without fee.
#
# The copyright notices in the Software and this entire statement,
# including the above license grant, this restriction and the
# following disclaimer, must be included in all copies of the
# Software, in whole or in part, and all derivative works of
# the Software, unless such copies or derivative works are solely
# in the form of machine-executable object code generated by a
# source language processor.
#
# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND.
# AUTODESK DOES NOT MAKE AND HEREBY DISCLAIMS ANY EXPRESS OR IMPLIED
# WARRANTIES INCLUDING, BUT NOT LIMITED TO, THE WARRANTIES OF
# NON-INFRINGEMENT, MERCHANTABILITY OR FITNESS FOR A PARTICULAR
# PURPOSE, OR ARISING FROM A COURSE OF DEALING, USAGE, OR
# TRADE PRACTICE. IN NO EVENT WILL AUTODESK AND/OR ITS LICENSORS
# BE LIABLE FOR ANY LOST REVENUES, DATA, OR PROFITS, OR SPECIAL,
# DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES, EVEN IF AUTODESK
# AND/OR ITS LICENSORS HAS BEEN ADVISED OF THE POSSIBILITY
# OR PROBABILITY OF SUCH DAMAGES.
#
# ==========================================================================
#+

########################################################################
# DESCRIPTION:
#
# Produces the Python command "spMathTableControl".
#
# This plug-in creates a simple spreadsheet table in a separate output window.
# You can perform calculations within this table such as addition and multiplication.
#
# To create a table with rows and columns, execute the following commands:
#
#   import maya.cmds as cmds
#   window = cmds.window(title="Math Table",widthHeight=(400,150))
#   cmds.paneLayout()
#   cmds.showWindow()
#   cmds.spMathTableControl()
#
# A new window named "Math Table" appears with three columns and five rows. 
#
########################################################################

#
# Creation Date:   13 October 2006
#
# Author: mlausch
#

import math, sys

import maya.OpenMaya as OpenMaya
import maya.OpenMayaMPx as OpenMayaMPx
import maya.OpenMayaUI as OpenMayaUI

kPluginCmdName = "spMathTableControl"

kNopFlag = "-nop"
kNopLongFlag = "-noOperation"
kMultFlag = "-mul"
kMultLongFlag = "-multiplyVals"
kAddFlag = "-add"
kAddLongFlag = "-addVals"
kRedrawFlag = "-rd"
kRedrawFlagLong = "-redraw"


# operations on cell coordinates, must return strings
kNop = lambda x,y: "cell(%d,%d)" % (x,y)
kMult = lambda x,y: str(x*y)
kAdd = lambda x,y: str(x+y)

kPythonPtrTable = {}

class MathTableControlCmd(OpenMayaMPx.MPxControlCommand):
    def __init__(self):
        OpenMayaMPx.MPxControlCommand.__init__(self)


    def makeControl(self):
        control = MathTableControl(self)
        control.setOperation(kNop)
        control.setNumberOfRows(5)
        control.setNumberOfColumns(3)
        return OpenMayaMPx.asMPxPtr(control)


    def doEditFlags(self):
        theParser = self._parser()
        theControl = kPythonPtrTable.get(OpenMayaMPx.asHashable(self._control()), None)

        if theParser.isFlagSet(kNopFlag):
            theControl.setOperation(kNop)
        elif theParser.isFlagSet(kMultFlag):
            theControl.setOperation(kMult)
        elif theParser.isFlagSet(kAddFlag):
            theControl.setOperation(kAdd)
        elif theParser.isFlagSet(kRedrawFlag):
            theControl.redrawCells()
            theControl.redrawLabels()
        else:
            OpenMayaMPx.MPxControlCommand.doEditFlags(self)


    def doQueryFlags(self):
        return OpenMayaMPx.MPxControlCommand.doQueryFlags(self)


    def appendSyntax(self):
        theSyntax = self._syntax()
        theSyntax.addFlag(kNopFlag, kNopLongFlag)
        theSyntax.addFlag(kMultFlag, kMultLongFlag)
        theSyntax.addFlag(kAddFlag, kAddLongFlag)
        theSyntax.addFlag(kRedrawFlag, kRedrawFlagLong)


class MathTableControl(OpenMayaMPx.MPxUITableControl):
    def __init__(self, command):
        OpenMayaMPx.MPxUITableControl.__init__(self, command)
        self.__myOperation = None
        kPythonPtrTable[OpenMayaMPx.asHashable(self)] = self


    def __del__(self):
        del kPythonPtrTable[OpenMayaMPx.asHashable(self)]


    def cellString(self, row, column, isValidCell):
        result = ""
        if callable(self.__myOperation):
            result = self.__myOperation(row, column)
        OpenMaya.MScriptUtil.setBool(isValidCell, bool(result))
        return result


    def labelString(self, labelType, index):
        value = ""
        if labelType == OpenMayaMPx.MPxUITableControl.kRowLabel:
            value = "[Row %d]" % index
        elif labelType == OpenMayaMPx.MPxUITableControl.kColumnLabel:
            value = "[Col %d]" % index
        return value


    def setOperation(self, op):
        self.__myOperation = op
        self.redrawCells()


################################################################


def cmdCreator():
    return OpenMayaMPx.asMPxPtr(MathTableControlCmd())


def initializePlugin(mobject):
    mplugin = OpenMayaMPx.MFnPlugin(mobject, "Autodesk", "1.0", "Any")
    try:
        mplugin.registerControlCommand(kPluginCmdName, cmdCreator)
    except:
        sys.stderr.write( "Failed to register command: %s\n" % kPluginCmdName)
        raise


def uninitializePlugin(mobject):
    mplugin = OpenMayaMPx.MFnPlugin(mobject)
    try:
        mplugin.deregisterControlCommand(kPluginCmdName)
    except:
        sys.stderr.write("Failed to unregister command: %s\n" % kPluginCmdName)
        raise