OOColor Class Reference

#include <OOColor.h>

Inheritance diagram for OOColor:

Collaboration diagram for OOColor:

Instance Methods
(OOColor *)	- blendedColorWithFraction:ofColor:
(float)	- redComponent
(float)	- greenComponent
(float)	- blueComponent
(void)	- getRed:green:blue:alpha:
(OORGBAComponents)	- rgbaComponents
(BOOL)	- isBlack
(BOOL)	- isWhite
(float)	- hueComponent
(float)	- saturationComponent
(float)	- brightnessComponent
(void)	- getHue:saturation:brightness:alpha:
(OOHSBAComponents)	- hsbaComponents
(float)	- alphaComponent
(OOColor *)	- premultipliedColor
(OOColor *)	- colorWithBrightnessFactor:
(NSArray *)	- normalizedArray
(NSString *)	- rgbaDescription
(NSString *)	- hsbaDescription
(void)	- setRed:green:blue:alpha: [implementation]
(void)	- setHue:saturation:brightness:alpha: [implementation]
(id)	- copyWithZone: [implementation]
(NSString *)	- descriptionComponents [implementation]

Class Methods
(OOColor *)	+ colorWithHue:saturation:brightness:alpha:
(OOColor *)	+ colorWithRed:green:blue:alpha:
(OOColor *)	+ colorWithWhite:alpha:
(OOColor *)	+ colorWithRGBAComponents:
(OOColor *)	+ colorWithHSBAComponents:
(OOColor *)	+ colorWithDescription:
(OOColor *)	+ brightColorWithDescription:
(OOColor *)	+ colorWithDescription:saturationFactor:
(OOColor *)	+ colorFromString:
(OOColor *)	+ blackColor
(OOColor *)	+ darkGrayColor
(OOColor *)	+ lightGrayColor
(OOColor *)	+ whiteColor
(OOColor *)	+ grayColor
(OOColor *)	+ redColor
(OOColor *)	+ greenColor
(OOColor *)	+ blueColor
(OOColor *)	+ cyanColor
(OOColor *)	+ yellowColor
(OOColor *)	+ magentaColor
(OOColor *)	+ orangeColor
(OOColor *)	+ purpleColor
(OOColor *)	+ brownColor
(OOColor *)	+ clearColor

Private Attributes
float	rgba [4]

Detailed Description

Definition at line 44 of file OOColor.h.

Method Documentation

alphaComponent

- (float) alphaComponent

Definition at line 544 of file OOColor.m.

{
    return rgba[3];
}

Referenced by AddMacroColorIfAppropriate(), fillSquareImageDataWithCloudTexture(), and HeadUpDisplay::hudDrawReticleOnTarget.

Here is the caller graph for this function:

blackColor

+ (OOColor *) blackColor

Definition at line 544 of file OOColor.m.

{
    return [OOColor colorWithWhite:0.0f alpha:1.0f];
}

blendedColorWithFraction:ofColor:

- (OOColor *) blendedColorWithFraction:		(float)	fraction
ofColor:		(OOColor *)	color

Definition at line 544 of file OOColor.m.

                                      :(float)fraction ofColor:(OOColor *)color
{
    float   rgba1[4];
    [color getRed:&rgba1[0] green:&rgba1[1] blue:&rgba1[2] alpha:&rgba1[3]];
    
    OOColor *result = [[OOColor alloc] init];
    [result setRed:OOLerp(rgba[0], rgba1[0], fraction)
             green:OOLerp(rgba[1], rgba1[1], fraction)
              blue:OOLerp(rgba[2], rgba1[2], fraction)
             alpha:OOLerp(rgba[3], rgba1[3], fraction)];
    
    return [result autorelease];
}

Referenced by SaturatedColorInRange().

Here is the caller graph for this function:

blueColor

+ (OOColor *) blueColor

Definition at line 544 of file OOColor.m.

{
    return [OOColor colorWithRed:0.0f green:0.0f blue:1.0f alpha:1.0f];
}

blueComponent

- (float) blueComponent

Definition at line 544 of file OOColor.m.

{
    return rgba[2];
}

Referenced by AddMacroColorIfAppropriate(), fillSquareImageDataWithCloudTexture(), FloatRGBFromDictColor(), and HeadUpDisplay::hudDrawReticleOnTarget.

