CCEffectReflection - Add shininess property

This is an overall control of the affected sprite's shininess that works something like this:

finalColor = baseColor + reflectedColor * shininess * fresnelReflectance

Set it to zero and you see none of the reflected environment. Set it to one and the effect
is completely controlled by the fresnel term.

Author: Thayer J Andrews

cocos2d-ui-tests/tests/CCEffectsTest.m

@@ -81,7 +81,7 @@ -(void)setupReflectEffectTest
     [self.contentNode addChild:environment];
 
     CCSpriteFrame *normalMap = [CCSpriteFrame frameWithImageNamed:@"Images/ShinyBallNormals.png"];
-    CCEffectReflection *reflection = [[CCEffectReflection alloc] initWithEnvironment:environment];
+    CCEffectReflection *reflection = [[CCEffectReflection alloc] initWithShininess:0.4f environment:environment];
     reflection.fresnelBias = 0.0f;
     reflection.fresnelPower = 0.0f;
 
@@ -517,7 +517,7 @@ -(void)setupStackTest
                          [CCEffectHue effectWithHue:90.0f],
                          [CCEffectGlass effectWithRefraction:0.75f refractionEnvironment:refractEnvironment reflectionEnvironment:reflectEnvironment],
                          [CCEffectRefraction effectWithRefraction:0.75f environment:refractEnvironment],
-                         [CCEffectReflection effectWithFresnelBias:0.1f fresnelPower:2.0f environment:reflectEnvironment],
+                         [CCEffectReflection effectWithShininess:1.0f fresnelBias:0.1f fresnelPower:2.0f environment:reflectEnvironment],
                          ];
 
 
@@ -572,7 +572,7 @@ -(void)setupPerformanceTest
                             [CCEffectHue effectWithHue:90.0f],
                             [CCEffectGlass effectWithRefraction:0.5f refractionEnvironment:refractEnvironment reflectionEnvironment:reflectEnvironment],
                             [CCEffectRefraction effectWithRefraction:0.5f environment:refractEnvironment],
-                            [CCEffectReflection effectWithFresnelBias:0.1f fresnelPower:4.0f environment:reflectEnvironment],
+                            [CCEffectReflection effectWithShininess:1.0f fresnelBias:0.1f fresnelPower:4.0f environment:reflectEnvironment],
                             ];
     CCEffect *selectedEffect = allEffects[8];
 

cocos2d/CCEffectReflection.h

@@ -32,6 +32,11 @@
  */
 @property (nonatomic) CCSpriteFrame *normalMap;
 
+/** The overall shininess of the attached sprite. This value is in the range [0..1] and it controls
+ *  how much of the reflected environment contributes to the final color of the affected pixels.
+ */
+@property (nonatomic) float shininess;
+
 /** The bias term in the fresnel reflectance equation:
  *    reflectance = max(0.0, fresnelBias + (1 - fresnelBias) * pow((1 - nDotV), fresnelPower))
  *  This value is in the range [0..1] and it controls the constant (view angle independent) contribution
@@ -63,45 +68,49 @@
  *  Initializes a CCEffectReflection object with the specified environment and normal map and the following default parameters:
  *  fresnelBias = 1.0, fresnelPower = 0.0, normalMap = nil
  *
+ *  @param shininess The overall shininess of the effect.
  *  @param environment The environment image that will be reflected by the affected node.
  *
  *  @return The CCEffectReflection object.
  */
--(id)initWithEnvironment:(CCSprite *)environment;
+-(id)initWithShininess:(float)shininess environment:(CCSprite *)environment;
 
 /**
  *  Initializes a CCEffectReflection object with the specified environment and normal map and the following default parameters:
  *  fresnelBias = 1.0, fresnelPower = 0.0
  *
+ *  @param shininess The overall shininess of the effect.
  *  @param environment The environment image that will be reflected by the affected node.
  *  @param normalMap The normal map of the affected node. This can also be specified as a property of the affected sprite.
  *
  *  @return The CCEffectReflection object.
  */
--(id)initWithEnvironment:(CCSprite *)environment normalMap:(CCSpriteFrame *)normalMap;
+-(id)initWithShininess:(float)shininess environment:(CCSprite *)environment normalMap:(CCSpriteFrame *)normalMap;
 
 /**
  *  Initializes a CCEffectReflection object with the specified parameters and a nil normal map.
  *
+ *  @param shininess The overall shininess of the effect.
  *  @param bias The bias term in the fresnel reflectance equation.
  *  @param power The power term in the fresnel reflectance equation.
  *  @param environment The environment image that will be reflected by the affected node.
  *
  *  @return The CCEffectReflection object.
  */
