OOBasicMaterial Class Reference

#include <OOBasicMaterial.h>

Inheritance diagram for OOBasicMaterial:

Collaboration diagram for OOBasicMaterial:

Instance Methods
(id)	- initWithName:
(id)	- initWithName:configuration:
(OOColor *)	- diffuseColor
(void)	- setDiffuseColor:
(void)	- setAmbientAndDiffuseColor:
(OOColor *)	- specularColor
(void)	- setSpecularColor:
(OOColor *)	- ambientColor
(void)	- setAmbientColor:
(OOColor *)	- emmisionColor
(void)	- setEmissionColor:
(void)	- getDiffuseComponents:
(void)	- setDiffuseComponents:
(void)	- setAmbientAndDiffuseComponents:
(void)	- getSpecularComponents:
(void)	- setSpecularComponents:
(void)	- getAmbientComponents:
(void)	- setAmbientComponents:
(void)	- getEmissionComponents:
(void)	- setEmissionComponents:
(void)	- setDiffuseRed:green:blue:alpha:
(void)	- setAmbientAndDiffuseRed:green:blue:alpha:
(void)	- setSpecularRed:green:blue:alpha:
(void)	- setAmbientRed:green:blue:alpha:
(void)	- setEmissionRed:green:blue:alpha:
(uint8_t)	- shininess
(void)	- setShininess:
(BOOL)	- permitSpecular
(void)	- dealloc [implementation]
(NSString *)	- name [implementation]
(BOOL)	- doApply [implementation]
(void)	- unapplyWithNext: [implementation]
(NSSet *)	- allTextures [implementation]
Instance Methods inherited from OOMaterial
(void)	- apply
(void)	- ensureFinishedLoading
(BOOL)	- isFinishedLoading
(void)	- setBindingTarget:
(BOOL)	- wantsNormalsAsTextureCoordinates
(NSString *)	- descriptionComponents [implementation]
(void)	- willDealloc

Private Attributes
NSString *	materialName
GLfloat	diffuse [4]
GLfloat	specular [4]
GLfloat	ambient [4]
GLfloat	emission [4]
uint8_t	shininess

Additional Inherited Members
Class Methods inherited from OOMaterial
(void)	+ setUp
(void)	+ applyNone
(OOMaterial *)	+ current
(OOMaterial *)	+ materialWithName:cacheKey:configuration:macros:bindingTarget:forSmoothedMesh:
(OOMaterial *)	+ materialWithName:cacheKey:materialDictionary:shadersDictionary:macros:bindingTarget:forSmoothedMesh:
(NSDictionary *)	+ synthesizeMaterialDictionaryWithName:configuration:macros: [implementation]
(OOMaterial *)	+ defaultShaderMaterialWithName:cacheKey:configuration:macros:bindingTarget: [implementation]

Detailed Description

Definition at line 37 of file OOBasicMaterial.h.

Method Documentation

allTextures

- (NSSet *) allTextures

implementation

Reimplemented from OOMaterial.

Reimplemented in OOSingleTextureMaterial.

Definition at line 342 of file OOBasicMaterial.m.

{
    return [NSSet set];
}

References allTextures.

Referenced by allTextures.

Here is the call graph for this function:

Here is the caller graph for this function:

ambientColor

- (OOColor *) ambientColor

Definition at line 182 of file OOBasicMaterial.m.

{
    return [OOColor colorWithRed:ambient[0]
                           green:ambient[1]
                            blue:ambient[2]
                           alpha:ambient[3]];
}

References ambientColor, and OOColor::colorWithRed:green:blue:alpha:.

Referenced by ambientColor.

Here is the call graph for this function:

Here is the caller graph for this function:

dealloc

- (void) dealloc

implementation

Reimplemented from OOMaterial.

Reimplemented in OOSingleTextureMaterial.

Definition at line 92 of file OOBasicMaterial.m.

{
    [super willDealloc];
    [materialName release];
    
    [super dealloc];
}

References dealloc, OOMaterial::dealloc, and OOMaterial::willDealloc.

Referenced by dealloc, and OOSingleTextureMaterial::dealloc.

Here is the call graph for this function:

Here is the caller graph for this function:

diffuseColor

- (OOColor *) diffuseColor

Definition at line 133 of file OOBasicMaterial.m.

{
    return [OOColor colorWithRed:diffuse[0]
                           green:diffuse[1]
                            blue:diffuse[2]
                           alpha:diffuse[3]];
}

References OOColor::colorWithRed:green:blue:alpha:, and diffuseColor.

Referenced by diffuseColor, and initWithName:configuration:.

