Merge pull request #905 from thayerandrews/develop

CCEffectGlass/Reflection/Refraction - New initializer / constructor variants

Author: vlidholt

cocos2d-ui-tests/tests/CCEffectsTest.m

@@ -41,7 +41,7 @@ -(void)setupGlassEffectTest
 
 
     CCSpriteFrame *normalMap = [CCSpriteFrame frameWithImageNamed:@"Images/ShinyBallNormals.png"];
-    CCEffectGlass *glass = [[CCEffectGlass alloc] initWithRefraction:1.0f refractionEnvironment:refractEnvironment reflectionEnvironment:reflectEnvironment normalMap:nil];
+    CCEffectGlass *glass = [[CCEffectGlass alloc] initWithRefraction:1.0f refractionEnvironment:refractEnvironment reflectionEnvironment:reflectEnvironment];
     glass.fresnelBias = 0.1f;
     glass.fresnelPower = 2.0f;
     glass.refraction = 0.75f;
@@ -81,7 +81,7 @@ -(void)setupReflectEffectTest
     [self.contentNode addChild:environment];
 
     CCSpriteFrame *normalMap = [CCSpriteFrame frameWithImageNamed:@"Images/ShinyBallNormals.png"];
-    CCEffectReflection *reflection = [[CCEffectReflection alloc] initWithEnvironment:environment normalMap:nil];
+    CCEffectReflection *reflection = [[CCEffectReflection alloc] initWithEnvironment:environment];
     reflection.fresnelBias = 0.0f;
     reflection.fresnelPower = 0.0f;
 
@@ -148,7 +148,7 @@ -(void)setupRefractionEffectTest
     NSString *sphereTextureFile = @"Images/ShinyBallColor.png";
     CCTexture *sphereTexture = [CCTexture textureWithFile:sphereTextureFile];
     CCSpriteFrame *sphereNormalMap = [CCSpriteFrame frameWithImageNamed:@"Images/ShinyBallNormals.png"];
-    CCEffectRefraction *sphereRefraction = [[CCEffectRefraction alloc] initWithRefraction:0.1f environment:renderTexture.sprite normalMap:nil];
+    CCEffectRefraction *sphereRefraction = [[CCEffectRefraction alloc] initWithRefraction:0.1f environment:renderTexture.sprite];
     sphereRefraction.refraction = 0.75f;
 
     p1 = CGPointMake(0.1f, 0.8f);
@@ -515,9 +515,9 @@ -(void)setupStackTest
                          [CCEffectPixellate effectWithBlockSize:8.0f],
                          [CCEffectSaturation effectWithSaturation:-1.0f],
                          [CCEffectHue effectWithHue:90.0f],
-                         [CCEffectGlass effectWithRefraction:0.5f refractionEnvironment:refractEnvironment reflectionEnvironment:reflectEnvironment normalMap:nil],
-                         [CCEffectRefraction effectWithRefraction:0.5f environment:refractEnvironment normalMap:nil],
-                         [CCEffectReflection effectWithFresnelBias:0.2f fresnelPower:2.0f environment:reflectEnvironment normalMap:nil],
+                         [CCEffectGlass effectWithRefraction:0.5f refractionEnvironment:refractEnvironment reflectionEnvironment:reflectEnvironment],
+                         [CCEffectRefraction effectWithRefraction:0.5f environment:refractEnvironment],
+                         [CCEffectReflection effectWithFresnelBias:0.2f fresnelPower:2.0f environment:reflectEnvironment],
                          ];
 
 
@@ -563,9 +563,9 @@ -(void)setupPerformanceTest
                             [CCEffectPixellate effectWithBlockSize:4.0f],
                             [CCEffectSaturation effectWithSaturation:-1.0f],
                             [CCEffectHue effectWithHue:90.0f],
-                            [CCEffectGlass effectWithRefraction:0.5f refractionEnvironment:refractEnvironment reflectionEnvironment:reflectEnvironment normalMap:nil],
-                            [CCEffectRefraction effectWithRefraction:0.5f environment:refractEnvironment normalMap:nil],
-                            [CCEffectReflection effectWithFresnelBias:0.1f fresnelPower:4.0f environment:reflectEnvironment normalMap:nil],
+                            [CCEffectGlass effectWithRefraction:0.5f refractionEnvironment:refractEnvironment reflectionEnvironment:reflectEnvironment],
+                            [CCEffectRefraction effectWithRefraction:0.5f environment:refractEnvironment],
+                            [CCEffectReflection effectWithFresnelBias:0.1f fresnelPower:4.0f environment:reflectEnvironment],
                             ];
     CCEffect *selectedEffect = allEffects[8];
 

cocos2d/CCEffectGlass.h

