OOSkyDrawable.m

Go to the documentation of this file.

/*
 
OOSkyDrawable.m
 
 
Copyright (C) 2007-2013 Jens Ayton
 
Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:
 
The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.
 
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.
 
*/
 
#import "OOSkyDrawable.h"
#import "ResourceManager.h"
#import "OOTexture.h"
#import "GameController.h"
#import "OOColor.h"
#import "OOProbabilisticTextureManager.h"
#import "OOGraphicsResetManager.h"
#import "Universe.h"
#import "OOMacroOpenGL.h"
#import "NSObjectOOExtensions.h"
#import "OOCollectionExtractors.h"
 
 
#define SKY_ELEMENT_SCALE_FACTOR        (BILLBOARD_DEPTH / 500.0f)
#define NEBULA_SHUFFLE_FACTOR           0.005f
#define DEBUG_COLORS                    0   // If set, rgb = xyz (offset to range from 0.1 to 1.0).
 
 
/*  Min and max coords are 0 and 1 normally, but the default
    sky-render-inset-coords can be used to modify them slightly as an attempted
    work-around for artefacts on buggy S3/Via renderers.
*/
static float sMinTexCoord = 0.0f, sMaxTexCoord = 1.0f;
static BOOL sInited = NO;
 
 
/*  Struct used to describe quads initially. This form is optimized for
    reasoning about.
*/
typedef struct OOSkyQuadDesc
{
    Vector              corners[4];
    OOColor             *color;
    OOTexture           *texture;
} OOSkyQuadDesc;
 
 
enum
{
    kSkyQuadSetPositionEntriesPerVertex     = 3,
    kSkyQuadSetTexCoordEntriesPerVertex     = 2,
    kSkyQuadSetColorEntriesPerVertex        = 4
};
 
 
/*  Class containing a set of quads with the same texture. This form is
    optimized for rendering.
*/
@interface OOSkyQuadSet: NSObject
{
@private
    OOTexture               *_texture;
    unsigned                _count;
    GLfloat                 *_positions;    // 3 entries per vertex, 12 per quad
    GLfloat                 *_texCoords;    // 2 entries per vertex, 8 per quad
    GLfloat                 *_colors;       // 4 entries per vertex, 16 per quad
}
 
+ (void)addQuads:(OOSkyQuadDesc *)quads count:(unsigned)count toArray:(NSMutableArray *)ioArray;
 
- (id)initWithQuadsWithTexture:(OOTexture *)texture inArray:(OOSkyQuadDesc *)array count:(unsigned)totalCount;
 
- (void)render;
 
#ifndef NDEBUG
- (size_t) totalSize;
- (OOTexture *) texture;
#endif
 
@end
 
 
/*  Textures are global because there is always a sky, but the sky isn't
    replaced very often, so the textures are likely to fall out of the cache.
*/
static OOProbabilisticTextureManager    *sStarTextures;
static OOProbabilisticTextureManager    *sNebulaTextures;
 
 
static OOColor *SaturatedColorInRange(OOColor *color1, OOColor *color2, BOOL hueFix);
 
 
@interface OOSkyDrawable (OOPrivate) <OOGraphicsResetClient>
 
- (void)setUpStarsWithColor1:(OOColor *)color1 color2:(OOColor *)color2;
- (void)setUpNebulaeWithColor1:(OOColor *)color1
                        color2:(OOColor *)color2
                 clusterFactor:(float)nebulaClusterFactor
                  nebulaHueFix:(BOOL)nebulaHueFix
                         alpha:(float)nebulaAlpha
                         scale:(float)nebulaScale;
                        
 
- (void)loadStarTextures;
- (void)loadNebulaTextures;
 
- (void)addQuads:(OOSkyQuadDesc *)quads count:(unsigned)count;
 
- (void)ensureTexturesLoaded;
 
@end
 
 
@implementation OOSkyDrawable
 
