OOBasicMaterial.m

Go to the documentation of this file.

/*
 
OOBasicMaterial.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 "OOBasicMaterial.h"
#import "OOCollectionExtractors.h"
#import "OOFunctionAttributes.h"
#import "Universe.h"
#import "OOMaterialSpecifier.h"
#import "OOTexture.h"
 
 
static OOBasicMaterial *sDefaultMaterial = nil;
 
 
#define FACE        GL_FRONT_AND_BACK
 
 
@implementation OOBasicMaterial
 
- (id)initWithName:(NSString *)name
{
    self = [super init];
    if (EXPECT_NOT(self == nil))  return nil;
    
    materialName = [name copy];
    
    [self setDiffuseRed:1.0f green:1.0f blue:1.0f alpha:1.0f];
    [self setAmbientRed:1.0f green:1.0f blue:1.0f alpha:1.0f];
    specular[3] = 1.0;
    emission[3] = 1.0;
    
    return self;
}
- (id)initWithName:(NSString *)name {…}
 
 
- (id)initWithName:(NSString *)name configuration:(NSDictionary *)configuration
{
    id                  colorDesc = nil;
    int                 specularExponent;
    
    self = [self initWithName:name];
    if (EXPECT_NOT(self == nil))  return nil;
    
    if (configuration == nil)  configuration = [NSDictionary dictionary];
    
    colorDesc = [configuration oo_diffuseColor];
    if (colorDesc != nil)  [self setDiffuseColor:[OOColor colorWithDescription:colorDesc]];
    
    colorDesc = [configuration oo_ambientColor];
    if (colorDesc != nil)  [self setAmbientColor:[OOColor colorWithDescription:colorDesc]];
    else  [self setAmbientColor:[self diffuseColor]];
    
    colorDesc = [configuration oo_emissionColor];
    if (colorDesc != nil)  [self setEmissionColor:[OOColor colorWithDescription:colorDesc]];
    
    specularExponent = [configuration oo_specularExponent];
    if (specularExponent != 0 && [self permitSpecular])
    {
        colorDesc = [configuration oo_specularColor];
        [self setShininess:specularExponent];
        if (colorDesc != nil)  [self setSpecularColor:[OOColor colorWithDescription:colorDesc]];
    }
    
    return self;
}
- (id)initWithName:(NSString *)name configuration:(NSDictionary *)configuration {…}
 
 
- (void)dealloc
{
    [super willDealloc];
    [materialName release];
    
    [super dealloc];
}
- (void)dealloc {…}
 
 
- (NSString *)name
{
    return materialName;
}
- (NSString *)name {…}
 
 
- (BOOL)doApply
{
    OOGL(glMaterialfv(FACE, GL_DIFFUSE, diffuse));
    OOGL(glMaterialfv(FACE, GL_SPECULAR, specular));
    OOGL(glMaterialfv(FACE, GL_AMBIENT, ambient));
    OOGL(glMaterialfv(FACE, GL_EMISSION, emission));
    OOGL(glMateriali(FACE, GL_SHININESS, shininess));
    if ([self isMemberOfClass:[OOBasicMaterial class]])
    {
        [OOTexture applyNone];
    }
    
    return YES;
}
- (BOOL)doApply {…}
 
 
- (void)unapplyWithNext:(OOMaterial *)next
{
    if (![next isKindOfClass:[OOBasicMaterial class]])
    {
        if (EXPECT_NOT(sDefaultMaterial == nil))  sDefaultMaterial = [[OOBasicMaterial alloc] initWithName:@"<default material>"];
        [sDefaultMaterial doApply];
    }
}
- (void)unapplyWithNext:(OOMaterial *)next {…}
 
 
- (OOColor *)diffuseColor
{
    return [OOColor colorWithRed:diffuse[0]
                           green:diffuse[1]
                            blue:diffuse[2]
                           alpha:diffuse[3]];
}
- (OOColor *)diffuseColor {…}
 
 
- (void)setDiffuseColor:(OOColor *)color
{
    if (color != nil)
    {
        [self setDiffuseRed:[color redComponent] 
                      green:[color greenComponent]
                       blue:[color blueComponent]
                      alpha:[color alphaComponent]];
    }
}
- (void)setDiffuseColor:(OOColor *)color {…}
 
 
- (void)setAmbientAndDiffuseColor:(OOColor *)color
{
    [self setAmbientColor:color];
    [self setDiffuseColor:color];
}
- (void)setAmbientAndDiffuseColor:(OOColor *)color {…}
 
 
- (OOColor *)specularColor
{
    return [OOColor colorWithRed:specular[0]
                           green:specular[1]
                            blue:specular[2]
                           alpha:specular[3]];
}
- (OOColor *)specularColor {…}
 
 
- (void)setSpecularColor:(OOColor *)color
{
    if (color != nil)
    {
        [self setSpecularRed:[color redComponent] 
                       green:[color greenComponent]
                        blue:[color blueComponent]
                       alpha:[color alphaComponent]];
    }
}
- (void)setSpecularColor:(OOColor *)color {…}
 
 
- (OOColor *)ambientColor
{
    return [OOColor colorWithRed:ambient[0]
                           green:ambient[1]
                            blue:ambient[2]
                           alpha:ambient[3]];
}
- (OOColor *)ambientColor {…}
 
 
- (void)setAmbientColor:(OOColor *)color
{
    if (color != nil)
    {
        [self setAmbientRed:[color redComponent] 
                      green:[color greenComponent]
                       blue:[color blueComponent]
                      alpha:[color alphaComponent]];
    }
}
- (void)setAmbientColor:(OOColor *)color {…}
 
 
- (OOColor *)emmisionColor
{
    return [OOColor colorWithRed:emission[0]
                           green:emission[1]
                            blue:emission[2]
                           alpha:emission[3]];
}
- (OOColor *)emmisionColor {…}
 
 
- (void)setEmissionColor:(OOColor *)color
{
    if (color != nil)
    {
        [self setEmissionRed:[color redComponent] 
                       green:[color greenComponent]
                        blue:[color blueComponent]
                       alpha:[color alphaComponent]];
    }
}
- (void)setEmissionColor:(OOColor *)color {…}
 
 
- (void)getDiffuseComponents:(GLfloat[4])outComponents
{
    memcpy(outComponents, diffuse, 4 * sizeof *outComponents);
}
- (void)getDiffuseComponents:(GLfloat[4])outComponents {…}
 
 
- (void)setDiffuseComponents:(const GLfloat[4])components
{
    memcpy(diffuse, components, 4 * sizeof *components);
}
- (void)setDiffuseComponents:(const GLfloat[4])components {…}
 
 
- (void)setAmbientAndDiffuseComponents:(const GLfloat[4])components
{
    [self setAmbientComponents:components];
    [self setDiffuseComponents:components];
}
- (void)setAmbientAndDiffuseComponents:(const GLfloat[4])components {…}
 
 
- (void)getSpecularComponents:(GLfloat[4])outComponents
{
    memcpy(outComponents, specular, 4 * sizeof *outComponents);
}
- (void)getSpecularComponents:(GLfloat[4])outComponents {…}
 
 
- (void)setSpecularComponents:(const GLfloat[4])components
{
    memcpy(specular, components, 4 * sizeof *components);
}
- (void)setSpecularComponents:(const GLfloat[4])components {…}
 
 
- (void)getAmbientComponents:(GLfloat[4])outComponents
{
    memcpy(outComponents, ambient, 4 * sizeof *outComponents);
}
- (void)getAmbientComponents:(GLfloat[4])outComponents {…}
 
 
- (void)setAmbientComponents:(const GLfloat[4])components
{
    memcpy(ambient, components, 4 * sizeof *components);
}
- (void)setAmbientComponents:(const GLfloat[4])components {…}
 
 
- (void)getEmissionComponents:(GLfloat[4])outComponents
{
    memcpy(outComponents, emission, 4 * sizeof *outComponents);
}
- (void)getEmissionComponents:(GLfloat[4])outComponents {…}
 
 
- (void)setEmissionComponents:(const GLfloat[4])components
{
    memcpy(emission, components, 4 * sizeof *components);
}
- (void)setEmissionComponents:(const GLfloat[4])components {…}
 
 
- (void)setDiffuseRed:(GLfloat)r green:(GLfloat)g blue:(GLfloat)b alpha:(GLfloat)a
{
    diffuse[0] = r;
    diffuse[1] = g;
    diffuse[2] = b;
    diffuse[3] = a;
}
- (void)setDiffuseRed:(GLfloat)r green:(GLfloat)g blue:(GLfloat)b alpha:(GLfloat)a {…}
 
 
- (void)setAmbientAndDiffuseRed:(GLfloat)r green:(GLfloat)g blue:(GLfloat)b alpha:(GLfloat)a
{
    [self setAmbientRed:r green:g blue:b alpha:a];
    [self setDiffuseRed:r green:g blue:b alpha:a];
}
- (void)setAmbientAndDiffuseRed:(GLfloat)r green:(GLfloat)g blue:(GLfloat)b alpha:(GLfloat)a {…}
 
 
- (void)setSpecularRed:(GLfloat)r green:(GLfloat)g blue:(GLfloat)b alpha:(GLfloat)a
{
    specular[0] = r;
    specular[1] = g;
    specular[2] = b;
    specular[3] = a;
}
- (void)setSpecularRed:(GLfloat)r green:(GLfloat)g blue:(GLfloat)b alpha:(GLfloat)a {…}
 
 
- (void)setAmbientRed:(GLfloat)r green:(GLfloat)g blue:(GLfloat)b alpha:(GLfloat)a
{
    ambient[0] = r;
    ambient[1] = g;
    ambient[2] = b;
    ambient[3] = a;
}
- (void)setAmbientRed:(GLfloat)r green:(GLfloat)g blue:(GLfloat)b alpha:(GLfloat)a {…}
 
 
- (void)setEmissionRed:(GLfloat)r green:(GLfloat)g blue:(GLfloat)b alpha:(GLfloat)a
{
    emission[0] = r;
    emission[1] = g;
    emission[2] = b;
    emission[3] = a;
}
- (void)setEmissionRed:(GLfloat)r green:(GLfloat)g blue:(GLfloat)b alpha:(GLfloat)a {…}
 
 
 
- (uint8_t)shininess
{
    return shininess;
}
- (uint8_t)shininess {…};
 
 
- (void)setShininess:(uint8_t)value
{
    shininess = MIN(value, 128);
}
- (void)setShininess:(uint8_t)value {…}
 
 
- (BOOL) permitSpecular
{
    return ![UNIVERSE reducedDetail];
}
- (BOOL) permitSpecular {…}
 
 
#ifndef NDEBUG
- (NSSet *) allTextures
{
    return [NSSet set];
}
- (NSSet *) allTextures {…}
#endif
 
@end