/*

        File: SimpleTextPlugIn.m

    Abstract: SimpleTextPlugin class.

     Version: 1.0

    Disclaimer: IMPORTANT:  This Apple software is supplied to you by Apple

    Inc. ("Apple") in consideration of your agreement to the following

    terms, and your use, installation, modification or redistribution of

    this Apple software constitutes acceptance of these terms.  If you do

    not agree with these terms, please do not use, install, modify or

    redistribute this Apple software.

    In consideration of your agreement to abide by the following terms, and

    subject to these terms, Apple grants you a personal, non-exclusive

    license, under Apple's copyrights in this original Apple software (the

    "Apple Software"), to use, reproduce, modify and redistribute the Apple

    Software, with or without modifications, in source and/or binary forms;

    provided that if you redistribute the Apple Software in its entirety and

    without modifications, you must retain this notice and the following

    text and disclaimers in all such redistributions of the Apple Software.

    Neither the name, trademarks, service marks or logos of Apple Inc. may

    be used to endorse or promote products derived from the Apple Software

    without specific prior written permission from Apple.  Except as

    expressly stated in this notice, no other rights or licenses, express or

    implied, are granted by Apple herein, including but not limited to any

    patent rights that may be infringed by your derivative works or by other

    works in which the Apple Software may be incorporated.

    The Apple Software is provided by Apple on an "AS IS" basis.  APPLE

    MAKES NO WARRANTIES, EXPRESS OR IMPLIED, INCLUDING WITHOUT LIMITATION

    THE IMPLIED WARRANTIES OF NON-INFRINGEMENT, MERCHANTABILITY AND FITNESS

    FOR A PARTICULAR PURPOSE, REGARDING THE APPLE SOFTWARE OR ITS USE AND

    OPERATION ALONE OR IN COMBINATION WITH YOUR PRODUCTS.

    IN NO EVENT SHALL APPLE BE LIABLE FOR ANY SPECIAL, INDIRECT, INCIDENTAL

    OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF

    SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS

    INTERRUPTION) ARISING IN ANY WAY OUT OF THE USE, REPRODUCTION,

    MODIFICATION AND/OR DISTRIBUTION OF THE APPLE SOFTWARE, HOWEVER CAUSED

    AND WHETHER UNDER THEORY OF CONTRACT, TORT (INCLUDING NEGLIGENCE),

    STRICT LIABILITY OR OTHERWISE, EVEN IF APPLE HAS BEEN ADVISED OF THE

    POSSIBILITY OF SUCH DAMAGE.

    Copyright (C) 2009 Apple Inc. All Rights Reserved.

*/

/* It's highly recommended to use CGL macros instead of changing the current context for plug-ins that perform OpenGL rendering */

#import <OpenGL/CGLMacro.h>

#import "SimpleTextPlugIn.h"

#define kQCPlugIn_Name              @"Simple Text"

#define kQCPlugIn_Description       @"A patch that outputs a simple text!"

@implementation SimpleTextPlugIn

/* We need to declare the input / output properties as dynamic as Quartz Composer will handle their implementation */

@dynamic outputString;

/* The "text" property must be synthesized */

@synthesize text;

+ (NSDictionary*) attributes

{

    /* Return the attributes of this plug-in */

    return [NSDictionary dictionaryWithObjectsAndKeys:kQCPlugIn_Name, QCPlugInAttributeNameKey, kQCPlugIn_Description, QCPlugInAttributeDescriptionKey, nil];

}

+ (NSDictionary*) attributesForPropertyPortWithKey:(NSString*)key

{

    /* Return the attributes for the plug-in property ports */

    if([key isEqualToString:@"outputString"])

    return [NSDictionary dictionaryWithObject:@"Text" forKey:QCPortAttributeNameKey];

    return nil;

}

+ (QCPlugInExecutionMode) executionMode

{

    /* This plug-in is a processor (it outputs a text string) */

    return kQCPlugInExecutionModeProcessor;

}

+ (QCPlugInTimeMode) timeMode

{

    /* This plug-in does not depend on the time (time parameter is completely ignored in the -execute:atTime:withArguments: method) */

    return kQCPlugInTimeModeNone;

}

- (id) init

{

    if(self = [super init]) {

        /* Set a default value for our internal setting */

        self.text = @"Bonjour";

    }

    return self;

}

- (void) dealloc

{

    /* IMPORTANT: We need to set the property for our internal setting to nil on -dealloc or the property value will leak */

    self.text = nil;

    [super dealloc];

}

+ (NSArray*) plugInKeys

{

    /* Return the list of KVC keys corresponding to our internal settings */

    return [NSArray arrayWithObject:@"text"];

}

- (QCPlugInViewController*) createViewController

{

    /* Create a QCPlugInViewController to handle the user-interface to edit the our internal settings */

    return [[QCPlugInViewController alloc] initWithPlugIn:self viewNibName:@"SimpleTextSettings"];

}

@end

@implementation SimpleTextPlugIn (Execution)

- (BOOL) execute:(id<QCPlugInContext>)context atTime:(NSTimeInterval)time withArguments:(NSDictionary*)arguments

{

    /* This method is called by Quartz Composer whenever the plug-in needs to recompute its result (or if one of the keys listed in +plugInKeys has changed): simply set the output string to our internal setting */

    self.outputString = self.text;

    return YES;

}

@end