Home > Articles > Mobile Application Development & Programming

iOS Developer's Cookbook: Visualizing Sprite Kit

When working with Sprite Kit, determining exactly where items will appear and what size they'll occupy can be a tricky proposition. Here are a few tips to help you visualize the way your iOS Sprite Kit scenes are put together.
Like this article? We recommend

Although Sprite Kit offers feedback in the form of number of properties that show frames per second, drawing counts, node counts, and (on iOS) physics body outlines, it offers a minimum of help in terms of tree and frame visualization. Determining exactly where items will appear and what size they'll occupy can be a tricky proposition. Here's an example of why confusion happens.

Take a look at Figure 1. It shows a scene with a single label node. The left screen shot uses a "right" horizontal alignment and a "baseline" vertical alignment. The second keeps the horizontal alignment and adjusts the vertical alignment to "top." In each case, the actual frame you want to work with is the left rectangle, which correctly surrounds its text. The right rectangle shows the frame you'd get if you tried to determine its edges using just the node's position attribute and its reported size.

Figure 1 In Sprite Kit, bounds and frames can get tricky. These rectangles are created programmatically as shape node children and are not a standard part of Sprite Kit

So why is there this disparity? It's intentional. Modes enable you to adjust the label with respect to its position attribute. Here's the code that created the label used in these images.

// Create the label
SKLabelNode *label = [SKLabelNode labelNodeWithFontNamed:@"Futura"];
label.text = @"Hello World";
label.name = @"hello";
label.fontSize = 36; label.fontColor = [SKColor whiteColor];

// Place the label
label.position = CGPointMake(CGRectGetMidX(scene.frame), CGRectGetMidY(scene.frame));
label.horizontalAlignmentMode = SKLabelHorizontalAlignmentModeRight;
label.verticalAlignmentMode = example1 ? 
    SKLabelVerticalAlignmentModeBaseline : SKLabelVerticalAlignmentModeTop;

To understand what is onscreen at any time and where each item is, it helps to examine a scene's underlying node structure. The following methods are part of an SKNode category. They iterate through all the children of a scene and recursively descend their node trees. At each node, the methods print a node description. When working with sprite nodes, it adds the anchor information as well.

Visualization #1: Recursively Descending the Node Tree

@implementation SKNode (Utility)
- (void) dumpNode: (SKNode *) node atIndent: (int) indent into: (NSMutableString *) outstring
{
    for (int i = 0; i < indent; i++) [outstring appendString:@"--"];
    
    // Node class and built-in description
    [outstring appendFormat:@"[%2d] %@", indent, node.description];
    
    // Frame
    if ([node.description rangeOfString:@"frame:"].location == NSNotFound)
        [outstring appendFormat:@" Frame: %@" , SKReadableRectString(node.frame)];
    
    // Position
    if ([node.description rangeOfString:@"position:"].location == NSNotFound)
        [outstring appendFormat:@" Position: %@" , SKReadablePointString(node.position)];
    [outstring appendFormat:@" [ZPos %0.1f at %0.1f°/%0.3f]", 
        node.zPosition, node.zRotation * 180.0 / M_PI, node.zRotation];
    
    // Scale
    [outstring appendFormat:@" Scale: (%0.1f, %0.1f)" , node.xScale, node.yScale];
    
    // Anchor if applicable
    if ([node respondsToSelector:@selector(anchorPoint)])
    {
        // Scene, Sprite, or Video
        SKScene *standin = (SKScene *) node;
        CGPoint anchorPoint = [standin anchorPoint];
        [outstring appendFormat:@" Anchor: %@", SKReadablePointString(anchorPoint)];
    }
    
    // Accumulated Frame
    if ([node.description rangeOfString:@"accumulatedFrame:"].location == NSNotFound)
        [outstring appendFormat:@" Accumulated: %@" , 
            SKReadableRectString(node.calculateAccumulatedFrame)];
    
    // User data
    if (node.userData.allKeys.count)
        [outstring appendFormat:@" User Data: %@", SKReadableDictionary(node.userData)];
    [outstring appendString:@"\n"];
    
    // Recurse
    for (SKNode *child in node.children)
        [self dumpNode:child atIndent:indent + 1 into:outstring];
}

