TweetFollow Us on Twitter

Dec 01 Mac OS X

Volume Number: 17 (2001)
Issue Number: 12
Column Tag: Mac OS X

by Andrew Stone

Cocoamotion

Getting more for less with Cocoa.

Ever since ‘89 I’ve been developing with the precursor to Cocoa, NeXTStep & OpenStep. In each release, new features and new concepts have been added to the Application and related frameworks. making life even easier for the third party developer. The more reusable software components that Apple provides, the less code I have to write and maintain. Imagine being able to remove more and more code from your applications! Today I removed hundreds of lines of code in my Image drawing class by using the new NSImage drawing methods which respect the current transformation matrix.

This article goes over a few ways to eradicate code that you may have accrued by using new objects and new features in the old ones. We’ll look at a simplified Image drawing object, the NSStepper, and the fairly new drag methods in NSOutlineView and NSTableView.

NSImage Gets An Upgrade

Transformations

Before Mac OS X 10.0, NSImage would draw ignoring the current transformation matrix. Now this is fine if you have a simple list of graphics - but if you have nested layers of scaled, rotated, skewed groups, it’s a royal pain in the patooti to micromanage image drawing based on depth of a hierarchy!

For compatibility with older applications, the existing NSImage drawing methods such as compositeToPoint: alway draw with only the origin of the image transformed. The image itself is drawn ignoring scale and rotation transforms with the origin at the lower left. While it has been possible to draw with the current transform by getting one of the image’s representation and calling it’s draw method, two new methods have been added to NSImage that do this for you.

- (void)drawAtPoint:(NSPoint)point fromRect:(NSRect)fromRect operation:(NSCompositingOperation)op 
  fraction:(float)delta;
  
- (void)drawInRect:(NSRect)rect fromRect:(NSRect)fromRect operation:(NSCompositingOperation)op 
  fraction:(float)delta;

If you pass in NSZeroRect for the fromRect: parameter, then the whole image is used. For drawInRect:, the image will be scaled to fit in the destination rectangle as well as transformed with the context’s current transform. Please note that if you use these routines in a flipped view, you will need to ‘undo’ the negative y scale factor and adjust the origin before calling the new methods:

      // make a new transform:
                NSAffineTransform *t = [NSAffineTransform transform];
      
      // by scaling Y negatively, we effectively flip the image:
                [t scaleXBy:1.0 yBy:-1.0];
      
      // but we also have to translate it back by its height:
                [t translateXBy:0.0 yBy:-_bounds.size.height];
      
      // apply the transform:
                [t concat];

Now you can have groups of images that are scaled and skewed, and these transformations will automatically be correctly applied to the image when it is rendered. Total lines of code: 5. Number of lines of code replaced: 250. Improvement of rendering speed: 2x. Reliability and correctness were improved greatly.

Transparency:

Using these new methods, you can add a slider to your interface which controls the transparency of the image, because the new methods take a fractional dissolve, from 0.0 fully transparent to 1.0 fully opaque. Let’s say you store the amount of transparency as a float in _dissolve - then your call to render the image would be:

   // we have translated already to the origin of the image in its current group
   // _dissolve varies from 0 for no dissolve to 1 for fully transparent:
            [image drawInRect:NSMakeRect(0.0,0.0,_bounds.size.width,_bounds.size.height) 
            fromRect:NSZeroRect operation:NSCompositeSourceOver fraction:1.0 - _dissolve];

PDF Optimization:

In 10.1 and earlier, there is an “over-optimization” bug in Apple’s implementation of the NSPDFImageRep whereby it draws from its bitmap cache in certain circumstances which are incorrect. For example, when you print, you want the full resolution PDF, not a standin bitmap image which will produce jaggies. Also, when you zoom in, you want the PDF to render beautifully at that scale. You might want to test if you are printing or saving or at a high level zoom, and render the image directly from the PDF data:

      // if image is a pdf, and we are printing or saving or need the actual data:

            if (needToUseRealPDFData) {
          // grab the image’s best representation, the actual NSPDFImageRep:
                NSPDFImageRep *rep = [_image bestRepresentationForDevice:nil];
         // ask it to draw within our bounds:
                [rep drawInRect:NSMakeRect(0.0,0.0,_bounds.size.width,_bounds.size.height)];
            } else 
                  [image drawInRect:NSMakeRect(0.0,0.0,_bounds.size.width,_bounds.size.height) 
                  fromRect:NSZeroRect operation:NSCompositeSourceOver fraction:1.0 - _dissolve];

The trick to get zoomed PDF to render onscreen at full quality is to multiply the size of the PDF image to the zoom:

   // helper method to return an integral size of an image, based on the zoom:
   
    - (NSSize)sizeForZoom:(float)zoom {
       NSSize s = [_image size];
       if (zoom == 1.0 || zoom == 0.0) return s;
       // images cannot be fractional sizes, so we round down:
       return NSMakeSize(floor(s.width * zoom), floor(s.height * zoom));
    }
    
          // Before drawing the image, we check if we are zoomed:
         // if our image is a PDF, and we’re drawing to screen, get a bigger image:
         
            if (_isPDF &&  [[NSGraphicsContext currentContext] isDrawingToScreen]  &&  zoom != 1.0) {
                NSSize s = [self sizeForZoom:zoom];
                if (_zoomedPDFImage == nil) {
                    _zoomedPDFImage = [_image copyWithZone:[self zone]];
             }
             if ( !NSEqualSizes([_zoomedPDFImage size], s))
                    [_zoomedPDFImage setSize:s];
                image = _zoomedPDFImage;
            } else {
                image = _image;
            }

NSStepper

An NSStepper provides what is known in Carbon as ‘little arrows’. These are common controls for date and time entries, but are also useful for any UI component that has values which can be “tweaked” a little bit. For example, we use them in Create to allow small adjustments to scale:


The ‘little arrows’ are a new addition to Cocoa, but have been around Carbon for awhile.

Like most control subclasses, NSStepper relies on the behavior of its custom NSStepperCell for its functionality. You don’t even need to know to this to use the stepper because the control has cover methods for the standard cell methods. Besides methods familiar from slider controls (setMaxValue:, setMinValue:, setAutorepeat:), the NSStepper allows you to set the granularity of an increment (or a decrement if the lower arrow is clicked) with setIncrement:.

You can also set whether the values loop around (as would be true in the case of rotation stepper) or not with setValueWraps:. In the example of a scale slider, for example, it makes no sense to go from the maximum value to the minimum value with one click!

Using the NSStepper in your interface consists of two parts: initializing the stepper for your requirements and keeping the value of the stepper in synch with data model, since it needs to know the original value in order to increment or decrement the value. You can initialize the stepper when loading the UI components for the first itme or directly in Interface Builder. This example is for a rotational slider: When loading the UI components the first time, you might initialize the values of the stepper, in this example, for a rotational slider. You can also set these values directly in Interface Builder, or programmatically in the File Owner’s class in awakeFromNib, which is called by the nib loading mechanism if this method exists:

- (void)awakeFromNib {
   [stepper setMinValue:0.0];
   [stepper setMaxValue:360.0];
   [stepper setIncrement:1.0];
   [stepper setValueWraps:YES];
   [stepper setAutorepeat:YES];
       // target/action set in IB
}

When inspecting a graphic that can be rotated, you reload the stepper with the current value of the graphic’s rotation:

   double currentRotation = [graphic rotation];
    [circularSlider setDoubleValue: currentRotation];
      [rotationStepper setDoubleValue: currentRotation];
   ...

The stepper handles all mousedowns and it knows whether it needs to increment or decrement the value. Let’s say you have connected the stepper to an action “incrementDecrementAction:”: The stepper has set its internal value to its incremented or decremented value, depending where the user clicked.