Here is the caller graph for this function:

brightColorWithDescription:

+ (OOColor *) brightColorWithDescription:

(id)

description

Definition at line 544 of file OOColor.m.

                                        :(id)description
{
    OOColor *color = [OOColor colorWithDescription:description];
    if (color == nil || 0.5f <= [color brightnessComponent])  return color;
    
    return [OOColor colorWithHue:[color hueComponent] / 360.0f saturation:[color saturationComponent] brightness:0.5f alpha:1.0f];
}

brightnessComponent

- (float) brightnessComponent

Definition at line 544 of file OOColor.m.

{
    float maxrgb = (rgba[0] > rgba[1])? ((rgba[0] > rgba[2])? rgba[0]:rgba[2]):((rgba[1] > rgba[2])? rgba[1]:rgba[2]);
    return maxrgb;
}

brownColor

+ (OOColor *) brownColor

Definition at line 544 of file OOColor.m.

{
    return [OOColor colorWithRed:0.6f green:0.4f blue:0.2f alpha:1.0f];
}

clearColor

+ (OOColor *) clearColor

Definition at line 544 of file OOColor.m.

{
    return [OOColor colorWithWhite:0.0f alpha:0.0f];
}

colorFromString:

+ (OOColor *) colorFromString:

(NSString*)

colorFloatString

Definition at line 544 of file OOColor.m.

                             :(NSString*) colorFloatString
{
    float           rgbaValue[4] = { 0.0f, 0.0f, 0.0f, 1.0f };
    NSScanner       *scanner = [NSScanner scannerWithString:colorFloatString];
    float           factor = 1.0f;
    int             i;
    
    for (i = 0; i != 4; ++i)
    {
        if (![scanner scanFloat:&rgbaValue[i]])
        {
            // Less than three floats or non-float, can't parse -> quit
            if (i < 3) return nil;
            
            // If we get here, we only got three components. Make sure alpha is at correct scale:
            rgbaValue[3] /= factor;
        }
        if (1.0f < rgbaValue[i]) factor = 1.0f / 255.0f;
    }
    
    return [OOColor colorWithRed:rgbaValue[0] * factor green:rgbaValue[1] * factor blue:rgbaValue[2] * factor alpha:rgbaValue[3] * factor];
}

colorWithBrightnessFactor:

- (OOColor *) colorWithBrightnessFactor:

(float)

factor

Definition at line 544 of file OOColor.m.

                                       :(float)factor
{
    return [OOColor colorWithRed:OOClamp_0_1_f(rgba[0] * factor)
                           green:OOClamp_0_1_f(rgba[1] * factor)
                            blue:OOClamp_0_1_f(rgba[2] * factor)
                           alpha:rgba[3]];
}

colorWithDescription:

+ (OOColor *) colorWithDescription:

(id)

description

Definition at line 544 of file OOColor.m.

                                  :(id)description
{
    return [self colorWithDescription:description saturationFactor:1.0f];
}

Referenced by CanonicalizeMaterialSpecifier(), EquipmentInfoSetProperty(), FlasherSetProperty(), FloatRGBFromDictColor(), OOPlanetEntity(OOJavaScriptExtensions)::getJSClass:andPrototype:, GetRGBAArrayFromInfo(), GlobalSetGuiColorSettingForKey(), PlayerShipSetProperty(), SetGLColourFromInfo(), ShipSetProperty(), and VisualEffectSetProperty().

Here is the caller graph for this function:

colorWithDescription:saturationFactor:

+ (OOColor *) colorWithDescription:		(id)	description
saturationFactor:		(float)	factor