- (void) printNodeTree
{
    NSMutableString *string = @"".mutableCopy;    
    if ([self isKindOfClass:[SKScene class]])
    {
        SKScene *scene = (SKScene *) self;
        [string appendString:@"Scene"];
        if (scene.view.ignoresSiblingOrder)
            [string appendString:@" (SKView ignores sibling order)"];
        [string appendString:@"\n"];
    }
    [self dumpNode:self atIndent:0 into:string];
    printf("%s", string.UTF8String);
}
@end

When you print a node tree that includes a label, you discover that each label actually consists of two nodes. There's a parent node, the SKLabelNode instance that sets a frame, and there's a child node, an SKSpriteNode that draws the text. When run on this example, this code produces the following results.

Scene
[ 0] <SKLabelNode> name:'hello' text:'Hello World' fontName:'Futura' position:{284, 
150} Frame: [88.0, 116.0, 196.0, 34.0] [ZPos 0.0 at 0.0°/0.000] Scale: (1.0, 1.0) 
Accumulated: [88.0, 116.0, 196.0, 34.0]

--[ 1] <SKSpriteNode> name:'(null)' texture:[<SKTexture> '<data>' (196 x 34)] 
position:{-196, -34} size:{196, 34} rotation:0.00 Frame: [-196.0, -34.0, 196.0, 34.0] 
[ZPos 0.0 at 0.0°/0.000] Scale: (1.0, 1.0) Anchor: (0.0, 0.0) Accumulated: [-196.0, -
34.0, 196.0, 34.0]

The label's frame rectangle does not start at the node's position of {284, 150}. Instead, the label allows the text to float to a position with respect to the alignment modes you requested. The label's sprite child defines its frame relative to its parent's position.

A node's accumulated frame, available via calculateAccumulatedFrame, calculates an encompassing frame that includes the node and all its descendants. The frame is reported in its parent's coordinate system and includes any cumulative effects of scaling and rotation (specifically xScale, yScale, and zRotation) for all nodes in the subtree.

Drawing Frames

When working with UIView instances, you add overlays to views by adding run-time options to the Xcode scheme or by implementing a UIView category that uses a bordered default layer. With Sprite Kit, it's slightly trickier to visualize frames. Sprite nodes are responders, but they do not descend from the UIView class.

As Apple's Sprite Kit programming guide teaches you, built-in scene properties enable you to display debugging information for various features. You can enable showsDrawCount, showsFPS, showsNodeCount, and showsPhysics. You cannot, however, show node bounds without some kind of hacking workaround. To create the debugging panel in Figure 2, I searched Sprite Kit's binary framework to find the functionality I needed.

Figure 2 This slide-in debugging panel enables me to better visualize performance and position in Sprite Kit projects. Pro tip: If your FPS readout doesn't appear at run-time, toggle the draw-count a couple times

I discovered that SKView implements a showSpriteBounds property. However, this API is not public. To gain access, you must add a class extension, like the simple one shown here. When enabled, Sprite Kit draws a thin blue border around each participating view. If you've enabled showsPhysics (as in Figure 3), the physics body appears in pink.

Visualization #2: Enabling Bounds Display

// NOT FOR APP STORE
@interface SKView (Debug)
@property (nonatomic) BOOL showsSpriteBounds;
@end

This class extension is not suitable for the App Store. Apple's automatic scanner can detect any use of this unpublished API. For debugging, it's a valuable tool. I'm surprised that Sprite Kit did not ship with this option publicly available. (In iOS 8, this property has been renamed to _showsSpriteBounds.)

Figure 3 A sprite node's frame and physics body shape often may not correlate

Visualizing Node Names

The nodeAtPoint: method is fantastic for working with touch-based sprites. In practice, complex node trees can throw off program logic. I usually want to retrieve the name of the top-most object both when debugging and when implementing semantic distinctions.

Here's an example where a touch on the presented child, a textured sprite node, should pass up the chain to a top-level node that can apply the physics body impulse. Although you can jump up to the scene level using a node's scene property, you'll want to find an ancestor node that lives in the scene and not return the scene itself.

- (void) touchesBegan:(NSSet *)touches withEvent:(UIEvent *)event
{
    // Fetch the touched node
    UITouch *touch = touches.anyObject;
    CGPoint point = [touch locationInNode:self];
    SKNode *node = [self nodeAtPoint:point];
    if (!node) return;

    CGVector impulse = CGVectorMake(0, isText ? 50 : 10000);
    CGPoint adjustedPoint = [touch locationInNode:node];
    [node.derivedNode.physicsBody applyImpulse:impulse atPoint:adjustedPoint];
}