--(id)initWithFresnelBias:(float)bias fresnelPower:(float)power environment:(CCSprite *)environment;
+-(id)initWithShininess:(float)shininess fresnelBias:(float)bias fresnelPower:(float)power environment:(CCSprite *)environment;
 
 /**
  *  Initializes a CCEffectReflection object with the specified parameters.
  *
+ *  @param shininess The overall shininess of the effect.
  *  @param bias The bias term in the fresnel reflectance equation.
  *  @param power The power term in the fresnel reflectance equation.
  *  @param environment The environment image that will be reflected by the affected node.
  *  @param normalMap The normal map of the affected node. This can also be specified as a property of the affected sprite.
  *
  *  @return The CCEffectReflection object.
  */
--(id)initWithFresnelBias:(float)bias fresnelPower:(float)power environment:(CCSprite *)environment normalMap:(CCSpriteFrame *)normalMap;
+-(id)initWithShininess:(float)shininess fresnelBias:(float)bias fresnelPower:(float)power environment:(CCSprite *)environment normalMap:(CCSpriteFrame *)normalMap;
 
 
 /// -----------------------------------------------------------------------
@@ -112,44 +121,48 @@
  *  Creates a CCEffectReflection object with the specified environment and the following default parameters:
  *  fresnelBias = 1.0, fresnelPower = 0.0, normalMap = nil
  *
+ *  @param shininess The overall shininess of the effect.
  *  @param environment The environment image that will be reflected by the affected node.
  *
  *  @return The CCEffectReflection object.
  */
-+(id)effectWithEnvironment:(CCSprite *)environment;
++(id)effectWithShininess:(float)shininess environment:(CCSprite *)environment;
 
 /**
  *  Creates a CCEffectReflection object with the specified environment and normal map and the following default parameters:
  *  fresnelBias = 1.0, fresnelPower = 0.0
  *
+ *  @param shininess The overall shininess of the effect.
  *  @param environment The environment image that will be reflected by the affected node.
  *  @param normalMap The normal map of the affected node. This can also be specified as a property of the affected sprite.
  *
  *  @return The CCEffectReflection object.
  */
-+(id)effectWithEnvironment:(CCSprite *)environment normalMap:(CCSpriteFrame *)normalMap;
++(id)effectWithShininess:(float)shininess environment:(CCSprite *)environment normalMap:(CCSpriteFrame *)normalMap;
 
 /**
  *  Creates a CCEffectReflection object with the specified parameters and nil normal map.
  *
+ *  @param shininess The overall shininess of the effect.
  *  @param bias The bias term in the fresnel reflectance equation.
  *  @param power The power term in the fresnel reflectance equation.
  *  @param environment The environment image that will be reflected by the affected node.
  *
  *  @return The CCEffectReflection object.
  */
-+(id)effectWithFresnelBias:(float)bias fresnelPower:(float)power environment:(CCSprite *)environment;
++(id)effectWithShininess:(float)shininess fresnelBias:(float)bias fresnelPower:(float)power environment:(CCSprite *)environment;
 
 /**
  *  Creates a CCEffectReflection object with the specified parameters.
  *
+ *  @param shininess The overall shininess of the effect.
  *  @param bias The bias term in the fresnel reflectance equation.
  *  @param power The power term in the fresnel reflectance equation.
  *  @param environment The environment image that will be reflected by the affected node.
  *  @param normalMap The normal map of the affected node. This can also be specified as a property of the affected sprite.
  *
  *  @return The CCEffectReflection object.
  */
-+(id)effectWithFresnelBias:(float)bias fresnelPower:(float)power environment:(CCSprite *)environment normalMap:(CCSpriteFrame *)normalMap;
++(id)effectWithShininess:(float)shininess fresnelBias:(float)bias fresnelPower:(float)power environment:(CCSprite *)environment normalMap:(CCSpriteFrame *)normalMap;
 
 @end

cocos2d/CCEffectReflection.m

@@ -30,27 +30,28 @@ @implementation CCEffectReflection
 
 -(id)init
 {
-    return [self initWithEnvironment:nil];
+    return [self initWithShininess:1.0f environment:nil];
 }
 
--(id)initWithEnvironment:(CCSprite *)environment
+-(id)initWithShininess:(float)shininess environment:(CCSprite *)environment
 {
-    return [self initWithEnvironment:environment normalMap:nil];
+    return [self initWithShininess:shininess environment:environment normalMap:nil];
 }
 
--(id)initWithEnvironment:(CCSprite *)environment normalMap:(CCSpriteFrame *)normalMap
+-(id)initWithShininess:(float)shininess environment:(CCSprite *)environment normalMap:(CCSpriteFrame *)normalMap
 {
-    return [self initWithFresnelBias:1.0f fresnelPower:0.0f environment:environment normalMap:normalMap];
+    return [self initWithShininess:shininess fresnelBias:1.0f fresnelPower:0.0f environment:environment normalMap:normalMap];
 }
 
