OOTextureVerifierStage Class Reference

#include <OOTextureVerifierStage.h>

Inheritance diagram for OOTextureVerifierStage:

Collaboration diagram for OOTextureVerifierStage:

Instance Methods
(void)	- textureNamed:usedInContext:
(id)	- init [implementation]
(void)	- dealloc [implementation]
(NSString *)	- name [implementation]
(BOOL)	- shouldRun [implementation]
(void)	- run [implementation]
(void)	- checkTextureNamed:inFolder: [implementation]
Instance Methods inherited from OOFileHandlingVerifierStage
(NSSet *)	- dependencies [implementation]
(NSSet *)	- dependents [implementation]
Instance Methods inherited from OOOXPVerifierStage
(OOOXPVerifier *)	- verifier
(BOOL)	- completed
(id)	- description [implementation]
(void)	- setVerifier: [implementation]
(BOOL)	- isDependentOf: [implementation]
(void)	- registerDependency: [implementation]
(void)	- dependencyRegistrationComplete [implementation]
(BOOL)	- canRun [implementation]
(void)	- performRun [implementation]
(void)	- noteSkipped [implementation]
(NSSet *)	- resolvedDependencies [implementation]
(NSSet *)	- resolvedDependents [implementation]
(void)	- registerDepedent: [implementation]
(void)	- dependencyCompleted: [implementation]

Class Methods
(NSString *)	+ nameForReverseDependencyForVerifier:

Private Attributes
NSMutableSet *	_usedTextures

Detailed Description

Definition at line 33 of file OOTextureVerifierStage.h.

Method Documentation

checkTextureNamed:inFolder:

- (void) checkTextureNamed: (NSString *) name inFolder: (NSString *) folder

implementation

Provided by category OOTextureVerifierStage(OOPrivate).

Definition at line 34 of file OOTextureVerifierStage.m.

                         :(NSString *)name inFolder:(NSString *)folder
{
    OOTextureLoader             *loader = nil;
    NSString                    *path = nil;
    OOFileScannerVerifierStage  *fileScanner = nil;
    NSString                    *displayName = nil;
    OOPixMapDimension           rWidth, rHeight;
    BOOL                        success;
    OOPixMap                    pixmap;
    OOTextureDataFormat         format;
    
    fileScanner = [[self verifier] fileScannerStage];
    path = [fileScanner pathForFile:name
                           inFolder:folder
                     referencedFrom:nil
                       checkBuiltIn:NO];
    
    if (path == nil)  return;
    
    loader = [OOTextureLoader loaderWithPath:path
                                     options:kOOTextureMinFilterNearest |
                                             kOOTextureMinFilterNearest |
                                             kOOTextureNoShrink |
                                             kOOTextureNoFNFMessage |
                                             kOOTextureNeverScale];
    
    displayName = [fileScanner displayNameForFile:name andFolder:folder];
    if (loader == nil)
    {
        OOLog(@"verifyOXP.texture.failed", @"***** ERROR: image %@ could not be read.", displayName);
    }
    else
    {
        success = [loader getResult:&pixmap format:&format originalWidth:NULL originalHeight:NULL];
        
        if (success)
        {
            rWidth = OORoundUpToPowerOf2_PixMap((2 * pixmap.width) / 3);
            rHeight = OORoundUpToPowerOf2_PixMap((2 * pixmap.height) / 3);
            if (pixmap.width != rWidth || pixmap.height != rHeight)
            {
                OOLog(@"verifyOXP.texture.notPOT", @"----- WARNING: image %@ has non-power-of-two dimensions; it will have to be rescaled (from %ux%u pixels to %ux%u pixels) at runtime.", displayName, pixmap.width, pixmap.height, rWidth, rHeight);
            }
            else
            {
                OOLog(@"verifyOXP.verbose.texture.OK", @"- %@ (%ux%u px) OK.", displayName, pixmap.width, pixmap.height);
            }
            
            OOFreePixMap(&pixmap);
        }
        else
        {
            OOLog(@"verifyOXP.texture.failed", @"***** ERROR: texture loader failed to load %@.", displayName);
        }
    }
}

dealloc

- (void) dealloc

implementation

Reimplemented from OOOXPVerifierStage.

Definition at line 34 of file OOTextureVerifierStage.m.

{
    [_usedTextures release];
    
    [super dealloc];
}

init

- (id) init

implementation

Reimplemented from OOOXPVerifierStage.

Definition at line 34 of file OOTextureVerifierStage.m.

{
    self = [super init];
    if (self != nil)
    {
        _usedTextures = [[NSMutableSet alloc] init];
    }
    return self;
}

name

- (NSString *) name

implementation

Reimplemented from OOOXPVerifierStage.

Definition at line 34 of file OOTextureVerifierStage.m.

{
    return kStageName;
}

nameForReverseDependencyForVerifier:

+ (NSString *) nameForReverseDependencyForVerifier:

(OOOXPVerifier *)

verifier

Definition at line 34 of file OOTextureVerifierStage.m.

                                                 :(OOOXPVerifier *)verifier
{
    return kStageName;
}

run

- (void) run

implementation

Reimplemented from OOOXPVerifierStage.

Definition at line 34 of file OOTextureVerifierStage.m.

{
    NSEnumerator                *nameEnum = nil;
    NSString                    *name = nil;
    NSAutoreleasePool           *pool = nil;
    
    for (nameEnum = [_usedTextures objectEnumerator]; (name = [nameEnum nextObject]); )
    {
        pool = [[NSAutoreleasePool alloc] init];
        [self checkTextureNamed:name inFolder:@"Textures"];
        [pool release];
    }
    [_usedTextures release];
    _usedTextures = nil;
    
    // All "images" are considered used, since we don't have a reasonable way to look for images referenced in JavaScript scripts.
    nameEnum = [[[[self verifier] fileScannerStage] filesInFolder:@"Images"] objectEnumerator];
    while ((name = [nameEnum nextObject]))
    {
        [self checkTextureNamed:name inFolder:@"Images"];
    }
}

shouldRun

- (BOOL) shouldRun

implementation

Reimplemented from OOOXPVerifierStage.

Definition at line 34 of file OOTextureVerifierStage.m.

{
    return [_usedTextures count] != 0 || [[[self verifier] fileScannerStage] filesInFolder:@"Images"] != nil;
}

textureNamed:usedInContext:

- (void) textureNamed:		(NSString *)	name
usedInContext:		(NSString *)	context

Definition at line 34 of file OOTextureVerifierStage.m.

                     :(NSString *)name usedInContext:(NSString *)context
{
    OOFileScannerVerifierStage  *fileScanner = nil;
    
    if (name == nil)  return;
    if ([_usedTextures containsObject:name])  return;
    [_usedTextures addObject:name];
    
    fileScanner = [[self verifier] fileScannerStage];
    if (![fileScanner fileExists:name
                        inFolder:@"Textures"
                  referencedFrom:context
                    checkBuiltIn:YES])
    {
        OOLog(@"verifyOXP.texture.notFound", @"----- WARNING: texture \"%@\" referenced in %@ could not be found in %@ or in Oolite.", name, context, [[self verifier] oxpDisplayName]);
    }
}

Member Data Documentation

_usedTextures

- (NSMutableSet*) _usedTextures

private

Definition at line 36 of file OOTextureVerifierStage.h.

---

The documentation for this class was generated from the following files:

• src/Core/OXPVerifier/OOTextureVerifierStage.h
• src/Core/OXPVerifier/OOTextureVerifierStage.m