The following SKNode category creates a derivedNode property that does just that. It walks the node tree until it finds a node that lives directly under the scene and returns that node.

When inspecting the touched node, the name you're interested in usually better corresponds to an ancestor's name than the touched node itself. For example, "high-bounce target" tells you more than "pattered texture node." A second property, derivedName, offers direct access to the semantic name corresponding to a touched node.

Visualization #3: Retrieving Top-Level Node Names

- (SKNode *) derivedNode
{
    SKNode *node = self;
    while (node.parent && ![node.parent isKindOfClass:[SKScene class]])
        node = node.parent;    
    if ([node.parent isKindOfClass:[SKScene class]])
        return node;    
    return self;
}

- (NSString *) derivedName
{
    return self.derivedNode.name;
}

Wrap-Up

These few simple Sprite Kit tricks enable you to better delve into your scenes. With them, you can understand how they're composed, why items appear in the positions they're in, and how child nodes relate to their parents within a scene. There are more secrets and tricks that debuted with iOS 8, but those can wait until we're a lot closer to the Gold Master release.

InformIT Promotional Mailings & Special Offers

I would like to receive exclusive offers and hear about products from InformIT and its family of brands. I can unsubscribe at any time.

Overview


Pearson Education, Inc., 221 River Street, Hoboken, New Jersey 07030, (Pearson) presents this site to provide information about products and services that can be purchased through this site.

This privacy notice provides an overview of our commitment to privacy and describes how we collect, protect, use and share personal information collected through this site. Please note that other Pearson websites and online products and services have their own separate privacy policies.

Collection and Use of Information


To conduct business and deliver products and services, Pearson collects and uses personal information in several ways in connection with this site, including:

Questions and Inquiries

For inquiries and questions, we collect the inquiry or question, together with name, contact details (email address, phone number and mailing address) and any other additional information voluntarily submitted to us through a Contact Us form or an email. We use this information to address the inquiry and respond to the question.

Online Store

For orders and purchases placed through our online store on this site, we collect order details, name, institution name and address (if applicable), email address, phone number, shipping and billing addresses, credit/debit card information, shipping options and any instructions. We use this information to complete transactions, fulfill orders, communicate with individuals placing orders or visiting the online store, and for related purposes.

Surveys

Pearson may offer opportunities to provide feedback or participate in surveys, including surveys evaluating Pearson products, services or sites. Participation is voluntary. Pearson collects information requested in the survey questions and uses the information to evaluate, support, maintain and improve products, services or sites, develop new products and services, conduct educational research and for other purposes specified in the survey.

Contests and Drawings

Occasionally, we may sponsor a contest or drawing. Participation is optional. Pearson collects name, contact information and other information specified on the entry form for the contest or drawing to conduct the contest or drawing. Pearson may collect additional personal information from the winners of a contest or drawing in order to award the prize and for tax reporting purposes, as required by law.

Newsletters

If you have elected to receive email newsletters or promotional mailings and special offers but want to unsubscribe, simply email information@informit.com.

Service Announcements

On rare occasions it is necessary to send out a strictly service related announcement. For instance, if our service is temporarily suspended for maintenance we might send users an email. Generally, users may not opt-out of these communications, though they can deactivate their account information. However, these communications are not promotional in nature.

Customer Service

We communicate with users on a regular basis to provide requested services and in regard to issues relating to their account we reply via email or phone in accordance with the users' wishes when a user submits their information through our Contact Us form.

Other Collection and Use of Information


Application and System Logs

Pearson automatically collects log data to help ensure the delivery, availability and security of this site. Log data may include technical information about how a user or visitor connected to this site, such as browser type, type of computer/device, operating system, internet service provider and IP address. We use this information for support purposes and to monitor the health of the site, identify problems, improve service, detect unauthorized access and fraudulent activity, prevent and respond to security incidents and appropriately scale computing resources.

Web Analytics