Definition at line 544 of file OOColor.m.

                                  :(id)description saturationFactor:(float)factor
{
    NSDictionary            *dict = nil;
    OOColor                 *result = nil;
    
    if (description == nil) return nil;
    
    if ([description isKindOfClass:[OOColor class]])
    {
        result = [[description copy] autorelease];
    }
    else if ([description isKindOfClass:[NSString class]])
    {
        if ([description hasSuffix:@"Color"])
        {
            // +fooColor selector
            SEL selector = NSSelectorFromString(description);
            if ([self respondsToSelector:selector])  result = [self performSelector:selector];
        }
        else
        {
            // Some other string
            result = [self colorFromString:description];
        }
    }
    else if ([description isKindOfClass:[NSArray class]])
    {
        result = [self colorFromString:[description componentsJoinedByString:@" "]];
    }
    else if ([description isKindOfClass:[NSDictionary class]])
    {
        dict = description; // Workaround for gnu-gcc's more agressive "multiple methods named..." warnings.
        
        if ([dict objectForKey:@"hue"] != nil)
        {
            // Treat as HSB(A) dictionary
            float h = [dict oo_floatForKey:@"hue"];
            float s = [dict oo_floatForKey:@"saturation" defaultValue:1.0f];
            float b = [dict oo_floatForKey:@"brightness" defaultValue:-1.0f];
            if (b < 0.0f)  b = [dict oo_floatForKey:@"value" defaultValue:1.0f];
            float a = [dict oo_floatForKey:@"alpha" defaultValue:-1.0f];
            if (a < 0.0f)  a = [dict oo_floatForKey:@"opacity" defaultValue:1.0f];
            
            // Not "result =", because we handle the saturation scaling here to allow oversaturation.
            return [OOColor colorWithHue:h / 360.0f saturation:s * factor brightness:b alpha:a];
        }
        else
        {
            // Treat as RGB(A) dictionary
            float r = [dict oo_floatForKey:@"red"];
            float g = [dict oo_floatForKey:@"green"];
            float b = [dict oo_floatForKey:@"blue"];
            float a = [dict oo_floatForKey:@"alpha" defaultValue:-1.0f];
            if (a < 0.0f)  a = [dict oo_floatForKey:@"opacity" defaultValue:1.0f];
            
            result = [OOColor colorWithRed:r green:g blue:b alpha:a];
        }
    }
    
    if (factor != 1.0f && result != nil)
    {
        float h, s, b, a;
        [result getHue:&h saturation:&s brightness:&b alpha:&a];
        h *= 1.0 / 360.0f;  // See note in header.
        s *= factor;
        result = [self colorWithHue:h saturation:s brightness:b alpha:a];
    }
    
    return result;
}

colorWithHSBAComponents:

+ (OOColor *) colorWithHSBAComponents:

(OOHSBAComponents)

components

Definition at line 544 of file OOColor.m.

                                     :(OOHSBAComponents)components
{
    return [self colorWithHue:components.h / 360.0f
                   saturation:components.s
                   brightness:components.b
                        alpha:components.a];
}

colorWithHue:saturation:brightness:alpha:

+ (OOColor *) colorWithHue:		(float)	hue
saturation:		(float)	saturation
brightness:		(float)	brightness
alpha:		(float)	alpha

Definition at line 544 of file OOColor.m.

                          :(float)hue saturation:(float)saturation brightness:(float)brightness alpha:(float)alpha
{
    OOColor* result = [[OOColor alloc] init];
    [result setHue:360.0f * hue saturation:saturation brightness:brightness alpha:alpha];
    return [result autorelease];
}

Referenced by OOPlanetEntity::airColor, and SaturatedColorInRange().

Here is the caller graph for this function:

colorWithRed:green:blue:alpha:

+ (OOColor *) colorWithRed:		(float)	red
green:		(float)	green
blue:		(float)	blue
alpha:		(float)	alpha

Definition at line 544 of file OOColor.m.

                          :(float)red green:(float)green blue:(float)blue alpha:(float)alpha
{
    OOColor* result = [[OOColor alloc] init];
    [result setRed:red green:green blue:blue alpha:alpha];
    return [result autorelease];
}

Referenced by OOPlanetEntity::initFromDictionary:withAtmosphere:andSeed:forSystem:, and HeadUpDisplay::OODrawPlanetInfo.

Here is the caller graph for this function:

colorWithRGBAComponents:

+ (OOColor *) colorWithRGBAComponents:

(OORGBAComponents)

components

Definition at line 544 of file OOColor.m.

                                     :(OORGBAComponents)components
{
    return [self colorWithRed:components.r
                        green:components.g
                         blue:components.b
                        alpha:components.a];
}

Referenced by ModulateColor().

Here is the caller graph for this function:

colorWithWhite:alpha:

+ (OOColor *) colorWithWhite:		(float)	white
alpha:		(float)	alpha