Here is the call graph for this function:

Here is the caller graph for this function:

doApply

- (BOOL) doApply

implementation

Reimplemented from OOMaterial.

Reimplemented in OOSingleTextureMaterial.

Definition at line 107 of file OOBasicMaterial.m.

{
    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;
}

References ambient, OOTexture::applyNone, diffuse, doApply, emission, FACE, OOGL, shininess, and specular.

Referenced by doApply, and unapplyWithNext:.

Here is the call graph for this function:

Here is the caller graph for this function:

emmisionColor

- (OOColor *) emmisionColor

Definition at line 203 of file OOBasicMaterial.m.

{
    return [OOColor colorWithRed:emission[0]
                           green:emission[1]
                            blue:emission[2]
                           alpha:emission[3]];
}

References OOColor::colorWithRed:green:blue:alpha:, and emmisionColor.

Referenced by emmisionColor.

Here is the call graph for this function:

Here is the caller graph for this function:

getAmbientComponents:

- (void) getAmbientComponents:

(GLfloat[4])

outComponents

Definition at line 255 of file OOBasicMaterial.m.

                            :(GLfloat[4])outComponents
{
    memcpy(outComponents, ambient, 4 * sizeof *outComponents);
}

References ambient.

getDiffuseComponents:

- (void) getDiffuseComponents:

(GLfloat[4])

outComponents

Definition at line 224 of file OOBasicMaterial.m.

                            :(GLfloat[4])outComponents
{
    memcpy(outComponents, diffuse, 4 * sizeof *outComponents);
}

References diffuse.

getEmissionComponents:

- (void) getEmissionComponents:

(GLfloat[4])

outComponents

Definition at line 267 of file OOBasicMaterial.m.

                             :(GLfloat[4])outComponents
{
    memcpy(outComponents, emission, 4 * sizeof *outComponents);
}

References emission.

getSpecularComponents:

- (void) getSpecularComponents:

(GLfloat[4])

outComponents

Definition at line 243 of file OOBasicMaterial.m.

                             :(GLfloat[4])outComponents
{
    memcpy(outComponents, specular, 4 * sizeof *outComponents);
}

References specular.

initWithName:

- (id) initWithName:

(NSString *)

name

Definition at line 44 of file OOBasicMaterial.m.

                  :(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;
}

References emission, EXPECT_NOT, materialName, nil, setAmbientRed:green:blue:alpha:, setDiffuseRed:green:blue:alpha:, and specular.

Referenced by initWithName:configuration:.

Here is the call graph for this function:

Here is the caller graph for this function:

initWithName:configuration:

- (id) initWithName:		(NSString *)	name
configuration:		(NSDictionary *)	configuration

Reimplemented in OOSingleTextureMaterial.

Definition at line 60 of file OOBasicMaterial.m.

                  :(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;
}

References OOColor::colorWithDescription:, diffuseColor, EXPECT_NOT, initWithName:, nil, permitSpecular, setAmbientColor:, setDiffuseColor:, setEmissionColor:, setShininess:, and setSpecularColor:.

Referenced by OOSingleTextureMaterial::initWithName:texture:configuration:.

Here is the call graph for this function:

Here is the caller graph for this function:

name

- (NSString *) name

implementation

Reimplemented from OOMaterial.

Definition at line 101 of file OOBasicMaterial.m.

{
    return materialName;
}

References materialName, and name.

Referenced by OOSingleTextureMaterial::initWithName:configuration:, OOSingleTextureMaterial::initWithName:texture:configuration:, and name.

Here is the call graph for this function:

Here is the caller graph for this function:

permitSpecular

- (BOOL) permitSpecular

Definition at line 335 of file OOBasicMaterial.m.

{
    return ![UNIVERSE reducedDetail];
}

References permitSpecular.

Referenced by initWithName:configuration:, permitSpecular, and shininess.

Here is the call graph for this function:

Here is the caller graph for this function:

setAmbientAndDiffuseColor:

- (void) setAmbientAndDiffuseColor:

(OOColor *)

color

Definition at line 154 of file OOBasicMaterial.m.

                                 :(OOColor *)color
{
    [self setAmbientColor:color];
    [self setDiffuseColor:color];
}

References setAmbientColor:, and setDiffuseColor:.

Here is the call graph for this function:

setAmbientAndDiffuseComponents:

- (void) setAmbientAndDiffuseComponents:

(const GLfloat[4])

components

Definition at line 236 of file OOBasicMaterial.m.

                                      :(const GLfloat[4])components
{
    [self setAmbientComponents:components];
    [self setDiffuseComponents:components];
}