- (void)incrementDecrementAction:(id)aStepper {
    [self setSomeValue:[aStepper doubleValue]];  
      // take the value from the stepper
    [self reloadInspectingUI];   
         // update textfields, sliders, etc with new values 
}

The NSStepper is an excellent addition to the Cocoa developer’s toolkit, and both saves some lines of code as well as provide a standard mechanism for tweaking UI values.

Drag & Drop Support in NSTableView and NSOutlineView

The refinement of the Application framework is an ongoing process. For example, a few years ago we had to write our own code for drag and drop row reordering of table views and outlineviews (http://www.stone.com/GIFfun/GIFfunSource/Row_Moving_Protocol.html). Now, that code can be thrown away, and you can use the exposed API to accomplish this:

typedef enum { NSTableViewDropOn, NSTableViewDropAbove } NSTableViewDropOperation;

// In drag and drop, used to specify a dropOperation. For example, given a table with N rows 
(numbered with row 0 at the top visually), a row of N-1 and operation of NSTableViewDropOn would 
specify a drop on the last row. To specify a drop below the last row, one would use a row of N and 
NSTableViewDropAbove for the operation.

- (BOOL)tableView:(NSTableView *)tv writeRows:(NSArray*)rows toPasteboard:(NSPasteboard*)pboard;
    // This method is called after it has been determined that a drag should begin, but before the drag 
    has been started.  To refuse the drag, return NO.  To start a drag, return YES and place the drag 
    data onto the pasteboard (data, owner, etc...).  The drag image and other drag related information 
    will be set up and provided by the table view once this call returns with YES.  The rows array is 
    the list of row numbers that will be participating in the drag.

- (NSDragOperation)tableView:(NSTableView*)tv validateDrop:(id )info 
   proposedRow:(int)row proposedDropOperation:(NSTableViewDropOperation)op;
   
    // This method is used by NSTableView to determine a valid drop target.  Based on the mouse 
    position, the table view will suggest a proposed drop location.  This method must return a value 
    that indicates which dragging operation the data source will perform.  The data source may 
    “re-target” a drop if desired by calling setDropRow:dropOperation: and returning something other 
    than NSDragOperationNone.  One may choose to re-target for various reasons (eg. for better visual 
    feedback when inserting into a sorted position).

- (BOOL)tableView:(NSTableView*)tv acceptDrop:(id )info row:(int)row 
   dropOperation:(NSTableViewDropOperation)op;
    // This method is called when the mouse is released over an outline view that previously decided to 
    allow a drop via the validateDrop method.  The data source should incorporate the data from the 
    dragging pasteboard at this time.

Our free application, GIFfun, allows users to reorder the individual images that make up the final animated GIF. Here’ s a sample implementation of the Drag and Drop support in an NSTableView:

static int _moveRow = 0;

- (BOOL)tableView:(NSTableView *)tv writeRows:(NSArray*)rows toPasteboard:(NSPasteboard*)pboard 
{
    int count = [gifFileArray count];
    int rowCount = [rows count];
    if (count < 2) return NO; 

    [pboard declareTypes:[NSArray arrayWithObject:GifInfoPasteBoard] owner:self];
    [pboard setPropertyList:rows forType:GifInfoPasteBoard];
    _moveRow = [[rows objectAtIndex:0]intValue];
    return YES;
}

- (unsigned int)tableView:(NSTableView*)tv validateDrop:(id )info 
   proposedRow:(int)row proposedDropOperation:(NSTableViewDropOperation)op 
{
    if (row != _moveRow) {
        if (op==NSTableViewDropAbove) {
            return NSDragOperationAll;
        }
        return NSDragOperationNone;
    }
    return NSDragOperationNone;
}

- (BOOL)tableView:(NSTableView*)tv acceptDrop:(id )info row:(int)row 
   dropOperation:(NSTableViewDropOperation)op 
{
   BOOL result = [self tableView:tableView didDepositRow:_moveRow at:(int)row];
   [tableView reloadData];
   return result;
}

// here we actually do the management of the data model:

-  (BOOL)tableView:(NSTableView *)tv didDepositRow:(int)rowToMove at:(int)newPosition
{
   if (rowToMove != -1 && newPosition != -1) {
      id object = [gifFileArray objectAtIndex:rowToMove];
      if (newPosition < [gifFileArray count] - 1) {
         [gifFileArray removeObjectAtIndex:rowToMove];
         [gifFileArray insertObject:object atIndex:newPosition];
      } else {
         [gifFileArray removeObjectAtIndex:rowToMove];
         [gifFileArray addObject:object];
      }
      return YES;   // ie reload
   }
   return NO;
}

These few lines listed replace the 650 lines of code from SDTableView.h, SDTableView.m and SDMovingRowsProtocol.h. The complete source code to GIFfun is available at http://www.stone.com/GIFfun/.

Adding Features By Doing Nothing

And, if my Zen slacker coding model isn’t convincing enough, consider how you can add new features by doing nothing!

If you are using the Model-View-Controller pattern and taking advantage of the NSDocument architecture, then the introduction of Mac OS X 10.1 brought you new features, without you doing anything. Because your application links at runtime with the current version of the Application and Foundation frameworks, new features available in the kits become available to your users.

10.1 adds Hidden file extensions (which is way more Mac-like than the UNIX file extensions), ability to track documents, folders, and volumes which are renamed, and ability to save documents in a way which preserves aliases to the documents and additional document info such as maintaining file permissions, creation date, and icon settings.

Some of these features do require that you recompile your application, because the Apple engineers wanted to provide full backwards binary compatibility in programs that were linked against the Mac OS 10.0 version of the Cocoa framework.

Conclusion

Software is a process not a product, and therefore it is never finished! The frameworks that Cocoa developers rely on are continually being refined and improved, so it’s very important to carefully read the Release Notes found in /Developer/Documentation/ReleaseNotes, especially AppKit.html and Foundation.html. Always check for new functionality which can replace your home-rolled versions, thus making your application more compact and reducing the code base that you need to support.


Andrew Stone andrew@stone.com is the chief executive haquer at Stone Design Corp http://www.stone.com and divides his time between raising children, llamas & cane and writing applications for Mac OS X.

 

Community Search:
MacTech Search:

Software Updates via MacUpdate

Dropbox 193.4.5594 - Cloud backup and sy...
Dropbox is a file hosting service that provides cloud storage, file synchronization, personal cloud, and client software. It is a modern workspace that allows you to get to all of your files, manage... Read more
Google Chrome 122.0.6261.57 - Modern and...
Google Chrome is a Web browser by Google, created to be a modern platform for Web pages and applications. It utilizes very fast loading of Web pages and has a V8 engine, which is a custom built... Read more
Skype 8.113.0.210 - Voice-over-internet...
Skype is a telecommunications app that provides HD video calls, instant messaging, calling to any phone number or landline, and Skype for Business for productive cooperation on the projects. This... Read more
Tor Browser 13.0.10 - Anonymize Web brow...
Using Tor Browser you can protect yourself against tracking, surveillance, and censorship. Tor was originally designed, implemented, and deployed as a third-generation onion-routing project of the U.... Read more
Deeper 3.0.4 - Enable hidden features in...
Deeper is a personalization utility for macOS which allows you to enable and disable the hidden functions of the Finder, Dock, QuickTime, Safari, iTunes, login window, Spotlight, and many of Apple's... Read more
OnyX 4.5.5 - Maintenance and optimizatio...
OnyX is a multifunction utility that you can use to verify the startup disk and the structure of its system files, to run miscellaneous maintenance and cleaning tasks, to configure parameters in the... Read more
Hopper Disassembler 5.14.1 - Binary disa...
Hopper Disassembler is a binary disassembler, decompiler, and debugger for 32- and 64-bit executables. It will let you disassemble any binary you want, and provide you all the information about its... Read more
WhatsApp 24.3.78 - Desktop client for Wh...
WhatsApp is the desktop client for WhatsApp Messenger, a cross-platform mobile messaging app which allows you to exchange messages without having to pay for SMS. WhatsApp Messenger is available for... Read more
War Thunder 2.33.0.135 - Multiplayer war...
In War Thunder, aircraft, attack helicopters, ground forces and naval ships collaborate in realistic competitive battles. You can choose from over 1,500 vehicles and an extensive variety of combat... Read more
Iridient Developer 4.2 - Powerful image-...
Iridient Developer (was RAW Developer) is a powerful image-conversion application designed specifically for OS X. Iridient Developer gives advanced photographers total control over every aspect of... Read more

Latest Forum Discussions

See All

Gorgeous Tactical Puzzle Game ‘Howl’ is...
Following its release on PC and Nintendo Switch this past November, and it’s arrival on Xbox and PlayStation back in January, publisher Astragon Entertainment and developer Mi’pu’mi Games are now bringing their super stylish tactical puzzler Howl to... | Read more »
Best iPhone Game Updates: ‘Shoot the Moo...
Hello everyone, and welcome to the week! It’s time once again for our look back at the noteworthy updates of the last seven days. It feels like a bit of a dry spell this week, at least in terms of really interesting updates. I mean, I found some... | Read more »
Celebrate Phobies spooky second annivers...
Get ready to have that classic song stuck in your head, as Phobies celebrates its second anniversary with the release of its latest update; Birthday Bash, Monster Mash. Starting March 5th and lasting for four weeks, it will be a month of... | Read more »
‘Dissidia Final Fantasy Opera Omnia’ Sto...
Square Enix finally shut down Dissidia Final Fantasy Opera Omnia (Free) on iOS and Android last week following the end of service announcement back in November last year. Following the game shutting down, Square Enix | Read more »
‘Monster Hunter Now’ Is Celebrating the...
Niantic and Capcom have begun celebrating the 20th anniversary of Capcom’s best franchise from today inside Monster Hunter Now (Free) on iOS and Android for a limited time. | Read more »
New ‘Warframe Mobile’ Update Adds 60fps...
Warframe Mobile (Free) launched worldwide on iOS just under two weeks ago. I’ve been playing it for review across multiple iOS devices, but have also been picking it up on Steam Deck and Switch to compare. Right from launch, I was impressed with... | Read more »
Passionate About Fidget Toys – The Touch...
In this week’s episode of The TouchArcade Show we kick things off with some passionate discussion about… fidget toys? For some reason? We quickly change gears to talk about the card-based rogulike Balatro, which we’ve both been playing and enjoying... | Read more »
TouchArcade Game of the Week: ‘Flying Ta...
For me Hexage is one of those developers that harkens back to the early days of the App Store and really the beginnings of iPhone gaming. I have spent many collective hours playing the likes of Totemo, Radiant, Radiant Defense, EVAC, Reaper… the... | Read more »
SwitchArcade Round-Up: ‘Ufouria 2: The S...
Hello gentle readers, and welcome to the SwitchArcade Round-Up for March 1st, 2024. In today’s article, we’re looking at the remaining releases of the week. There are a few really good ones today, but the bin bunch certainly isn’t going home hungry... | Read more »
Steam Deck Weekly: Reviews of PowerWash...
Welcome to the first Steam Deck Weekly of March and this week’s edition is bigger than usual. I was a bit unwell last week and had to push some reviews to this week. Alongside that, there have been many notable announcements, releases, and new Steam... | Read more »

Price Scanner via MacPrices.net

Deal Alert! B&H is now selling 13-inch M2...
B&H Photo has 13″ MacBook Airs with M2 CPUs and 256GB of storage in stock and on sale for $100 off Apple’s new MSRP, now only $899. Free 1-2 day delivery is available to most US addresses. Their... Read more
At $999, Apple’s 13-inch M2 MacBook Air is th...
With today’s introduction of the new 13-inch M3 MacBook Air for $1099, Apple dropped prices on the previous-generation 13-inch M2 MacBook Air to $999. At the same time, Apple discontinued the 13-inch... Read more
Apple discontinues 15-inch M2 MacBook Airs, d...
With today’s introduction of new M3-powered 15″ MacBook Airs, Apple has dropped prices on clearance, Certified Refurbished, 15″ M2 MacBook Airs to a new low of $1019. These are the cheapest 15″... Read more
Price Drop! 13-inch M2 MacBook Airs at Apple...
Apple has dropped prices on Certified Refurbished 13″ M2 MacBook Airs to a new low of $849. These are the cheapest M2-powered MacBooks for sale at Apple. Apple’s one-year warranty is included,... Read more
Apple finally discontinues the 13-inch M1 Mac...
With the introduction of M3-powered 13″ MacBook Airs today, Apple has dropped prices on clearance 13″ M1 MacBook Airs, Certified Refurbished, to $759 for 8-Core CPU/7-Core GPU/256GB models and $929... Read more
Updated Apple iPad Price Trackers
Our Apple award-winning iPad Price Trackers are the best place to find the latest information on iPad sales and deals. We track prices from 20+ Apple retailers, including Apple, Amazon, Best Buy,... Read more
Updated Apple MacBook Price Trackers
Our Apple award-winning MacBook Price Trackers are continually updated with the latest information on prices, bundles, and availability for 16″, 14″, and (recently-discontinued) 13″ MacBook Pros... Read more
Mac Studios with Apple M2 Max and M2 Ultra CP...
B&H Photo has the standard-configuration Mac Studio model with Apple’s M2 Ultra CPU in stock today and on sale for $300 off MSRP, now $3699 (24-Core CPU and 64GB RAM/1TB SSD). B&H Photo has... Read more
Extended: Switch to Verizon and get the Apple...
Verizon has the iPhone 15 on sale for $0 per month when you add a new line if service. Discount is applied to your account monthly over a 36 month term and is valid for the 128GB model. For the first... Read more
Select 16-inch M3 Pro and M3 Max MacBook Pros...
B&H Photo has select 16-inch M3 Pro and M3 Max MacBook Pros on sale for $250 off MSRP. Their prices are the lowest currently available for these configurations. Free 1-2 day shipping is available... Read more

Jobs Board

Teller Part Time *Apple* Valley MN *Apple*...
…is not eligible for Visa sponsorship **Posting Location:** + 15574 Pilot Knod Road Apple Valley, MN 55124 @RWF22 **Posting End Date:** Job posting may come down Read more
*Apple* End User Support Specialist - North...
…that they are performed. + Responsible for support of all College owned Apple computers, mobile ios devices, and peripherals, and for diagnosing and resolving Read more
Omnichannel Associate - *Apple* Blossom Mal...
Omnichannel Associate - Apple Blossom Mall Location:Winchester, VA, United States (https://jobs.jcp.com/jobs/location/191170/winchester-va-united-states) - Apple Read more
Teller Part Time *Apple* Valley MN *Apple*...
…is not eligible for Visa sponsorship **Posting Location:** + 15574 Pilot Knod Road Apple Valley, MN 55124 @RWF22 **Posting End Date:** Job posting may come down Read more
Nurse Anesthetist - *Apple* Hill Surgery Ce...
Nurse Anesthetist - Apple Hill Surgery Center WellSpan Medical Group, York, PA | Advanced Practice Providers | Certified Registered Nurse Anesthetists | FTE: 1 | Read more
All contents are Copyright 1984-2011 by Xplain Corporation. All rights reserved. Theme designed by Icreon.