TweetFollow Us on Twitter

Screen Savers in Cocoa

Volume Number: 20 (2004)
Issue Number: 6
Column Tag: Programming

Screen Savers in Cocoa

by Scott Knaster

One of the classic mantra-like goals for computer science over the past 20 years or so has been to "Make simple things simple, and complex things possible". Programming with Cocoa has a sometimes-complex learning curve, but once you've swerved through that curve, there are definitely a bunch of things that are much easier to accomplish than they were in the old pre-OS X world we knew and occasionally loved.

One of the classic mantra-like goals for computer science over the past 20 years or so has been to "Make simple things simple, and complex things possible". Programming with Cocoa has a sometimes-complex learning curve, but once you've swerved through that curve, there are definitely a bunch of things that are much easier to accomplish than they were in the old pre-OS X world we knew and occasionally loved. Writing a screen saver is a perfect example: it should be simple. Most typical OS 9 application programmers never dipped their toes into the slightly wacky world of screen savers, but with Cocoa in OS X, implementing a screen saver is well within everybody's grasp. In this month's column, we'll take a look at how to get your very own screen saver up and, er, saving.

Here's What We're Gonna Do

Let's start by taking a look at the process for creating a screen saver in OS X. Here are the broad steps:

  • Create a new screen saver project in Xcode.
  • Edit our .h file.
  • Override methods and write other code in our .m file.
  • Build the project to create a .saver package.
  • Install the .saver package by putting it into the Library/Screen Savers/ folder.
  • Open System Preferences and see a preview of our screen saver.
  • Enjoy the savings!

We'll go through each of these steps in greater depth now.

Little Help

The basic magic that makes screen savers so easy is the Screen Saver framework in Cocoa. This framework defines the ScreenSaverView class, which is a subclass of NSView. By creating your own subclass of ScreenSaverView and adding some code, you define your screen saver. The Screen Saver framework also defines the class ScreenSaverDefaults, which you can use for handling preferences for your saver. Along with these classes, the framework provides some handy utility functions you can use in your code.

We'll go over some of the most interesting methods and functions in the ScreenSaverView class. You will rarely call methods defined by ScreenSaverView - most of the work is creating your own subclass and override some methods.

initWithFrame:isPreview:

- (id)initWithFrame:(NSRect)frame isPreview:(BOOL)isPreview

You override initWithFrame in your ScreenSaverView subclass. The system calls initWithFrame when the screen saver is about take over the screen or is selected in System Preferences. The frame parameter is the frame rectangle for the view. The isPreview parameter tells whether the screen saver is actually being invoked or is merely being asked to preview itself in System Preferences (as shown in Figure 1).


Figure 1. You can preview the screen saver in a little box in System Preferences. In your code, you can tell whether the screen saver is drawing full-screen or in the preview box.

startAnimation

- (void) startAnimation

The system calls startAnimation right before the screen saver is about to start drawing. You should override startAnimation to set up your screen saver's initial state, such as setting line widths or loading images. You should call the inherited implementation, or bad things might happen, such as incorrect drawing, or all water on earth instantaneously evaporating.

animateOneFrame

- (void) animateOneFrame

This is where your screen saver gets to show off its amazing graphical skills. Mac OS X asks your screen saver to do its drawing by calling animateOneFrame repeatedly. You can actually do your drawing in animateOneFrame or in drawRect, or even a little in both places. If you make any changes here that require further redrawing, your implementation should call setNeedsDisplay:YES, which will cause drawRect to be called.

drawRect

- (void) drawRect:(NSRect)rect 

Override drawRect to draw the screen saver view. You can do your drawing in animateOneFrame, or you can do some or all of it here. rect is the rectangle you're drawing into, which is handy to have when you want to erase the view and start drawing afresh.

stopAnimation

- (void) stopAnimation 

When Mac OS X wants your screen saver to stop doing its thing, it calls stopAnimation. You can override stopAnimation to release resources or do any other cleanup you want before your screen saver goes away.

Saving Time