- (id)initWithColor1:(OOColor *)color1
              Color2:(OOColor *)color2
              Color3:(OOColor *)color3
              Color4:(OOColor *)color4
           starCount:(unsigned)starCount
         nebulaCount:(unsigned)nebulaCount
        nebulaHueFix:(BOOL)nebulaHueFix
       clusterFactor:(float)nebulaClusterFactor
               alpha:(float)nebulaAlpha
               scale:(float)nebulaScale
{
    NSAutoreleasePool       *pool = nil;
    
    if (!sInited)
    {
        sInited = YES;
        if ([[NSUserDefaults standardUserDefaults] boolForKey:@"sky-render-inset-coords"])
        {
            sMinTexCoord += 1.0f/128.0f;
            sMaxTexCoord -= 1.0f/128.0f;
        }
    }
    
    self = [super init];
    if (self == nil)  return nil;
    
    _starCount = starCount;
    _nebulaCount = nebulaCount;
    
    pool = [[NSAutoreleasePool alloc] init];
    [self setUpStarsWithColor1:color1 color2:color2];
    
    if (![UNIVERSE reducedDetail])
    {
        [self setUpNebulaeWithColor1:color3
                              color2:color4
                       clusterFactor:nebulaClusterFactor
                        nebulaHueFix:nebulaHueFix
                               alpha:nebulaAlpha
                               scale:nebulaScale];
    }
    [pool release];
    
    [[OOGraphicsResetManager sharedManager] registerClient:self];
    
    return self;
}
 
 
- (void)dealloc
{
    OO_ENTER_OPENGL();
    
    [_quadSets release];
    [[OOGraphicsResetManager sharedManager] unregisterClient:self];
    if (_displayListName != 0)  glDeleteLists(_displayListName, 1);
    
    [super dealloc];
}
 
 
- (void)renderOpaqueParts
{
    // While technically translucent, the sky doesn't need to be depth-sorted
    // since it'll be behind everything else anyway.
    
    OO_ENTER_OPENGL();
    OOSetOpenGLState(OPENGL_STATE_ADDITIVE_BLENDING);
    
    OOGL(glDisable(GL_DEPTH_TEST));  // don't read the depth buffer
    OOGL(glEnable(GL_TEXTURE_2D));
    
    // Make stars dim in atmosphere. Note: works OK on night side because sky is dark blue, not black.
    GLfloat fogColor[4] = {0.02, 0.02, 0.02, 1.0};
    OOGL(glFogfv(GL_FOG_COLOR, fogColor));
    
    if (_displayListName != 0)
    {
        OOGL(glCallList(_displayListName));
    }
    else
    {
        // Set up display list
        [self ensureTexturesLoaded];
        _displayListName = glGenLists(1);
        
        OOGL(glNewList(_displayListName, GL_COMPILE));
        
        OOGL(glEnableClientState(GL_TEXTURE_COORD_ARRAY));
        OOGL(glEnableClientState(GL_COLOR_ARRAY));
        
        [_quadSets makeObjectsPerformSelector:@selector(render)];
        
        OOGL(glDisableClientState(GL_TEXTURE_COORD_ARRAY));
        OOGL(glDisableClientState(GL_COLOR_ARRAY));
        
        OOGL(glEndList());
    }
    
    // Restore state
    OOGL(glEnable(GL_DEPTH_TEST));
    OOGL(glDisable(GL_TEXTURE_2D));
    
    // Resetting fog is draw loop's responsibility.
    
    OOVerifyOpenGLState();
    OOCheckOpenGLErrors(@"OOSkyDrawable after rendering");
}
 
 
- (BOOL)hasOpaqueParts
{
    return YES;
}
 
 
- (GLfloat)maxDrawDistance
{
    return INFINITY;
}
 