@@ -72,6 +72,17 @@
  */
 -(id)init;
 
+/**
+ *  Initializes a CCEffectGlass object with the supplied parameters and a nil normal map.
+ *
+ *  @param refraction The refraction strength.
+ *  @param refractionEnvironment The environment image that will be refracted by the affected node.
+ *  @param reflectionEnvironment The environment image that will be reflected by the affected node.
+ *
+ *  @return The CCEffectGlass object.
+ */
+-(id)initWithRefraction:(float)refraction refractionEnvironment:(CCSprite *)refractionEnvironment reflectionEnvironment:(CCSprite *)reflectionEnvironment;
+
 /**
  *  Initializes a CCEffectGlass object with the supplied parameters.
  *
@@ -89,6 +100,18 @@
 /// @name Creating a CCEffectGlass object
 /// -----------------------------------------------------------------------
 
+
+/**
+ *  Creates a CCEffectGlass object with the supplied parameters and a nil normal map.
+ *
+ *  @param refraction The refraction strength.
+ *  @param refractionEnvironment The environment image that will be refracted by the affected node.
+ *  @param reflectionEnvironment The environment image that will be reflected by the affected node.
+ *
+ *  @return The CCEffectGlass object.
+ */
++(id)effectWithRefraction:(float)refraction refractionEnvironment:(CCSprite *)refractionEnvironment reflectionEnvironment:(CCSprite *)reflectionEnvironment;
+
 /**
  *  Creates a CCEffectGlass object with the supplied parameters.
  *

cocos2d/CCEffectGlass.m

@@ -32,6 +32,11 @@ -(id)init
     return [self initWithRefraction:1.0f refractionEnvironment:nil reflectionEnvironment:nil normalMap:nil];
 }
 
+-(id)initWithRefraction:(float)refraction refractionEnvironment:(CCSprite *)refractionEnvironment reflectionEnvironment:(CCSprite *)reflectionEnvironment
+{
+    return [self initWithRefraction:refraction refractionEnvironment:refractionEnvironment reflectionEnvironment:reflectionEnvironment normalMap:nil];
+}
+
 -(id)initWithRefraction:(float)refraction refractionEnvironment:(CCSprite *)refractionEnvironment reflectionEnvironment:(CCSprite *)reflectionEnvironment normalMap:(CCSpriteFrame *)normalMap
 {
     NSArray *uniforms = @[
@@ -66,6 +71,10 @@ -(id)initWithRefraction:(float)refraction refractionEnvironment:(CCSprite *)refr
     }
     return self;
 }
++(id)effectWithRefraction:(float)refraction refractionEnvironment:(CCSprite *)refractionEnvironment reflectionEnvironment:(CCSprite *)reflectionEnvironment
+{
+    return [[self alloc] initWithRefraction:refraction refractionEnvironment:refractionEnvironment reflectionEnvironment:reflectionEnvironment];
+}
 
 +(id)effectWithRefraction:(float)refraction refractionEnvironment:(CCSprite *)refractionEnvironment reflectionEnvironment:(CCSprite *)reflectionEnvironment normalMap:(CCSpriteFrame *)normalMap
 {

cocos2d/CCEffectReflection.h

@@ -59,6 +59,16 @@
  */
 -(id)init;
 
+/**
+ *  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 environment The environment image that will be reflected by the affected node.
+ *
+ *  @return The CCEffectReflection object.
+ */
+-(id)initWithEnvironment:(CCSprite *)environment;
+
 /**
  *  Initializes a CCEffectReflection object with the specified environment and normal map and the following default parameters:
  *  fresnelBias = 1.0, fresnelPower = 0.0
@@ -70,6 +80,17 @@
  */
 -(id)initWithEnvironment:(CCSprite *)environment normalMap:(CCSpriteFrame *)normalMap;
 
+/**
+ *  Initializes a CCEffectReflection object with the specified parameters and a nil normal map.
+ *
+ *  @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;
+
 /**
  *  Initializes a CCEffectReflection object with the specified parameters.
  *
@@ -87,6 +108,16 @@
 /// @name Creating a CCEffectReflection object
 /// -----------------------------------------------------------------------
 
+/**
+ *  Creates a CCEffectReflection object with the specified environment and the following default parameters:
+ *  fresnelBias = 1.0, fresnelPower = 0.0, normalMap = nil
+ *
+ *  @param environment The environment image that will be reflected by the affected node.
+ *
+ *  @return The CCEffectReflection object.
+ */
++(id)effectWithEnvironment:(CCSprite *)environment;
+
 /**
  *  Creates a CCEffectReflection object with the specified environment and normal map and the following default parameters:
  *  fresnelBias = 1.0, fresnelPower = 0.0
@@ -98,6 +129,17 @@
  */
 +(id)effectWithEnvironment:(CCSprite *)environment normalMap:(CCSpriteFrame *)normalMap;
 
