CCLightNode - Add separate specular color and intensity properties

Author: Thayer J Andrews

cocos2d/CCLightNode.h

@@ -53,6 +53,20 @@ typedef NS_ENUM(NSUInteger, CCLightType)
  */
 @property (nonatomic, assign) float intensity;
 
+/** The specular color of the light. As described below, the color is modulated by the
+ *  specular intensity value to determine the contribution of the light to the lighting
+ *  effect. This color is used when computing the light's specular (shiny) contribution
+ *  to the lighting effect.
+ */
+@property (nonatomic, strong) CCColor* specularColor;
+
+/** The brightness of the light's specular color. This value is in the range [0..1]
+ *  with 0 resulting in no contribution from the specular color to the final image
+ *  (the specular color effectively becomes black) and 1 resulting in full contribution
+ *  from this light.
+ */
+@property (nonatomic, assign) float specularIntensity;
+
 /** The ambient color of the light. As described below, the color is modulated by the
  *  ambient intensity value to determine the contribution of the light to the lighting
  *  effect. The ambient color contributes to the lighting effect independent of the light's
@@ -101,15 +115,28 @@ typedef NS_ENUM(NSUInteger, CCLightType)
 /**
  *  Initializes a CCLightNode object with the specified parameters.
  *
- *  @param type             The type of the light.
- *  @param color            The primary color of the light.
- *  @param intensity        The brightness of the light's primary color.
- *  @param ambientColor     The ambient color of the light.
- *  @param ambientIntensity The brightness of the light's ambient color.
+ *  @param type              The type of the light.
+ *  @param color             The primary color of the light.
+ *  @param intensity         The brightness of the light's primary color.
  *
  *  @return The CCLighttNode object.
  */
--(id)initWithType:(CCLightType)type color:(CCColor *)color intensity:(float)intensity ambientColor:(CCColor *)ambientColor ambientIntensity:(float)ambientIntensity;
+-(id)initWithType:(CCLightType)type color:(CCColor *)color intensity:(float)intensity;
+
+/**
+ *  Initializes a CCLightNode object with the specified parameters.
+ *
+ *  @param type              The type of the light.
+ *  @param color             The primary color of the light.
+ *  @param intensity         The brightness of the light's primary color.
+ *  @param specularColor     The specular color of the light.
+ *  @param specularIntensity The brightness of the light's specular color.
+ *  @param ambientColor      The ambient color of the light.
+ *  @param ambientIntensity  The brightness of the light's ambient color.
+ *
+ *  @return The CCLighttNode object.
+ */
+-(id)initWithType:(CCLightType)type color:(CCColor *)color intensity:(float)intensity specularColor:(CCColor *)specularColor specularIntensity:(float)specularIntensity ambientColor:(CCColor *)ambientColor ambientIntensity:(float)ambientIntensity;
 
 
 /// -----------------------------------------------------------------------
@@ -119,15 +146,28 @@ typedef NS_ENUM(NSUInteger, CCLightType)
 /**
  *  Creates a CCLightNode object with the specified parameters.
  *
- *  @param type             The type of the light.
- *  @param color            The primary color of the light.
- *  @param intensity        The brightness of the light's primary color.
- *  @param ambientColor     The ambient color of the light.
- *  @param ambientIntensity The brightness of the light's ambient color.
+ *  @param type              The type of the light.
+ *  @param color             The primary color of the light.
+ *  @param intensity         The brightness of the light's primary color.
+ *
+ *  @return An initialized CCLightNode object.
+ */
++(id)lightWithType:(CCLightType)type color:(CCColor *)color intensity:(float)intensity;
+
+/**
+ *  Creates a CCLightNode object with the specified parameters.
+ *
+ *  @param type              The type of the light.
+ *  @param color             The primary color of the light.
+ *  @param intensity         The brightness of the light's primary color.
+ *  @param specularColor     The specular color of the light.
+ *  @param specularIntensity The brightness of the light's specular color.
+ *  @param ambientColor      The ambient color of the light.
+ *  @param ambientIntensity  The brightness of the light's ambient color.
  *
  *  @return An initialized CCLightNode object.
  */