#ifndef NDEBUG
- (NSSet *) allTextures
{
    NSMutableSet *result = [NSMutableSet setWithCapacity:[_quadSets count]];
    
    NSEnumerator *quadSetEnum = nil;
    OOSkyQuadSet *quadSet = nil;
    for (quadSetEnum = [_quadSets objectEnumerator]; (quadSet = [quadSetEnum nextObject]); )
    {
        [result addObject:[quadSet texture]];
    }
    
    return result;
}
 
 
- (size_t) totalSize
{
    size_t result = [super totalSize];
    
    NSEnumerator *quadSetEnum = nil;
    OOSkyQuadSet *quadSet = nil;
    for (quadSetEnum = [_quadSets objectEnumerator]; (quadSet = [quadSetEnum nextObject]); )
    {
        result += [quadSet totalSize];
    }
    
    return result;
}
#endif
 
@end
 
 
#if DEBUG_COLORS
static OOColor *DebugColor(Vector orientation)
{
    Vector color = vector_add(make_vector(0.55, 0.55, 0.55), vector_multiply_scalar(vector_normal(orientation), 0.45));
    return [OOColor colorWithCalibratedRed:color.x green:color.y blue:color.z alpha:1.0];
}
#endif
 
 
@implementation OOSkyDrawable (OOPrivate)
 
