Merge pull request #32 from djfun/newgui-commandline

making commandline features from master work with the new component system

1 files changed, 49 insertions, 17 deletions

diff --git a/components/__base__.py b/components/__base__.py
index 88f22d4..bef7f0e 100644
--- a/components/__base__.py
+++ b/components/__base__.py
@@ -1,5 +1,6 @@
 from PyQt4 import QtGui, QtCore
 from PIL import Image
+import os
 
 
 class Component(QtCore.QObject):
@@ -7,11 +8,12 @@ class Component(QtCore.QObject):
 
     # modified = QtCore.pyqtSignal(int, bool)
 
-    def __init__(self, moduleIndex, compPos):
+    def __init__(self, moduleIndex, compPos, core):
         super().__init__()
         self.currentPreset = None
         self.moduleIndex = moduleIndex
         self.compPos = compPos
+        self.core = core
 
     def __str__(self):
         return self.__doc__
@@ -32,24 +34,60 @@ class Component(QtCore.QObject):
         # read your widget values, then call super().update()
 
     def loadPreset(self, presetDict, presetName):
-        '''Children should take (presetDict, presetName=None) as args'''
-
-        # Use super().loadPreset(presetDict, presetName)
-        # Then update your widgets using the preset dict
+        '''Subclasses take (presetDict, presetName=None) as args.
+        Must use super().loadPreset(presetDict, presetName) first,
+        then update self.page widgets using the preset dict.
+        '''
         self.currentPreset = presetName \
             if presetName != None else presetDict['preset']
-    '''
-    def savePreset(self):
-        return {}
-    '''
+
     def preFrameRender(self, **kwargs):
+        '''Triggered only before a video is exported (video_thread.py)
+            self.worker = the video thread worker
+            self.completeAudioArray = a list of audio samples
+            self.sampleSize = number of audio samples per video frame
+            self.progressBarUpdate = signal to set progress bar number
+            self.progressBarSetText = signal to set progress bar text
+        Use the latter two signals to update the MainProgram if needed
+        for a long initialization procedure (i.e., for a visualizer)
+        '''
         for var, value in kwargs.items():
             exec('self.%s = value' % var)
 
+    def command(self, arg):
+        '''Configure a component using argument from the commandline.
+        Use super().command(arg) at the end of a subclass's method,
+        if no arguments are found in that method first
+        '''
+        if arg.startswith('preset='):
+            _, preset = arg.split('=', 1)
+            path = os.path.join(self.core.getPresetDir(self), preset)
+            if not os.path.exists(path):
+                print('Couldn\'t locate preset "%s"' % preset)
+                quit(1)
+            else:
+                print('Opening "%s" preset on layer %s' % \
+                    (preset, self.compPos))
+                self.core.openPreset(path, self.compPos, preset)
+        else:
+            print(
+                self.__doc__, 'Usage:\n'
+                'Open a preset for this component:\n'
+                '    "preset=Preset Name"')
+            self.commandHelp()
+            quit(0)
+
+    def commandHelp(self):
+        '''Print help text for this Component's commandline arguments'''
+
     def blankFrame(self, width, height):
         return Image.new("RGBA", (width, height), (0, 0, 0, 0))
 
     def pickColor(self):
+        '''Use color picker to get color input from the user,
+        and return this as an RGB string and QPushButton stylesheet.
+        In a subclass apply stylesheet to any color selection widgets
+        '''
         dialog = QtGui.QColorDialog()
         dialog.setOption(QtGui.QColorDialog.ShowAlphaChannel, True)
         color = dialog.getColor()
@@ -63,7 +101,7 @@ class Component(QtCore.QObject):
             return None, None
 
     def RGBFromString(self, string):
-        ''' turns an RGB string like "255, 255, 255" into a tuple '''
+        ''' Turns an RGB string like "255, 255, 255" into a tuple '''
         try:
             tup = tuple([int(i) for i in string.split(',')])
             if len(tup) != 3:
@@ -83,7 +121,7 @@ class Component(QtCore.QObject):
         self.parent = parent
         page = uic.loadUi(os.path.join(
             os.path.dirname(os.path.realpath(__file__)), 'example.ui'))
-        # connect widgets signals
+        # --- connect widget signals here ---
         self.page = page
         return page
 
@@ -102,12 +140,6 @@ class Component(QtCore.QObject):
         height = int(self.worker.core.settings.value('outputHeight'))
         image = Image.new("RGBA", (width, height), (0,0,0,0))
         return image
-
-    def cancel(self):
-        self.canceled = True
-
-    def reset(self):
-        self.canceled = False
     '''
 
 class BadComponentInit(Exception):