-+(id)lightWithType:(CCLightType)type color:(CCColor *)color intensity:(float)intensity ambientColor:(CCColor *)ambientColor ambientIntensity:(float)ambientIntensity;
++(id)lightWithType:(CCLightType)type color:(CCColor *)color intensity:(float)intensity specularColor:(CCColor *)specularColor specularIntensity:(float)specularIntensity ambientColor:(CCColor *)ambientColor ambientIntensity:(float)ambientIntensity;
 
 
 @end

cocos2d/CCLightNode.m

@@ -14,19 +14,29 @@ @implementation CCLightNode
 
 -(id)init
 {
-    return [self initWithType:CCLightPoint color:[CCColor whiteColor] intensity:1.0f ambientColor:[CCColor whiteColor] ambientIntensity:0.5f];
+    return [self initWithType:CCLightPoint color:[CCColor whiteColor] intensity:1.0f];
 }
 
+-(id)initWithType:(CCLightType)type color:(CCColor *)color intensity:(float)intensity
+{
+    return [self initWithType:type color:color intensity:intensity specularColor:color specularIntensity:intensity ambientColor:[CCColor whiteColor] ambientIntensity:0.5f];
+}
 
--(id)initWithType:(CCLightType)type color:(CCColor *)color intensity:(float)intensity ambientColor:(CCColor *)ambientColor ambientIntensity:(float)ambientIntensity
+-(id)initWithType:(CCLightType)type color:(CCColor *)color intensity:(float)intensity specularColor:(CCColor *)specularColor specularIntensity:(float)specularIntensity ambientColor:(CCColor *)ambientColor ambientIntensity:(float)ambientIntensity
 {
     if ((self = [super init]))
     {
         _type = type;
+        
         _color = color.ccColor4f;
         _intensity = intensity;
+        
+        _specularColor = specularColor;
+        _specularIntensity = specularIntensity;
+        
         _ambientColor = ambientColor;
         _ambientIntensity = ambientIntensity;
+        
         _cutoffRadius = 0.0f;
         if (type == CCLightDirectional)
         {
@@ -41,9 +51,14 @@ -(id)initWithType:(CCLightType)type color:(CCColor *)color intensity:(float)inte
     return self;
 }
 
-+(id)lightWithType:(CCLightType)type color:(CCColor *)color intensity:(float)intensity ambientColor:(CCColor *)ambientColor ambientIntensity:(float)ambientIntensity
++(id)lightWithType:(CCLightType)type color:(CCColor *)color intensity:(float)intensity
+{
+    return [[self alloc] initWithType:type color:color intensity:intensity];
+}
+
++(id)lightWithType:(CCLightType)type color:(CCColor *)color intensity:(float)intensity specularColor:(CCColor *)specularColor specularIntensity:(float)specularIntensity ambientColor:(CCColor *)ambientColor ambientIntensity:(float)ambientIntensity
 {
-    return [[self alloc] initWithType:type color:color intensity:intensity ambientColor:ambientColor ambientIntensity:ambientIntensity];
+    return [[self alloc] initWithType:type color:color intensity:intensity specularColor:specularColor specularIntensity:specularIntensity ambientColor:ambientColor ambientIntensity:ambientIntensity];
 }
 
 -(void)setIntensity:(float)intensity
@@ -52,6 +67,12 @@ -(void)setIntensity:(float)intensity
     _intensity = intensity;
 }
 
+-(void)setSpecularIntensity:(float)intensity
+{
+    NSCAssert((intensity >= 0.0) && (intensity <= 1.0), @"Supplied intensity out of range [0..1].");
+    _specularIntensity = intensity;
+}
+
 -(void)setAmbientIntensity:(float)intensity
 {
     NSCAssert((intensity >= 0.0) && (intensity <= 1.0), @"Supplied intensity out of range [0..1].");