- (void)setUpStarsWithColor1:(OOColor *)color1 color2:(OOColor *)color2
{
    OOSkyQuadDesc       *quads = NULL, *currQuad = NULL;
    unsigned            i;
    Quaternion          q;
    Vector              vi, vj, vk;
    float               size;
    Vector              middle, offset;
    
    [self loadStarTextures];
    
    quads = malloc(sizeof *quads * _starCount);
    if (quads == NULL)  return;
    
    currQuad = quads;
    for (i = 0; i != _starCount; ++i)
    {
        // Select a direction and rotation.
        q = OORandomQuaternion();
        basis_vectors_from_quaternion(q, &vi, &vj, &vk);
        
        // Select colour and texture.
#if DEBUG_COLORS
        currQuad->color = DebugColor(vk);
#else
        currQuad->color = [color1 blendedColorWithFraction:randf() ofColor:color2];
#endif
        currQuad->texture = [sStarTextures selectTexture];  // Not retained, since sStarTextures is never released.
        
        // Select scale; calculate centre position and offset to first corner.
        size = (1 + (ranrot_rand() % 6)) * SKY_ELEMENT_SCALE_FACTOR;
        middle = vector_multiply_scalar(vk, BILLBOARD_DEPTH);
        offset = vector_multiply_scalar(vector_add(vi, vj), 0.5f * size);
        
        // Scale the "side" vectors.
        Vector vj2 = vector_multiply_scalar(vj, size);
        Vector vi2 = vector_multiply_scalar(vi, size);
        
        // Set up corners.
        currQuad->corners[0] = vector_subtract(middle, offset);
        currQuad->corners[1] = vector_add(currQuad->corners[0], vj2);
        currQuad->corners[2] = vector_add(currQuad->corners[1], vi2);
        currQuad->corners[3] = vector_add(currQuad->corners[0], vi2);
        
        ++currQuad;
    }
    
    [self addQuads:quads count:_starCount];
    free(quads);
}
 
 
- (void)setUpNebulaeWithColor1:(OOColor *)color1
                        color2:(OOColor *)color2
                 clusterFactor:(float)nebulaClusterFactor
                  nebulaHueFix:(BOOL)nebulaHueFix
                         alpha:(float)nebulaAlpha
                         scale:(float)nebulaScale
{
    OOSkyQuadDesc       *quads = NULL, *currQuad = NULL;
    unsigned            i, actualCount = 0, clusters = 0;
    OOColor             *color;
    Quaternion          q;
    Vector              vi, vj, vk;
    double              size, r2;
    Vector              middle, offset;
    int                 r1;
    
    [self loadNebulaTextures];
    
    quads = malloc(sizeof *quads * _nebulaCount);
    if (quads == NULL)  return;
    
    currQuad = quads;
    for (i = 0; i < _nebulaCount; ++i)
    {
        color = SaturatedColorInRange(color1, color2, nebulaHueFix);
        
        // Select a direction and rotation.
        q = OORandomQuaternion();
        
        // Create a cluster of nebula quads.
        while ((i < _nebulaCount) && (randf() < nebulaClusterFactor))
        {
            // Select size.
            r1 = 1 + (ranrot_rand() & 15);
            size = nebulaScale * r1 * SKY_ELEMENT_SCALE_FACTOR;
            
            // Calculate centre position and offset to first corner.
            basis_vectors_from_quaternion(q, &vi, &vj, &vk);
            
            // Select colour and texture. Smaller nebula quads are dimmer.
#if DEBUG_COLORS
            currQuad->color = DebugColor(vk);
#else
            currQuad->color = [color colorWithBrightnessFactor:nebulaAlpha * (0.5f + (float)r1 / 32.0f)];
#endif
            currQuad->texture = [sNebulaTextures selectTexture];    // Not retained, since sStarTextures is never released.
            
            middle = vector_multiply_scalar(vk, BILLBOARD_DEPTH);
            offset = vector_multiply_scalar(vector_add(vi, vj), 0.5f * size);
            
            // Rotate vi and vj by a random angle
            r2 = randf() * M_PI * 2.0;
            quaternion_rotate_about_axis(&q, vk, r2);
            vi = vector_right_from_quaternion(q);
            vj = vector_up_from_quaternion(q);
            
            // Scale the "side" vectors.
            vj = vector_multiply_scalar(vj, size);
            vi = vector_multiply_scalar(vi, size);
            
            // Set up corners.
            currQuad->corners[0] = vector_subtract(middle, offset);
            currQuad->corners[1] = vector_add(currQuad->corners[0], vj);
            currQuad->corners[2] = vector_add(currQuad->corners[1], vi);
            currQuad->corners[3] = vector_add(currQuad->corners[0], vi);
            
            // Shuffle direction quat around a bit to spread the cluster out.
            size = NEBULA_SHUFFLE_FACTOR / (nebulaScale * SKY_ELEMENT_SCALE_FACTOR);
            q.x += size * (randf() - 0.5);
            q.y += size * (randf() - 0.5);
            q.z += size * (randf() - 0.5);
            q.w += size * (randf() - 0.5);
            quaternion_normalize(&q);
            
            ++i;
            ++currQuad;
            ++actualCount;
        }
        ++clusters;
    }
    
    /*  The above code generates less than _nebulaCount quads, because i is
        incremented once in the outer loop as well as in the inner loop. To
        keep skies looking the same, we leave the bug in and fill in the
        actual generated count here.
    */
    _nebulaCount = actualCount;
    
    [self addQuads:quads count:_nebulaCount];
    free(quads);
}
 
 
- (void)addQuads:(OOSkyQuadDesc *)quads count:(unsigned)count
{
    if (_quadSets == nil)  _quadSets = [[NSMutableArray alloc] init];
    
    [OOSkyQuadSet addQuads:quads count:count toArray:_quadSets];
}
 
 
- (void)loadStarTextures
{
    if (sStarTextures == nil)
    {
        sStarTextures = [[OOProbabilisticTextureManager alloc]
                            initWithPListName:@"startextures.plist"
                                      options:kOOTextureMinFilterMipMap | kOOTextureMagFilterLinear | kOOTextureAlphaMask
                                   anisotropy:0.0f
                                      lodBias:-0.0f];
        if (sStarTextures == nil)
        {
            [NSException raise:OOLITE_EXCEPTION_DATA_NOT_FOUND format:@"No star textures could be loaded."];
        }
    }
    
    [sStarTextures setSeed:RANROTGetFullSeed()];
    
}
 
 
- (void)loadNebulaTextures
{
    if (sNebulaTextures == nil)
    {
        sNebulaTextures = [[OOProbabilisticTextureManager alloc]
                            initWithPListName:@"nebulatextures.plist"
                                      options:kOOTextureDefaultOptions | kOOTextureAlphaMask
                                   anisotropy:0.0f
                                      lodBias:0.0f];
        if (sNebulaTextures == nil)
        {
            [NSException raise:OOLITE_EXCEPTION_DATA_NOT_FOUND format:@"No nebula textures could be loaded."];
        }
    }
    
    [sNebulaTextures setSeed:RANROTGetFullSeed()];
    
}
 
 
- (void)ensureTexturesLoaded
{
    [sStarTextures ensureTexturesLoaded];
    [sNebulaTextures ensureTexturesLoaded];
}
 
 
- (void)resetGraphicsState
{
    OO_ENTER_OPENGL();
    
    if (_displayListName != 0)
    {
        glDeleteLists(_displayListName, 1);
        _displayListName = 0;
    }
}
 
