Sources/Classes/Application/Model/OpenGL/Text/Engine/OpenGLText.m

//------------------------------------------------------------------------
//
//  File: OpenGLText.h
//
//  Abstract: Utility for drawing antialised attributedString w/o borders
//
//  Disclaimer: IMPORTANT:  This Apple software is supplied to you by
//  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) 2008, 2012 Apple Inc., All rights reserved.
//
//------------------------------------------------------------------------
 
//------------------------------------------------------------------------
 
#import "OpenGLText.h"
 
//------------------------------------------------------------------------
 
//------------------------------------------------------------------------
 
@implementation OpenGLText
 
//------------------------------------------------------------------------
 
#pragma mark -
#pragma mark Initializer
 
//------------------------------------------------------------------------
 
- (id) initWithString:(NSString *)theTextString
             fontName:(NSString *)theFontName
             fontSize:(const CGFloat)theFontSize
            textColor:(NSColor *)theTextColor
             boxColor:(NSColor *)theBoxColor
          borderColor:(NSColor *)theBorderColor
          coordinates:(const NSPoint *)theCoordinates
               bounds:(const NSRect *)theBounds
{
    NSFont *font = [NSFont fontWithName:theFontName
                                   size:theFontSize];
    
    if( font )
    {
        NSMutableParagraphStyle *pParagraphStyle = [NSMutableParagraphStyle new];
        
        if( pParagraphStyle )
        {
            [pParagraphStyle setAlignment:NSNaturalTextAlignment];
            [pParagraphStyle setLineSpacing:1.0f];
            
            NSString *pFontNameDst = (theFontName) ? theFontName : @"Helvetica";
            
            NSFont *pFont = [NSFont fontWithName:pFontNameDst
                                            size:theFontSize];
            
            if( pFont )
            {
                NSMutableDictionary *pAttribs = [NSMutableDictionary dictionaryWithCapacity:0];
                
                if( pAttribs )
                {
                    NSColor *pTextColor = (theTextColor) ? theTextColor : [NSColor whiteColor];
                    
                    [pAttribs setObject:pFont
                                 forKey:NSFontAttributeName];
                    
                    [pAttribs setObject:pTextColor
                                 forKey:NSForegroundColorAttributeName];
                    
                    [pAttribs setObject:pParagraphStyle
                                 forKey:NSParagraphStyleAttributeName];
                    
                    NSAttributedString *pAttrStr = [[NSAttributedString alloc] initWithString:theTextString
                                                                                   attributes:pAttribs];
                    
                    if( pAttrStr )
                    {
                        NSColor *pBoxColor    = (theBoxColor)    ? theBoxColor    : [NSColor darkGrayColor];
                        NSColor *pBorderColor = (theBorderColor) ? theBorderColor : [NSColor lightGrayColor];
                        
                        self = [super initWithAttributedString:pAttrStr
                                                   stringColor:pTextColor
                                                      boxColor:pBoxColor
                                                   borderColor:pBorderColor
                                                        bounds:theBounds];
                        
                        if( self )
                        {
                            m_Coordinates = *theCoordinates;
                            mpDictionary  = [pAttribs retain];
                        } // if
                        
                        [pParagraphStyle release];
                        [pAttrStr release];
                        
                        return self;
                    } // if
                } // if
            } // if
            
            [pParagraphStyle release];
        } // if
    } // if
    
    return nil;
} // initWithString
 
//------------------------------------------------------------------------
 
- (id) initWithString:(NSString *)theTextString
             fontName:(NSString *)theFontName
             fontSize:(const CGFloat)theFontSize
            textColor:(NSColor *)theTextColor
          coordinates:(const NSPoint *)theCoordinates
               bounds:(const NSRect *)theBounds
{
    return [self initWithString:theTextString
                       fontName:theFontName
                       fontSize:theFontSize
                      textColor:theTextColor
                       boxColor:nil
                    borderColor:nil
                    coordinates:theCoordinates
                         bounds:theBounds];
} // initWithString
 
//------------------------------------------------------------------------
 
- (id) initWithString:(NSString *)theTextString
             fontName:(NSString *)theFontName
             fontSize:(const CGFloat)theFontSize
          coordinates:(const NSPoint *)theCoordinates
               bounds:(const NSRect *)theBounds
{
    return [self initWithString:theTextString
                       fontName:theFontName
                       fontSize:theFontSize
                      textColor:nil
                       boxColor:nil
                    borderColor:nil
                    coordinates:theCoordinates
                         bounds:theBounds];
} // initWithString
 
//------------------------------------------------------------------------
 
#pragma mark -
#pragma mark Deallocating Resources
 
//------------------------------------------------------------------------
 
- (void) dealloc
{
    // Dealloc the superclass
    
    [super dealloc];
} // dealloc
 
//------------------------------------------------------------------------
 
#pragma mark -
#pragma mark Utilities
 
//------------------------------------------------------------------------
 
- (void) setText:(NSString *)theTextString
{
    if( theTextString )
    {
        NSAttributedString  *pAttrString = [[NSAttributedString alloc] initWithString:theTextString
                                                                           attributes:mpDictionary];
        
        if( pAttrString )
        {
            [self setString:pAttrString];
            
            [pAttrString  release];
        } // if
    } // if
} // setText
 
//------------------------------------------------------------------------
 
- (void) moveTo:(const NSPoint *)thePoint
{
    m_Coordinates = *thePoint;
} // moveTo
 
//------------------------------------------------------------------------
 
- (void) drawText
{
    [self drawString:&m_Coordinates];
} // draw
 
//---------------------------------------------------------------------------
 
@end
 
//---------------------------------------------------------------------------
 
//---------------------------------------------------------------------------