References setAmbientComponents:, and setDiffuseComponents:.

Here is the call graph for this function:

setAmbientAndDiffuseRed:green:blue:alpha:

- (void) setAmbientAndDiffuseRed:		(GLfloat)	r
green:		(GLfloat)	g
blue:		(GLfloat)	b
alpha:		(GLfloat)	a

Definition at line 288 of file OOBasicMaterial.m.

                               :(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];
}

References setAmbientRed:green:blue:alpha:, and setDiffuseRed:green:blue:alpha:.

Here is the call graph for this function:

setAmbientColor:

- (void) setAmbientColor:

(OOColor *)

color

Definition at line 191 of file OOBasicMaterial.m.

                       :(OOColor *)color
{
    if (color != nil)
    {
        [self setAmbientRed:[color redComponent] 
                      green:[color greenComponent]
                       blue:[color blueComponent]
                      alpha:[color alphaComponent]];
    }
}

References OOColor::alphaComponent, OOColor::blueComponent, OOColor::greenComponent, nil, OOColor::redComponent, and setAmbientRed:green:blue:alpha:.

Referenced by initWithName:configuration:, and setAmbientAndDiffuseColor:.

Here is the call graph for this function:

Here is the caller graph for this function:

setAmbientComponents:

- (void) setAmbientComponents:

(const GLfloat[4])

components

Definition at line 261 of file OOBasicMaterial.m.

                            :(const GLfloat[4])components
{
    memcpy(ambient, components, 4 * sizeof *components);
}

References ambient.

Referenced by setAmbientAndDiffuseComponents:.

Here is the caller graph for this function:

setAmbientRed:green:blue:alpha:

- (void) setAmbientRed:		(GLfloat)	r
green:		(GLfloat)	g
blue:		(GLfloat)	b
alpha:		(GLfloat)	a

Definition at line 304 of file OOBasicMaterial.m.

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

References ambient.

Referenced by initWithName:, setAmbientAndDiffuseRed:green:blue:alpha:, and setAmbientColor:.

Here is the caller graph for this function:

setDiffuseColor:

- (void) setDiffuseColor:

(OOColor *)

color

Definition at line 142 of file OOBasicMaterial.m.

                       :(OOColor *)color
{
    if (color != nil)
    {
        [self setDiffuseRed:[color redComponent] 
                      green:[color greenComponent]
                       blue:[color blueComponent]
                      alpha:[color alphaComponent]];
    }
}

References OOColor::alphaComponent, OOColor::blueComponent, OOColor::greenComponent, nil, OOColor::redComponent, and setDiffuseRed:green:blue:alpha:.

Referenced by initWithName:configuration:, and setAmbientAndDiffuseColor:.

Here is the call graph for this function:

Here is the caller graph for this function:

setDiffuseComponents:

- (void) setDiffuseComponents:

(const GLfloat[4])

components

Definition at line 230 of file OOBasicMaterial.m.

                            :(const GLfloat[4])components
{
    memcpy(diffuse, components, 4 * sizeof *components);
}

References diffuse.

Referenced by setAmbientAndDiffuseComponents:.

Here is the caller graph for this function:

setDiffuseRed:green:blue:alpha:

- (void) setDiffuseRed:		(GLfloat)	r
green:		(GLfloat)	g
blue:		(GLfloat)	b
alpha:		(GLfloat)	a

Definition at line 279 of file OOBasicMaterial.m.

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

References diffuse.

Referenced by initWithName:, setAmbientAndDiffuseRed:green:blue:alpha:, and setDiffuseColor:.

Here is the caller graph for this function:

setEmissionColor:

- (void) setEmissionColor:

(OOColor *)

color

Definition at line 212 of file OOBasicMaterial.m.

                        :(OOColor *)color
{
    if (color != nil)
    {
        [self setEmissionRed:[color redComponent] 
                       green:[color greenComponent]
                        blue:[color blueComponent]
                       alpha:[color alphaComponent]];
    }
}

References OOColor::alphaComponent, OOColor::blueComponent, OOColor::greenComponent, nil, OOColor::redComponent, and setEmissionRed:green:blue:alpha:.

Referenced by initWithName:configuration:.

Here is the call graph for this function:

Here is the caller graph for this function:

setEmissionComponents:

- (void) setEmissionComponents:

(const GLfloat[4])

components

Definition at line 273 of file OOBasicMaterial.m.

                             :(const GLfloat[4])components
{
    memcpy(emission, components, 4 * sizeof *components);
}

References emission.

setEmissionRed:green:blue:alpha:

- (void) setEmissionRed:		(GLfloat)	r
green:		(GLfloat)	g
blue:		(GLfloat)	b
alpha:		(GLfloat)	a

Definition at line 313 of file OOBasicMaterial.m.

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

References emission.

Referenced by setEmissionColor:.

Here is the caller graph for this function:

setShininess:

- (void) setShininess:

(uint8_t)

value

Definition at line 329 of file OOBasicMaterial.m.

                    :(uint8_t)value
{
    shininess = MIN(value, 128);
}

References MIN, and shininess.

Referenced by initWithName:configuration:.

Here is the caller graph for this function:

setSpecularColor:

- (void) setSpecularColor:

(OOColor *)

color

Definition at line 170 of file OOBasicMaterial.m.

                        :(OOColor *)color
{
    if (color != nil)
    {
        [self setSpecularRed:[color redComponent] 
                       green:[color greenComponent]
                        blue:[color blueComponent]
                       alpha:[color alphaComponent]];
    }
}

References OOColor::alphaComponent, OOColor::blueComponent, OOColor::greenComponent, nil, OOColor::redComponent, and setSpecularRed:green:blue:alpha:.

Referenced by initWithName:configuration:.

Here is the call graph for this function:

Here is the caller graph for this function:

setSpecularComponents:

- (void) setSpecularComponents:

(const GLfloat[4])

components

Definition at line 249 of file OOBasicMaterial.m.

                             :(const GLfloat[4])components
{
    memcpy(specular, components, 4 * sizeof *components);
}

References specular.

setSpecularRed:green:blue:alpha:

- (void) setSpecularRed:		(GLfloat)	r
green:		(GLfloat)	g
blue:		(GLfloat)	b
alpha:		(GLfloat)	a

Definition at line 295 of file OOBasicMaterial.m.

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

References specular.

Referenced by setSpecularColor:.

Here is the caller graph for this function:

shininess

- (uint8_t) shininess

References permitSpecular, and shininess.

Here is the call graph for this function:

specularColor

- (OOColor *) specularColor

Definition at line 161 of file OOBasicMaterial.m.

{
    return [OOColor colorWithRed:specular[0]
                           green:specular[1]
                            blue:specular[2]
                           alpha:specular[3]];
}

References OOColor::colorWithRed:green:blue:alpha:, and specularColor.

Referenced by specularColor.

Here is the call graph for this function:

Here is the caller graph for this function:

unapplyWithNext:

- (void) unapplyWithNext: (OOMaterial *) next

implementation

Reimplemented from OOMaterial.

Reimplemented in OOSingleTextureMaterial.

Definition at line 123 of file OOBasicMaterial.m.

                       :(OOMaterial *)next
{
    if (![next isKindOfClass:[OOBasicMaterial class]])
    {
        if (EXPECT_NOT(sDefaultMaterial == nil))  sDefaultMaterial = [[OOBasicMaterial alloc] initWithName:@"<default material>"];
        [sDefaultMaterial doApply];
    }
}

References doApply, EXPECT_NOT, nil, and sDefaultMaterial.

Referenced by OOSingleTextureMaterial::unapplyWithNext:.

Here is the call graph for this function:

Here is the caller graph for this function:

Member Data Documentation

ambient

- (GLfloat ambient[4])

private

Definition at line 45 of file OOBasicMaterial.h.

Referenced by doApply, getAmbientComponents:, setAmbientComponents:, and setAmbientRed:green:blue:alpha:.

diffuse

- (GLfloat diffuse[4])

private

Definition at line 43 of file OOBasicMaterial.h.

Referenced by doApply, getDiffuseComponents:, setDiffuseComponents:, and setDiffuseRed:green:blue:alpha:.

emission

- (GLfloat emission[4])

private

Definition at line 46 of file OOBasicMaterial.h.

Referenced by doApply, getEmissionComponents:, initWithName:, setEmissionComponents:, and setEmissionRed:green:blue:alpha:.

materialName

- (NSString*) materialName

private

Definition at line 40 of file OOBasicMaterial.h.

Referenced by initWithName:, and name.

shininess

- (uint8_t) shininess

private

Definition at line 323 of file OOBasicMaterial.m.

{
    return shininess;
}

Referenced by doApply, setShininess:, and shininess.

specular

- (GLfloat specular[4])

private

Definition at line 44 of file OOBasicMaterial.h.

Referenced by doApply, getSpecularComponents:, initWithName:, setSpecularComponents:, and setSpecularRed:green:blue:alpha:.

---

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

• src/Core/Materials/OOBasicMaterial.h
• src/Core/Materials/OOBasicMaterial.m