@end
 
 
@implementation OOSkyQuadSet
 
+ (void)addQuads:(OOSkyQuadDesc *)quads count:(unsigned)count toArray:(NSMutableArray *)ioArray
{
    NSMutableSet            *seenTextures = nil;
    OOTexture               *texture = nil;
    OOSkyQuadSet            *quadSet = nil;
    unsigned                i;
    
    // Iterate over all quads.
    seenTextures = [NSMutableSet set];
    for (i = 0; i != count; ++i)
    {
        texture = quads[i].texture;
        
        // If we haven't seen this quad's texture before...
        if (![seenTextures containsObject:texture])
        {
            [seenTextures addObject:texture];
            
            // ...create a quad set for this texture.
            quadSet = [[self alloc] initWithQuadsWithTexture:texture
                                                     inArray:quads
                                                       count:count];
            if (quadSet != nil)
            {
                [ioArray addObject:quadSet];
                [quadSet release];
            }
        }
    }
}
 
 
- (id)initWithQuadsWithTexture:(OOTexture *)texture inArray:(OOSkyQuadDesc *)array count:(unsigned)totalCount
{
    BOOL                    OK = YES;
    unsigned                i, j, vertexCount;
    GLfloat                 *pos;
    GLfloat                 *tc;
    GLfloat                 *col;
    GLfloat                 r, g, b, x;
    size_t                  posSize, tcSize, colSize;
    unsigned                count = 0;
    int                 skyColorCorrection = [[NSUserDefaults standardUserDefaults] oo_integerForKey:@"sky-color-correction" defaultValue:0];
    
// Hejl / Burgess-Dawson filmic tone mapping
// this algorithm has gamma correction already embedded 
#define SKYCOLOR_TONEMAP_COMPONENT(skyColorComponent) \
do { \
    x = MAX(0.0, skyColorComponent - 0.004); \
    *col++ = (x * (6.2 * x + 0.5)) / (x * (6.2 * x + 1.7) + 0.06); \
} while (0) 
 
    self = [super init];
    if (self == nil)  OK = NO;
    
    if (OK)
    {
        // Count the quads in the array using this texture.
        for (i = 0; i != totalCount; ++i)
        {
            if (array[i].texture == texture)  ++_count;
        }
        if (_count == 0)  OK = NO;
    }
    
    if (OK)
    {
        // Allocate arrays.
        vertexCount = _count * 4;
        posSize = sizeof *_positions * vertexCount * kSkyQuadSetPositionEntriesPerVertex;
        tcSize = sizeof *_texCoords * vertexCount * kSkyQuadSetTexCoordEntriesPerVertex;
        colSize = sizeof *_colors * vertexCount * kSkyQuadSetColorEntriesPerVertex;
        
        _positions = malloc(posSize);
        _texCoords = malloc(tcSize);
        _colors = malloc(colSize);
        
        if (_positions == NULL || _texCoords == NULL || _colors == NULL)  OK = NO;
        
        pos = _positions;
        tc = _texCoords;
        col = _colors;
    }
    
    if (OK)
    {
        // Find the matching quads again, and convert them to renderable representation.
        for (i = 0; i != totalCount; ++i)
        {
            if (array[i].texture == texture)
            {
                r = [array[i].color redComponent];
                g = [array[i].color greenComponent];
                b = [array[i].color blueComponent];
                
                // Loop over vertices
                for (j = 0; j != 4; ++j)
                {
                    *pos++ = array[i].corners[j].x;
                    *pos++ = array[i].corners[j].y;
                    *pos++ = array[i].corners[j].z;
                    
                    // Colour is the same for each vertex
                    if (skyColorCorrection == 0)        // no color correction
                    {
                        *col++ = r;
                        *col++ = g;
                        *col++ = b;
                    }
                    else if (skyColorCorrection == 1)   // gamma correction only
                    {
                        *col++ = pow(r, 1.0/2.2);
                        *col++ = pow(g, 1.0/2.2);
                        *col++ = pow(b, 1.0/2.2);
                    }
                    else                    // gamma correctioin + filmic tone mapping
                    {
                        SKYCOLOR_TONEMAP_COMPONENT(r);
                        SKYCOLOR_TONEMAP_COMPONENT(g);
                        SKYCOLOR_TONEMAP_COMPONENT(b);
                    }
                    *col++ = 1.0f;  // Alpha is unused but needs to be there
                }
                
                // Texture co-ordinates are the same for each quad.
                *tc++ = sMinTexCoord;
                *tc++ = sMinTexCoord;
                
                *tc++ = sMaxTexCoord;
                *tc++ = sMinTexCoord;
                
                *tc++ = sMaxTexCoord;
                *tc++ = sMaxTexCoord;
                
                *tc++ = sMinTexCoord;
                *tc++ = sMaxTexCoord;
                
                count++;
            }
        }
        
        _texture = [texture retain];
        OOLog(@"sky.setup", @"Generated quadset with %u quads for texture %@", count, _texture);
    }
    
    if (!OK)
    {
        [self release];
        self = nil;
    }
    
    return self;
}
 
 
- (void)dealloc
{
    [_texture release];
    
    if (_positions != NULL)  free(_positions);
    if (_texCoords != NULL)  free(_texCoords);
    if (_colors != NULL)  free(_colors);
    
    [super dealloc];
}
 
 
- (NSString *)description
{
    return [NSString stringWithFormat:@"<%@ %p>{%u quads, texture: %@}", [self class], self, _count, _texture];
}
 
 
- (void)render
{
    OO_ENTER_OPENGL();
    
    [_texture apply];
    
    OOGL(glVertexPointer(kSkyQuadSetPositionEntriesPerVertex, GL_FLOAT, 0, _positions));
    OOGL(glTexCoordPointer(kSkyQuadSetTexCoordEntriesPerVertex, GL_FLOAT, 0, _texCoords));
    OOGL(glColorPointer(kSkyQuadSetColorEntriesPerVertex, GL_FLOAT, 0, _colors));
    
    OOGL(glDrawArrays(GL_QUADS, 0, 4 * _count));
}
 
 
#ifndef NDEBUG
- (size_t) totalSize
{
    return [self oo_objectSize] + _count * 4 * (sizeof *_positions + sizeof *_texCoords + sizeof *_colors);
}
 
 
- (OOTexture *) texture
{
    return _texture;
}
#endif
 
@end
 
 
static OOColor *SaturatedColorInRange(OOColor *color1, OOColor *color2, BOOL hueFix)
{
    OOColor             *color = nil;
    float               hue, saturation, brightness, alpha;
    
    color = [color1 blendedColorWithFraction:randf() ofColor:color2];
    [color getHue:&hue saturation:&saturation brightness:&brightness alpha:&alpha];
    
    saturation = 0.5 * saturation + 0.5;    // move saturation up a notch!
    
    /*  NOTE: this changes the hue, because getHue:... produces hue values
        in [0, 360], but colorWithCalibratedHue:... takes hue values in
        [0, 1].
    */
    if (hueFix)
    {
        /* now nebula colours can be independently set, correct the
         * range so they behave expectedly if they have actually been
         * set in planetinfo */
        hue /= 360.0;
    }
    /* else keep it how it was before so the nebula hues are clearer */
    
    return [OOColor colorWithHue:hue saturation:saturation brightness:brightness alpha:alpha];
}