+/**
+ *  Creates a CCEffectReflection object with the specified parameters and nil normal map.
+ *
+ *  @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;
+
 /**
  *  Creates a CCEffectReflection object with the specified parameters.
  *

cocos2d/CCEffectReflection.m

@@ -30,14 +30,24 @@ @implementation CCEffectReflection
 
 -(id)init
 {
-    return [self initWithEnvironment:nil normalMap:nil];
+    return [self initWithEnvironment:nil];
+}
+
+-(id)initWithEnvironment:(CCSprite *)environment
+{
+    return [self initWithEnvironment:environment normalMap:nil];
 }
 
 -(id)initWithEnvironment:(CCSprite *)environment normalMap:(CCSpriteFrame *)normalMap
 {
     return [self initWithFresnelBias:1.0f fresnelPower:0.0f environment:environment normalMap:normalMap];
 }
 
+-(id)initWithFresnelBias:(float)bias fresnelPower:(float)power environment:(CCSprite *)environment
+{
+    return [self initWithFresnelBias:bias fresnelPower:power environment:environment normalMap:nil];
+}
+
 -(id)initWithFresnelBias:(float)bias fresnelPower:(float)power environment:(CCSprite *)environment normalMap:(CCSpriteFrame *)normalMap
 {
     NSArray *uniforms = @[
@@ -61,11 +71,21 @@ -(id)initWithFresnelBias:(float)bias fresnelPower:(float)power environment:(CCSp
     return self;
 }
 
++(id)effectWithEnvironment:(CCSprite *)environment
+{
+    return [[self alloc] initWithEnvironment:environment];
+}
+
 +(id)effectWithEnvironment:(CCSprite *)environment normalMap:(CCSpriteFrame *)normalMap
 {
     return [[self alloc] initWithEnvironment:environment normalMap:normalMap];
 }
 
++(id)effectWithFresnelBias:(float)bias fresnelPower:(float)power environment:(CCSprite *)environment
+{
+    return [[self alloc] initWithFresnelBias:bias fresnelPower:power environment:environment];
+}
+
 +(id)effectWithFresnelBias:(float)bias fresnelPower:(float)power environment:(CCSprite *)environment normalMap:(CCSpriteFrame *)normalMap
 {
     return [[self alloc] initWithFresnelBias:bias fresnelPower:power environment:environment normalMap:normalMap];

cocos2d/CCEffectRefraction.h

@@ -49,6 +49,16 @@
  */
 -(id)init;
 
+/**
+ *  Initializes a CCEffectRefraction object with the supplied parameters and a nil normal map.
+ *
+ *  @param refraction The refraction strength.
+ *  @param environment The environment image that will be refracted by the affected node.
+ *
+ *  @return The CCEffectRefraction object.
+ */
+-(id)initWithRefraction:(float)refraction environment:(CCSprite *)environment;
+
 /**
  *  Initializes a CCEffectRefraction object with the supplied parameters.
  *
@@ -65,6 +75,16 @@
 /// @name Initializing a CCEffectRefraction object
 /// -----------------------------------------------------------------------
 
+/**
+ *  Creates a CCEffectRefraction object with the supplied parameters and a nil normal map.
+ *
+ *  @param refraction The refraction strength.
+ *  @param environment The environment image that will be refracted by the affected node.
+ *
+ *  @return The CCEffectRefraction object.
+ */
++(id)effectWithRefraction:(float)refraction environment:(CCSprite *)environment;
+
 /**
  *  Creates a CCEffectRefraction object with the supplied parameters.
  *

cocos2d/CCEffectRefraction.m

@@ -31,6 +31,11 @@ -(id)init
     return [self initWithRefraction:1.0f environment:nil normalMap:nil];
 }
 
+-(id)initWithRefraction:(float)refraction environment:(CCSprite *)environment
+{
+    return [self initWithRefraction:refraction environment:environment normalMap:nil];
+}
+
 -(id)initWithRefraction:(float)refraction environment:(CCSprite *)environment normalMap:(CCSpriteFrame *)normalMap
 {
     NSArray *uniforms = @[
@@ -53,6 +58,11 @@ -(id)initWithRefraction:(float)refraction environment:(CCSprite *)environment no
     return self;
 }
 
++(id)effectWithRefraction:(float)refraction environment:(CCSprite *)environment
+{
+    return [[self alloc] initWithRefraction:refraction environment:environment];
+}
+
 +(id)effectWithRefraction:(float)refraction environment:(CCSprite *)environment normalMap:(CCSpriteFrame *)normalMap
 {
     return [[self alloc] initWithRefraction:refraction environment:environment normalMap:normalMap];