--(id)initWithFresnelBias:(float)bias fresnelPower:(float)power environment:(CCSprite *)environment
+-(id)initWithShininess:(float)shininess fresnelBias:(float)bias fresnelPower:(float)power environment:(CCSprite *)environment
 {
-    return [self initWithFresnelBias:bias fresnelPower:power environment:environment normalMap:nil];
+    return [self initWithShininess:shininess fresnelBias:bias fresnelPower:power environment:environment normalMap:nil];
 }
 
--(id)initWithFresnelBias:(float)bias fresnelPower:(float)power environment:(CCSprite *)environment normalMap:(CCSpriteFrame *)normalMap
+-(id)initWithShininess:(float)shininess fresnelBias:(float)bias fresnelPower:(float)power environment:(CCSprite *)environment normalMap:(CCSpriteFrame *)normalMap
 {
     NSArray *uniforms = @[
+                          [CCEffectUniform uniform:@"float" name:@"u_shininess" value:[NSNumber numberWithFloat:1.0f]],
                           [CCEffectUniform uniform:@"float" name:@"u_fresnelBias" value:[NSNumber numberWithFloat:1.0f]],
                           [CCEffectUniform uniform:@"float" name:@"u_fresnelPower" value:[NSNumber numberWithFloat:0.0f]],
                           [CCEffectUniform uniform:@"sampler2D" name:@"u_envMap" value:(NSValue*)[CCTexture none]],
@@ -63,6 +64,7 @@ -(id)initWithFresnelBias:(float)bias fresnelPower:(float)power environment:(CCSp
     {
         _environment = environment;
         _normalMap = normalMap;
+        _shininess = shininess;
         _fresnelBias = bias;
         _fresnelPower = power;
 
@@ -71,24 +73,24 @@ -(id)initWithFresnelBias:(float)bias fresnelPower:(float)power environment:(CCSp
     return self;
 }
 
-+(id)effectWithEnvironment:(CCSprite *)environment
++(id)effectWithShininess:(float)shininess environment:(CCSprite *)environment
 {
-    return [[self alloc] initWithEnvironment:environment];
+    return [[self alloc] initWithShininess:shininess environment:environment];
 }
 
-+(id)effectWithEnvironment:(CCSprite *)environment normalMap:(CCSpriteFrame *)normalMap
++(id)effectWithShininess:(float)shininess environment:(CCSprite *)environment normalMap:(CCSpriteFrame *)normalMap
 {
-    return [[self alloc] initWithEnvironment:environment normalMap:normalMap];
+    return [[self alloc] initWithShininess:shininess environment:environment normalMap:normalMap];
 }
 
-+(id)effectWithFresnelBias:(float)bias fresnelPower:(float)power environment:(CCSprite *)environment
++(id)effectWithShininess:(float)shininess fresnelBias:(float)bias fresnelPower:(float)power environment:(CCSprite *)environment
 {
-    return [[self alloc] initWithFresnelBias:bias fresnelPower:power environment:environment];
+    return [[self alloc] initWithShininess:shininess fresnelBias:bias fresnelPower:power environment:environment];
 }
 
-+(id)effectWithFresnelBias:(float)bias fresnelPower:(float)power environment:(CCSprite *)environment normalMap:(CCSpriteFrame *)normalMap
++(id)effectWithShininess:(float)shininess fresnelBias:(float)bias fresnelPower:(float)power environment:(CCSprite *)environment normalMap:(CCSpriteFrame *)normalMap
 {
-    return [[self alloc] initWithFresnelBias:bias fresnelPower:power environment:environment normalMap:normalMap];
+    return [[self alloc] initWithShininess:shininess fresnelBias:bias fresnelPower:power environment:environment normalMap:normalMap];
 }
 
 -(void)buildFragmentFunctions
@@ -130,7 +132,7 @@ -(void)buildFragmentFunctions
                                    // If the refracted texture coordinates are within the bounds of the environment map
                                    // blend the primary color with the refracted environment. Multiplying by the normal
                                    // map alpha also allows the effect to be disabled for specific pixels.
-                                   primaryColor += normalMap.a * fresnel * texture2D(u_envMap, reflectTexCoords);
+                                   primaryColor += normalMap.a * fresnel * u_shininess * texture2D(u_envMap, reflectTexCoords);
                                    return primaryColor;
                                    );
 
@@ -162,6 +164,7 @@ -(void)buildRenderPasses
             pass.verts = verts;
         }
 
+        pass.shaderUniforms[weakSelf.uniformTranslationTable[@"u_shininess"]] = [NSNumber numberWithFloat:weakSelf.shininess];
         pass.shaderUniforms[weakSelf.uniformTranslationTable[@"u_fresnelBias"]] = [NSNumber numberWithFloat:weakSelf.fresnelBias];
         pass.shaderUniforms[weakSelf.uniformTranslationTable[@"u_fresnelPower"]] = [NSNumber numberWithFloat:weakSelf.fresnelPower];