Now that you're familiar with the cast of characters in ScreenSaverView, let's go ahead and code up our screen saver. To start, we'll open Xcode and create a new project of type Screen Saver (see Figure 2).


Figure 2. Creating a new Screen Saver project gets you started with the Screen Saver framework, including your own subclass of ScreenSaverView.

This proves that Xcode already knows about the screen saver framework, which saves us plenty of work. Our new project already contains a subclass of ScreenSaverView, and we already have the usual .h and .m files. We'll edit the .h file that Xcode gives us until it looks like this:

#import <ScreenSaver/ScreenSaver.h>


@interface SaveyerView : ScreenSaverView 
{
   NSBezierPath *path;
}


@end

The header file is pretty darn basic. All we do here is create a subclass of ScreenSaverView and add an NSBezierPath object to keep track of what we're drawing.

Now let's get into the implementation files and see what we can find. When we told Xcode to create a new ScreenSaver project, it start us off with some code, including the implementation for initWithFrame:isPreview:, the designated initializer. In this case, we're able to use the supplied code for initWithFrame without any changes:

- (id)initWithFrame:(NSRect)frame isPreview:(BOOL)isPreview
{
    self = [super initWithFrame:frame isPreview:isPreview];
    if (self) {
        [self setAnimationTimeInterval:1/30.0];
            // Draw 30 frames per second
    }
    return self;

The code here starts by calling the inherited implementation. After that, we use setAnimationTimeInterval to tell Mac OS X that we want our screen saver to draw 30 frames per second. As I mentioned, this is the default code that Xcode writes for this method. You can modify it if you want to perform some other task when the screen saver starts up. For example, if your screen saver has user-settable options, you can handle them here.

Next, we'll take a look at our startAnimation method, which the system calls right before asking our screen saver to start drawing. Our implementation of startAnimation begins by calling the inherited implementation. Then, we create our Bezier path and choose a nifty line join style:

- (void)startAnimation
{
   NSPoint x;

   [super startAnimation];
	
   path = [[NSBezierPath alloc] init];
      // We'll use a Bezier path for drawing

   [path setLineJoinStyle: NSRoundLineJoinStyle];	
      // Just for fun, connect the lines with
      // a round joint

When the system asks our screen saver to get ready to draw, we can call the view's isPreview method to see if we're being asked to draw on the full screen or in the little preview box in System Preferences (as shown back in Figure 1).

We can use the result of isPreview to make decisions about just what to draw. In our screen saver, we'll make the lines skinny for the preview, and fatter for the real, full-screen version:

   if ([self isPreview])
      // When drawing a preview, make the lines
      // much thinner than when saving screens.
   {
      [path setLineWidth: 0.0];
      // This is the thinnest possible line width
   }
   else
   {
      [path setLineWidth: 10.18];
      // This line width was chosen at random.
      // OK, actually, it's my son's birthdate.
   }

Our last task here is to get the Bezier path started. We'll do that by picking a random starting point and moving the path there:

   x = SSRandomPointForSizeWithinRect 
         (NSMakeSize (0,0), [self bounds]);
      // Call utility function to get a random point

   [path moveToPoint:x];
      // Start the path at the random point
}

We get a random point by calling SSRandomPointForSizeWithinRect, a handy function provided by the screen saver framework for just this purpose. Hooray for handy functions! Then, we simply move the path pen to that random point to start it out.

Everything that starts must end, and the next method we define is stopAnimation, which is called when the system doesn't need the screen saver to draw any more. Here's our implementation of stopAnimation:

- (void)stopAnimation
{
   [super stopAnimation];
	
   [path release];
         // Release the path

   path = nil;
         // Tell our screen saver view that there's no path
}

The standard stopAnimation provided by Xcode simply calls the inherited implementation. In our version, we keep that super call, and add code to release the Bezier path object and set the path instance variable to nil.

Every time the system wants our screen saver to draw another piece, it calls our animateOneFrame method. Let's take a look at that. First, we'll call that convenient SSRandomPointForSizeWithinRect utility function to get another random point:

- (void)animateOneFrame
{
    NSPoint x;
	
   x = SSRandomPointForSizeWithinRect 
         (NSMakeSize (0,0), [self bounds]);
            // Get a random point to extend the Bezier path

We want our screen saver to draw a bunch of lines on the screen, and every so often, we want it to erase the lines and start over. Let's say we want 50 lines at a time, in honor of our 50 states. If we haven't reached 50 yet, we add the new random point to the path:

if ([path elementCount] < 50)
      // Draw 50 lines before erasing
      {
         [path lineToPoint: x];
            // If we don't have 50 yet, add the 
            // new point to the line
      }

Once we have 50 points in the path, we want to reset the path by callously discarding all points and then start building it up again:

      else
      {
         [path removeAllPoints];
         [path moveToPoint:x];
            // If we do have 50, clean out the path
            // and get ready to start over
      }

We finish by telling the system that we've messed with the path and it needs to be redrawn by calling the screen saver view's drawRect method. Alternatively, we could do the actual drawing right here in animateOneFrame:

   [self setNeedsDisplay:YES];
      // Tell the system that something has changed
      // and drawRect should be called
}

The actual drawing happens in drawRect, which we'll look at NeXT. We start by calling the inherited drawRect, which by default erases the background to black.

- (void)drawRect:(NSRect)rect
{
   NSColor *color;

   [super drawRect:rect];

We then choose a pretty color, and call set to make sure that the drawing happens in that color. Then we call stroke on the Bezier path object to actually draw the thing:

   color = [NSColor colorWithCalibratedRed:(0.0) 
                  green:(1.0) blue:(1.0) alpha:(1.0)];

   [color set];
      // Set the color to teal. Go Sharks!
	
   [path stroke];
      // Draw the Bezier path 
}

The last method we implement is our version of dealloc. The view's Bezier path is the only allocated object we have to worry about, so our method looks like this:

- (void) dealloc
{
   [path release];
      // Release the Bezier path

   [super dealloc];
}

Put Me In, Coach

When we have all the source code done, we build our project. If everything builds OK, a file with the suffix .saver ends up in the project's build folder. To install the screen saver, start by quitting System Preferences if it's running. Then move or copy the .saver file into the /Library/Screen Savers directory. You can put it in ~/Library/Screen Savers if you want to keep it all to yourself and prevent other users from seeing it.

Once our screen saver is in the folder, you can start System Preferences, click Desktop & Screen Saver, click the Screen Saver tab, and select our screen saver in the list. You should see the skinny lines in the preview mode. Then click Test, and observe the big teal lines with their round elbows. There you go! You can get this month's code at http://www.papercar.com/mt/Jun04.zip

If you're interested in making your own screen savers, there are lots of directions you can go from here. Add user-settable options by overriding the hasConfigureSheet and configureSheet methods. Use random colors. Do some much fancier drawing in your animateOneFrame method - for example, draw shapes, use curveToPoint instead of lineToPoint, or load images from disk. Whatever you do, have fun, and remember: the screen you save may be your own.


Scott Knaster writes books, including the recently published Mac Toys and the brand-new Hacking iPod and iTunes, both from Wiley Publishing. Scott can't read and listen to vocal music at the same time. Scott writes these little bios in the third person. Write to Scott at scottk@mactech.com.

 

Community Search:
MacTech Search:

Software Updates via MacUpdate

Vivaldi 1.0.118.19 - Lightweight browser...
Vivaldi browser. In 1994, two programmers started working on a web browser. Our idea was to make a really fast browser, capable of running on limited hardware, keeping in mind that users are... Read more
Stacks 2.6.11 - New way to create pages...
Stacks is a new way to create pages in RapidWeaver. It's a plugin designed to combine drag-and-drop simplicity with the power of fluid layout. Features: Fluid Layout: Stacks lets you build pages... Read more
xScope 4.1.3 - Onscreen graphic measurem...
xScope is powerful set of tools that are ideal for measuring, inspecting, and testing on-screen graphics and layouts. Its tools float above your desktop windows and can be accessed via a toolbar,... Read more
Cyberduck 4.7 - FTP and SFTP browser. (F...
Cyberduck is a robust FTP/FTP-TLS/SFTP browser for the Mac whose lack of visual clutter and cleverly intuitive features make it easy to use. Support for external editors and system technologies such... Read more
Labels & Addresses 1.7 - Powerful la...
Labels & Addresses is a home and office tool for printing all sorts of labels, envelopes, inventory labels, and price tags. Merge-printing capability makes the program a great tool for holiday... Read more
teleport 1.2.1 - Use one mouse/keyboard...
teleport is a simple utility to let you use one single mouse and keyboard to control several of your Macs. Simply reach the edge of your screen, and your mouse teleports to your other Mac! The... Read more
Apple iMovie 10.0.8 - Edit personal vide...
With an all-new design, Apple iMovie lets you enjoy your videos like never before. Browse your clips more easily, instantly share your favorite moments, and create beautiful HD movies and Hollywood-... Read more
Box Sync 4.0.6233 - Online synchronizati...
Box Sync gives you a hard-drive in the Cloud for online storage. Note: You must first sign up to use Box. What if the files you need are on your laptop -- but you're on the road with your iPhone? No... Read more
Fantastical 2.0.3 - Create calendar even...
Fantastical 2 is the Mac calendar you'll actually enjoy using. Creating an event with Fantastical is quick, easy, and fun: Open Fantastical with a single click or keystroke Type in your event... Read more
The Hit List 1.1.14 - Advanced reminder...
The Hit List manages the daily chaos of your modern life. It's easy to learn - it's as easy as making lists. And it's powerful enough to let you plan, then forget, then act when the time is right.... Read more

SoundHound + LiveLyrics is Making its De...
SoundHound Inc. has announced that SoundHound + LiveLyrics, will be one of the first third-party apps to hit the Apple Watch. With  SoundHound you'll be able to tap on your watch and have the app recognize the music you are listening to, then have... | Read more »
Adobe Joins the Apple Watch Lineup With...
A whole tidal wave of apps are headed for the Apple Watch, and Adobe has joined in with 3 new ways to enhance your creativity and collaborate with others. The watch apps pair with iPad/iPhone apps to give you total control over your Adobe projects... | Read more »
Z Steel Soldiers, Sequel to Kavcom'...
Kavcom has released Z Steel Soldiers, which continues the story of the comedic RTS originally created by the Bitmap Brothers. [Read more] | Read more »
Seene Lets You Create 3D Images With You...
Seene, by Obvious Engineering, is a 3D capture app that's meant to allow you to create visually stunning 3D images with a tap of your finger, and then share them as a 3D photo, video or gif. [Read more] | Read more »
Lost Within - Tips, Tricks, and Strategi...
Have you just downloaded Lost Within and are you in need of a guiding hand? While it’s not the toughest of games out there you might still want some helpful tips to get you started. [Read more] | Read more »
Entertain Your Pet With Your Watch With...
The Petcube Camera is a device that lets you use live video to check in on your pet, talk to them, and play with them using a laser pointer - all while you're away. And the Petcube app is coming to the Apple Watch, so you'll be able to hang out with... | Read more »
Now You Can Manage Your Line2 Calls With...
You'll be able to get your Line2 cloud phone service on the Apple Watch very soon. The watch app can send and receive messages using hands-free voice dictation, or by selecting from a list of provided responses. [Read more] | Read more »
R.B.I. Baseball 15 (Games)
R.B.I. Baseball 15 1.01 Device: iOS Universal Category: Games Price: $4.99, Version: 1.01 (iTunes) Description: The legendary Major League Baseball franchise returns to the diamond. Make History. ** ALL iPOD Touch, the iPad 2 and the... | Read more »
Here's How You Can Tell if an App W...
The Apple Watch is pretty much here, and that means a whole lot of compatible apps and games are going to be updated or released onto the App Store. That's okay though, beacause Apple has quietly updated their app description pages to make things... | Read more »
Forgotten Memories : Alternate Realities...
Forgotten Memories : Alternate Realities 1.0.1 Device: iOS Universal Category: Games Price: $4.99, Version: 1.0.1 (iTunes) Description: + REDUCED PRICE ONLY THE LAUNCHING WEEK + "The most exciting horror game of 2015." - AppSpy... | Read more »

Price Scanner via MacPrices.net

Intel Compute Stick: A New Mini-Computing For...
The Intel Compute Stick, a new pocket-sized computer based on a quad-core Intel Atom processor running Windows 8.1 with Bing, is available now through Intel Authorized Dealers across much of the... Read more
Heal to Launch First One-Touch House Call Doc...
Santa Monica, California based Heal, a pioneer in on-demand personal health care services — will offer the first one-touch, on-demand house call doctor app for the Apple Watch. Heal’s Watch app,... Read more
Mac Notebooks: Avoiding MagSafe Power Adapter...
Apple Support says proper usage, care, and maintenance of Your Mac notebook’s MagSafe power adapter can substantially increase the the adapter’s service life. Of course, MagSafe itself is an Apple... Read more
12″ Retina MacBook In Shootout With Air And P...
BareFeats’ rob-ART morgan has posted another comparison of the 12″ MacBook with other Mac laptops, noting that the general goodness of all Mac laptops can make which one to purchase a tough decision... Read more
FileMaker Go for iPad and iPhone: Over 1.5 Mi...
FileMaker has announced that its FileMaker Go for iPad and iPhone app has surpassed 1.5 million downloads from the iTunes App Store. The milestone confirms the continued popularity of the FileMaker... Read more
Sale! 13-inch 2.7GHz Retina MacBook Pro for $...
 Best Buy has the new 2015 13″ 2.7GHz/128GB Retina MacBook Pro on sale for $1099 – $200 off MSRP. Choose free shipping or free local store pickup (if available). Price for online orders only, in-... Read more
Minimalist MacBook Confirms Death of Steve Jo...
ReadWrite’s Adriana Lee has posted a eulogy for the “Digital Hub” concept Steve Jobs first proposed back in 2001, declaring the new 12-inch MacBook with its single, over-subscribed USB-C port to be... Read more
13-inch 2.7GHz Retina MacBook Pro for $1234 w...
Adorama has the 13″ 2.7GHz/128GB Retina MacBook Pro in stock for $1234.99 ($65 off MSRP) including free shipping plus a free LG external DVD/CD optical drive. Adorama charges sales tax in NY & NJ... Read more
13-inch 2.5GHz MacBook Pro available for $999...
 Adorama has the 13-inch 2.5GHz MacBook Pro on sale for $999 including free shipping plus NY & NJ sales tax only. Their price is $100 off MSRP. Read more
Save up to $600 with Apple refurbished Mac Pr...
The Apple Store is offering Apple Certified Refurbished Mac Pros for up to $600 off the cost of new models. An Apple one-year warranty is included with each Mac Pro, and shipping is free. The... Read more

Jobs Board

*Apple* Retail - Multiple Positions (US) - A...
Sales Specialist - Retail Customer Service and Sales Transform Apple Store visitors into loyal Apple customers. When customers enter the store, you're also the Read more
*Apple* Watch SW Application Project Manager...
**Job Summary** The Apple Watch software team is looking for an Application Engineering Project Manager to work on new projects for Apple . The successful candidate Read more
Map Services Frameworks Manager - *Apple* M...
Job Description: Apple 's Maps Evaluation Organization is seeking a Senior Manager to lead the Map services assertions and performance frameworks group. Key Read more
Shuttle Driver - APPLE EAST, APPLE EAST (Unit...
HERE WE GROW AGAIN!! We are adding to our team! Red Lion Chevrolet of Apple Automotive is growing and we are looking for a PART TIME SHUTTLE DRIVER/ PORTER FOR SERVICE Read more
*Apple* Retail - Multiple Positions (US) - A...
Job Description: Sales Specialist - Retail Customer Service and Sales Transform Apple Store visitors into loyal Apple customers. When customers enter the store, Read more
All contents are Copyright 1984-2011 by Xplain Corporation. All rights reserved. Theme designed by Icreon.