Definition at line 544 of file OOColor.m.

                            :(float)white alpha:(float)alpha
{
    return [OOColor colorWithRed:white green:white blue:white alpha:alpha];
}

copyWithZone:

- (id) copyWithZone: (NSZone *)  zone

implementation

Definition at line 544 of file OOColor.m.

                   :(NSZone *)zone
{
    // Copy is implemented as retain since OOColor is immutable.
    return [self retain];
}

cyanColor

+ (OOColor *) cyanColor

Definition at line 544 of file OOColor.m.

{
    return [OOColor colorWithRed:0.0f green:1.0f blue:1.0f alpha:1.0f];
}

darkGrayColor

+ (OOColor *) darkGrayColor

Definition at line 544 of file OOColor.m.

{
    return [OOColor colorWithWhite:1.0f/3.0f alpha:1.0f];
}

descriptionComponents

- (NSString *) descriptionComponents

implementation

Definition at line 544 of file OOColor.m.

{
    return [NSString stringWithFormat:@"%g, %g, %g, %g", rgba[0], rgba[1], rgba[2], rgba[3]];
}

getHue:saturation:brightness:alpha:

- (void) getHue:		(float *)	hue
saturation:		(float *)	saturation
brightness:		(float *)	brightness
alpha:		(float *)	alpha

Definition at line 544 of file OOColor.m.

               :(float *)hue saturation:(float *)saturation brightness:(float *)brightness alpha:(float *)alpha
{
    NSParameterAssert(hue != NULL && saturation != NULL && brightness != NULL && alpha != NULL);
    
    *alpha = rgba[3];
    
    float fRed = rgba[0], fGreen = rgba[1], fBlue = rgba[2];
    float maxrgb = fmax(fRed, fmax(fGreen, fBlue));
    float minrgb = fmin(fRed, fmin(fGreen, fBlue));
    float delta = maxrgb - minrgb + 0.0001f;
    float h = 0.0f;
    if (maxrgb == fRed && fGreen >= fBlue)
    {
        h = 60.0f * (fGreen - fBlue) / delta;
    }
    else if (maxrgb == fRed && fGreen < fBlue)
    {
        h = 60.0f * (fGreen - fBlue) / delta + 360.0f;
    }
    else if (maxrgb == fGreen)
    {
        h = 60.0f * (fBlue - fRed) / delta + 120.0f;
    }
    else if (maxrgb == fBlue)
    {
        h = 60.0f * (fRed - fGreen) / delta + 240.0f;
    }
    
    float s = (maxrgb == 0.0f) ? 0.0f : (1.0f - (minrgb / maxrgb));
    
    *hue = h;
    *saturation = s;
    *brightness = maxrgb;
}

Referenced by SaturatedColorInRange().

Here is the caller graph for this function:

getRed:green:blue:alpha:

- (void) getRed:		(float *)	red
green:		(float *)	green
blue:		(float *)	blue
alpha:		(float *)	alpha

Definition at line 544 of file OOColor.m.

               :(float *)red green:(float *)green blue:(float *)blue alpha:(float *)alpha
{
    NSParameterAssert(red != NULL && green != NULL && blue != NULL && alpha != NULL);
    
    *red = rgba[0];
    *green = rgba[1];
    *blue = rgba[2];
    *alpha = rgba[3];
}

Referenced by ApplyColor(), GetRGBAArrayFromInfo(), and SetGLColourFromInfo().

Here is the caller graph for this function:

grayColor

+ (OOColor *) grayColor

Definition at line 544 of file OOColor.m.

{
    return [OOColor colorWithWhite:0.5f alpha:1.0f];
}

greenColor

+ (OOColor *) greenColor

Definition at line 544 of file OOColor.m.

{
    return [OOColor colorWithRed:0.0f green:1.0f blue:0.0f alpha:1.0f];
}

Referenced by HeadUpDisplay::hudDrawReticleOnTarget.

Here is the caller graph for this function:

greenComponent

- (float) greenComponent

Definition at line 544 of file OOColor.m.

{
    return rgba[1];
}

Referenced by AddMacroColorIfAppropriate(), fillSquareImageDataWithCloudTexture(), FloatRGBFromDictColor(), and HeadUpDisplay::hudDrawReticleOnTarget.

Here is the caller graph for this function:

hsbaComponents