Pearson may use third party web trend analytical services, including Google Analytics, to collect visitor information, such as IP addresses, browser types, referring pages, pages visited and time spent on a particular site. While these analytical services collect and report information on an anonymous basis, they may use cookies to gather web trend information. The information gathered may enable Pearson (but not the third party web trend services) to link information with application and system log data. Pearson uses this information for system administration and to identify problems, improve service, detect unauthorized access and fraudulent activity, prevent and respond to security incidents, appropriately scale computing resources and otherwise support and deliver this site and its services.

Cookies and Related Technologies

This site uses cookies and similar technologies to personalize content, measure traffic patterns, control security, track use and access of information on this site, and provide interest-based messages and advertising. Users can manage and block the use of cookies through their browser. Disabling or blocking certain cookies may limit the functionality of this site.

Do Not Track

This site currently does not respond to Do Not Track signals.

Security


Pearson uses appropriate physical, administrative and technical security measures to protect personal information from unauthorized access, use and disclosure.

Children


This site is not directed to children under the age of 13.

Marketing


Pearson may send or direct marketing communications to users, provided that

  • Pearson will not use personal information collected or processed as a K-12 school service provider for the purpose of directed or targeted advertising.
  • Such marketing is consistent with applicable law and Pearson's legal obligations.
  • Pearson will not knowingly direct or send marketing communications to an individual who has expressed a preference not to receive marketing.
  • Where required by applicable law, express or implied consent to marketing exists and has not been withdrawn.

Pearson may provide personal information to a third party service provider on a restricted basis to provide marketing solely on behalf of Pearson or an affiliate or customer for whom Pearson is a service provider. Marketing preferences may be changed at any time.

Correcting/Updating Personal Information


If a user's personally identifiable information changes (such as your postal address or email address), we provide a way to correct or update that user's personal data provided to us. This can be done on the Account page. If a user no longer desires our service and desires to delete his or her account, please contact us at customer-service@informit.com and we will process the deletion of a user's account.

Choice/Opt-out


Users can always make an informed choice as to whether they should proceed with certain services offered by InformIT. If you choose to remove yourself from our mailing list(s) simply visit the following page and uncheck any communication you no longer want to receive: www.informit.com/u.aspx.

Sale of Personal Information


Pearson does not rent or sell personal information in exchange for any payment of money.

While Pearson does not sell personal information, as defined in Nevada law, Nevada residents may email a request for no sale of their personal information to NevadaDesignatedRequest@pearson.com.

Supplemental Privacy Statement for California Residents


California residents should read our Supplemental privacy statement for California residents in conjunction with this Privacy Notice. The Supplemental privacy statement for California residents explains Pearson's commitment to comply with California law and applies to personal information of California residents collected in connection with this site and the Services.

Sharing and Disclosure


Pearson may disclose personal information, as follows:

  • As required by law.
  • With the consent of the individual (or their parent, if the individual is a minor)
  • In response to a subpoena, court order or legal process, to the extent permitted or required by law
  • To protect the security and safety of individuals, data, assets and systems, consistent with applicable law
  • In connection the sale, joint venture or other transfer of some or all of its company or assets, subject to the provisions of this Privacy Notice
  • To investigate or address actual or suspected fraud or other illegal activities
  • To exercise its legal rights, including enforcement of the Terms of Use for this site or another contract
  • To affiliated Pearson companies and other companies and organizations who perform work for Pearson and are obligated to protect the privacy of personal information consistent with this Privacy Notice
  • To a school, organization, company or government agency, where Pearson collects or processes the personal information in a school setting or on behalf of such organization, company or government agency.

Links


This web site contains links to other sites. Please be aware that we are not responsible for the privacy practices of such other sites. We encourage our users to be aware when they leave our site and to read the privacy statements of each and every web site that collects Personal Information. This privacy statement applies solely to information collected by this web site.

Requests and Contact


Please contact us about this Privacy Notice or if you have any requests or questions relating to the privacy of your personal information.

Changes to this Privacy Notice


We may revise this Privacy Notice through an updated posting. We will identify the effective date of the revision in the posting. Often, updates are made to provide greater clarity or to comply with changes in regulatory requirements. If the updates involve material changes to the collection, protection, use or disclosure of Personal Information, Pearson will provide notice of the change through a conspicuous notice on this site or other appropriate way. Continued use of the site after the effective date of a posted revision evidences acceptance. Please contact us if you have questions or concerns about the Privacy Notice or any objection to any revisions.

Last Update: November 17, 2020