- (OOHSBAComponents) hsbaComponents

Definition at line 544 of file OOColor.m.

{
    OOHSBAComponents c;
    [self getHue:&c.h
      saturation:&c.s
      brightness:&c.b
           alpha:&c.a];
    return c;
}

Referenced by OOPlanetEntity::HSBColorWithColor.

Here is the caller graph for this function:

hsbaDescription

- (NSString *) hsbaDescription

Definition at line 544 of file OOColor.m.

{
    return OOHSBAComponentsDescription([self hsbaComponents]);
}

hueComponent

- (float) hueComponent

Definition at line 544 of file OOColor.m.

{
    float maxrgb = (rgba[0] > rgba[1])? ((rgba[0] > rgba[2])? rgba[0]:rgba[2]):((rgba[1] > rgba[2])? rgba[1]:rgba[2]);
    float minrgb = (rgba[0] < rgba[1])? ((rgba[0] < rgba[2])? rgba[0]:rgba[2]):((rgba[1] < rgba[2])? rgba[1]:rgba[2]);
    float delta = maxrgb - minrgb + 0.0001f;
    float fRed = rgba[0], fGreen = rgba[1], fBlue = rgba[2];
    float hue = 0.0f;
    if (maxrgb == fRed && fGreen >= fBlue)
    {
        hue = 60.0f * (fGreen - fBlue) / delta;
    }
    else if (maxrgb == fRed && fGreen < fBlue)
    {
        hue = 60.0f * (fGreen - fBlue) / delta + 360.0f;
    }
    else if (maxrgb == fGreen)
    {
        hue = 60.0f * (fBlue - fRed) / delta + 120.0f;
    }
    else if (maxrgb == fBlue)
    {
        hue = 60.0f * (fRed - fGreen) / delta + 240.0f;
    }
    return hue;
}

isBlack

- (BOOL) isBlack

Definition at line 544 of file OOColor.m.

{
    return rgba[0] == 0.0f && rgba[1] == 0.0f && rgba[2] == 0.0f;
}

isWhite

- (BOOL) isWhite

Definition at line 544 of file OOColor.m.

{
    return rgba[0] == 1.0f && rgba[1] == 1.0f && rgba[2] == 1.0f && rgba[3] == 1.0f;
}

lightGrayColor

+ (OOColor *) lightGrayColor

Definition at line 544 of file OOColor.m.

{
    return [OOColor colorWithWhite:2.0f/3.0f alpha:1.0f];
}

Referenced by ApplyColor().

Here is the caller graph for this function:

magentaColor

+ (OOColor *) magentaColor

Definition at line 544 of file OOColor.m.

{
    return [OOColor colorWithRed:1.0f green:0.0f blue:1.0f alpha:1.0f];
}

normalizedArray

- (NSArray *) normalizedArray

Definition at line 544 of file OOColor.m.

{
    float r, g, b, a;
    [self getRed:&r green:&g blue:&b alpha:&a];
    return [NSArray arrayWithObjects:
        [NSNumber numberWithFloat:r],
        [NSNumber numberWithFloat:g],
        [NSNumber numberWithFloat:b],
        [NSNumber numberWithFloat:a],
        nil];
}

Referenced by AddColorIfAppropriate(), CanonicalizeMaterialSpecifier(), EquipmentInfoGetProperty(), FlasherGetProperty(), PlayerShipGetProperty(), ShipGetProperty(), SynthSpecular(), and VisualEffectGetProperty().

Here is the caller graph for this function:

orangeColor

+ (OOColor *) orangeColor

Definition at line 544 of file OOColor.m.

{
    return [OOColor colorWithRed:1.0f green:0.5f blue:0.0f alpha:1.0f];
}

premultipliedColor

- (OOColor *) premultipliedColor

Definition at line 544 of file OOColor.m.

{
    if (rgba[3] == 1.0f)  return [[self retain] autorelease];
    return [OOColor colorWithRed:rgba[0] * rgba[3]
                           green:rgba[1] * rgba[3]
                            blue:rgba[2] * rgba[3]
                           alpha:1.0f];
}

purpleColor

+ (OOColor *) purpleColor

Definition at line 544 of file OOColor.m.

{
    return [OOColor colorWithRed:0.5f green:0.0f blue:0.5f alpha:1.0f];
}

redColor

+ (OOColor *) redColor

Definition at line 544 of file OOColor.m.

{
    return [OOColor colorWithRed:1.0f green:0.0f blue:0.0f alpha:1.0f];
}

Referenced by HeadUpDisplay::hudDrawReticleOnTarget.

Here is the caller graph for this function:

redComponent

- (float) redComponent

Definition at line 544 of file OOColor.m.

{
    return rgba[0];
}

Referenced by AddMacroColorIfAppropriate(), fillSquareImageDataWithCloudTexture(), FloatRGBFromDictColor(), and HeadUpDisplay::hudDrawReticleOnTarget.

Here is the caller graph for this function:

rgbaComponents

- (OORGBAComponents) rgbaComponents

Definition at line 544 of file OOColor.m.

{
    OORGBAComponents c = { rgba[0], rgba[1], rgba[2], rgba[3] };
    return c;
}

Referenced by ModulateColor().

Here is the caller graph for this function:

rgbaDescription

- (NSString *) rgbaDescription

Definition at line 544 of file OOColor.m.

{
    return OORGBAComponentsDescription([self rgbaComponents]);
}

saturationComponent

- (float) saturationComponent

Definition at line 544 of file OOColor.m.

{
    float maxrgb = (rgba[0] > rgba[1])? ((rgba[0] > rgba[2])? rgba[0]:rgba[2]):((rgba[1] > rgba[2])? rgba[1]:rgba[2]);
    float minrgb = (rgba[0] < rgba[1])? ((rgba[0] < rgba[2])? rgba[0]:rgba[2]):((rgba[1] < rgba[2])? rgba[1]:rgba[2]);
    return maxrgb == 0.0f ? 0.0f : (1.0f - (minrgb / maxrgb));
}

setHue:saturation:brightness:alpha:

- (void) setHue: (float)  h saturation: (float)  s brightness: (float)  b alpha: (float)  a

implementation

Definition at line 544 of file OOColor.m.

               :(float)h saturation:(float)s brightness:(float)b alpha:(float)a
{
    rgba[3] = a;
    if (s == 0.0f)
    {
        rgba[0] = rgba[1] = rgba[2] = b;
        return;
    }
    float f, p, q, t;
    int i;
    h = fmod(h, 360.0f);
    if (h < 0.0) h += 360.0f;
    h /= 60.0f;
    
    i = floor(h);
    f = h - i;
    p = b * (1.0f - s);
    q = b * (1.0f - (s * f));
    t = b * (1.0f - (s * (1.0f - f)));
    
    switch (i)
    {
        case 0:
            rgba[0] = b;    rgba[1] = t;    rgba[2] = p;    break;
        case 1:
            rgba[0] = q;    rgba[1] = b;    rgba[2] = p;    break;
        case 2:
            rgba[0] = p;    rgba[1] = b;    rgba[2] = t;    break;
        case 3:
            rgba[0] = p;    rgba[1] = q;    rgba[2] = b;    break;
        case 4:
            rgba[0] = t;    rgba[1] = p;    rgba[2] = b;    break;
        case 5:
            rgba[0] = b;    rgba[1] = p;    rgba[2] = q;    break;
    }
}

setRed:green:blue:alpha:

- (void) setRed: (float)  r green: (float)  g blue: (float)  b alpha: (float)  a

implementation

Definition at line 544 of file OOColor.m.

               :(float)r green:(float)g blue:(float)b alpha:(float)a
{
    rgba[0] = r;
    rgba[1] = g;
    rgba[2] = b;
    rgba[3] = a;
}

whiteColor

+ (OOColor *) whiteColor

Definition at line 544 of file OOColor.m.

{
    return [OOColor colorWithWhite:1.0f alpha:1.0f];
}

yellowColor

+ (OOColor *) yellowColor

Definition at line 544 of file OOColor.m.

{
    return [OOColor colorWithRed:1.0f green:1.0f blue:0.0f alpha:1.0f];
}

Referenced by GuiDisplayGen::addLongText:startingAtRow:align:.

Here is the caller graph for this function:

Member Data Documentation

rgba

- (float rgba[4])

private

Definition at line 48 of file OOColor.h.

---

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

• src/Core/OOColor.h
• src/Core/OOColor.m